@enbox/dwn-sql-store 0.0.1

package/dist/esm/src/message-store-sql.js

@@ -0,0 +1,317 @@
+import { DwnInterfaceName, DwnMethodName, executeUnlessAborted, SortDirection, } from '@enbox/dwn-sdk-js';
+import { Kysely } from 'kysely';
+import * as block from 'multiformats/block';
+import * as cbor from '@ipld/dag-cbor';
+import { executeWithRetryIfDatabaseIsLocked } from './utils/transaction.js';
+import { extractTagsAndSanitizeIndexes } from './utils/sanitize.js';
+import { filterSelectQuery } from './utils/filter.js';
+import { sha256 } from 'multiformats/hashes/sha2';
+import { TagTables } from './utils/tags.js';
+export class MessageStoreSql {
+    #dialect;
+    #tags;
+    #db = null;
+    constructor(dialect) {
+        this.#dialect = dialect;
+        this.#tags = new TagTables(dialect, 'messageStoreMessages');
+    }
+    async open() {
+        if (this.#db) {
+            return;
+        }
+        this.#db = new Kysely({ dialect: this.#dialect });
+        // create messages table if it does not exist
+        const messagesTableName = 'messageStoreMessages';
+        const messagesTableExists = await this.#dialect.hasTable(this.#db, messagesTableName);
+        if (!messagesTableExists) {
+            let createMessagesTable = this.#db.schema
+                .createTable(messagesTableName)
+                .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') // we optionally store encoded data if it is below a threshold
+                .addColumn('attester', 'text')
+                .addColumn('permissionGrantId', 'varchar(60)')
+                .addColumn('latest', 'text'); // TODO: obsolete, remove once `dwn-sdk-js` tests are updated
+            // Add columns that have dialect-specific constraints
+            createMessagesTable = this.#dialect.addAutoIncrementingColumn(createMessagesTable, 'id', (col) => col.primaryKey());
+            createMessagesTable = this.#dialect.addBlobColumn(createMessagesTable, 'encodedMessageBytes', (col) => col.notNull());
+            await createMessagesTable.execute();
+            // add indexes to the table
+            await this.createIndexes(this.#db, messagesTableName, [
+                ['tenant'],
+                ['tenant', 'recordId'],
+                ['tenant', 'parentId'],
+                ['tenant', 'protocol', 'published', 'messageTimestamp'],
+                ['tenant', 'interface'],
+                ['tenant', 'contextId', 'messageTimestamp'],
+                ['tenant', 'permissionGrantId'], // for deleting grant-authorized messages though pending https://github.com/TBD54566975/dwn-sdk-js/issues/716
+                // other potential indexes
+                // ['tenant', 'author'],
+                // ['tenant', 'recipient'],
+                // ['tenant', 'schema', 'dataFormat'],
+                // ['tenant', 'dateCreated'],
+                // ['tenant', 'datePublished'],
+                // ['tenant', 'messageCid'],
+                // ['tenant', 'protocolPath'],
+            ]);
+        }
+        // create tags table
+        const tagsTableName = 'messageStoreRecordsTags';
+        const tagsTableExists = await this.#dialect.hasTable(this.#db, tagsTableName);
+        if (!tagsTableExists) {
+            let createRecordsTagsTable = this.#db.schema
+                .createTable(tagsTableName)
+                .ifNotExists()
+                .addColumn('tag', 'varchar(30)', (col) => col.notNull())
+                .addColumn('valueString', 'varchar(200)')
+                .addColumn('valueNumber', 'decimal');
+            // Add columns that have dialect-specific constraints
+            const foreignMessageInsertId = 'messageInsertId';
+            createRecordsTagsTable = this.#dialect.addAutoIncrementingColumn(createRecordsTagsTable, 'id', (col) => col.primaryKey());
+            createRecordsTagsTable = this.#dialect.addReferencedColumn(createRecordsTagsTable, tagsTableName, foreignMessageInsertId, 'integer', 'messageStoreMessages', 'id', 'cascade');
+            await createRecordsTagsTable.execute();
+            // add indexes to the table
+            await this.createIndexes(this.#db, tagsTableName, [
+                [foreignMessageInsertId],
+                ['tag', 'valueString'],
+                ['tag', 'valueNumber']
+            ]);
+        }
+    }
+    /**
+     *  Creates indexes on the given table.
+     * @param tableName The name of the table to create the indexes on.
+     * @param indexes Each inner array represents a single index and contains the column names to be indexed as a composite index.
+     *                If the inner array contains only one element, it will be treated as a single column index.
+     */
+    async createIndexes(database, tableName, indexes) {
+        for (const columnNames of indexes) {
+            const indexName = 'index_' + columnNames.join('_'); // e.g. index_tenant_protocol
+            await database.schema
+                .createIndex(indexName)
+                // .ifNotExists() // intentionally kept commented out code to show that it is not supported by all dialects (ie. MySQL)
+                .on(tableName)
+                .columns(columnNames)
+                .execute();
+        }
+    }
+    async close() {
+        await this.#db?.destroy();
+        this.#db = null;
+    }
+    async put(tenant, message, indexes, options) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `put`.');
+        }
+        options?.signal?.throwIfAborted();
+        // gets the encoded data and removes it from the message
+        // we remove it from the message as it would cause the `encodedMessageBytes` to be greater than the
+        // maximum bytes allowed by SQL
+        const getEncodedData = (message) => {
+            let encodedData = null;
+            if (message.descriptor.interface === DwnInterfaceName.Records && message.descriptor.method === DwnMethodName.Write) {
+                const data = message.encodedData;
+                if (data) {
+                    delete message.encodedData;
+                    encodedData = data;
+                }
+            }
+            return { message, encodedData };
+        };
+        const { message: messageToProcess, encodedData } = getEncodedData(message);
+        const encodedMessageBlock = await executeUnlessAborted(block.encode({ value: messageToProcess, codec: cbor, hasher: sha256 }), options?.signal);
+        const messageCid = encodedMessageBlock.cid.toString();
+        const encodedMessageBytes = Buffer.from(encodedMessageBlock.bytes);
+        // 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 putMessageOperation = this.constructPutMessageOperation({ tenant, messageCid, encodedMessageBytes, encodedData, indexes });
+        await executeWithRetryIfDatabaseIsLocked(this.#db, putMessageOperation);
+    }
+    /**
+     * Constructs the transactional operation to insert the given message into the database.
+     */
+    constructPutMessageOperation(queryOptions) {
+        const { tenant, messageCid, encodedMessageBytes, encodedData, 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: putIndexes, tags } = extractTagsAndSanitizeIndexes(indexes);
+        return async (tx) => {
+            const messageIndexValues = {
+                tenant,
+                messageCid,
+                encodedMessageBytes,
+                encodedData,
+                ...putIndexes
+            };
+            // we use the dialect-specific `insertThenReturnId` in order to be able to extract the `insertId`
+            const result = await this.#dialect
+                .insertThenReturnId(tx, 'messageStoreMessages', messageIndexValues, 'id 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 get(tenant, cid, options) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `get`.');
+        }
+        options?.signal?.throwIfAborted();
+        const result = await executeUnlessAborted(this.#db
+            .selectFrom('messageStoreMessages')
+            .selectAll()
+            .where('tenant', '=', tenant)
+            .where('messageCid', '=', cid)
+            .executeTakeFirst(), options?.signal);
+        if (!result) {
+            return undefined;
+        }
+        return this.parseEncodedMessage(result.encodedMessageBytes, result.encodedData, options);
+    }
+    async query(tenant, filters, messageSort, pagination, options) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `query`.');
+        }
+        options?.signal?.throwIfAborted();
+        // extract sort property and direction from the supplied messageSort
+        const { property: sortProperty, direction: sortDirection } = this.extractSortProperties(messageSort);
+        let query = this.#db
+            .selectFrom('messageStoreMessages')
+            .leftJoin('messageStoreRecordsTags', 'messageStoreRecordsTags.messageInsertId', 'messageStoreMessages.id')
+            .select('messageCid')
+            .distinct()
+            .select([
+            'encodedMessageBytes',
+            'encodedData',
+            sortProperty,
+        ])
+            .where('tenant', '=', tenant);
+        // filter sanitization takes place within `filterSelectQuery`
+        query = filterSelectQuery(filters, query);
+        if (pagination?.cursor !== undefined) {
+            // currently the sort property is explicitly either `dateCreated` | `messageTimestamp` | `datePublished` which are all strings
+            // TODO: https://github.com/TBD54566975/dwn-sdk-js/issues/664 to handle the edge case
+            const cursorValue = pagination.cursor.value;
+            const cursorMessageId = pagination.cursor.messageCid;
+            query = query.where(({ eb, refTuple, tuple }) => {
+                const direction = sortDirection === SortDirection.Ascending ? '>' : '<';
+                // https://kysely-org.github.io/kysely-apidoc/interfaces/ExpressionBuilder.html#refTuple
+                return eb(refTuple(sortProperty, 'messageCid'), direction, tuple(cursorValue, cursorMessageId));
+            });
+        }
+        const orderDirection = sortDirection === SortDirection.Ascending ? 'asc' : 'desc';
+        // sorting by the provided sort property, the tiebreak is always in ascending order regardless of sort
+        query = query
+            .orderBy(sortProperty, orderDirection)
+            .orderBy('messageCid', orderDirection);
+        if (pagination?.limit !== undefined && pagination?.limit > 0) {
+            // we query for one additional record to decide if we return a pagination cursor or not.
+            query = query.limit(pagination.limit + 1);
+        }
+        const results = await executeUnlessAborted(query.execute(), options?.signal);
+        // prunes the additional requested message, if it exists, and adds a cursor to the results.
+        // also parses the encoded message for each of the returned results.
+        return this.processPaginationResults(results, sortProperty, pagination?.limit, options);
+    }
+    async delete(tenant, cid, options) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `delete`.');
+        }
+        options?.signal?.throwIfAborted();
+        await executeUnlessAborted(this.#db
+            .deleteFrom('messageStoreMessages')
+            .where('tenant', '=', tenant)
+            .where('messageCid', '=', cid)
+            .execute(), options?.signal);
+    }
+    async clear() {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `clear`.');
+        }
+        await this.#db
+            .deleteFrom('messageStoreMessages')
+            .execute();
+    }
+    async parseEncodedMessage(encodedMessageBytes, encodedData, options) {
+        options?.signal?.throwIfAborted();
+        const decodedBlock = await block.decode({
+            bytes: encodedMessageBytes,
+            codec: cbor,
+            hasher: sha256
+        });
+        const message = decodedBlock.value;
+        // If encodedData is stored within the MessageStore we include it in the response.
+        // We store encodedData when the data is below a certain threshold.
+        // https://github.com/TBD54566975/dwn-sdk-js/pull/456
+        if (message !== undefined && encodedData !== undefined && encodedData !== null) {
+            message.encodedData = encodedData;
+        }
+        return message;
+    }
+    /**
+     * Processes the paginated query results.
+     * Builds a pagination cursor if there are additional messages to paginate.
+     * Accepts more messages than the limit, as we query for additional records to check if we should paginate.
+     *
+     * @param messages a list of messages, potentially larger than the provided limit.
+     * @param limit the maximum number of messages to be returned
+     *
+     * @returns the pruned message results and an optional pagination cursor
+     */
+    async processPaginationResults(results, sortProperty, limit, options) {
+        // we queried for one additional message to determine if there are any additional messages beyond the limit
+        // we now check if the returned results are greater than the limit, if so we pluck the last item out of the result set
+        // the cursor is always the last item in the *returned* result so we use the last item in the remaining result set to build a cursor
+        let cursor;
+        if (limit !== undefined && results.length > limit) {
+            results = results.slice(0, limit);
+            const lastMessage = results.at(-1);
+            const cursorValue = lastMessage[sortProperty];
+            cursor = { messageCid: lastMessage.messageCid, value: cursorValue };
+        }
+        // extracts the full encoded message from the stored blob for each result item.
+        const messages = results.map(r => this.parseEncodedMessage(r.encodedMessageBytes, r.encodedData, options));
+        return { messages: await Promise.all(messages), cursor };
+    }
+    /**
+     * Extracts the appropriate sort property and direction given a MessageSort object.
+     */
+    extractSortProperties(messageSort) {
+        if (messageSort?.dateCreated !== undefined) {
+            return { property: 'dateCreated', direction: messageSort.dateCreated };
+        }
+        else if (messageSort?.datePublished !== undefined) {
+            return { property: 'datePublished', direction: messageSort.datePublished };
+        }
+        else if (messageSort?.messageTimestamp !== undefined) {
+            return { property: 'messageTimestamp', direction: messageSort.messageTimestamp };
+        }
+        else {
+            return { property: 'messageTimestamp', direction: SortDirection.Ascending };
+        }
+    }
+}
+//# sourceMappingURL=message-store-sql.js.map

