@cratis/chronicle 0.0.1

package/dist/Metrics.js

@@ -0,0 +1,100 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+import { metrics } from '@opentelemetry/api';
+/**
+ * The name of the Chronicle metrics instrumentation library.
+ * This matches {@link ChronicleInstrumentationName} from Tracing so that all Chronicle
+ * telemetry is grouped under a single instrumentation scope in your observability backend.
+ */
+export const ChronicleMeterName = '@cratis/chronicle';
+/**
+ * The OpenTelemetry meter used by the Chronicle client for all metric instrumentation.
+ *
+ * If your application has configured an OpenTelemetry SDK (e.g. via {@link https://www.npmjs.com/package/@opentelemetry/sdk-node}),
+ * Chronicle metrics will automatically flow through it.
+ * If no SDK is configured, the no-op meter is used and no overhead is incurred.
+ */
+export const ChronicleMeter = metrics.getMeter(ChronicleMeterName);
+/**
+ * Pre-built metric instruments for all Chronicle client operations.
+ * These are created once and shared across all invocations.
+ */
+export const ChronicleMetrics = {
+    /**
+     * Counts the number of individual events appended to an event sequence.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`,
+     * `chronicle.event_sequence_id`, `chronicle.event_type_id`
+     */
+    eventsAppended: ChronicleMeter.createCounter('chronicle.events.appended', {
+        description: 'Number of individual events appended to an event sequence.',
+        unit: '{event}'
+    }),
+    /**
+     * Counts the number of batch-append operations performed on an event sequence.
+     * Each call to appendMany counts as one batch regardless of how many events it contains.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`,
+     * `chronicle.event_sequence_id`, `chronicle.events_count`
+     */
+    batchAppendsPerformed: ChronicleMeter.createCounter('chronicle.events.batch_appends', {
+        description: 'Number of batch-append operations performed on an event sequence.',
+        unit: '{operation}'
+    }),
+    /**
+     * Counts the number of event store retrieval operations.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`
+     */
+    eventStoreRetrievals: ChronicleMeter.createCounter('chronicle.client.event_store_retrievals', {
+        description: 'Number of event store retrieval operations.',
+        unit: '{operation}'
+    }),
+    /**
+     * Measures the duration of append operations in milliseconds.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`,
+     * `chronicle.event_sequence_id`, `chronicle.event_type_id`
+     */
+    appendDuration: ChronicleMeter.createHistogram('chronicle.events.append_duration', {
+        description: 'Duration of individual event append operations.',
+        unit: 'ms',
+        advice: {
+            explicitBucketBoundaries: [1, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000]
+        }
+    }),
+    /**
+     * Measures the duration of batch-append operations in milliseconds.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`,
+     * `chronicle.event_sequence_id`, `chronicle.events_count`
+     */
+    appendManyDuration: ChronicleMeter.createHistogram('chronicle.events.append_many_duration', {
+        description: 'Duration of batch event append operations.',
+        unit: 'ms',
+        advice: {
+            explicitBucketBoundaries: [1, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000]
+        }
+    }),
+    /**
+     * Counts the number of append constraint violations encountered.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`,
+     * `chronicle.event_sequence_id`
+     */
+    constraintViolations: ChronicleMeter.createCounter('chronicle.events.constraint_violations', {
+        description: 'Number of constraint violations encountered during event appends.',
+        unit: '{violation}'
+    }),
+    /**
+     * Counts the number of append errors encountered.
+     *
+     * Attributes: `chronicle.event_store`, `chronicle.namespace`,
+     * `chronicle.event_sequence_id`
+     */
+    appendErrors: ChronicleMeter.createCounter('chronicle.events.append_errors', {
+        description: 'Number of errors encountered during event appends.',
+        unit: '{error}'
+    })
+};
+//# sourceMappingURL=Metrics.js.map

