@enbox/dwn-sql-store 0.0.1 → 0.0.3

package/dist/cjs/package.json

@@ -1 +0,0 @@
-{"type": "commonjs"}

package/dist/esm/src/event-log-sql.js

@@ -1,169 +0,0 @@
-import { filterSelectQuery } from './utils/filter.js';
-import { Kysely } from 'kysely';
-import { executeWithRetryIfDatabaseIsLocked } from './utils/transaction.js';
-import { extractTagsAndSanitizeIndexes } from './utils/sanitize.js';
-import { TagTables } from './utils/tags.js';
-export class EventLogSql {
-    #dialect;
-    #db = null;
-    #tags;
-    constructor(dialect) {
-        this.#dialect = dialect;
-        this.#tags = new TagTables(dialect, 'eventLogMessages');
-    }
-    async open() {
-        if (this.#db) {
-            return;
-        }
-        this.#db = new Kysely({ dialect: this.#dialect });
-        let createTable = this.#db.schema
-            .createTable('eventLogMessages')
-            .ifNotExists()
-            .addColumn('tenant', 'varchar(255)', (col) => col.notNull())
-            .addColumn('messageCid', 'varchar(60)', (col) => col.notNull())
-            .addColumn('interface', 'varchar(20)')
-            .addColumn('method', 'varchar(20)')
-            .addColumn('recordId', 'varchar(60)')
-            .addColumn('entryId', 'varchar(60)')
-            .addColumn('parentId', 'varchar(60)')
-            .addColumn('protocol', 'varchar(200)')
-            .addColumn('protocolPath', 'varchar(200)')
-            .addColumn('contextId', 'varchar(500)')
-            .addColumn('schema', 'varchar(200)')
-            .addColumn('author', 'varchar(255)')
-            .addColumn('recipient', 'varchar(255)')
-            .addColumn('messageTimestamp', 'varchar(30)')
-            .addColumn('dateCreated', 'varchar(30)')
-            .addColumn('datePublished', 'varchar(30)')
-            .addColumn('isLatestBaseState', 'boolean')
-            .addColumn('published', 'boolean')
-            .addColumn('prune', 'boolean')
-            .addColumn('dataFormat', 'varchar(30)')
-            .addColumn('dataCid', 'varchar(60)')
-            .addColumn('dataSize', 'integer')
-            // .addColumn('encodedData', 'text') // intentionally kept commented out code to show the only difference to `messageStoreMessages` table
-            .addColumn('attester', 'text')
-            .addColumn('permissionGrantId', 'varchar(60)')
-            .addColumn('latest', 'text'); // TODO: obsolete, remove once `dwn-sdk-js` is updated
-        let createRecordsTagsTable = this.#db.schema
-            .createTable('eventLogRecordsTags')
-            .ifNotExists()
-            .addColumn('tag', 'text', (col) => col.notNull())
-            .addColumn('valueString', 'text')
-            .addColumn('valueNumber', 'decimal');
-        // Add columns that have dialect-specific constraints
-        createTable = this.#dialect.addAutoIncrementingColumn(createTable, 'watermark', (col) => col.primaryKey());
-        createRecordsTagsTable = this.#dialect.addAutoIncrementingColumn(createRecordsTagsTable, 'id', (col) => col.primaryKey());
-        createRecordsTagsTable = this.#dialect.addReferencedColumn(createRecordsTagsTable, 'eventLogRecordsTags', 'eventWatermark', 'integer', 'eventLogMessages', 'watermark', 'cascade');
-        await createTable.execute();
-        await createRecordsTagsTable.execute();
-    }
-    async close() {
-        await this.#db?.destroy();
-        this.#db = null;
-    }
-    async append(tenant, messageCid, indexes) {
-        if (!this.#db) {
-            throw new Error('Connection to database not open. Call `open` before using `append`.');
-        }
-        // we execute the insert in a transaction as we are making multiple inserts into multiple tables.
-        // if any of these inserts would throw, the whole transaction would be rolled back.
-        // otherwise it is committed.
-        const putEventOperation = this.constructPutEventOperation({ tenant, messageCid, indexes });
-        await executeWithRetryIfDatabaseIsLocked(this.#db, putEventOperation);
-    }
-    /**
-     * Constructs a transactional operation to insert an event into the database.
-     */
-    constructPutEventOperation(queryOptions) {
-        const { tenant, messageCid, indexes } = queryOptions;
-        // we extract the tag indexes into their own object to be inserted separately.
-        // we also sanitize the indexes to convert any `boolean` values to `text` representations.
-        const { indexes: appendIndexes, tags } = extractTagsAndSanitizeIndexes(indexes);
-        return async (tx) => {
-            const eventIndexValues = {
-                tenant,
-                messageCid,
-                ...appendIndexes,
-            };
-            // we use the dialect-specific `insertThenReturnId` in order to be able to extract the `insertId`
-            const result = await this.#dialect
-                .insertThenReturnId(tx, 'eventLogMessages', eventIndexValues, 'watermark as insertId')
-                .executeTakeFirstOrThrow();
-            // if tags exist, we execute those within the transaction associating them with the `insertId`.
-            if (Object.keys(tags).length > 0) {
-                await this.#tags.executeTagsInsert(result.insertId, tags, tx);
-            }
-        };
-    }
-    async getEvents(tenant, cursor) {
-        // get events is simply a query without any filters. gets all events beyond the cursor.
-        return this.queryEvents(tenant, [], cursor);
-    }
-    async queryEvents(tenant, filters, cursor) {
-        if (!this.#db) {
-            throw new Error('Connection to database not open. Call `open` before using `queryEvents`.');
-        }
-        let query = this.#db
-            .selectFrom('eventLogMessages')
-            .leftJoin('eventLogRecordsTags', 'eventLogRecordsTags.eventWatermark', 'eventLogMessages.watermark')
-            .select('messageCid')
-            .distinct()
-            .select('watermark')
-            .where('tenant', '=', tenant);
-        if (filters.length > 0) {
-            // filter sanitization takes place within `filterSelectQuery`
-            query = filterSelectQuery(filters, query);
-        }
-        if (cursor !== undefined) {
-            // eventLogMessages in the sql store uses the watermark cursor value which is a number in SQL
-            // if not we will return empty results
-            const cursorValue = cursor.value;
-            const cursorMessageCid = cursor.messageCid;
-            query = query.where(({ eb, refTuple, tuple }) => {
-                // https://kysely-org.github.io/kysely-apidoc/interfaces/ExpressionBuilder.html#refTuple
-                return eb(refTuple('watermark', 'messageCid'), '>', tuple(cursorValue, cursorMessageCid));
-            });
-        }
-        query = query.orderBy('watermark', 'asc').orderBy('messageCid', 'asc');
-        const events = [];
-        // we always return a cursor with the event log query, so we set the return cursor to the properties of the last item.
-        let returnCursor;
-        if (this.#dialect.isStreamingSupported) {
-            for await (let { messageCid, watermark: value } of query.stream()) {
-                events.push(messageCid);
-                returnCursor = { messageCid, value };
-            }
-        }
-        else {
-            const results = await query.execute();
-            for (let { messageCid, watermark: value } of results) {
-                events.push(messageCid);
-                returnCursor = { messageCid, value };
-            }
-        }
-        return { events, cursor: returnCursor };
-    }
-    async deleteEventsByCid(tenant, messageCids) {
-        if (!this.#db) {
-            throw new Error('Connection to database not open. Call `open` before using `deleteEventsByCid`.');
-        }
-        if (messageCids.length === 0) {
-            return;
-        }
-        await this.#db
-            .deleteFrom('eventLogMessages')
-            .where('tenant', '=', tenant)
-            .where('messageCid', 'in', messageCids)
-            .execute();
-    }
-    async clear() {
-        if (!this.#db) {
-            throw new Error('Connection to database not open. Call `open` before using `clear`.');
-        }
-        await this.#db
-            .deleteFrom('eventLogMessages')
-            .execute();
-    }
-}
-//# sourceMappingURL=event-log-sql.js.map

package/dist/esm/src/event-log-sql.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"event-log-sql.js","sourceRoot":"","sources":["../../../src/event-log-sql.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAe,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,kCAAkC,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,OAAO,WAAW;IACtB,QAAQ,CAAU;IAClB,GAAG,GAAmC,IAAI,CAAC;IAC3C,KAAK,CAAY;IAEjB,YAAY,OAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,OAAO;SACR;QAED,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAkB,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM;aAC9B,WAAW,CAAC,kBAAkB,CAAC;aAC/B,WAAW,EAAE;aACb,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aAC3D,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aAC9D,SAAS,CAAC,WAAW,EAAE,aAAa,CAAC;aACrC,SAAS,CAAC,QAAQ,EAAE,aAAa,CAAC;aAClC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;aACpC,SAAS,CAAC,SAAS,EAAC,aAAa,CAAC;aAClC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;aACpC,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;aACrC,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;aACzC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC;aACtC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;aACnC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;aACnC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC;aACtC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC;aAC5C,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC;aACvC,SAAS,CAAC,eAAe,EAAE,aAAa,CAAC;aACzC,SAAS,CAAC,mBAAmB,EAAE,SAAS,CAAC;aACzC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC;aACjC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC;aAC7B,SAAS,CAAC,YAAY,EAAE,aAAa,CAAC;aACtC,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC;aACnC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC;YACjC,yIAAyI;aACxI,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;aAC7B,SAAS,CAAC,mBAAmB,EAAE,aAAa,CAAC;aAC7C,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,sDAAsD;QAEtF,IAAI,sBAAsB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM;aACzC,WAAW,CAAC,qBAAqB,CAAC;aAClC,WAAW,EAAE;aACb,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aAChD,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;aAChC,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACvC,qDAAqD;QACrD,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,WAAW,EAAE,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3G,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,sBAAsB,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1H,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QAEnL,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;QAC5B,MAAM,sBAAsB,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAc,EACd,UAAkB,EAClB,OAAkD;QAElD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;SACH;QAED,iGAAiG;QACjG,mFAAmF;QACnF,6BAA6B;QAC7B,MAAM,iBAAiB,GAAG,IAAI,CAAC,0BAA0B,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3F,MAAM,kCAAkC,CAAC,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACK,0BAA0B,CAAC,YAIlC;QACC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC;QAErD,8EAA8E;QAC9E,0FAA0F;QAC1F,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;QAEhF,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE;YAElB,MAAM,gBAAgB,GAAG;gBACvB,MAAM;gBACN,UAAU;gBACV,GAAG,aAAa;aACjB,CAAC;YAEF,iGAAiG;YACjG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ;iBAC/B,kBAAkB,CAAC,EAAE,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,uBAAuB,CAAC;iBACrF,uBAAuB,EAAE,CAAC;YAE7B,+FAA+F;YAC/F,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBAChC,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;aAC/D;QACH,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CACb,MAAc,EACd,MAAyB;QAGzB,uFAAuF;QACvF,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,MAAc,EACd,OAAiB,EACjB,MAAyB;QAEzB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;SACH;QAED,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG;aACjB,UAAU,CAAC,kBAAkB,CAAC;aAC9B,QAAQ,CAAC,qBAAqB,EAAE,oCAAoC,EAAE,4BAA4B,CAAC;aACnG,MAAM,CAAC,YAAY,CAAC;aACpB,QAAQ,EAAE;aACV,MAAM,CAAC,WAAW,CAAC;aACnB,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAEhC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,6DAA6D;YAC7D,KAAK,GAAG,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SAC3C;QAED,IAAG,MAAM,KAAK,SAAS,EAAE;YACvB,6FAA6F;YAC7F,sCAAsC;YACtC,MAAM,WAAW,GAAG,MAAM,CAAC,KAAe,CAAC;YAC3C,MAAM,gBAAgB,GAAG,MAAM,CAAC,UAAU,CAAC;YAE3C,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC9C,wFAAwF;gBACxF,OAAO,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC;YAC5F,CAAC,CAAC,CAAC;SACJ;QAED,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAEvE,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,sHAAsH;QACtH,IAAI,YAA0C,CAAC;QAC/C,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE;YACtC,IAAI,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;gBACjE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACxB,YAAY,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;aACtC;SACF;aAAM;YACL,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;YACtC,KAAK,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,OAAO,EAAE;gBACpD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACxB,YAAY,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;aACtC;SACF;QAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,MAAc,EACd,WAA0B;QAE1B,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;SACH;QAED,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,OAAO;SACR;QAED,MAAM,IAAI,CAAC,GAAG;aACX,UAAU,CAAC,kBAAkB,CAAC;aAC9B,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC;aAC5B,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,WAAW,CAAC;aACtC,OAAO,EAAE,CAAC;IACf,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;SACH;QAED,MAAM,IAAI,CAAC,GAAG;aACX,UAAU,CAAC,kBAAkB,CAAC;aAC9B,OAAO,EAAE,CAAC;IACf,CAAC;CACF"}

package/dist/types/src/event-log-sql.d.ts

@@ -1,24 +0,0 @@
-import type { EventLog, Filter, PaginationCursor } from '@enbox/dwn-sdk-js';
-import { Dialect } from './dialect/dialect.js';
-export declare class EventLogSql implements EventLog {
-    #private;
-    constructor(dialect: Dialect);
-    open(): Promise<void>;
-    close(): Promise<void>;
-    append(tenant: string, messageCid: string, indexes: Record<string, string | boolean | number>): Promise<void>;
-    /**
-     * Constructs a transactional operation to insert an event into the database.
-     */
-    private constructPutEventOperation;
-    getEvents(tenant: string, cursor?: PaginationCursor): Promise<{
-        events: string[];
-        cursor?: PaginationCursor;
-    }>;
-    queryEvents(tenant: string, filters: Filter[], cursor?: PaginationCursor): Promise<{
-        events: string[];
-        cursor?: PaginationCursor;
-    }>;
-    deleteEventsByCid(tenant: string, messageCids: Array<string>): Promise<void>;
-    clear(): Promise<void>;
-}
-//# sourceMappingURL=event-log-sql.d.ts.map

package/dist/types/src/event-log-sql.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"event-log-sql.d.ts","sourceRoot":"","sources":["../../../src/event-log-sql.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE5E,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAO/C,qBAAa,WAAY,YAAW,QAAQ;;gBAK9B,OAAO,EAAE,OAAO;IAKtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAmDrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtB,MAAM,CACV,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;IAchB;;OAEG;IACH,OAAO,CAAC,0BAA0B;IA+B5B,SAAS,CACb,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,gBAAgB,GACxB,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAE,CAAC;IAMpD,WAAW,CACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,CAAC,EAAE,gBAAgB,GACxB,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAE,CAAC;IAqDpD,iBAAiB,CACrB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,GACzB,OAAO,CAAC,IAAI,CAAC;IAkBV,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAW7B"}

package/src/event-log-sql.ts

@@ -1,227 +0,0 @@
-import type { DwnDatabaseType, KeyValues } from './types.js';
-import type { EventLog, Filter, PaginationCursor } from '@enbox/dwn-sdk-js';
-
-import { Dialect } from './dialect/dialect.js';
-import { filterSelectQuery } from './utils/filter.js';
-import { Kysely, Transaction } from 'kysely';
-import { executeWithRetryIfDatabaseIsLocked } from './utils/transaction.js';
-import { extractTagsAndSanitizeIndexes } from './utils/sanitize.js';
-import { TagTables } from './utils/tags.js';
-
-export class EventLogSql implements EventLog {
-  #dialect: Dialect;
-  #db: Kysely<DwnDatabaseType> | null = null;
-  #tags: TagTables;
-
-  constructor(dialect: Dialect) {
-    this.#dialect = dialect;
-    this.#tags = new TagTables(dialect, 'eventLogMessages');
-  }
-
-  async open(): Promise<void> {
-    if (this.#db) {
-      return;
-    }
-
-    this.#db = new Kysely<DwnDatabaseType>({ dialect: this.#dialect });
-    let createTable = this.#db.schema
-      .createTable('eventLogMessages')
-      .ifNotExists()
-      .addColumn('tenant', 'varchar(255)', (col) => col.notNull())
-      .addColumn('messageCid', 'varchar(60)', (col) => col.notNull())
-      .addColumn('interface', 'varchar(20)')
-      .addColumn('method', 'varchar(20)')
-      .addColumn('recordId', 'varchar(60)')
-      .addColumn('entryId','varchar(60)')
-      .addColumn('parentId', 'varchar(60)')
-      .addColumn('protocol', 'varchar(200)')
-      .addColumn('protocolPath', 'varchar(200)')
-      .addColumn('contextId', 'varchar(500)')
-      .addColumn('schema', 'varchar(200)')
-      .addColumn('author', 'varchar(255)')
-      .addColumn('recipient', 'varchar(255)')
-      .addColumn('messageTimestamp', 'varchar(30)')
-      .addColumn('dateCreated', 'varchar(30)')
-      .addColumn('datePublished', 'varchar(30)')
-      .addColumn('isLatestBaseState', 'boolean')
-      .addColumn('published', 'boolean')
-      .addColumn('prune', 'boolean')
-      .addColumn('dataFormat', 'varchar(30)')
-      .addColumn('dataCid', 'varchar(60)')
-      .addColumn('dataSize', 'integer')
-      // .addColumn('encodedData', 'text') // intentionally kept commented out code to show the only difference to `messageStoreMessages` table
-      .addColumn('attester', 'text')
-      .addColumn('permissionGrantId', 'varchar(60)')
-      .addColumn('latest', 'text'); // TODO: obsolete, remove once `dwn-sdk-js` is updated
-
-    let createRecordsTagsTable = this.#db.schema
-      .createTable('eventLogRecordsTags')
-      .ifNotExists()
-      .addColumn('tag', 'text', (col) => col.notNull())
-      .addColumn('valueString', 'text')
-      .addColumn('valueNumber', 'decimal');
-    // Add columns that have dialect-specific constraints
-    createTable = this.#dialect.addAutoIncrementingColumn(createTable, 'watermark', (col) => col.primaryKey());
-    createRecordsTagsTable = this.#dialect.addAutoIncrementingColumn(createRecordsTagsTable, 'id', (col) => col.primaryKey());
-    createRecordsTagsTable = this.#dialect.addReferencedColumn(createRecordsTagsTable, 'eventLogRecordsTags', 'eventWatermark', 'integer', 'eventLogMessages', 'watermark', 'cascade');
-
-    await createTable.execute();
-    await createRecordsTagsTable.execute();
-  }
-
-  async close(): Promise<void> {
-    await this.#db?.destroy();
-    this.#db = null;
-  }
-
-  async append(
-    tenant: string,
-    messageCid: string,
-    indexes: Record<string, string | boolean | number>
-  ): Promise<void> {
-    if (!this.#db) {
-      throw new Error(
-        'Connection to database not open. Call `open` before using `append`.'
-      );
-    }
-
-    // we execute the insert in a transaction as we are making multiple inserts into multiple tables.
-    // if any of these inserts would throw, the whole transaction would be rolled back.
-    // otherwise it is committed.
-    const putEventOperation = this.constructPutEventOperation({ tenant, messageCid, indexes });
-    await executeWithRetryIfDatabaseIsLocked(this.#db, putEventOperation);
-  }
-
-  /**
-   * Constructs a transactional operation to insert an event into the database.
-   */
-  private constructPutEventOperation(queryOptions: {
-    tenant: string;
-    messageCid: string;
-    indexes: KeyValues;
-  }): (tx: Transaction<DwnDatabaseType>) => Promise<void> {
-    const { tenant, messageCid, indexes } = queryOptions;
-
-    // we extract the tag indexes into their own object to be inserted separately.
-    // we also sanitize the indexes to convert any `boolean` values to `text` representations.
-    const { indexes: appendIndexes, tags } = extractTagsAndSanitizeIndexes(indexes);
-
-    return async (tx) => {
-
-      const eventIndexValues = {
-        tenant,
-        messageCid,
-        ...appendIndexes,
-      };
-
-      // we use the dialect-specific `insertThenReturnId` in order to be able to extract the `insertId`
-      const result = await this.#dialect
-        .insertThenReturnId(tx, 'eventLogMessages', eventIndexValues, 'watermark as insertId')
-        .executeTakeFirstOrThrow();
-
-      // if tags exist, we execute those within the transaction associating them with the `insertId`.
-      if (Object.keys(tags).length > 0) {
-        await this.#tags.executeTagsInsert(result.insertId, tags, tx);
-      }
-    };
-  }
-
-  async getEvents(
-    tenant: string,
-    cursor?: PaginationCursor
-  ): Promise<{events: string[], cursor?: PaginationCursor }> {
-
-    // get events is simply a query without any filters. gets all events beyond the cursor.
-    return this.queryEvents(tenant, [], cursor);
-  }
-
-  async queryEvents(
-    tenant: string,
-    filters: Filter[],
-    cursor?: PaginationCursor
-  ): Promise<{events: string[], cursor?: PaginationCursor }> {
-    if (!this.#db) {
-      throw new Error(
-        'Connection to database not open. Call `open` before using `queryEvents`.'
-      );
-    }
-
-    let query = this.#db
-      .selectFrom('eventLogMessages')
-      .leftJoin('eventLogRecordsTags', 'eventLogRecordsTags.eventWatermark', 'eventLogMessages.watermark')
-      .select('messageCid')
-      .distinct()
-      .select('watermark')
-      .where('tenant', '=', tenant);
-
-    if (filters.length > 0) {
-      // filter sanitization takes place within `filterSelectQuery`
-      query = filterSelectQuery(filters, query);
-    }
-
-    if(cursor !== undefined) {
-      // eventLogMessages in the sql store uses the watermark cursor value which is a number in SQL
-      // if not we will return empty results
-      const cursorValue = cursor.value as number;
-      const cursorMessageCid = cursor.messageCid;
-
-      query = query.where(({ eb, refTuple, tuple }) => {
-        // https://kysely-org.github.io/kysely-apidoc/interfaces/ExpressionBuilder.html#refTuple
-        return eb(refTuple('watermark', 'messageCid'), '>', tuple(cursorValue, cursorMessageCid));
-      });
-    }
-
-    query = query.orderBy('watermark', 'asc').orderBy('messageCid', 'asc');
-
-    const events: string[] = [];
-    // we always return a cursor with the event log query, so we set the return cursor to the properties of the last item.
-    let returnCursor: PaginationCursor | undefined;
-    if (this.#dialect.isStreamingSupported) {
-      for await (let { messageCid, watermark: value } of query.stream()) {
-        events.push(messageCid);
-        returnCursor = { messageCid, value };
-      }
-    } else {
-      const results = await query.execute();
-      for (let { messageCid, watermark: value } of results) {
-        events.push(messageCid);
-        returnCursor = { messageCid, value };
-      }
-    }
-
-    return { events, cursor: returnCursor };
-  }
-
-  async deleteEventsByCid(
-    tenant: string,
-    messageCids: Array<string>
-  ): Promise<void> {
-    if (!this.#db) {
-      throw new Error(
-        'Connection to database not open. Call `open` before using `deleteEventsByCid`.'
-      );
-    }
-
-    if (messageCids.length === 0) {
-      return;
-    }
-
-    await this.#db
-      .deleteFrom('eventLogMessages')
-      .where('tenant', '=', tenant)
-      .where('messageCid', 'in', messageCids)
-      .execute();
-  }
-
-  async clear(): Promise<void> {
-    if (!this.#db) {
-      throw new Error(
-        'Connection to database not open. Call `open` before using `clear`.'
-      );
-    }
-
-    await this.#db
-      .deleteFrom('eventLogMessages')
-      .execute();
-  }
-}