package/dist/esm/src/message-store-sql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-store-sql.js","sourceRoot":"","sources":["../../../src/message-store-sql.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,oBAAoB,EAOpB,aAAa,GAEd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,MAAM,EAAe,MAAM,QAAQ,CAAC;AAE7C,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AAEvC,OAAO,EAAE,kCAAkC,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,MAAM,OAAO,eAAe;IAC1B,QAAQ,CAAU;IAClB,KAAK,CAAY;IACjB,GAAG,GAAmC,IAAI,CAAC;IAE3C,YAAY,OAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IAC9D,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;QAEnE,6CAA6C;QAC7C,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;QACjD,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;QACtF,IAAI,CAAC,mBAAmB,EAAE;YACxB,IAAI,mBAAmB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM;iBACtC,WAAW,CAAC,iBAAiB,CAAC;iBAC9B,WAAW,EAAE;iBACb,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;iBAC3D,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;iBAC9D,SAAS,CAAC,WAAW,EAAE,aAAa,CAAC;iBACrC,SAAS,CAAC,QAAQ,EAAE,aAAa,CAAC;iBAClC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;iBACpC,SAAS,CAAC,SAAS,EAAC,aAAa,CAAC;iBAClC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;iBACpC,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;iBACrC,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;iBACzC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC;iBACtC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;iBACnC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;iBACnC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC;iBACtC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC;iBAC5C,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC;iBACvC,SAAS,CAAC,eAAe,EAAE,aAAa,CAAC;iBACzC,SAAS,CAAC,mBAAmB,EAAE,SAAS,CAAC;iBACzC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC;iBACjC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC;iBAC7B,SAAS,CAAC,YAAY,EAAE,aAAa,CAAC;iBACtC,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC;iBACnC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC;iBAChC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,8DAA8D;iBAC/F,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;iBAC7B,SAAS,CAAC,mBAAmB,EAAE,aAAa,CAAC;iBAC7C,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,6DAA6D;YAE7F,qDAAqD;YACrD,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,mBAAmB,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;YACpH,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YACtH,MAAM,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAEpC,2BAA2B;YAC3B,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,iBAAiB,EAAE;gBACpD,CAAC,QAAQ,CAAC;gBACV,CAAC,QAAQ,EAAE,UAAU,CAAC;gBACtB,CAAC,QAAQ,EAAE,UAAU,CAAC;gBACtB,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC;gBACvD,CAAC,QAAQ,EAAE,WAAW,CAAC;gBACvB,CAAC,QAAQ,EAAE,WAAW,EAAE,kBAAkB,CAAC;gBAC3C,CAAC,QAAQ,EAAE,mBAAmB,CAAC,EAAE,6GAA6G;gBAC9I,0BAA0B;gBAC1B,wBAAwB;gBACxB,2BAA2B;gBAC3B,sCAAsC;gBACtC,6BAA6B;gBAC7B,+BAA+B;gBAC/B,4BAA4B;gBAC5B,8BAA8B;aAC/B,CAAC,CAAC;SACJ;QAED,oBAAoB;QACpB,MAAM,aAAa,GAAG,yBAAyB,CAAC;QAChD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC9E,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,sBAAsB,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM;iBACzC,WAAW,CAAC,aAAa,CAAC;iBAC1B,WAAW,EAAE;iBACb,SAAS,CAAC,KAAK,EAAE,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;iBACvD,SAAS,CAAC,aAAa,EAAE,cAAc,CAAC;iBACxC,SAAS,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAEvC,qDAAqD;YACrD,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;YACjD,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,sBAAsB,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;YAC1H,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,aAAa,EAAE,sBAAsB,EAAE,SAAS,EAAE,sBAAsB,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAC9K,MAAM,sBAAsB,CAAC,OAAO,EAAE,CAAC;YAEvC,2BAA2B;YAC3B,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE;gBAChD,CAAC,sBAAsB,CAAC;gBACxB,CAAC,KAAK,EAAE,aAAa,CAAC;gBACtB,CAAC,KAAK,EAAE,aAAa,CAAC;aACvB,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAI,QAAmB,EAAE,SAAiB,EAAE,OAAmB;QAChF,KAAK,MAAM,WAAW,IAAI,OAAO,EAAE;YACjC,MAAM,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,6BAA6B;YACjF,MAAM,QAAQ,CAAC,MAAM;iBAClB,WAAW,CAAC,SAAS,CAAC;gBACvB,uHAAuH;iBACtH,EAAE,CAAC,SAAS,CAAC;iBACb,OAAO,CAAC,WAAW,CAAC;iBACpB,OAAO,EAAE,CAAC;SACd;IACH,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,GAAG,CACP,MAAc,EACd,OAAuB,EACvB,OAAkB,EAClB,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;QAED,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAElC,wDAAwD;QACxD,mGAAmG;QACnG,+BAA+B;QAC/B,MAAM,cAAc,GAAG,CAAC,OAAuB,EAAwD,EAAE;YACvG,IAAI,WAAW,GAAgB,IAAI,CAAC;YACpC,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,KAAK,gBAAgB,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,KAAK,aAAa,CAAC,KAAK,EAAE;gBAClH,MAAM,IAAI,GAAI,OAAe,CAAC,WAA+B,CAAC;gBAC9D,IAAG,IAAI,EAAE;oBACP,OAAQ,OAAe,CAAC,WAAW,CAAC;oBACpC,WAAW,GAAG,IAAI,CAAC;iBACpB;aACF;YACD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QAClC,CAAC,CAAC;QAEF,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAE1E,MAAM,mBAAmB,GAAG,MAAM,oBAAoB,CACpD,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,EACrE,OAAO,EAAE,MAAM,CAChB,CAAC;QAEF,MAAM,UAAU,GAAG,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACtD,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAEnE,iGAAiG;QACjG,mFAAmF;QACnF,6BAA6B;QAC7B,MAAM,mBAAmB,GAAG,IAAI,CAAC,4BAA4B,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;QACjI,MAAM,kCAAkC,CAAC,IAAI,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACK,4BAA4B,CAAC,YAMpC;QACC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC;QAEvF,8EAA8E;QAC9E,0FAA0F;QAC1F,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;QAE7E,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE;YAElB,MAAM,kBAAkB,GAAG;gBACzB,MAAM;gBACN,UAAU;gBACV,mBAAmB;gBACnB,WAAW;gBACX,GAAG,UAAU;aACd,CAAC;YAEF,iGAAiG;YACjG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ;iBAC/B,kBAAkB,CAAC,EAAE,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,gBAAgB,CAAC;iBACpF,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;QAEH,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CACP,MAAc,EACd,GAAW,EACX,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;QAED,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,oBAAoB,CACvC,IAAI,CAAC,GAAG;aACL,UAAU,CAAC,sBAAsB,CAAC;aAClC,SAAS,EAAE;aACX,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC;aAC5B,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC;aAC7B,gBAAgB,EAAE,EACrB,OAAO,EAAE,MAAM,CAChB,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED,KAAK,CAAC,KAAK,CACT,MAAc,EACd,OAAiB,EACjB,WAAyB,EACzB,UAAuB,EACvB,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;SACH;QAED,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAElC,oEAAoE;QACpE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAErG,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG;aACjB,UAAU,CAAC,sBAAsB,CAAC;aAClC,QAAQ,CAAC,yBAAyB,EAAE,yCAAyC,EAAE,yBAAyB,CAAC;aACzG,MAAM,CAAC,YAAY,CAAC;aACpB,QAAQ,EAAE;aACV,MAAM,CAAC;YACN,qBAAqB;YACrB,aAAa;YACb,YAAY;SACb,CAAC;aACD,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAEhC,6DAA6D;QAC7D,KAAK,GAAG,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAE1C,IAAG,UAAU,EAAE,MAAM,KAAK,SAAS,EAAE;YACnC,8HAA8H;YAC9H,qFAAqF;YACrF,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,KAAe,CAAC;YACtD,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;YAErD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC9C,MAAM,SAAS,GAAG,aAAa,KAAK,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;gBACxE,wFAAwF;gBACxF,OAAO,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;YAClG,CAAC,CAAC,CAAC;SACJ;QAED,MAAM,cAAc,GAAG,aAAa,KAAK,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAClF,sGAAsG;QACtG,KAAK,GAAI,KAAK;aACX,OAAO,CAAC,YAAY,EAAE,cAAc,CAAC;aACrC,OAAO,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QAEzC,IAAI,UAAU,EAAE,KAAK,KAAK,SAAS,IAAI,UAAU,EAAE,KAAK,GAAG,CAAC,EAAE;YAC5D,wFAAwF;YACxF,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;SAC3C;QAED,MAAM,OAAO,GAAG,MAAM,oBAAoB,CACxC,KAAK,CAAC,OAAO,EAAE,EACf,OAAO,EAAE,MAAM,CAChB,CAAC;QAEF,2FAA2F;QAC3F,oEAAoE;QACpE,OAAO,IAAI,CAAC,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAc,EACd,GAAW,EACX,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;SACH;QAED,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAElC,MAAM,oBAAoB,CACxB,IAAI,CAAC,GAAG;aACL,UAAU,CAAC,sBAAsB,CAAC;aAClC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC;aAC5B,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC;aAC7B,OAAO,EAAE,EACZ,OAAO,EAAE,MAAM,CAChB,CAAC;IACJ,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,sBAAsB,CAAC;aAClC,OAAO,EAAE,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,mBAA+B,EAC/B,WAAsC,EACtC,OAA6B;QAE7B,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;QAElC,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC;YACtC,KAAK,EAAI,mBAAmB;YAC5B,KAAK,EAAI,IAAI;YACb,MAAM,EAAG,MAAM;SAChB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,YAAY,CAAC,KAAuB,CAAC;QACrD,kFAAkF;QAClF,mEAAmE;QACnE,qDAAqD;QACrD,IAAI,OAAO,KAAK,SAAS,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,EAAE;YAC7E,OAAe,CAAC,WAAW,GAAG,WAAW,CAAC;SAC5C;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,wBAAwB,CACpC,OAAc,EACd,YAAoB,EACpB,KAAc,EACd,OAA6B;QAE7B,2GAA2G;QAC3G,sHAAsH;QACtH,oIAAoI;QACpI,IAAI,MAAoC,CAAC;QACzC,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,KAAK,EAAE;YACjD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAClC,MAAM,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,WAAW,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,GAAG,EAAE,UAAU,EAAE,WAAW,CAAC,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;SACrE;QAED,+EAA+E;QAC/E,MAAM,QAAQ,GAA8B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;QACtI,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3D,CAAC;IAED;;OAEG;IACK,qBAAqB,CAC3B,WAAyB;QAEzB,IAAG,WAAW,EAAE,WAAW,KAAK,SAAS,EAAG;YAC1C,OAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC;SACzE;aAAM,IAAG,WAAW,EAAE,aAAa,KAAK,SAAS,EAAE;YAClD,OAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,CAAC,aAAa,EAAE,CAAC;SAC7E;aAAM,IAAI,WAAW,EAAE,gBAAgB,KAAK,SAAS,EAAE;YACtD,OAAQ,EAAE,QAAQ,EAAE,kBAAkB,EAAE,SAAS,EAAE,WAAW,CAAC,gBAAgB,EAAE,CAAC;SACnF;aAAM;YACL,OAAQ,EAAE,QAAQ,EAAE,kBAAkB,EAAE,SAAS,EAAE,aAAa,CAAC,SAAS,EAAE,CAAC;SAC9E;IACH,CAAC;CACF"}

