@kurrent/kurrentdb-client 1.0.0-alpha.1

package/dist/streams/utils/ReadStream.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadStream = void 0;
+const stream_1 = require("stream");
+const utils_1 = require("../../utils");
+class ReadStream extends stream_1.Transform {
+    #convertGrpcEvent;
+    #grpcStream;
+    constructor(createGRPCStream, convertGrpcEvent, options) {
+        super({ ...options, objectMode: true });
+        this.#convertGrpcEvent = convertGrpcEvent;
+        this.#grpcStream = createGRPCStream();
+        this.initialize();
+    }
+    initialize = async () => {
+        try {
+            (await this.#grpcStream)
+                .on("error", (err) => {
+                if ((0, utils_1.isClientCancellationError)(err))
+                    return;
+                const error = (0, utils_1.convertToCommandError)(err);
+                this.emit("error", error);
+            })
+                .pipe(this);
+        }
+        catch (error) {
+            this.emit("error", error);
+        }
+    };
+    _transform(resp, _encoding, next) {
+        if (resp.hasConfirmation?.()) {
+            this.emit("confirmation");
+        }
+        if (resp.hasStreamNotFound?.()) {
+            const streamNotFound = resp.getStreamNotFound();
+            this.#grpcStream.then((stream) => {
+                stream.destroy(new utils_1.StreamNotFoundError(null, streamNotFound.getStreamIdentifier()?.getStreamName()));
+                next();
+            });
+            return;
+        }
+        if (resp.hasEvent?.()) {
+            const resolved = this.#convertGrpcEvent(resp.getEvent());
+            return next(null, resolved);
+        }
+        next();
+    }
+    async cancel() {
+        const stream = await this.#grpcStream;
+        return new Promise((resolve) => {
+            // https://github.com/grpc/grpc-node/issues/1464
+            // https://github.com/grpc/grpc-node/issues/1652
+            setImmediate(() => {
+                stream.cancel();
+                resolve();
+            });
+        });
+    }
+}
+exports.ReadStream = ReadStream;
+//# sourceMappingURL=ReadStream.js.map

package/dist/streams/utils/ReadStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadStream.js","sourceRoot":"","sources":["../../../src/streams/utils/ReadStream.ts"],"names":[],"mappings":";;;AAAA,mCAAwE;AAOxE,uCAKqB;AAIrB,MAAa,UAAc,SAAQ,kBAAS;IAC1C,iBAAiB,CAA0C;IAC3D,WAAW,CAA0C;IAErD,YACE,gBAAkC,EAClC,gBAAyD,EACzD,OAAyB;QAEzB,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,gBAAgB,EAAE,CAAC;QACtC,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEO,UAAU,GAAG,KAAK,IAAI,EAAE;QAC9B,IAAI,CAAC;YACH,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC;iBACrB,EAAE,CAAC,OAAO,EAAE,CAAC,GAAiB,EAAE,EAAE;gBACjC,IAAI,IAAA,iCAAyB,EAAC,GAAG,CAAC;oBAAE,OAAO;gBAC3C,MAAM,KAAK,GAAG,IAAA,6BAAqB,EAAC,GAAG,CAAC,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC;IAEF,UAAU,CAAC,IAAc,EAAE,SAAiB,EAAE,IAAuB;QACnE,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,EAAE,CAAC;YAC/B,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,EAAG,CAAC;YACjD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC/B,MAAM,CAAC,OAAO,CACZ,IAAI,2BAAmB,CACrB,IAAa,EACb,cAAc,CAAC,mBAAmB,EAAE,EAAE,aAAa,EAAE,CACtD,CACF,CAAC;gBACF,IAAI,EAAE,CAAC;YACT,CAAC,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAG,CAAC,CAAC;YAC1D,OAAO,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,EAAE,CAAC;IACT,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;QACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,gDAAgD;YAChD,gDAAgD;YAChD,YAAY,CAAC,GAAG,EAAE;gBAChB,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnED,gCAmEC"}

