@enbox/dwn-sql-store 0.0.1

package/dist/cjs/package.json

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

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

@@ -0,0 +1,103 @@
+import { DataStream } from '@enbox/dwn-sdk-js';
+import { Kysely } from 'kysely';
+import { Readable } from 'readable-stream';
+export class DataStoreSql {
+    #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 = 'dataStore';
+        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('tenant', 'varchar(255)', (col) => col.notNull())
+            .addColumn('recordId', 'varchar(60)', (col) => col.notNull())
+            .addColumn('dataCid', 'varchar(60)', (col) => col.notNull());
+        // Add columns that have dialect-specific constraints
+        table = this.#dialect.addAutoIncrementingColumn(table, 'id', (col) => col.primaryKey());
+        table = this.#dialect.addBlobColumn(table, 'data', (col) => col.notNull());
+        await table.execute();
+        // Add index for efficient lookups.
+        await this.#db.schema
+            .createIndex('tenant_recordId_dataCid')
+            // .ifNotExists() // intentionally kept commented out code to show that it is not supported by all dialects (ie. MySQL)
+            .on(tableName)
+            .columns(['tenant', 'recordId', 'dataCid'])
+            .unique()
+            .execute();
+    }
+    async close() {
+        await this.#db?.destroy();
+        this.#db = null;
+    }
+    async get(tenant, recordId, dataCid) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `get`.');
+        }
+        const result = await this.#db
+            .selectFrom('dataStore')
+            .selectAll()
+            .where('tenant', '=', tenant)
+            .where('recordId', '=', recordId)
+            .where('dataCid', '=', dataCid)
+            .executeTakeFirst();
+        if (!result) {
+            return undefined;
+        }
+        return {
+            dataSize: result.data.length,
+            dataStream: new Readable({
+                read() {
+                    this.push(Buffer.from(result.data));
+                    this.push(null);
+                }
+            }),
+        };
+    }
+    async put(tenant, recordId, dataCid, dataStream) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `put`.');
+        }
+        const bytes = await DataStream.toBytes(dataStream);
+        const data = Buffer.from(bytes);
+        await this.#db
+            .insertInto('dataStore')
+            .values({ tenant, recordId, dataCid, data })
+            .executeTakeFirstOrThrow();
+        return {
+            dataSize: bytes.length
+        };
+    }
+    async delete(tenant, recordId, dataCid) {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `delete`.');
+        }
+        await this.#db
+            .deleteFrom('dataStore')
+            .where('tenant', '=', tenant)
+            .where('recordId', '=', recordId)
+            .where('dataCid', '=', dataCid)
+            .execute();
+    }
+    async clear() {
+        if (!this.#db) {
+            throw new Error('Connection to database not open. Call `open` before using `clear`.');
+        }
+        await this.#db
+            .deleteFrom('dataStore')
+            .execute();
+    }
+}
+//# sourceMappingURL=data-store-sql.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data-store-sql.js","sourceRoot":"","sources":["../../../src/data-store-sql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAA0C,MAAM,mBAAmB,CAAC;AAClG,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI3C,MAAM,OAAO,YAAY;IACvB,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,WAAW,CAAC;QAC9B,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,CAAA,6HAA6H;aAC1I,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aAC3D,SAAS,CAAC,UAAU,EAAE,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aAC5D,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAE/D,qDAAqD;QACrD,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACxF,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3E,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;QAEtB,mCAAmC;QACnC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM;aAClB,WAAW,CAAC,yBAAyB,CAAC;YACvC,uHAAuH;aACtH,EAAE,CAAC,SAAS,CAAC;aACb,OAAO,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;aAC1C,MAAM,EAAE;aACR,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,GAAG,CACP,MAAc,EACd,QAAgB,EAChB,OAAe;QAEf,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG;aAC1B,UAAU,CAAC,WAAW,CAAC;aACvB,SAAS,EAAE;aACX,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC;aAC5B,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC;aAChC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC;aAC9B,gBAAgB,EAAE,CAAC;QAEtB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QAED,OAAO;YACL,QAAQ,EAAK,MAAM,CAAC,IAAI,CAAC,MAAM;YAC/B,UAAU,EAAG,IAAI,QAAQ,CAAC;gBACxB,IAAI;oBACF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBACpC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,CAAC;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CACP,MAAc,EACd,QAAgB,EAChB,OAAe,EACf,UAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;QAED,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEhC,MAAM,IAAI,CAAC,GAAG;aACX,UAAU,CAAC,WAAW,CAAC;aACvB,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;aAC3C,uBAAuB,EAAE,CAAC;QAE7B,OAAO;YACL,QAAQ,EAAE,KAAK,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAAc,EACd,QAAgB,EAChB,OAAe;QAEf,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;SACH;QAED,MAAM,IAAI,CAAC,GAAG;aACX,UAAU,CAAC,WAAW,CAAC;aACvB,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC;aAC5B,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,QAAQ,CAAC;aAChC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC;aAC9B,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,WAAW,CAAC;aACvB,OAAO,EAAE,CAAC;IACf,CAAC;CAEF"}