package/dist/Metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../Metrics.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,mBAAmB,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAEnE;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B;;;;;OAKG;IACH,cAAc,EAAE,cAAc,CAAC,aAAa,CAAC,2BAA2B,EAAE;QACtE,WAAW,EAAE,4DAA4D;QACzE,IAAI,EAAE,SAAS;KAClB,CAAC;IAEF;;;;;;OAMG;IACH,qBAAqB,EAAE,cAAc,CAAC,aAAa,CAAC,gCAAgC,EAAE;QAClF,WAAW,EAAE,mEAAmE;QAChF,IAAI,EAAE,aAAa;KACtB,CAAC;IAEF;;;;OAIG;IACH,oBAAoB,EAAE,cAAc,CAAC,aAAa,CAAC,yCAAyC,EAAE;QAC1F,WAAW,EAAE,6CAA6C;QAC1D,IAAI,EAAE,aAAa;KACtB,CAAC;IAEF;;;;;OAKG;IACH,cAAc,EAAE,cAAc,CAAC,eAAe,CAAC,kCAAkC,EAAE;QAC/E,WAAW,EAAE,iDAAiD;QAC9D,IAAI,EAAE,IAAI;QACV,MAAM,EAAE;YACJ,wBAAwB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;SAChF;KACJ,CAAC;IAEF;;;;;OAKG;IACH,kBAAkB,EAAE,cAAc,CAAC,eAAe,CAAC,uCAAuC,EAAE;QACxF,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,IAAI;QACV,MAAM,EAAE;YACJ,wBAAwB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;SAChF;KACJ,CAAC;IAEF;;;;;OAKG;IACH,oBAAoB,EAAE,cAAc,CAAC,aAAa,CAAC,wCAAwC,EAAE;QACzF,WAAW,EAAE,mEAAmE;QAChF,IAAI,EAAE,aAAa;KACtB,CAAC;IAEF;;;;;OAKG;IACH,YAAY,EAAE,cAAc,CAAC,aAAa,CAAC,gCAAgC,EAAE;QACzE,WAAW,EAAE,oDAAoD;QACjE,IAAI,EAAE,SAAS;KAClB,CAAC;CACL,CAAC"}

package/dist/Observation/ObserverId.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Represents the unique identifier of an observer.
+ */
+export declare class ObserverId {
+    readonly value: string;
+    constructor(value: string);
+    /** @inheritdoc */
+    toString(): string;
+}
+//# sourceMappingURL=ObserverId.d.ts.map

package/dist/Observation/ObserverId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObserverId.d.ts","sourceRoot":"","sources":["../../Observation/ObserverId.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,UAAU;IACP,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAElC,kBAAkB;IAClB,QAAQ,IAAI,MAAM;CAGrB"}

package/dist/Observation/ObserverId.js

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Represents the unique identifier of an observer.
+ */
+export class ObserverId {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    /** @inheritdoc */
+    toString() {
+        return this.value;
+    }
+}
+//# sourceMappingURL=ObserverId.js.map

package/dist/Observation/ObserverId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObserverId.js","sourceRoot":"","sources":["../../Observation/ObserverId.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG;;GAEG;AACH,MAAM,OAAO,UAAU;IACE;IAArB,YAAqB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAEtC,kBAAkB;IAClB,QAAQ;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;CACJ"}

package/dist/Observation/ObserverRunningState.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Represents the running state of an observer.
+ */
+export declare enum ObserverRunningState {
+    /** The observer is in an unknown state. */
+    Unknown = "Unknown",
+    /** The observer is subscribing to the event sequence. */
+    Subscribing = "Subscribing",
+    /** The observer is replaying events from the beginning. */
+    Replaying = "Replaying",
+    /** The observer is resuming after a pause. */
+    Resuming = "Resuming",
+    /** The observer is actively processing events. */
+    Active = "Active",
+    /** The observer is paused and not processing events. */
+    Paused = "Paused",
+    /** The observer has stopped processing events. */
+    Stopped = "Stopped",
+    /** The observer is in a failed state. */
+    Failed = "Failed",
+    /** The observer has been disconnected. */
+    Disconnected = "Disconnected"
+}
+//# sourceMappingURL=ObserverRunningState.d.ts.map