package/dist/streams/utils/Subscription.d.ts

@@ -0,0 +1,16 @@
+import { Transform, TransformCallback, TransformOptions } from "stream";
+import type { ClientReadableStream } from "@grpc/grpc-js";
+import type { ReadResp } from "../../../generated/streams_pb";
+import type { Filter, ReadableSubscription } from "../../types";
+import { ConvertGrpcEvent } from "../../utils";
+type CreateGRPCStream = () => Promise<ClientReadableStream<ReadResp>>;
+export declare class Subscription<E> extends Transform implements ReadableSubscription<E> {
+    #private;
+    protected convertGrpcEvent: ConvertGrpcEvent<ReadResp.ReadEvent, E>;
+    id?: string;
+    constructor(createGRPCStream: CreateGRPCStream, convertGrpcEvent: ConvertGrpcEvent<ReadResp.ReadEvent, E>, options: TransformOptions, checkpointReached?: Filter["checkpointReached"]);
+    private initialize;
+    _transform(resp: ReadResp, _encoding: string, next: TransformCallback): Promise<void>;
+    unsubscribe(): Promise<void>;
+}
+export {};

package/dist/streams/utils/Subscription.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscription = void 0;
+const stream_1 = require("stream");
+const utils_1 = require("../../utils");
+class Subscription extends stream_1.Transform {
+    convertGrpcEvent;
+    #grpcStream;
+    #checkpointReached;
+    id;
+    constructor(createGRPCStream, convertGrpcEvent, options, checkpointReached) {
+        super({ ...options, objectMode: true });
+        this.convertGrpcEvent = convertGrpcEvent;
+        this.#grpcStream = createGRPCStream();
+        this.#checkpointReached = checkpointReached;
+        this.initialize();
+    }
+    initialize = async () => {
+        try {
+            (await this.#grpcStream)
+                .on("error", (err) => {
+                if ((0, utils_1.isClientCancellationError)(err))
+                    return;
+                const error = (0, utils_1.convertToCommandError)(err);
+                this.emit("error", error);
+            })
+                .pipe(this);
+        }
+        catch (error) {
+            this.emit("error", error);
+        }
+    };
+    async _transform(resp, _encoding, next) {
+        if (resp.hasConfirmation?.()) {
+            this.id = resp.getConfirmation()?.getSubscriptionId();
+            this.emit("confirmation");
+        }
+        if (resp.hasCaughtUp?.()) {
+            this.emit("caughtUp");
+        }
+        if (resp.hasFellBehind?.()) {
+            this.emit("fellBehind");
+        }
+        if (resp.hasCheckpoint?.() && this.#checkpointReached) {
+            const checkpoint = resp.getCheckpoint();
+            const position = {
+                commit: BigInt(checkpoint.getCommitPosition()),
+                prepare: BigInt(checkpoint.getPreparePosition()),
+            };
+            await this.#checkpointReached(this, position);
+        }
+        if (resp.hasEvent?.()) {
+            const resolved = this.convertGrpcEvent(resp.getEvent());
+            return next(null, resolved);
+        }
+        next();
+    }
+    async unsubscribe() {
+        const stream = await this.#grpcStream;
+        return new Promise((resolve) => {
+            // https://github.com/grpc/grpc-node/issues/1464
+            // https://github.com/grpc/grpc-node/issues/1652
+            setImmediate(() => {
+                stream.cancel();
+                resolve();
+            });
+        });
+    }
+}
+exports.Subscription = Subscription;
+//# sourceMappingURL=Subscription.js.map

package/dist/streams/utils/Subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Subscription.js","sourceRoot":"","sources":["../../../src/streams/utils/Subscription.ts"],"names":[],"mappings":";;;AAAA,mCAAwE;AAOxE,uCAIqB;AAIrB,MAAa,YACX,SAAQ,kBAAS;IAGP,gBAAgB,CAA0C;IACpE,WAAW,CAA0C;IACrD,kBAAkB,CAA+B;IAC1C,EAAE,CAAU;IAEnB,YACE,gBAAkC,EAClC,gBAAyD,EACzD,OAAyB,EACzB,iBAA+C;QAE/C,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,gBAAgB,EAAE,CAAC;QACtC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEO,UAAU,GAAG,KAAK,IAAI,EAAE;QAC9B,IAAI,CAAC;YACH,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC;iBACrB,EAAE,CAAC,OAAO,EAAE,CAAC,GAAiB,EAAE,EAAE;gBACjC,IAAI,IAAA,iCAAyB,EAAC,GAAG,CAAC;oBAAE,OAAO;gBAC3C,MAAM,KAAK,GAAG,IAAA,6BAAqB,EAAC,GAAG,CAAC,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC;IAEF,KAAK,CAAC,UAAU,CACd,IAAc,EACd,SAAiB,EACjB,IAAuB;QAEvB,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE,EAAE,iBAAiB,EAAE,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAG,CAAC;YACzC,MAAM,QAAQ,GAAa;gBACzB,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;gBAC9C,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC;aACjD,CAAC;YACF,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAG,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,EAAE,CAAC;IACT,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;QACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,gDAAgD;YAChD,gDAAgD;YAChD,YAAY,CAAC,GAAG,EAAE;gBAChB,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAlFD,oCAkFC"}

package/dist/streams/utils/streamMetadata.d.ts

@@ -0,0 +1,53 @@
+import type { END, START } from "../../constants";
+/**
+ * Represents an access control list for a stream.
+ */
+export interface StreamACL {
+    /**
+     * Roles and users permitted to read the stream.
+     */
+    readRoles?: string[];
+    /**
+     * Roles and users permitted to write to the stream.
+     */
+    writeRoles?: string[];
+    /**
+     * Roles and users permitted to delete the stream.
+     */
+    deleteRoles?: string[];
+    /**
+     * Roles and users permitted to read stream metadata.
+     */
+    metaReadRoles?: string[];
+    /**
+     * Roles and users permitted to write stream metadata.
+     */
+    metaWriteRoles?: string[];
+}
+export interface SystemStreamMetadata {
+    /**
+     * The optional maximum age (in seconds) of events allowed in the stream.
+     */
+    maxAge?: number;
+    /**
+     * The optional streamPositon from which previous events can be scavenged.
+     * This is used to implement soft-deletion of streams.
+     */
+    truncateBefore?: typeof START | typeof END | number;
+    /**
+     * The optional amount of time (in seconds) for which the stream head is cacheable.
+     */
+    cacheControl?: number;
+    /**
+     * The optional ACL for the stream.
+     */
+    acl?: StreamACL;
+    /**
+     * The optional maximum number of events allowed in the stream.
+     */
+    maxCount?: number;
+}
+export type CustomStreamMetadata = Record<string | number, unknown>;
+export type StreamMetadata<CustomMetadata extends CustomStreamMetadata = CustomStreamMetadata> = SystemStreamMetadata & CustomMetadata;
+export declare const prepareStreamMetadata: <CustomMetadata extends CustomStreamMetadata = CustomStreamMetadata>(metadata: StreamMetadata<CustomMetadata>) => Record<string, unknown>;
+export declare const readStreamMetadata: <CustomMetadata extends CustomStreamMetadata = CustomStreamMetadata>(metadata: Record<string, unknown>) => StreamMetadata<CustomMetadata>;

package/dist/streams/utils/streamMetadata.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readStreamMetadata = exports.prepareStreamMetadata = void 0;
+const MAX_AGE = "$maxAge";
+const MAX_COUNT = "$maxCount";
+const TRUNCATE_BEFORE = "$tb";
+const CACHE_CONTROL = "$cacheControl";
+const ACL = "$acl";
+const ACL_READ = "$r";
+const ACL_WRITE = "$w";
+const ACL_DELETE = "$d";
+const ACL_META_READ = "$mr";
+const ACL_META_WRITE = "$mw";
+const convertAcl = (keyLookup) => (acl) => {
+    if (typeof acl === "string")
+        return acl;
+    return Object.entries(acl).reduce((acc, [key, value]) => {
+        if (keyLookup[key])
+            return { ...acc, [keyLookup[key]]: value };
+        console.warn(`Unknown key "${key}" in acl will be ignored`);
+        return acc;
+    }, {});
+};
+const prepareAcl = convertAcl({
+    readRoles: ACL_READ,
+    writeRoles: ACL_WRITE,
+    deleteRoles: ACL_DELETE,
+    metaReadRoles: ACL_META_READ,
+    metaWriteRoles: ACL_META_WRITE,
+});
+const readAcl = convertAcl({
+    [ACL_READ]: "readRoles",
+    [ACL_WRITE]: "writeRoles",
+    [ACL_DELETE]: "deleteRoles",
+    [ACL_META_READ]: "metaReadRoles",
+    [ACL_META_WRITE]: "metaWriteRoles",
+});
+const ensureInteger = (key, value) => {
+    if (Number.isInteger(value))
+        return value;
+    throw new Error(`Invalid stream metadata: "${key}" must be an integer.`);
+};
+const prepareStreamMetadata = (metadata) => Object.entries(metadata).reduce((acc, [key, value]) => {
+    switch (key) {
+        case "maxAge":
+            return { ...acc, [MAX_AGE]: ensureInteger(key, value) };
+        case "truncateBefore":
+            return { ...acc, [TRUNCATE_BEFORE]: ensureInteger(key, value) };
+        case "cacheControl":
+            return { ...acc, [CACHE_CONTROL]: ensureInteger(key, value) };
+        case "maxCount":
+            return { ...acc, [MAX_COUNT]: ensureInteger(key, value) };
+        case "acl":
+            return { ...acc, [ACL]: prepareAcl(value) };
+        default:
+            return { ...acc, [key]: value };
+    }
+}, {});
+exports.prepareStreamMetadata = prepareStreamMetadata;
+const readStreamMetadata = (metadata) => Object.entries(metadata).reduce((acc, [key, value]) => {
+    switch (key) {
+        case MAX_AGE:
+            return { ...acc, maxAge: value };
+        case TRUNCATE_BEFORE:
+            return { ...acc, truncateBefore: value };
+        case CACHE_CONTROL:
+            return { ...acc, cacheControl: value };
+        case MAX_COUNT:
+            return { ...acc, maxCount: value };
+        case ACL:
+            return { ...acc, acl: readAcl(value) };
+        default:
+            return { ...acc, [key]: value };
+    }
+}, {});
+exports.readStreamMetadata = readStreamMetadata;
+//# sourceMappingURL=streamMetadata.js.map

package/dist/streams/utils/streamMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamMetadata.js","sourceRoot":"","sources":["../../../src/streams/utils/streamMetadata.ts"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,MAAM,eAAe,GAAG,KAAK,CAAC;AAC9B,MAAM,aAAa,GAAG,eAAe,CAAC;AAEtC,MAAM,GAAG,GAAG,MAAM,CAAC;AACnB,MAAM,QAAQ,GAAG,IAAI,CAAC;AACtB,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,aAAa,GAAG,KAAK,CAAC;AAC5B,MAAM,cAAc,GAAG,KAAK,CAAC;AAkE7B,MAAM,UAAU,GACd,CAAC,SAAiC,EAAE,EAAE,CACtC,CAAC,GAAY,EAAW,EAAE;IACxB,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IACxC,OAAO,MAAM,CAAC,OAAO,CAAC,GAA8B,CAAC,CAAC,MAAM,CAC1D,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,IAAI,SAAS,CAAC,GAAG,CAAC;YAAE,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,gBAAgB,GAAG,0BAA0B,CAAC,CAAC;QAC5D,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AACJ,MAAM,UAAU,GAAG,UAAU,CAAC;IAC5B,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,SAAS;IACrB,WAAW,EAAE,UAAU;IACvB,aAAa,EAAE,aAAa;IAC5B,cAAc,EAAE,cAAc;CAC/B,CAAC,CAAC;AAEH,MAAM,OAAO,GAAG,UAAU,CAAC;IACzB,CAAC,QAAQ,CAAC,EAAE,WAAW;IACvB,CAAC,SAAS,CAAC,EAAE,YAAY;IACzB,CAAC,UAAU,CAAC,EAAE,aAAa;IAC3B,CAAC,aAAa,CAAC,EAAE,eAAe;IAChC,CAAC,cAAc,CAAC,EAAE,gBAAgB;CACnC,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,KAAc,EAAE,EAAE;IACpD,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1C,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,uBAAuB,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEK,MAAM,qBAAqB,GAAG,CAGnC,QAAwC,EACf,EAAE,CAC3B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACpD,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,QAAQ;YACX,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAC1D,KAAK,gBAAgB;YACnB,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAClE,KAAK,cAAc;YACjB,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAChE,KAAK,UAAU;YACb,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAC5D,KAAK,KAAK;YACR,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C;YACE,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;IACpC,CAAC;AACH,CAAC,EAAE,EAAE,CAAC,CAAC;AApBI,QAAA,qBAAqB,yBAoBzB;AAEF,MAAM,kBAAkB,GAAG,CAGhC,QAAiC,EACD,EAAE,CAClC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACpD,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,OAAO;YACV,OAAO,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QACnC,KAAK,eAAe;YAClB,OAAO,EAAE,GAAG,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;QAC3C,KAAK,aAAa;YAChB,OAAO,EAAE,GAAG,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;QACzC,KAAK,SAAS;YACZ,OAAO,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACrC,KAAK,GAAG;YACN,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC;YACE,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;IACpC,CAAC;AACH,CAAC,EAAE,EAAE,CAAmC,CAAC;AApB9B,QAAA,kBAAkB,sBAoBY"}

