@cratis/chronicle 0.2.0 → 0.2.2

package/dist/readModels/IReadModels.d.ts

@@ -0,0 +1,75 @@
+import type { Constructor } from '@cratis/fundamentals';
+import type { IMaterializedReadModels } from './IMaterializedReadModels';
+import type { ReadModelChangeset } from './ReadModelChangeset';
+import type { ReadModelSnapshot } from './ReadModelSnapshot';
+/**
+ * Defines a system that works with read models in the event store.
+ */
+export interface IReadModels {
+    /**
+     * Gets the {@link IMaterializedReadModels} for working with materialized read model instances from the sink.
+     */
+    readonly materialized: IMaterializedReadModels;
+    /**
+     * Registers all discovered read models.
+     * @returns A promise that resolves when registration completes.
+     */
+    register(): Promise<void>;
+    /**
+     * Registers a specific read model type.
+     * @param readModelType - The read model type to register.
+     * @returns A promise that resolves when registration completes.
+     */
+    register<TReadModel>(readModelType: Constructor<TReadModel>): Promise<void>;
+    /**
+     * Gets a read model instance by key.
+     * @param readModelType - The read model type to retrieve.
+     * @param key - The read model key.
+     * @param sessionId - Optional session identifier.
+     * @returns The read model instance.
+     */
+    getInstanceById<TReadModel>(readModelType: Constructor<TReadModel>, key: string, sessionId?: string): Promise<TReadModel>;
+    /**
+     * Gets all instances of a read model.
+     * @param readModelType - The read model type to retrieve.
+     * @param eventCount - Optional maximum number of events to process.
+     * @returns The read model instances.
+     */
+    getInstances<TReadModel>(readModelType: Constructor<TReadModel>, eventCount?: bigint): Promise<TReadModel[]>;
+    /**
+     * Gets snapshots for a read model instance by key.
+     * @param readModelType - The read model type to retrieve snapshots for.
+     * @param key - The read model key.
+     * @returns The read model snapshots.
+     */
+    getSnapshotsById<TReadModel>(readModelType: Constructor<TReadModel>, key: string): Promise<ReadModelSnapshot<TReadModel>[]>;
+    /**
+     * Watches changes for a specific read model type.
+     * @param readModelType - The read model type to observe.
+     * @returns An async iterable of read model changes.
+     */
+    watch<TReadModel>(readModelType: Constructor<TReadModel>): AsyncIterable<ReadModelChangeset<TReadModel>>;
+    /**
+     * Dehydrates a read model session.
+     * @param sessionId - The session identifier to dehydrate.
+     * @param readModelType - The read model type.
+     * @param key - The read model key.
+     * @returns A promise that resolves when dehydration completes.
+     */
+    dehydrateSession<TReadModel>(sessionId: string, readModelType: Constructor<TReadModel>, key: string): Promise<void>;
+    /**
+     * Releases (decrypts) PII properties in a read model instance.
+     * @param readModelType - The read model type.
+     * @param instance - The read model instance with encrypted PII.
+     * @returns The read model instance with decrypted PII values.
+     */
+    release<TReadModel>(readModelType: Constructor<TReadModel>, instance: TReadModel): Promise<TReadModel>;
+    /**
+     * Releases (decrypts) PII properties in multiple read model instances.
+     * @param readModelType - The read model type.
+     * @param instances - The read model instances with encrypted PII.
+     * @returns The read model instances with decrypted PII values.
+     */
+    releaseMany<TReadModel>(readModelType: Constructor<TReadModel>, instances: TReadModel[]): Promise<TReadModel[]>;
+}
+//# sourceMappingURL=IReadModels.d.ts.map

package/dist/readModels/IReadModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IReadModels.d.ts","sourceRoot":"","sources":["../../readModels/IReadModels.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,uBAAuB,CAAC;IAE/C;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;;;;;OAMG;IACH,eAAe,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE1H;;;;;OAKG;IACH,YAAY,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAE7G;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAE5H;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzG;;;;;;OAMG;IACH,gBAAgB,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpH;;;;;OAKG;IACH,OAAO,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvG;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;CACnH"}