package/dist/esm/src/dialect/dialect.js

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

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

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

package/dist/esm/src/dialect/mysql-dialect.js

@@ -0,0 +1,40 @@
+import { MysqlDialect as KyselyMysqlDialect, } from 'kysely';
+export class MysqlDialect extends KyselyMysqlDialect {
+    name = 'MySQL';
+    isStreamingSupported = true;
+    async hasTable(db, tableName) {
+        const result = await db
+            .selectFrom('information_schema.tables')
+            .select('table_name')
+            .where('table_name', '=', tableName)
+            .execute();
+        return result.length > 0;
+    }
+    addAutoIncrementingColumn(builder, columnName, callback) {
+        return builder.addColumn(columnName, 'integer', (col) => {
+            col = col.autoIncrement();
+            if (callback) {
+                col = callback(col);
+            }
+            return col;
+        });
+    }
+    addBlobColumn(builder, columnName, callback) {
+        return builder.addColumn(columnName, 'blob', callback);
+    }
+    /**
+     * In MySQL, the ForeignKey name it creates in `mysql` will be in the following format:
+     * `${referenceTable}_${referenceColumnName}__${tableName}_${columnName}`
+     * ex: if the reference table is `users` and the reference column is `id` and the table is `profiles` and the column is `userId`,
+     * the resulting name for the foreign key is: `users_id__profiles_userId`
+     */
+    addReferencedColumn(builder, tableName, columnName, columnType, referenceTable, referenceColumnName, onDeleteAction) {
+        return builder
+            .addColumn(columnName, columnType, (col) => col.notNull())
+            .addForeignKeyConstraint(`${referenceTable}_${referenceColumnName}__${tableName}_${columnName}`, [columnName], referenceTable, [referenceColumnName], (constraint) => constraint.onDelete(onDeleteAction));
+    }
+    insertThenReturnId(db, table, values, _returning) {
+        return db.insertInto(table).values(values);
+    }
+}
+//# sourceMappingURL=mysql-dialect.js.map