package/dist/streams/utils/systemStreams.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Returns true if the stream is a system stream.
+ * @param streamId - The stream id to test against.
+ */
+export declare const isSystemStream: (streamId: string) => boolean;
+/**
+ * Returns true if the stream is a metadata stream.
+ * @param streamId - The stream id to test against.
+ */
+export declare const isMetastream: (streamId: string) => boolean;
+/**
+ * Returns the metadata stream of the stream.
+ * @param streamId - The stream id to get the metastream name of.
+ */
+export declare const metastreamOf: (streamId: string) => string;
+/**
+ * Returns the original stream of the metadata stream.
+ * @param metastreamId - The metastream id to get the original stream name of.
+ */
+export declare const originalStreamOf: (metastreamId: string) => string;

package/dist/streams/utils/systemStreams.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.originalStreamOf = exports.metastreamOf = exports.isMetastream = exports.isSystemStream = void 0;
+/**
+ * Returns true if the stream is a system stream.
+ * @param streamId - The stream id to test against.
+ */
+const isSystemStream = (streamId) => streamId[0] === "$";
+exports.isSystemStream = isSystemStream;
+/**
+ * Returns true if the stream is a metadata stream.
+ * @param streamId - The stream id to test against.
+ */
+const isMetastream = (streamId) => streamId.slice(0, 2) == "$$";
+exports.isMetastream = isMetastream;
+/**
+ * Returns the metadata stream of the stream.
+ * @param streamId - The stream id to get the metastream name of.
+ */
+const metastreamOf = (streamId) => `$$${streamId}`;
+exports.metastreamOf = metastreamOf;
+/**
+ * Returns the original stream of the metadata stream.
+ * @param metastreamId - The metastream id to get the original stream name of.
+ */
+const originalStreamOf = (metastreamId) => metastreamId.slice(2);
+exports.originalStreamOf = originalStreamOf;
+//# sourceMappingURL=systemStreams.js.map