package/dist/Observation/ObserverRunningState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObserverRunningState.d.ts","sourceRoot":"","sources":["../../Observation/ObserverRunningState.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,oBAAoB;IAC5B,2CAA2C;IAC3C,OAAO,YAAY;IAEnB,yDAAyD;IACzD,WAAW,gBAAgB;IAE3B,2DAA2D;IAC3D,SAAS,cAAc;IAEvB,8CAA8C;IAC9C,QAAQ,aAAa;IAErB,kDAAkD;IAClD,MAAM,WAAW;IAEjB,wDAAwD;IACxD,MAAM,WAAW;IAEjB,kDAAkD;IAClD,OAAO,YAAY;IAEnB,yCAAyC;IACzC,MAAM,WAAW;IAEjB,0CAA0C;IAC1C,YAAY,iBAAiB;CAChC"}

package/dist/Observation/ObserverRunningState.js

@@ -0,0 +1,27 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Represents the running state of an observer.
+ */
+export var ObserverRunningState;
+(function (ObserverRunningState) {
+    /** The observer is in an unknown state. */
+    ObserverRunningState["Unknown"] = "Unknown";
+    /** The observer is subscribing to the event sequence. */
+    ObserverRunningState["Subscribing"] = "Subscribing";
+    /** The observer is replaying events from the beginning. */
+    ObserverRunningState["Replaying"] = "Replaying";
+    /** The observer is resuming after a pause. */
+    ObserverRunningState["Resuming"] = "Resuming";
+    /** The observer is actively processing events. */
+    ObserverRunningState["Active"] = "Active";
+    /** The observer is paused and not processing events. */
+    ObserverRunningState["Paused"] = "Paused";
+    /** The observer has stopped processing events. */
+    ObserverRunningState["Stopped"] = "Stopped";
+    /** The observer is in a failed state. */
+    ObserverRunningState["Failed"] = "Failed";
+    /** The observer has been disconnected. */
+    ObserverRunningState["Disconnected"] = "Disconnected";
+})(ObserverRunningState || (ObserverRunningState = {}));
+//# sourceMappingURL=ObserverRunningState.js.map

package/dist/Observation/ObserverRunningState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObserverRunningState.js","sourceRoot":"","sources":["../../Observation/ObserverRunningState.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG;;GAEG;AACH,MAAM,CAAN,IAAY,oBA2BX;AA3BD,WAAY,oBAAoB;IAC5B,2CAA2C;IAC3C,2CAAmB,CAAA;IAEnB,yDAAyD;IACzD,mDAA2B,CAAA;IAE3B,2DAA2D;IAC3D,+CAAuB,CAAA;IAEvB,8CAA8C;IAC9C,6CAAqB,CAAA;IAErB,kDAAkD;IAClD,yCAAiB,CAAA;IAEjB,wDAAwD;IACxD,yCAAiB,CAAA;IAEjB,kDAAkD;IAClD,2CAAmB,CAAA;IAEnB,yCAAyC;IACzC,yCAAiB,CAAA;IAEjB,0CAA0C;IAC1C,qDAA6B,CAAA;AACjC,CAAC,EA3BW,oBAAoB,KAApB,oBAAoB,QA2B/B"}

package/dist/Observation/index.d.ts

@@ -0,0 +1,3 @@
+export { ObserverId } from './ObserverId';
+export { ObserverRunningState } from './ObserverRunningState';
+//# sourceMappingURL=index.d.ts.map

package/dist/Observation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../Observation/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/Observation/index.js

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

package/dist/Observation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../Observation/index.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/Projections/IProjections.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Defines a system to work with projections, including discovery and registration with the Kernel.
+ */
+export interface IProjections {
+    /**
+     * Discovers all projections from the registered client artifacts.
+     * @returns A promise that resolves when discovery is complete.
+     */
+    discover(): Promise<void>;
+    /**
+     * Registers all discovered projections with the Chronicle Kernel.
+     * @returns A promise that resolves when registration is complete.
+     */
+    register(): Promise<void>;
+}
+//# sourceMappingURL=IProjections.d.ts.map