package/dist/esm/src/resumable-task-store-sql.js

@@ -0,0 +1,141 @@
+import { executeWithRetryIfDatabaseIsLocked } from './utils/transaction.js';
+import { Kysely } from 'kysely';
+import { Cid } from '@enbox/dwn-sdk-js';
+class ResumableTaskStoreSql {
+    static taskTimeoutInSeconds = 60;
+    #dialect;
+    #db = null;
+    constructor(dialect) {
+        this.#dialect = dialect;
+    }
+    async open() {
+        if (this.#db) {
+            return;
+        }
+        this.#db = new Kysely({ dialect: this.#dialect });
+        // if table already exists, there is no more things todo
+        const tableName = 'resumableTasks';
+        const tableExists = await this.#dialect.hasTable(this.#db, tableName);
+        if (tableExists) {
+            return;
+        }
+        // else create the table and corresponding indexes
+        let table = this.#db.schema
+            .createTable(tableName)
+            .ifNotExists() // kept to show supported by all dialects in contrast to ifNotExists() below, though not needed due to hasTable() check above
+            .addColumn('id', 'varchar(255)', (col) => col.primaryKey())
+            .addColumn('task', 'text')
+            .addColumn('timeout', 'bigint')
+            .addColumn('retryCount', 'integer');
+        await table.execute();
+        await this.#db.schema
+            .createIndex('index_timeout')
+            // .ifNotExists() // intentionally kept commented out code to show that it is not supported by all dialects (ie. MySQL)
+            .on('resumableTasks')
+            .column('timeout')
+            .execute();
+    }
+    async close() {
+        await this.#db?.destroy();
+        this.#db = null;
+    }
+    async register(task, timeoutInSeconds) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `register`.');
+        }
+        const id = await Cid.computeCid(task);
+        const timeout = Date.now() + timeoutInSeconds * 1000;
+        const taskString = JSON.stringify(task);
+        const retryCount = 0;
+        const taskEntryInDatabase = { id, task: taskString, timeout, retryCount };
+        await this.#db.insertInto('resumableTasks').values(taskEntryInDatabase).execute();
+        return {
+            id,
+            task,
+            retryCount,
+            timeout,
+        };
+    }
+    async grab(count) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `grab`.');
+        }
+        const now = Date.now();
+        const newTimeout = now + (ResumableTaskStoreSql.taskTimeoutInSeconds * 1000);
+        let tasks = [];
+        const operation = async (transaction) => {
+            tasks = await transaction
+                .selectFrom('resumableTasks')
+                .selectAll()
+                .where('timeout', '<=', now)
+                .limit(count)
+                .execute();
+            if (tasks.length > 0) {
+                const ids = tasks.map((task) => task.id);
+                await transaction
+                    .updateTable('resumableTasks')
+                    .set({ timeout: newTimeout })
+                    .where((eb) => eb('id', 'in', ids))
+                    .execute();
+            }
+        };
+        await executeWithRetryIfDatabaseIsLocked(this.#db, operation);
+        const tasksToReturn = tasks.map((task) => {
+            return {
+                id: task.id,
+                task: JSON.parse(task.task),
+                retryCount: task.retryCount,
+                timeout: task.timeout,
+            };
+        });
+        return tasksToReturn;
+    }
+    async read(taskId) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `read`.');
+        }
+        const task = await this.#db
+            .selectFrom('resumableTasks')
+            .selectAll()
+            .where('id', '=', taskId)
+            .executeTakeFirst();
+        if (task !== undefined) {
+            // NOTE: special handling ONLY for PostgreSQL:
+            // Even though PostgreSQL stores `bigint` as a 64 bit number, the `pg` library we depend on returns it as a string, hence the conversion.
+            if (typeof task.timeout !== 'number') {
+                task.timeout = parseInt(task.timeout, 10);
+            }
+        }
+        return task;
+    }
+    async extend(taskId, timeoutInSeconds) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `extend`.');
+        }
+        const timeout = Date.now() + (timeoutInSeconds * 1000);
+        await this.#db
+            .updateTable('resumableTasks')
+            .set({ timeout })
+            .where('id', '=', taskId)
+            .execute();
+    }
+    async delete(taskId) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `delete`.');
+        }
+        await this.#db
+            .deleteFrom('resumableTasks')
+            .where('id', '=', taskId)
+            .execute();
+    }
+    async clear() {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `clear`.');
+        }
+        await this.#db
+            .deleteFrom('resumableTasks')
+            .execute();
+    }
+}
+export { ResumableTaskStoreSql };
+//# sourceMappingURL=resumable-task-store-sql.js.map