package/dist/readModels/IReadModels.js

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+export {};
+//# sourceMappingURL=IReadModels.js.map

package/dist/readModels/IReadModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IReadModels.js","sourceRoot":"","sources":["../../readModels/IReadModels.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG"}

package/dist/readModels/MaterializedReadModels.d.ts

@@ -0,0 +1,25 @@
+import type { Constructor } from '@cratis/fundamentals';
+import { ChronicleConnection } from '../connection';
+import type { IMaterializedReadModels } from './IMaterializedReadModels';
+/**
+ * Implements {@link IMaterializedReadModels} by working with the Chronicle materialized read model gRPC service.
+ */
+export declare class MaterializedReadModels implements IMaterializedReadModels {
+    private readonly _eventStore;
+    private readonly _namespace;
+    private readonly _connection;
+    constructor(_eventStore: string, _namespace: string, _connection: ChronicleConnection);
+    /** @inheritdoc */
+    getInstances<TReadModel>(readModelType: Constructor<TReadModel>, skip?: number, take?: number): Promise<TReadModel[]>;
+    /** @inheritdoc */
+    observeInstances<TReadModel>(readModelType: Constructor<TReadModel>, skip?: number, take?: number): AsyncIterable<TReadModel[]>;
+    private resolveIdentifier;
+    private toPageParams;
+    private deserialize;
+    private releaseInstances;
+    private releaseInstance;
+    private getSchema;
+    private schemaHasComplianceMetadata;
+    private extractSubject;
+}
+//# sourceMappingURL=MaterializedReadModels.d.ts.map

package/dist/readModels/MaterializedReadModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaterializedReadModels.d.ts","sourceRoot":"","sources":["../../readModels/MaterializedReadModels.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAIzE;;GAEG;AACH,qBAAa,sBAAuB,YAAW,uBAAuB;IAE9D,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,WAAW;gBAFX,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,mBAAmB;IAGrD,kBAAkB;IACZ,YAAY,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,GAAE,MAAU,EAAE,IAAI,GAAE,MAAoB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAqB3I,kBAAkB;IACX,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,GAAE,MAAU,EAAE,IAAI,GAAE,MAAoB,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;IAqBtJ,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,WAAW;YAOL,gBAAgB;YAShB,eAAe;IAsB7B,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,2BAA2B;IAenC,OAAO,CAAC,cAAc;CAOzB"}

package/dist/readModels/MaterializedReadModels.js