package/dist/Projections/IProjections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IProjections.d.ts","sourceRoot":"","sources":["../../Projections/IProjections.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B"}

package/dist/Projections/IProjections.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=IProjections.js.map

package/dist/Projections/IProjections.js.map

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

package/dist/Projections/ProjectionId.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Unique identifier for a projection.
+ */
+export declare class ProjectionId {
+    readonly value: string;
+    constructor(value: string);
+    /** @inheritdoc */
+    toString(): string;
+}
+//# sourceMappingURL=ProjectionId.d.ts.map

package/dist/Projections/ProjectionId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectionId.d.ts","sourceRoot":"","sources":["../../Projections/ProjectionId.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,YAAY;IACT,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;IAElC,kBAAkB;IAClB,QAAQ,IAAI,MAAM;CAGrB"}

package/dist/Projections/ProjectionId.js

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Unique identifier for a projection.
+ */
+export class ProjectionId {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    /** @inheritdoc */
+    toString() {
+        return this.value;
+    }
+}
+//# sourceMappingURL=ProjectionId.js.map

package/dist/Projections/ProjectionId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectionId.js","sourceRoot":"","sources":["../../Projections/ProjectionId.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG;;GAEG;AACH,MAAM,OAAO,YAAY;IACA;IAArB,YAAqB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAEtC,kBAAkB;IAClB,QAAQ;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;CACJ"}

package/dist/Projections/Projections.d.ts

@@ -0,0 +1,36 @@
+import { IClientArtifactsProvider } from '../artifacts';
+import { ChronicleConnection } from '../connection';
+import { IProjections } from './IProjections';
+/**
+ * Implements {@link IProjections}, managing discovery and registration of projections
+ * with the Chronicle Kernel.
+ */
+export declare class Projections implements IProjections {
+    private readonly _eventStore;
+    private readonly _connection;
+    private readonly _clientArtifacts;
+    private readonly _declarative;
+    private readonly _modelBound;
+    /**
+     * Creates a new {@link Projections} instance.
+     * @param _clientArtifacts - Provider for discovered client artifact types.
+     */
+    constructor(_eventStore: string, _connection: ChronicleConnection, _clientArtifacts: IClientArtifactsProvider);
+    /** @inheritdoc */
+    discover(): Promise<void>;
+    /** @inheritdoc */
+    register(): Promise<void>;
+    private buildReadModelDefinitions;
+    private getReadModelSchema;
+    private buildDeclarativeDefinition;
+    private inferReadModelIdentifier;
+    private buildModelBoundDefinition;
+    private resolveModelBoundMetadata;
+    private throwIfUnsupportedModelBoundDecorators;
+    private ensureFromEntry;
+    private ensureJoinEntry;
+    private toContractEventType;
+    private getEventTypeMapKey;
+    private toContractsGuid;
+}
+//# sourceMappingURL=Projections.d.ts.map

package/dist/Projections/Projections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Projections.d.ts","sourceRoot":"","sources":["../../Projections/Projections.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAKpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AA+B9C;;;GAGG;AACH,qBAAa,WAAY,YAAW,YAAY;IASxC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAVrC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkC;IAC/D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAkC;IAE9D;;;OAGG;gBAEkB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,mBAAmB,EAChC,gBAAgB,EAAE,wBAAwB;IAG/D,kBAAkB;IACZ,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA2B/B,kBAAkB;IACZ,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAsC/B,OAAO,CAAC,yBAAyB;IAgCjC,OAAO,CAAC,kBAAkB;IAe1B,OAAO,CAAC,0BAA0B;IAsBlC,OAAO,CAAC,wBAAwB;IAoBhC,OAAO,CAAC,yBAAyB;IAqIjC,OAAO,CAAC,yBAAyB;IAcjC,OAAO,CAAC,sCAAsC;IA2B9C,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,eAAe;CAO1B"}