package/dist/esm/src/resumable-task-store-sql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resumable-task-store-sql.js","sourceRoot":"","sources":["../../../src/resumable-task-store-sql.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kCAAkC,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,GAAG,EAA4C,MAAM,mBAAmB,CAAC;AAElF,MAAa,qBAAqB;IACxB,MAAM,CAAU,oBAAoB,GAAG,EAAE,CAAC;IAElD,QAAQ,CAAU;IAClB,GAAG,GAAmC,IAAI,CAAC;IAE3C,YAAY,OAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,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;QAEnE,wDAAwD;QACxD,MAAM,SAAS,GAAG,gBAAgB,CAAC;QACnC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACtE,IAAI,WAAW,EAAE;YACf,OAAO;SACR;QAED,kDAAkD;QAElD,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM;aACxB,WAAW,CAAC,SAAS,CAAC;aACtB,WAAW,EAAE,CAAC,6HAA6H;aAC3I,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;aAC1D,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;aACzB,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC;aAC9B,SAAS,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAEtC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;QAEtB,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM;aAClB,WAAW,CAAC,eAAe,CAAC;YAC7B,uHAAuH;aACtH,EAAE,CAAC,gBAAgB,CAAC;aACpB,MAAM,CAAC,SAAS,CAAC;aACjB,OAAO,EAAE,CAAC;IACf,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,QAAQ,CAAC,IAAS,EAAE,gBAAwB;QAChD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC1F;QAED,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB,GAAG,IAAI,CAAC;QACrD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,UAAU,GAAG,CAAC,CAAC;QACrB,MAAM,mBAAmB,GAAyB,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QAChG,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,OAAO,EAAE,CAAC;QAElF,OAAO;YACL,EAAE;YACF,IAAI;YACJ,UAAU;YACV,OAAO;SACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAa;QACtB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACtF;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,UAAU,GAAG,GAAG,GAAG,CAAC,qBAAqB,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;QAE7E,IAAI,KAAK,GAAwC,EAAE,CAAC;QAEpD,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,EAAE,EAAE;YACtC,KAAK,GAAG,MAAM,WAAW;iBACtB,UAAU,CAAC,gBAAgB,CAAC;iBAC5B,SAAS,EAAE;iBACX,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC;iBAC3B,KAAK,CAAC,KAAK,CAAC;iBACZ,OAAO,EAAE,CAAC;YAEb,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACzC,MAAM,WAAW;qBACd,WAAW,CAAC,gBAAgB,CAAC;qBAC7B,GAAG,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;qBAC5B,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;qBAClC,OAAO,EAAE,CAAC;aACd;QACH,CAAC,CAAC;QAEF,MAAM,kCAAkC,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAE9D,MAAM,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,OAAO;gBACL,EAAE,EAAW,IAAI,CAAC,EAAE;gBACpB,IAAI,EAAS,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;gBAClC,UAAU,EAAG,IAAI,CAAC,UAAU;gBAC5B,OAAO,EAAM,IAAI,CAAC,OAAO;aAC1B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAAc;QACvB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACtF;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG;aACxB,UAAU,CAAC,gBAAgB,CAAC;aAC5B,SAAS,EAAE;aACX,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC;aACxB,gBAAgB,EAAE,CAAC;QAEtB,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,8CAA8C;YAC9C,yIAAyI;YACzI,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACpC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;aAC3C;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,gBAAwB;QACnD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;QAEvD,MAAM,IAAI,CAAC,GAAG;aACX,WAAW,CAAC,gBAAgB,CAAC;aAC7B,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;aAChB,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC;aACxB,OAAO,EAAE,CAAC;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAc;QACzB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QAED,MAAM,IAAI,CAAC,GAAG;aACX,UAAU,CAAC,gBAAgB,CAAC;aAC5B,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC;aACxB,OAAO,EAAE,CAAC;IACf,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;SACvF;QAED,MAAM,IAAI,CAAC,GAAG;aACX,UAAU,CAAC,gBAAgB,CAAC;aAC5B,OAAO,EAAE,CAAC;IACf,CAAC;;SAtKU,qBAAqB"}