package/dist/esm/src/dialect/mysql-dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mysql-dialect.js","sourceRoot":"","sources":["../../../../src/dialect/mysql-dialect.ts"],"names":[],"mappings":"AACA,OAAO,EAUL,YAAY,IAAI,kBAAkB,GAEnC,MAAM,QAAQ,CAAC;AAEhB,MAAM,OAAO,YAAa,SAAQ,kBAAkB;IAClD,IAAI,GAAG,OAAO,CAAC;IACf,oBAAoB,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,QAAQ,CAAC,EAAe,EAAE,SAAiB;QAC/C,MAAM,MAAM,GAAG,MAAM,EAAE;aACpB,UAAU,CAAC,2BAA2B,CAAC;aACvC,MAAM,CAAC,YAAY,CAAC;aACpB,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,SAAS,CAAC;aACnC,OAAO,EAAE,CAAC;QAEb,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,yBAAyB,CACvB,OAA+B,EAC/B,UAAkB,EAClB,QAAgC;QAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YACtD,GAAG,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;YAC1B,IAAI,QAAQ,EAAE;gBACZ,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;aACrB;YACD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CACX,OAA+B,EAC/B,UAAkB,EAClB,QAAgC;QAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CACjB,OAAwC,EACxC,SAAa,EACb,UAAkB,EAClB,UAA0B,EAC1B,cAAsB,EACtB,mBAA2B,EAC3B,cAAiF;QAEjF,OAAO,OAAO;aACX,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;aACzD,uBAAuB,CACtB,GAAG,cAAc,IAAI,mBAAmB,KAAK,SAAS,IAAI,UAAU,EAAE,EACtE,CAAC,UAAU,CAAC,EACZ,cAAc,EACd,CAAC,mBAAmB,CAAC,EACrB,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CACpD,CAAC;IACN,CAAC;IAED,kBAAkB,CAChB,EAAgC,EAChC,KAAkB,EAClB,MAAqC,EACrC,UAAwC;QAExC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/esm/src/dialect/postgres-dialect.js

@@ -0,0 +1,26 @@
+import { PostgresDialect as KyselyPostgresDialect, } from 'kysely';
+export class PostgresDialect extends KyselyPostgresDialect {
+    name = 'PostgreSQL';
+    isStreamingSupported = true;
+    async hasTable(db, tableName) {
+        const result = await db
+            .selectFrom('information_schema.tables')
+            .select('table_name')
+            .where('table_name', '=', tableName)
+            .execute();
+        return result.length > 0;
+    }
+    addAutoIncrementingColumn(builder, columnName, callback) {
+        return builder.addColumn(columnName, 'serial', callback);
+    }
+    addBlobColumn(builder, columnName, callback) {
+        return builder.addColumn(columnName, 'bytea', callback);
+    }
+    addReferencedColumn(builder, _tableName, columnName, columnType, referenceTable, referenceColumnName, onDeleteAction) {
+        return builder.addColumn(columnName, columnType, (col) => col.notNull().references(`${referenceTable}.${referenceColumnName}`).onDelete(onDeleteAction));
+    }
+    insertThenReturnId(db, table, values, returning) {
+        return db.insertInto(table).values(values).returning(returning);
+    }
+}
+//# sourceMappingURL=postgres-dialect.js.map

package/dist/esm/src/dialect/postgres-dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres-dialect.js","sourceRoot":"","sources":["../../../../src/dialect/postgres-dialect.ts"],"names":[],"mappings":"AACA,OAAO,EAOL,eAAe,IAAI,qBAAqB,GAIzC,MAAM,QAAQ,CAAC;AAEhB,MAAM,OAAO,eAAgB,SAAQ,qBAAqB;IACxD,IAAI,GAAG,YAAY,CAAC;IACpB,oBAAoB,GAAG,IAAI,CAAC;IAE5B,KAAK,CAAC,QAAQ,CAAC,EAAe,EAAE,SAAiB;QAC/C,MAAM,MAAM,GAAG,MAAM,EAAE;aACpB,UAAU,CAAC,2BAA2B,CAAC;aACvC,MAAM,CAAC,YAAY,CAAC;aACpB,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,SAAS,CAAC;aACnC,OAAO,EAAE,CAAC;QAEb,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,yBAAyB,CACvB,OAA+B,EAC/B,UAAkB,EAClB,QAAgC;QAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED,aAAa,CACX,OAA+B,EAC/B,UAAkB,EAClB,QAAgC;QAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,mBAAmB,CACjB,OAAwC,EACxC,UAAc,EACd,UAAkB,EAClB,UAA0B,EAC1B,cAAsB,EACtB,mBAA2B,EAC3B,cAAiF;QAEjF,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,cAAc,IAAI,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;IAC3J,CAAC;IAED,kBAAkB,CAChB,EAAgC,EAChC,KAAkB,EAClB,MAAqC,EACrC,SAAuC;QAEvC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;CAEF"}

