cratis-chronicle-client-typescript

The Chronicle client for TypeScript

@cratis/chronicle is a standalone Node.js client SDK that speaks gRPC to a Chronicle server. It is not a browser library and it is not the Arc TypeScript proxy layer — an Arc frontend calls generated command and query proxies over HTTP and never sees this package.

Verified product sources

This skill is verified against Cratis/Chronicle.TypeScript at tag v4.0.0 (commit bed0b86), which is the version published on npm.

Package	Version	Where
@cratis/chronicle	4.0.0	Source/package.json:2
@cratis/chronicle.contracts	17.0.0	Source/package.json dependency
@cratis/fundamentals	^7.14.0	peer dependency — you install it

Do not read the version out of the repository. Source/package.json says 1.0.0; publish-version.js overwrites it at publish time. Take the version from npm.

v4.0.0 is a major bump and it changed real API. Guidance written against 3.x is wrong in at least three places — event tags did not exist, reducers took two arguments, and two event-store RPCs were renamed. Do not carry 3.x examples forward.

Project setup

yarn add @cratis/chronicle @cratis/fundamentals reflect-metadata

@cratis/fundamentals is a peer dependency, so it does not arrive on its own. reflect-metadata must be imported once, at the entry point, before any decorated class is loaded (Documentation/getting-started.md:16-27):

import 'reflect-metadata';

The package is ESM-only ("type": "module", Source/package.json:34) and requires decorator support:

// tsconfig.json
{
    "compilerOptions": {
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true
    }
}

Both are set in the shipped sample (Samples/Console/tsconfig.json:12-13).

Connecting

import 'reflect-metadata';
import { ChronicleClient, ChronicleOptions } from '@cratis/chronicle';

const client = new ChronicleClient(ChronicleOptions.development());
try {
    const store = await client.getEventStore('<EventStoreName>');
    // ... use store ...
} finally {
    client.dispose();
}