package/dist/esm/src/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/src/types.js.map

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

package/dist/esm/src/utils/filter.js

@@ -0,0 +1,125 @@
+import { DynamicModule } from 'kysely';
+import { sanitizeFiltersAndSeparateTags, sanitizedValue } from './sanitize.js';
+/**
+ * Takes multiple Filters and returns a single query.
+ * Each filter is evaluated as an OR operation.
+ *
+ * @param filters Array of filters to be evaluated as OR operations
+ * @param query the incoming QueryBuilder.
+ * @returns The modified QueryBuilder respecting the provided filters.
+ */
+export function filterSelectQuery(filters, query) {
+    const sanitizedFilters = sanitizeFiltersAndSeparateTags(filters);
+    return query.where((eb) => 
+    // evaluate the filters as an OR expression.
+    eb.or(sanitizedFilters.map(({ filter, tags }) => {
+        // evaluate each filter + tags tuple as an AND expression.
+        const andOperands = [];
+        processFilter(eb, andOperands, filter);
+        processTags(eb, andOperands, tags);
+        return eb.and(andOperands);
+    })));
+}
+/**
+ * Processes each property in the non-tags filter as an AND operand and adds it to the `andOperands` array.
+ * If a property has an array of values it will treat it as a OneOf (IN) within the overall AND query.
+ *
+ * @param eb The ExpressionBuilder from the query.
+ * @param andOperands The array of AND operands to append to.
+ * @param filter The filter to be evaluated.
+ */
+function processFilter(eb, andOperands, filter) {
+    for (let property in filter) {
+        const value = filter[property];
+        const column = new DynamicModule().ref(property);
+        if (Array.isArray(value)) { // OneOfFilter
+            andOperands.push(eb(column, 'in', value));
+        }
+        else if (typeof value === 'object') { // RangeFilter
+            if (value.gt) {
+                andOperands.push(eb(column, '>', sanitizedValue(value.gt)));
+            }
+            if (value.gte) {
+                andOperands.push(eb(column, '>=', sanitizedValue(value.gte)));
+            }
+            if (value.lt) {
+                andOperands.push(eb(column, '<', sanitizedValue(value.lt)));
+            }
+            if (value.lte) {
+                andOperands.push(eb(column, '<=', sanitizedValue(value.lte)));
+            }
+        }
+        else { // EqualFilter
+            andOperands.push(eb(column, '=', sanitizedValue(value)));
+        }
+    }
+}
+/**
+ * Processes each property in the tags filter as an AND operand and adds it to the `andOperands` array.
+ * If a property has an array of values it will treat it as a OneOf (IN) within the overall AND query.
+ *
+ * @param eb The ExpressionBuilder from the query.
+ * @param andOperands The array of AND operands to append to.
+ * @param tag The tags filter to be evaluated.
+ */
+function processTags(eb, andOperands, tags) {
+    const tagColumn = new DynamicModule().ref('tag');
+    const valueNumber = new DynamicModule().ref('valueNumber');
+    const valueString = new DynamicModule().ref('valueString');
+    // process each tag and add it to the andOperands from the rest of the filters
+    for (let property in tags) {
+        andOperands.push(eb(tagColumn, '=', property));
+        const value = tags[property];
+        if (Array.isArray(value)) { // OneOfFilter
+            if (value.some(val => typeof val === 'number')) {
+                andOperands.push(eb(valueNumber, 'in', value));
+            }
+            else {
+                andOperands.push(eb(valueString, 'in', value.map(v => String(v))));
+            }
+        }
+        else if (typeof value === 'object') { // RangeFilter
+            if (value.gt) {
+                if (typeof value.gt === 'number') {
+                    andOperands.push(eb(valueNumber, '>', value.gt));
+                }
+                else {
+                    andOperands.push(eb(valueString, '>', String(value.gt)));
+                }
+            }
+            if (value.gte) {
+                if (typeof value.gte === 'number') {
+                    andOperands.push(eb(valueNumber, '>=', value.gte));
+                }
+                else {
+                    andOperands.push(eb(valueString, '>=', String(value.gte)));
+                }
+            }
+            if (value.lt) {
+                if (typeof value.lt === 'number') {
+                    andOperands.push(eb(valueNumber, '<', value.lt));
+                }
+                else {
+                    andOperands.push(eb(valueString, '<', String(value.lt)));
+                }
+            }
+            if (value.lte) {
+                if (typeof value.lte === 'number') {
+                    andOperands.push(eb(valueNumber, '<=', value.lte));
+                }
+                else {
+                    andOperands.push(eb(valueString, '<=', String(value.lte)));
+                }
+            }
+        }
+        else { // EqualFilter
+            if (typeof value === 'number') {
+                andOperands.push(eb(valueNumber, '=', value));
+            }
+            else {
+                andOperands.push(eb(valueString, '=', String(value)));
+            }
+        }
+    }
+}
+//# sourceMappingURL=filter.js.map