@@ -0,0 +1,125 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { JsonSerializer } from '@cratis/fundamentals';
+import { JsonSchemaGenerator } from '../schemas';
+import { getReadModelMetadata } from './readModel';
+const defaultTake = 50;
+/**
+ * Implements {@link IMaterializedReadModels} by working with the Chronicle materialized read model gRPC service.
+ */
+export class MaterializedReadModels {
+    _eventStore;
+    _namespace;
+    _connection;
+    constructor(_eventStore, _namespace, _connection) {
+        this._eventStore = _eventStore;
+        this._namespace = _namespace;
+        this._connection = _connection;
+    }
+    /** @inheritdoc */
+    async getInstances(readModelType, skip = 0, take = defaultTake) {
+        const readModelIdentifier = this.resolveIdentifier(readModelType);
+        const { page, pageSize, skipWithinPage } = this.toPageParams(skip, take);
+        const response = await this._connection.materializedReadModels.getInstances({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModel: readModelIdentifier,
+            Page: page,
+            PageSize: pageSize
+        });
+        let instances = response.Instances.map(json => this.deserialize(readModelType, json));
+        if (skipWithinPage > 0) {
+            instances = instances.slice(skipWithinPage);
+        }
+        return this.releaseInstances(readModelType, instances);
+    }
+    /** @inheritdoc */
+    async *observeInstances(readModelType, skip = 0, take = defaultTake) {
+        const readModelIdentifier = this.resolveIdentifier(readModelType);
+        const { page, pageSize, skipWithinPage } = this.toPageParams(skip, take);
+        for await (const response of this._connection.materializedReadModels.observeInstances({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModel: readModelIdentifier,
+            Page: page,
+            PageSize: pageSize
+        })) {
+            let instances = response.Instances.map(json => this.deserialize(readModelType, json));
+            if (skipWithinPage > 0) {
+                instances = instances.slice(skipWithinPage);
+            }
+            yield await this.releaseInstances(readModelType, instances);
+        }
+    }
+    resolveIdentifier(readModelType) {
+        const metadata = getReadModelMetadata(readModelType);
+        return metadata?.id.value ?? readModelType.name;
+    }
+    toPageParams(skip, take) {
+        if (take <= 0) {
+            return { page: 0, pageSize: Number.MAX_SAFE_INTEGER, skipWithinPage: 0 };
+        }
+        const page = skip > 0 ? Math.floor(skip / take) : 0;
+        const skipWithinPage = skip % take;
+        return { page, pageSize: take, skipWithinPage };
+    }
+    deserialize(readModelType, json) {
+        if (!json) {
+            return Object.create(readModelType.prototype);
+        }
+        return JsonSerializer.deserialize(readModelType, json);
+    }
+    async releaseInstances(readModelType, instances) {
+        const schema = this.getSchema(readModelType);
+        if (!this.schemaHasComplianceMetadata(schema)) {
+            return instances;
+        }
+        return Promise.all(instances.map(instance => this.releaseInstance(readModelType, instance, schema)));
+    }
+    async releaseInstance(readModelType, instance, schema) {
+        const subject = this.extractSubject(instance);
+        if (!subject) {
+            return instance;
+        }
+        const payload = JsonSerializer.serialize(instance);
+        const response = await this._connection.compliance.release({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            Subject: subject,
+            Schema: schema,
+            Payload: payload
+        });
+        if (response.HasError) {
+            return instance;
+        }
+        return this.deserialize(readModelType, response.Payload);
+    }
+    getSchema(readModelType) {
+        const metadata = getReadModelMetadata(readModelType);
+        if (metadata) {
+            return JSON.stringify(metadata.schema);
+        }
+        return JSON.stringify(JsonSchemaGenerator.generate(readModelType) ?? JsonSchemaGenerator.createEmptySchema(readModelType.name));
+    }
+    schemaHasComplianceMetadata(schema) {
+        try {
+            const parsed = JSON.parse(schema);
+            const properties = parsed.properties;
+            if (!properties) {
+                return false;
+            }
+            return Object.values(properties).some(property => Array.isArray(property.compliance) && property.compliance.length > 0);
+        }
+        catch {
+            return false;
+        }
+    }
+    extractSubject(instance) {
+        const anyInstance = instance;
+        if (anyInstance.id !== undefined && anyInstance.id !== null) {
+            return String(anyInstance.id);
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=MaterializedReadModels.js.map

package/dist/readModels/MaterializedReadModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaterializedReadModels.js","sourceRoot":"","sources":["../../readModels/MaterializedReadModels.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAGrG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAEV;IACA;IACA;IAHrB,YACqB,WAAmB,EACnB,UAAkB,EAClB,WAAgC;QAFhC,gBAAW,GAAX,WAAW,CAAQ;QACnB,eAAU,GAAV,UAAU,CAAQ;QAClB,gBAAW,GAAX,WAAW,CAAqB;IAClD,CAAC;IAEJ,kBAAkB;IAClB,KAAK,CAAC,YAAY,CAAa,aAAsC,EAAE,OAAe,CAAC,EAAE,OAAe,WAAW;QAC/G,MAAM,mBAAmB,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAClE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,YAAY,CAAC;YACxE,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,mBAAmB;YAC9B,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;SACrB,CAAC,CAAC;QAEH,IAAI,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAEtF,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;YACrB,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,CAAC,gBAAgB,CAAa,aAAsC,EAAE,OAAe,CAAC,EAAE,OAAe,WAAW;QACpH,MAAM,mBAAmB,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAClE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEzE,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,gBAAgB,CAAC;YAClF,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,mBAAmB;YAC9B,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;SACrB,CAAC,EAAE,CAAC;YACD,IAAI,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;YAEtF,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;gBACrB,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;IAEO,iBAAiB,CAAa,aAAsC;QACxE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;QACrD,OAAO,QAAQ,EAAE,EAAE,CAAC,KAAK,IAAI,aAAa,CAAC,IAAI,CAAC;IACpD,CAAC;IAEO,YAAY,CAAC,IAAY,EAAE,IAAY;QAC3C,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACZ,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,gBAAgB,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC;QAC7E,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC;QAEnC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;IACpD,CAAC;IAEO,WAAW,CAAa,aAAsC,EAAE,IAAY;QAChF,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAe,CAAC;QAChE,CAAC;QACD,OAAO,cAAc,CAAC,WAAW,CAAC,aAAoC,EAAE,IAAI,CAAe,CAAC;IAChG,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAa,aAAsC,EAAE,SAAuB;QACtG,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5C,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAEO,KAAK,CAAC,eAAe,CAAa,aAAsC,EAAE,QAAoB,EAAE,MAAc;QAClH,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC;YACvD,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,OAAO;SACnB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACpB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAEO,SAAS,CAAa,aAAsC;QAChE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,mBAAmB,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IACpI,CAAC;IAEO,2BAA2B,CAAC,MAAc;QAC9C,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAA4B,CAAC;YAC7D,MAAM,UAAU,GAAG,MAAM,CAAC,UAAiE,CAAC;YAC5F,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CACjC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAK,QAAQ,CAAC,UAAwB,CAAC,MAAM,GAAG,CAAC,CAClG,CAAC;QACN,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAEO,cAAc,CAAa,QAAoB;QACnD,MAAM,WAAW,GAAG,QAAmC,CAAC;QACxD,IAAI,WAAW,CAAC,EAAE,KAAK,SAAS,IAAI,WAAW,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;YAC1D,OAAO,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ"}

package/dist/readModels/ReadModelChangeset.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Represents a change observed for a read model.
+ */
+export interface ReadModelChangeset<TReadModel> {
+    /** The namespace the change belongs to. */
+    readonly namespace: string;
+    /** The read model key. */
+    readonly key: string;
+    /** The current read model state. */
+    readonly readModel: TReadModel;
+    /** Whether the read model was removed. */
+    readonly removed: boolean;
+}
+//# sourceMappingURL=ReadModelChangeset.d.ts.map

package/dist/readModels/ReadModelChangeset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadModelChangeset.d.ts","sourceRoot":"","sources":["../../readModels/ReadModelChangeset.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,UAAU;IAC1C,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,0BAA0B;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAE/B,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B"}

package/dist/readModels/ReadModelChangeset.js

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+export {};
+//# sourceMappingURL=ReadModelChangeset.js.map

package/dist/readModels/ReadModelChangeset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadModelChangeset.js","sourceRoot":"","sources":["../../readModels/ReadModelChangeset.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG"}

package/dist/readModels/ReadModelSnapshot.d.ts

@@ -0,0 +1,15 @@
+import type { AppendedEvent, Guid as ContractsGuid } from '@cratis/chronicle.contracts';
+/**
+ * Represents a read model snapshot together with the events that produced it.
+ */
+export interface ReadModelSnapshot<TReadModel> {
+    /** The read model state at the snapshot. */
+    readonly readModel: TReadModel;
+    /** The events that were applied to reach the snapshot. */
+    readonly events: AppendedEvent[];
+    /** When the snapshot occurred. */
+    readonly occurred: Date | undefined;
+    /** The correlation identifier for the snapshot, when available. */
+    readonly correlationId: ContractsGuid | undefined;
+}
+//# sourceMappingURL=ReadModelSnapshot.d.ts.map

package/dist/readModels/ReadModelSnapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadModelSnapshot.d.ts","sourceRoot":"","sources":["../../readModels/ReadModelSnapshot.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,IAAI,IAAI,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,UAAU;IACzC,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAE/B,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IAEjC,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAC;IAEpC,mEAAmE;IACnE,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;CACrD"}

package/dist/readModels/ReadModelSnapshot.js

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+export {};
+//# sourceMappingURL=ReadModelSnapshot.js.map

package/dist/readModels/ReadModelSnapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadModelSnapshot.js","sourceRoot":"","sources":["../../readModels/ReadModelSnapshot.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG"}

package/dist/readModels/ReadModels.d.ts

@@ -0,0 +1,43 @@
+import type { Constructor } from '@cratis/fundamentals';
+import { IClientArtifactsProvider } from '../artifacts';
+import { ChronicleConnection } from '../connection';
+import type { IMaterializedReadModels } from './IMaterializedReadModels';
+import type { IReadModels } from './IReadModels';
+import type { ReadModelChangeset } from './ReadModelChangeset';
+import type { ReadModelSnapshot } from './ReadModelSnapshot';
+/**
+ * Implements {@link IReadModels} by working with the Chronicle read-model gRPC service.
+ */
+export declare class ReadModels implements IReadModels {
+    private readonly _eventStore;
+    private readonly _namespace;
+    private readonly _connection;
+    private readonly _clientArtifacts;
+    readonly materialized: IMaterializedReadModels;
+    constructor(_eventStore: string, _namespace: string, _connection: ChronicleConnection, _clientArtifacts: IClientArtifactsProvider);
+    /** @inheritdoc */
+    register<TReadModel>(readModelType?: Constructor<TReadModel>): Promise<void>;
+    /** @inheritdoc */
+    getInstanceById<TReadModel>(readModelType: Constructor<TReadModel>, key: string, sessionId?: string): Promise<TReadModel>;
+    /** @inheritdoc */
+    getInstances<TReadModel>(readModelType: Constructor<TReadModel>, eventCount?: bigint): Promise<TReadModel[]>;
+    /** @inheritdoc */
+    getSnapshotsById<TReadModel>(readModelType: Constructor<TReadModel>, key: string): Promise<ReadModelSnapshot<TReadModel>[]>;
+    /** @inheritdoc */
+    watch<TReadModel>(readModelType: Constructor<TReadModel>): AsyncIterable<ReadModelChangeset<TReadModel>>;
+    /** @inheritdoc */
+    dehydrateSession<TReadModel>(sessionId: string, readModelType: Constructor<TReadModel>, key: string): Promise<void>;
+    /** @inheritdoc */
+    release<TReadModel>(readModelType: Constructor<TReadModel>, instance: TReadModel): Promise<TReadModel>;
+    /** @inheritdoc */
+    releaseMany<TReadModel>(readModelType: Constructor<TReadModel>, instances: TReadModel[]): Promise<TReadModel[]>;
+    private releaseSnapshotInstances;
+    private resolveReadModels;
+    private resolveReadModel;
+    private toDefinition;
+    private getReadModelSchema;
+    private deserializeReadModel;
+    private schemaHasComplianceMetadata;
+    private extractSubject;
+}
+//# sourceMappingURL=ReadModels.d.ts.map

package/dist/readModels/ReadModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadModels.d.ts","sourceRoot":"","sources":["../../readModels/ReadModels.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAQpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAa7D;;GAEG;AACH,qBAAa,UAAW,YAAW,WAAW;IAItC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IANrC,QAAQ,CAAC,YAAY,EAAE,uBAAuB,CAAC;gBAG1B,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,mBAAmB,EAChC,gBAAgB,EAAE,wBAAwB;IAK/D,kBAAkB;IACZ,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAclF,kBAAkB;IACZ,eAAe,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAoB/H,kBAAkB;IACZ,YAAY,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,UAAU,GAAE,MAA4B,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAmBvI,kBAAkB;IACZ,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;IAwBjI,kBAAkB;IACX,KAAK,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAkB/G,kBAAkB;IACZ,gBAAgB,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYzH,kBAAkB;IACZ,OAAO,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAqB5G,kBAAkB;IACZ,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;YAKvG,wBAAwB;IAStC,OAAO,CAAC,iBAAiB;IA0EzB,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,YAAY;IAqBpB,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,2BAA2B;IAenC,OAAO,CAAC,cAAc;CAQzB"}

package/dist/readModels/ReadModels.js

@@ -0,0 +1,280 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { ReadModelObserverType as ContractReadModelObserverType } from '@cratis/chronicle.contracts';
+import { JsonSerializer } from '@cratis/fundamentals';
+import { toContractsGuid } from '../connection/Guid';
+import { EventSequenceId } from '../eventSequences/EventSequenceId';
+import { getProjectionMetadata } from '../projections/declarative/projection';
+import { hasFromEventMetadata } from '../projections/modelBound/fromEvent';
+import { getReducerMetadata } from '../reducers/reducer';
+import { JsonSchemaGenerator } from '../schemas';
+import { WellKnownSinks } from '../sinks';
+import { getReadModelMetadata } from './readModel';
+import { MaterializedReadModels } from './MaterializedReadModels';
+const unlimitedEventCount = BigInt('18446744073709551615');
+/**
+ * Implements {@link IReadModels} by working with the Chronicle read-model gRPC service.
+ */
+export class ReadModels {
+    _eventStore;
+    _namespace;
+    _connection;
+    _clientArtifacts;
+    materialized;
+    constructor(_eventStore, _namespace, _connection, _clientArtifacts) {
+        this._eventStore = _eventStore;
+        this._namespace = _namespace;
+        this._connection = _connection;
+        this._clientArtifacts = _clientArtifacts;
+        this.materialized = new MaterializedReadModels(_eventStore, _namespace, _connection);
+    }
+    /** @inheritdoc */
+    async register(readModelType) {
+        const readModels = this.resolveReadModels(readModelType);
+        if (readModels.length === 0) {
+            return;
+        }
+        await this._connection.readModels.registerMany({
+            EventStore: this._eventStore,
+            Owner: 1,
+            Source: 1,
+            ReadModels: readModels.map(readModel => this.toDefinition(readModel))
+        });
+    }
+    /** @inheritdoc */
+    async getInstanceById(readModelType, key, sessionId) {
+        const readModel = this.resolveReadModel(readModelType);
+        const response = await this._connection.readModels.getInstanceByKey({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModelIdentifier: readModel.identifier,
+            EventSequenceId: readModel.eventSequenceId,
+            ReadModelKey: key,
+            SessionId: sessionId ?? ''
+        });
+        const instance = this.deserializeReadModel(readModelType, response.ReadModel);
+        if (readModel.observerType === ContractReadModelObserverType.Reducer && this.schemaHasComplianceMetadata(readModel.schema)) {
+            return this.release(readModelType, instance);
+        }
+        return instance;
+    }
+    /** @inheritdoc */
+    async getInstances(readModelType, eventCount = unlimitedEventCount) {
+        const readModel = this.resolveReadModel(readModelType);
+        const response = await this._connection.readModels.getAllInstances({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModelIdentifier: readModel.identifier,
+            EventSequenceId: readModel.eventSequenceId,
+            EventCount: eventCount
+        });
+        const instances = response.Instances.map(instance => this.deserializeReadModel(readModelType, instance));
+        if (readModel.observerType === ContractReadModelObserverType.Reducer && this.schemaHasComplianceMetadata(readModel.schema)) {
+            return this.releaseMany(readModelType, instances);
+        }
+        return instances;
+    }
+    /** @inheritdoc */
+    async getSnapshotsById(readModelType, key) {
+        const readModel = this.resolveReadModel(readModelType);
+        const response = await this._connection.readModels.getSnapshotsByKey({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModelIdentifier: readModel.identifier,
+            EventSequenceId: readModel.eventSequenceId,
+            ReadModelKey: key
+        });
+        const snapshots = response.Snapshots.map(snapshot => ({
+            readModel: this.deserializeReadModel(readModelType, snapshot.ReadModel),
+            events: (snapshot.Events ?? []),
+            occurred: snapshot.Occurred?.Value ? new Date(snapshot.Occurred.Value) : undefined,
+            correlationId: snapshot.CorrelationId
+        }));
+        if (readModel.observerType === ContractReadModelObserverType.Reducer && this.schemaHasComplianceMetadata(readModel.schema)) {
+            return this.releaseSnapshotInstances(readModelType, snapshots);
+        }
+        return snapshots;
+    }
+    /** @inheritdoc */
+    async *watch(readModelType) {
+        const readModel = this.resolveReadModel(readModelType);
+        for await (const changeset of this._connection.readModels.watch({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModelIdentifier: readModel.identifier,
+            EventSequenceId: readModel.eventSequenceId
+        })) {
+            yield {
+                namespace: changeset.Namespace,
+                key: changeset.ModelKey,
+                readModel: this.deserializeReadModel(readModelType, changeset.ReadModel),
+                removed: changeset.Removed
+            };
+        }
+    }
+    /** @inheritdoc */
+    async dehydrateSession(sessionId, readModelType, key) {
+        const readModel = this.resolveReadModel(readModelType);
+        await this._connection.readModels.dehydrateSession({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            ReadModelIdentifier: readModel.identifier,
+            EventSequenceId: readModel.eventSequenceId,
+            ReadModelKey: key,
+            SessionId: sessionId
+        });
+    }
+    /** @inheritdoc */
+    async release(readModelType, instance) {
+        const readModel = this.resolveReadModel(readModelType);
+        const schema = this.getReadModelSchema(readModelType, readModel.identifier);
+        const payload = JsonSerializer.serialize(instance);
+        const subject = this.extractSubject(instance);
+        const response = await this._connection.compliance.release({
+            EventStore: this._eventStore,
+            Namespace: this._namespace,
+            Subject: subject,
+            Schema: schema,
+            Payload: payload
+        });
+        if (response.HasError) {
+            throw new Error(`Failed to release PII: ${response.Error}`);
+        }
+        return this.deserializeReadModel(readModelType, response.Payload);
+    }
+    /** @inheritdoc */
+    async releaseMany(readModelType, instances) {
+        const releasePromises = instances.map(instance => this.release(readModelType, instance));
+        return Promise.all(releasePromises);
+    }
+    async releaseSnapshotInstances(readModelType, snapshots) {
+        return Promise.all(snapshots.map(async (snapshot) => ({
+            ...snapshot,
+            readModel: await this.release(readModelType, snapshot.readModel)
+        })));
+    }
+    resolveReadModels(readModelType) {
+        const resolved = new Map();
+        for (const projectionType of this._clientArtifacts.projections) {
+            const metadata = getProjectionMetadata(projectionType);
+            if (!metadata?.readModelType) {
+                continue;
+            }
+            if (readModelType && metadata.readModelType !== readModelType) {
+                continue;
+            }
+            const readModelMetadata = getReadModelMetadata(metadata.readModelType);
+            const identifier = readModelMetadata?.id.value ?? metadata.readModelType.name;
+            resolved.set(identifier, {
+                type: metadata.readModelType,
+                identifier,
+                eventSequenceId: metadata.eventSequenceId ?? EventSequenceId.eventLog.value,
+                observerType: ContractReadModelObserverType.Projection,
+                observerIdentifier: metadata.id.value,
+                schema: this.getReadModelSchema(metadata.readModelType, identifier)
+            });
+        }
+        for (const modelBoundType of this._clientArtifacts.readModels) {
+            if (!hasFromEventMetadata(modelBoundType)) {
+                continue;
+            }
+            if (readModelType && modelBoundType !== readModelType) {
+                continue;
+            }
+            const metadata = getReadModelMetadata(modelBoundType);
+            if (!metadata) {
+                continue;
+            }
+            resolved.set(metadata.id.value, {
+                type: modelBoundType,
+                identifier: metadata.id.value,
+                eventSequenceId: EventSequenceId.eventLog.value,
+                observerType: ContractReadModelObserverType.Projection,
+                observerIdentifier: metadata.id.value,
+                schema: JSON.stringify(metadata.schema)
+            });
+        }
+        for (const reducerType of this._clientArtifacts.reducers) {
+            const metadata = getReducerMetadata(reducerType);
+            if (!metadata?.readModel) {
+                continue;
+            }
+            if (readModelType && metadata.readModel !== readModelType) {
+                continue;
+            }
+            const readModelMetadata = getReadModelMetadata(metadata.readModel);
+            const identifier = readModelMetadata?.id.value ?? metadata.readModel.name;
+            resolved.set(identifier, {
+                type: metadata.readModel,
+                identifier,
+                eventSequenceId: metadata.eventSequenceId ?? EventSequenceId.eventLog.value,
+                observerType: ContractReadModelObserverType.Reducer,
+                observerIdentifier: metadata.id.value,
+                schema: this.getReadModelSchema(metadata.readModel, identifier)
+            });
+        }
+        return Array.from(resolved.values());
+    }
+    resolveReadModel(readModelType) {
+        const [resolved] = this.resolveReadModels(readModelType);
+        if (!resolved) {
+            throw new Error(`Unknown read model '${readModelType.name}'. Make sure it is decorated and discoverable.`);
+        }
+        return resolved;
+    }
+    toDefinition(readModel) {
+        return {
+            Type: {
+                Identifier: readModel.identifier,
+                Generation: 1
+            },
+            ContainerName: readModel.identifier,
+            DisplayName: readModel.identifier,
+            Sink: {
+                ConfigurationId: toContractsGuid(WellKnownSinks.Null),
+                TypeId: toContractsGuid(WellKnownSinks.MongoDB)
+            },
+            Schema: readModel.schema,
+            Indexes: [],
+            ObserverType: readModel.observerType,
+            ObserverIdentifier: readModel.observerIdentifier,
+            Owner: 1,
+            Source: 1
+        };
+    }
+    getReadModelSchema(readModelType, identifier) {
+        const metadata = getReadModelMetadata(readModelType);
+        if (metadata) {
+            return JSON.stringify(metadata.schema);
+        }
+        return JSON.stringify(JsonSchemaGenerator.generate(readModelType) ?? JsonSchemaGenerator.createEmptySchema(identifier));
+    }
+    deserializeReadModel(readModelType, json) {
+        if (!json) {
+            return Object.create(readModelType.prototype);
+        }
+        return JsonSerializer.deserialize(readModelType, json);
+    }
+    schemaHasComplianceMetadata(schema) {
+        try {
+            const parsed = JSON.parse(schema);
+            const properties = parsed.properties;
+            if (!properties) {
+                return false;
+            }
+            return Object.values(properties).some(property => Array.isArray(property.compliance) && property.compliance.length > 0);
+        }
+        catch {
+            return false;
+        }
+    }
+    extractSubject(instance) {
+        // By convention, use the 'id' property as the subject
+        const anyInstance = instance;
+        if (anyInstance.id !== undefined && anyInstance.id !== null) {
+            return String(anyInstance.id);
+        }
+        throw new Error('Read model instance must have an "id" property to serve as the subject for PII release');
+    }
+}
+//# sourceMappingURL=ReadModels.js.map