package/dist/streams/utils/systemStreams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemStreams.js","sourceRoot":"","sources":["../../../src/streams/utils/systemStreams.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAW,EAAE,CAC1D,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AADT,QAAA,cAAc,kBACL;AAEtB;;;GAGG;AACI,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAW,EAAE,CACxD,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC;AADlB,QAAA,YAAY,gBACM;AAE/B;;;GAGG;AACI,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAU,EAAE,CAAC,KAAK,QAAQ,EAAE,CAAC;AAA7D,QAAA,YAAY,gBAAiD;AAE1E;;;GAGG;AACI,MAAM,gBAAgB,GAAG,CAAC,YAAoB,EAAU,EAAE,CAC/D,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AADX,QAAA,gBAAgB,oBACL"}

package/dist/types/events.d.ts

@@ -0,0 +1,157 @@
+import type { Position } from "../types";
+export type JSONType = Record<string | number, unknown> | unknown[] | string;
+export type MetadataType = JSONType | Uint8Array;
+export type JSONEventType<Type extends string = string, Data extends JSONType = JSONType, Metadata extends MetadataType | unknown = unknown> = Metadata extends MetadataType ? {
+    type: Type;
+    data: Data;
+    metadata: Metadata;
+} : {
+    type: Type;
+    data: Data;
+    metadata?: Metadata;
+};
+export type BinaryEventType<Type extends string = string, Metadata extends MetadataType | unknown = unknown> = Metadata extends MetadataType ? {
+    type: Type;
+    data: Uint8Array;
+    metadata: Metadata;
+} : {
+    type: Type;
+    data: Uint8Array;
+    metadata?: Metadata;
+};
+export type EventType = JSONEventType | BinaryEventType;
+export type JSONEventData<E extends JSONEventType = JSONEventType> = E extends JSONEventType ? {
+    id: string;
+    contentType: "application/json";
+    type: E["type"];
+    data: E["data"];
+    metadata: E["metadata"] extends MetadataType ? E["metadata"] : MetadataType | undefined;
+} : never;
+export type BinaryEventData<E extends BinaryEventType = BinaryEventType> = E extends BinaryEventType ? {
+    id: string;
+    contentType: "application/octet-stream";
+    type: E["type"];
+    data: E["data"];
+    metadata: E["metadata"] extends MetadataType ? E["metadata"] : MetadataType | undefined;
+} : never;
+export type EventData<E extends EventType = EventType> = E extends BinaryEventType ? BinaryEventData<E> : E extends JSONEventType ? JSONEventData<E> : never;
+export type LinkEvent = BinaryEventType<"$>", {
+    $causedBy?: string;
+    $correlationId?: string;
+    [key: string]: unknown;
+}>;
+/**
+ * Represents a previously written event.
+ */
+export type RecordedEvent<E extends EventType = EventType> = E extends EventType ? {
+    /**
+     * The event stream that events belongs to.
+     */
+    streamId: string;
+    /**
+     * Unique identifier representing this event. UUID format.
+     */
+    id: string;
+    /**
+     * Indicates whether the content is internally marked as JSON.
+     */
+    isJson: E extends JSONEventType ? true : false;
+    /**
+     * Number of this event in the stream.
+     */
+    revision: bigint;
+    /**
+     * Type of this event.
+     */
+    type: E["type"];
+    /**
+     * Representing when this event was created in the database system.
+     */
+    created: Date;
+    /**
+     * Data of this event.
+     */
+    data: E extends JSONEventType ? E["data"] : Uint8Array;
+    /**
+     * Representing the metadata associated with this event.
+     */
+    metadata: E["metadata"] extends MetadataType ? E["metadata"] : MetadataType | undefined;
+    /**
+     * Position of this event in the transaction log.
+     * Only returned on server versions later than 22.6.0.
+     */
+    position?: Position;
+} : never;
+export type JSONRecordedEvent<E extends JSONEventType = JSONEventType> = RecordedEvent<E>;
+export type BinaryRecordedEvent<E extends BinaryEventType = BinaryEventType> = RecordedEvent<E>;
+export type AllStreamJSONRecordedEvent<E extends JSONEventType = JSONEventType> = RecordedEvent<E> & {
+    /**
+     * Position of this event in the transaction log.
+     */
+    position: Position;
+};
+export type AllStreamBinaryRecordedEvent<E extends BinaryEventType = BinaryEventType> = RecordedEvent<E> & {
+    /**
+     * Position of this event in the transaction log.
+     */
+    position: Position;
+};
+export type AllStreamRecordedEvent = AllStreamJSONRecordedEvent | AllStreamBinaryRecordedEvent;
+/**
+ * A structure representing a single event or an resolved link event.
+ */
+export interface ResolvedEvent<Event extends EventType = EventType> {
+    /**
+     * The event, or the resolved link event if this {@link ResolvedEvent} is a link event.
+     */
+    event?: EventTypeToRecordedEvent<Event>;
+    /**
+     * The link event if this ResolvedEvent is a link event.
+     */
+    link?: EventTypeToRecordedEvent<LinkEvent>;
+    /**
+     * Commit position of the record.
+     */
+    commitPosition?: bigint;
+}
+/**
+ * A structure representing a single event or a resolved link event from a persistent subscription to a stream.
+ */
+export interface PersistentSubscriptionToStreamResolvedEvent<Event extends EventType = EventType> extends ResolvedEvent<Event> {
+    /**
+     * The number of times this event has been retried.
+     */
+    retryCount: number;
+}
+/**
+ * A structure representing a single event or an resolved link event.
+ */
+export interface AllStreamResolvedEvent {
+    /**
+     * The event, or the resolved link event if this {@link ResolvedEvent} is a link event.
+     */
+    event?: AllStreamRecordedEvent;
+    /**
+     * The link event if this ResolvedEvent is a link event.
+     */
+    link?: AllStreamBinaryRecordedEvent<LinkEvent>;
+    /**
+     * Commit position of the record.
+     */
+    commitPosition?: bigint;
+}
+/**
+ * A structure representing a single event or a resolved link event from a persistent subscription to $all.
+ */
+export interface PersistentSubscriptionToAllResolvedEvent extends AllStreamResolvedEvent {
+    /**
+     * The number of times this event has been retried.
+     */
+    retryCount: number;
+}
+export type EventTypeToRecordedEvent<T extends EventType> = T extends JSONEventType ? JSONRecordedEvent<T> : T extends BinaryEventType ? BinaryRecordedEvent<T> : never;
+export type RecordedEventToEventType<T extends RecordedEvent> = T extends JSONRecordedEvent<infer E> ? E : T extends BinaryRecordedEvent<infer E> ? E : never;
+export type EventTypeToEventData<T extends EventType> = T extends JSONEventType ? JSONEventData<T> : T extends BinaryEventType ? BinaryEventData<T> : never;
+export type EventDataToEventType<T extends EventData> = T extends JSONEventData<infer E> ? E : T extends BinaryEventData<infer E> ? E : never;
+export type RecordedEventToEventData<T extends RecordedEvent> = T extends JSONRecordedEvent<infer E> ? JSONEventData<E> : T extends BinaryRecordedEvent<infer E> ? BinaryEventData<E> : never;
+export type EventDataToRecordedEvent<T extends EventData> = T extends JSONRecordedEvent<infer E> ? JSONEventData<E> : T extends BinaryRecordedEvent<infer E> ? BinaryEventData<E> : never;

package/dist/types/events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/dist/types/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":""}