package/dist/esm/src/dialect/sqlite-dialect.js

@@ -0,0 +1,33 @@
+import { SqliteDialect as KyselySqliteDialect, } from 'kysely';
+export class SqliteDialect extends KyselySqliteDialect {
+    name = 'SQLite';
+    isStreamingSupported = false;
+    async hasTable(db, tableName) {
+        const result = await db
+            .selectFrom('sqlite_master')
+            .select('name')
+            .where('type', '=', 'table')
+            .where('name', '=', tableName)
+            .execute();
+        return result.length > 0;
+    }
+    addAutoIncrementingColumn(builder, columnName, callback) {
+        return builder.addColumn(columnName, 'integer', (col) => {
+            col = col.autoIncrement();
+            if (callback) {
+                col = callback(col);
+            }
+            return col;
+        });
+    }
+    addBlobColumn(builder, columnName, callback) {
+        return builder.addColumn(columnName, 'blob', callback);
+    }
+    addReferencedColumn(builder, _tableName, columnName, columnType, referenceTable, referenceColumnName, onDeleteAction) {
+        return builder.addColumn(columnName, columnType, (col) => col.notNull().references(`${referenceTable}.${referenceColumnName}`).onDelete(onDeleteAction));
+    }
+    insertThenReturnId(db, table, values, returning) {
+        return db.insertInto(table).values(values).returning(returning);
+    }
+}
+//# sourceMappingURL=sqlite-dialect.js.map

package/dist/esm/src/dialect/sqlite-dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite-dialect.js","sourceRoot":"","sources":["../../../../src/dialect/sqlite-dialect.ts"],"names":[],"mappings":"AACA,OAAO,EASL,aAAa,IAAI,mBAAmB,GAErC,MAAM,QAAQ,CAAC;AAEhB,MAAM,OAAO,aAAc,SAAQ,mBAAmB;IACpD,IAAI,GAAG,QAAQ,CAAC;IAChB,oBAAoB,GAAG,KAAK,CAAC;IAE7B,KAAK,CAAC,QAAQ,CAAC,EAAe,EAAE,SAAiB;QAC/C,MAAM,MAAM,GAAG,MAAM,EAAE;aACpB,UAAU,CAAC,eAAe,CAAC;aAC3B,MAAM,CAAC,MAAM,CAAC;aACd,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;aAC3B,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,CAAC;aAC7B,OAAO,EAAE,CAAC;QAEb,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,yBAAyB,CACvB,OAA+B,EAC/B,UAAkB,EAClB,QAAgC;QAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YACtD,GAAG,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC;YAC1B,IAAI,QAAQ,EAAE;gBACZ,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;aACrB;YACD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CACX,OAA+B,EAC/B,UAAkB,EAClB,QAAgC;QAEhC,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,mBAAmB,CACjB,OAAwC,EACxC,UAAc,EACd,UAAkB,EAClB,UAA0B,EAC1B,cAAsB,EACtB,mBAA2B,EAC3B,cAAiF;QAEjF,OAAO,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,cAAc,IAAI,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;IAC3J,CAAC;IAED,kBAAkB,CAChB,EAAgC,EAChC,KAAkB,EAClB,MAAqC,EACrC,SAAuC;QAEvC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;CACF"}

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

@@ -0,0 +1,169 @@
+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

@@ -0,0 +1 @@
+{"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/esm/src/main.js

@@ -0,0 +1,9 @@
+export * from './dialect/dialect.js';
+export * from './dialect/mysql-dialect.js';
+export * from './dialect/postgres-dialect.js';
+export * from './dialect/sqlite-dialect.js';
+export * from './data-store-sql.js';
+export * from './event-log-sql.js';
+export * from './message-store-sql.js';
+export * from './resumable-task-store-sql.js';
+//# sourceMappingURL=main.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC"}