The Cratis package

An application that uses Arc and Chronicle together imports from @cratis/arc.core and @cratis/arc.chronicle, and calls withChronicle on every builder. @cratis/cratis composes the two: one import, one builder call. It is the TypeScript counterpart of the .NET Cratis package.

Create the builder

import { CratisApplication } from '@cratis/cratis';
import { metadata } from './Features/generatedMetadata.js';

const builder = CratisApplication.createBuilder();
builder.useGeneratedMetadata(metadata);
await builder.discover(new URL('./Features/', import.meta.url));
const app = await builder.build();
await app.run();

CratisApplication.createBuilder(options, chronicle) creates an Arc builder with options, the same configuration options ArcApplication.createBuilder takes, and registers Chronicle with chronicle. Both default to empty, so the example above reads the event store and connection from Cratis:Chronicle in appsettings.json or the environment. Registration options lists the Chronicle options and the configuration keys.

On a builder you created yourself, builder.addCratis({ eventStore, connectionString }) does the same after you import @cratis/cratis.

What it exports

Import	Re-exports
`@cratis/cratis`	`@cratis/arc.core` and `@cratis/arc.chronicle`, plus `CratisApplication`
`@cratis/cratis/testing`	`@cratis/arc.testing` and `@cratis/arc.chronicle/testing`

What it does not add

It does not install an authentication handler. If your routes need authentication, pass one in CratisApplication.createBuilder({ authentication: [...] }), as you would to ArcApplication.createBuilder; see Authentication. Public routes need no handler.

The Cratis package

Create the builder

What it exports

What it does not add

Related