package/dist/esm/src/utils/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../../src/utils/filter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAqE,MAAM,QAAQ,CAAC;AAC1G,OAAO,EAAE,8BAA8B,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/E;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiB,EACjB,KAAoC;IAEpC,MAAM,gBAAgB,GAAG,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAEjE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE;IACxB,4CAA4C;IAC5C,EAAE,CAAC,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;QAC9C,0DAA0D;QAC1D,MAAM,WAAW,GAAiC,EAAE,CAAC;QAErD,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QACvC,WAAW,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QAEnC,OAAO,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC,CACJ,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,aAAa,CACpB,EAA6B,EAC7B,WAAyC,EACzC,MAAc;IAEd,KAAK,IAAI,QAAQ,IAAI,MAAM,EAAE;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,cAAc;YACxC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;SAC3C;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,EAAE,cAAc;YACpD,IAAI,KAAK,CAAC,EAAE,EAAE;gBACZ,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aAC7D;YACD,IAAI,KAAK,CAAC,GAAG,EAAE;gBACb,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAC/D;YACD,IAAI,KAAK,CAAC,EAAE,EAAE;gBACZ,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aAC7D;YACD,IAAI,KAAK,CAAC,GAAG,EAAE;gBACb,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAC/D;SACF;aAAM,EAAE,cAAc;YACrB,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1D;KACF;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,EAA6B,EAC7B,WAAyC,EACzC,IAAY;IAGZ,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC3D,MAAM,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAE3D,8EAA8E;IAC9E,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE;QACzB,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,cAAc;YACxC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,EAAE;gBAC9C,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aAChD;iBAAM;gBACL,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACpE;SACF;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,EAAE,cAAc;YACpD,IAAI,KAAK,CAAC,EAAE,EAAE;gBACZ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;oBAChC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;iBAClD;qBAAM;oBACL,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;iBAC1D;aACF;YACD,IAAI,KAAK,CAAC,GAAG,EAAE;gBACb,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,EAAE;oBACjC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;iBACpD;qBAAM;oBACL,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBAC5D;aACF;YACD,IAAI,KAAK,CAAC,EAAE,EAAE;gBACZ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;oBAChC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;iBAClD;qBAAM;oBACL,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;iBAC1D;aACF;YACD,IAAI,KAAK,CAAC,GAAG,EAAE;gBACb,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,EAAE;oBACjC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;iBACpD;qBAAM;oBACL,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBAC5D;aACF;SACF;aAAM,EAAE,cAAc;YACrB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;aAC/C;iBAAM;gBACL,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACvD;SACF;KACF;AACH,CAAC"}