@xyo-network/archivist-indexeddb 2.87.2 → 2.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/Archivist.d.cts +14 -2
- package/dist/browser/Archivist.d.cts.map +1 -1
- package/dist/browser/Archivist.d.mts +14 -2
- package/dist/browser/Archivist.d.mts.map +1 -1
- package/dist/browser/Archivist.d.ts +14 -2
- package/dist/browser/Archivist.d.ts.map +1 -1
- package/dist/browser/index.cjs +88 -45
- package/dist/browser/index.cjs.map +1 -1
- package/dist/browser/index.js +88 -45
- package/dist/browser/index.js.map +1 -1
- package/dist/node/Archivist.d.cts +14 -2
- package/dist/node/Archivist.d.cts.map +1 -1
- package/dist/node/Archivist.d.mts +14 -2
- package/dist/node/Archivist.d.mts.map +1 -1
- package/dist/node/Archivist.d.ts +14 -2
- package/dist/node/Archivist.d.ts.map +1 -1
- package/dist/node/index.cjs +88 -45
- package/dist/node/index.cjs.map +1 -1
- package/dist/node/index.js +88 -45
- package/dist/node/index.js.map +1 -1
- package/package.json +10 -10
- package/src/Archivist.ts +113 -45
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n buildStandardIndexName,\n IndexDescription,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { IDBPDatabase, openDB } from 'idb'\n\nimport { IndexedDbArchivistConfigSchema } from './Config'\nimport { IndexedDbArchivistParams } from './Params'\n\nexport interface PayloadStore {\n [s: string]: Payload\n}\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static readonly defaultDbName = 'archivist'\n static readonly defaultDbVersion = 1\n static readonly defaultStoreName = 'payloads'\n private static readonly hashIndex: IndexDescription = { key: { _hash: 1 }, multiEntry: false, unique: true }\n private static readonly schemaIndex: IndexDescription = { key: { schema: 1 }, multiEntry: false, unique: false }\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly hashIndexName = buildStandardIndexName(IndexedDbArchivist.hashIndex)\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly schemaIndexName = buildStandardIndexName(IndexedDbArchivist.schemaIndex)\n\n private _db: IDBPDatabase<PayloadStore> | undefined\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n /**\n * The database version. If not supplied via config, it defaults to 1.\n */\n get dbVersion() {\n return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`.\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n private get db(): IDBPDatabase<PayloadStore> {\n return assertEx(this._db, 'DB not initialized')\n }\n\n private get indexes() {\n return this.config?.storage?.indexes ?? []\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n // Get all payloads from the store\n const payloads = await this.db.getAll(this.storeName)\n // Remove any metadata before returning to the client\n return payloads.map((payload) => PayloadHasher.jsonPayload(payload))\n }\n\n protected override async clearHandler(): Promise<void> {\n await this.db.clear(this.storeName)\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n const distinctHashes = [...new Set(hashes)]\n const found = await Promise.all(\n distinctHashes.map(async (hash) => {\n let existing: IDBValidKey | undefined\n do {\n existing = await this.db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)\n if (existing) await this.db.delete(this.storeName, existing)\n } while (!existing)\n return hash\n }),\n )\n // Return hashes removed\n return found.filter(exists)\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n const payloads = await Promise.all(hashes.map((hash) => this.db.getFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)))\n return payloads.filter(exists)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const pairs = await PayloadHasher.hashPairs(payloads)\n // Only return the payloads that were successfully inserted\n const inserted = await Promise.all(\n pairs.map(async ([payload, _hash]) => {\n const tx = this.db.transaction(this.storeName, 'readwrite')\n try {\n const store = tx.objectStore(this.storeName)\n const existing = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n if (!existing) {\n await store.put({ ...payload, _hash })\n return payload\n }\n } finally {\n await tx.done\n }\n }),\n )\n return inserted.filter(exists)\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n const { dbName, dbVersion, indexes, storeName } = this\n this._db = await openDB<PayloadStore>(dbName, dbVersion, {\n async upgrade(database) {\n await Promise.resolve() // Async to match spec\n // Create the store\n const store = database.createObjectStore(storeName, {\n // If it isn't explicitly set, create a value by auto incrementing.\n autoIncrement: true,\n })\n // Name the store\n store.name = storeName\n // Create an index on the hash\n const indexesToCreate = [IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...indexes]\n for (const { key, multiEntry, unique } of indexesToCreate) {\n const indexKeys = Object.keys(key)\n const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys\n const indexName = buildStandardIndexName({ key, unique })\n store.createIndex(indexName, keys, { multiEntry, unique })\n }\n },\n })\n return true\n }\n}\n","export type IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\nexport const IndexedDbArchivistSchema: IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\n","import { ArchivistConfig, IndexDescription } from '@xyo-network/archivist-model'\n\nimport { IndexedDbArchivistSchema } from './Schema'\n\nexport type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n /**\n * The version of the DB, defaults to 1\n */\n dbVersion?: number\n schema: IndexedDbArchivistConfigSchema\n /**\n * The storage configuration\n * // TODO: Hoist to main archivist config\n */\n storage?: {\n /**\n * The indexes to create on the object store\n */\n indexes?: IndexDescription[]\n }\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,cAAc;AACvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,8BAEK;AACP,SAASC,qBAAqB;AAC9B,SAASC,uBAAuB;AAEhC,SAAuBC,cAAc;;;ACd9B,IAAMC,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,qBAAN,MAAMA,4BAGHC,kBAAAA;SAAAA;;;EACR,OAAgBC,gBAAgB;IAACC;;EACjC,OAAgBC,gBAAgB;EAChC,OAAgBC,mBAAmB;EACnC,OAAgBC,mBAAmB;EACnC,OAAwBC,YAA8B;IAAEC,KAAK;MAAEC,OAAO;IAAE;IAAGC,YAAY;IAAOC,QAAQ;EAAK;EAC3G,OAAwBC,cAAgC;IAAEJ,KAAK;MAAEK,QAAQ;IAAE;IAAGH,YAAY;IAAOC,QAAQ;EAAM;;EAE/G,OAAgBG,gBAAgBC,uBAAuBf,oBAAmBO,SAAS;;EAEnF,OAAgBS,kBAAkBD,uBAAuBf,oBAAmBY,WAAW;EAE/EK;;;;;;;;EASR,IAAIC,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQpB,oBAAmBI;EACxE;;;;EAKA,IAAIiB,YAAY;AACd,WAAO,KAAKF,QAAQE,aAAarB,oBAAmBK;EACtD;EAEA,IAAaiB,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;AACd,WAAO,KAAKR,QAAQQ,aAAa3B,oBAAmBM;EACtD;EAEA,IAAYsB,KAAiC;AAC3C,WAAOC,SAAS,KAAKZ,KAAK,oBAAA;EAC5B;EAEA,IAAYa,UAAU;AACpB,WAAO,KAAKX,QAAQY,SAASD,WAAW,CAAA;EAC1C;EAEA,MAAyBE,aAAiC;AAExD,UAAMC,WAAW,MAAM,KAAKL,GAAGM,OAAO,KAAKP,SAAS;AAEpD,WAAOM,SAASE,IAAI,CAACC,YAAYC,cAAcC,YAAYF,OAAAA,CAAAA;EAC7D;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKX,GAAGY,MAAM,KAAKb,SAAS;EACpC;EAEA,MAAyBc,cAAcC,QAAqC;AAC1E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIF,MAAAA;;AACnC,UAAMG,QAAQ,MAAMC,QAAQC,IAC1BJ,eAAeR,IAAI,OAAOa,SAAAA;AACxB,UAAIC;AACJ,SAAG;AACDA,mBAAW,MAAM,KAAKrB,GAAGsB,gBAAgB,KAAKvB,WAAW3B,oBAAmBc,eAAekC,IAAAA;AAC3F,YAAIC;AAAU,gBAAM,KAAKrB,GAAGuB,OAAO,KAAKxB,WAAWsB,QAAAA;MACrD,SAAS,CAACA;AACV,aAAOD;IACT,CAAA,CAAA;AAGF,WAAOH,MAAMO,OAAOC,MAAAA;EACtB;EAEA,MAAyBC,WAAWZ,QAAsC;AACxE,UAAMT,WAAW,MAAMa,QAAQC,IAAIL,OAAOP,IAAI,CAACa,SAAS,KAAKpB,GAAG2B,aAAa,KAAK5B,WAAW3B,oBAAmBc,eAAekC,IAAAA,CAAAA,CAAAA;AAC/H,WAAOf,SAASmB,OAAOC,MAAAA;EACzB;EAEA,MAAyBG,cAAcvB,UAAyC;AAC9E,UAAMwB,QAAQ,MAAMpB,cAAcqB,UAAUzB,QAAAA;AAE5C,UAAM0B,WAAW,MAAMb,QAAQC,IAC7BU,MAAMtB,IAAI,OAAO,CAACC,SAAS3B,KAAAA,MAAM;AAC/B,YAAMmD,KAAK,KAAKhC,GAAGiC,YAAY,KAAKlC,WAAW,WAAA;AAC/C,UAAI;AACF,cAAMmC,QAAQF,GAAGG,YAAY,KAAKpC,SAAS;AAC3C,cAAMsB,WAAW,MAAMa,MAAME,MAAMhE,oBAAmBc,aAAa,EAAEmD,IAAIxD,KAAAA;AACzE,YAAI,CAACwC,UAAU;AACb,gBAAMa,MAAMI,IAAI;YAAE,GAAG9B;YAAS3B;UAAM,CAAA;AACpC,iBAAO2B;QACT;MACF,UAAA;AACE,cAAMwB,GAAGO;MACX;IACF,CAAA,CAAA;AAEF,WAAOR,SAASP,OAAOC,MAAAA;EACzB;EAEA,MAAyBe,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,EAAElD,QAAQG,WAAWS,SAASH,UAAS,IAAK;AAClD,SAAKV,MAAM,MAAMoD,OAAqBnD,QAAQG,WAAW;MACvD,MAAMiD,QAAQC,UAAQ;AACpB,cAAMzB,QAAQ0B,QAAO;AAErB,cAAMV,QAAQS,SAASE,kBAAkB9C,WAAW;;UAElD+C,eAAe;QACjB,CAAA;AAEAZ,cAAM1C,OAAOO;AAEb,cAAMgD,kBAAkB;UAAC3E,oBAAmBO;UAAWP,oBAAmBY;aAAgBkB;;AAC1F,mBAAW,EAAEtB,KAAKE,YAAYC,OAAM,KAAMgE,iBAAiB;AACzD,gBAAMC,YAAYC,OAAOC,KAAKtE,GAAAA;AAC9B,gBAAMsE,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMI,YAAYjE,uBAAuB;YAAEP;YAAKG;UAAO,CAAA;AACvDmD,gBAAMmB,YAAYD,WAAWF,MAAM;YAAEpE;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAO;EACT;AACF;AAvIaX,qBAAAA,aAAAA;EADZkF,gBAAAA;GACYlF,kBAAAA;","names":["assertEx","exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","buildStandardIndexName","PayloadHasher","creatableModule","openDB","IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","IndexedDbArchivistConfigSchema","defaultDbName","defaultDbVersion","defaultStoreName","hashIndex","key","_hash","multiEntry","unique","schemaIndex","schema","hashIndexName","buildStandardIndexName","schemaIndexName","_db","dbName","config","name","dbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","db","assertEx","indexes","storage","allHandler","payloads","getAll","map","payload","PayloadHasher","jsonPayload","clearHandler","clear","deleteHandler","hashes","distinctHashes","Set","found","Promise","all","hash","existing","getKeyFromIndex","delete","filter","exists","getHandler","getFromIndex","insertHandler","pairs","hashPairs","inserted","tx","transaction","store","objectStore","index","get","put","done","startHandler","openDB","upgrade","database","resolve","createObjectStore","autoIncrement","indexesToCreate","indexKeys","Object","keys","length","indexName","createIndex","creatableModule"]}
|
|
1
|
+
{"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n buildStandardIndexName,\n IndexDescription,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { IDBPDatabase, openDB } from 'idb'\n\nimport { IndexedDbArchivistConfigSchema } from './Config'\nimport { IndexedDbArchivistParams } from './Params'\n\nexport interface PayloadStore {\n [s: string]: Payload\n}\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static readonly defaultDbName = 'archivist'\n static readonly defaultDbVersion = 1\n static readonly defaultStoreName = 'payloads'\n private static readonly hashIndex: IndexDescription = { key: { _hash: 1 }, multiEntry: false, unique: true }\n private static readonly schemaIndex: IndexDescription = { key: { schema: 1 }, multiEntry: false, unique: false }\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly hashIndexName = buildStandardIndexName(IndexedDbArchivist.hashIndex)\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly schemaIndexName = buildStandardIndexName(IndexedDbArchivist.schemaIndex)\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n /**\n * The database version. If not supplied via config, it defaults to 1.\n */\n get dbVersion() {\n return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`.\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n /**\n * The indexes to create on the store\n */\n private get indexes() {\n return [IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n // Get all payloads from the store\n const payloads = await this.useDb((db) => db.getAll(this.storeName))\n // Remove any metadata before returning to the client\n return payloads.map((payload) => PayloadHasher.jsonPayload(payload))\n }\n\n protected override async clearHandler(): Promise<void> {\n await this.useDb((db) => db.clear(this.storeName))\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n // Remove any duplicates\n const distinctHashes = [...new Set(hashes)]\n return await this.useDb(async (db) => {\n // Only return hashes that were successfully deleted\n const found = await Promise.all(\n distinctHashes.map(async (hash) => {\n // Check if the hash exists\n const existing = await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)\n // If it does exist\n if (existing) {\n // Delete it\n await db.delete(this.storeName, existing)\n // Return the hash so it gets added to the list of deleted hashes\n return hash\n }\n }),\n )\n return found.filter(exists)\n })\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => db.getFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n return payloads.filter(exists)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const pairs = await PayloadHasher.hashPairs(payloads)\n const db = await this.getInitializedDb()\n try {\n // Only return the payloads that were successfully inserted\n const inserted = await Promise.all(\n pairs.map(async ([payload, _hash]) => {\n // Perform each insert via a transaction to ensure it is atomic\n // with respect to checking for the pre-existence of the hash.\n // This is done to preserve iteration via insertion order.\n const tx = db.transaction(this.storeName, 'readwrite')\n try {\n // Get the object store\n const store = tx.objectStore(this.storeName)\n // Check if the hash already exists\n const existing = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existing) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n // Return it so it gets added to the list of inserted payloads\n return payload\n }\n } finally {\n // Close the transaction\n await tx.done\n }\n }),\n )\n return inserted.filter(exists)\n } finally {\n db.close()\n }\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n await this.useDb(() => {})\n return true\n }\n\n /**\n * Returns that the desired DB/Store initialized to the correct version\n * @returns The initialized DB\n */\n private async getInitializedDb(): Promise<IDBPDatabase<PayloadStore>> {\n const { dbName, dbVersion, indexes, storeName } = this\n const db = await openDB<PayloadStore>(dbName, dbVersion, {\n blocked(currentVersion, blockedVersion, event) {\n console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n blocking(currentVersion, blockedVersion, event) {\n console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n terminated() {\n console.log('IndexedDbArchivist: Terminated')\n },\n upgrade(database, oldVersion, newVersion, transaction) {\n // NOTE: This is called whenever the DB is created/updated. We could simply ensure the desired end\n // state but, out of an abundance of caution, we will just delete (so we know where we are starting\n // from a known good point) and recreate the desired state. This prioritizes resilience over data\n // retention but we can revisit that tradeoff when it becomes limiting. Because distributed browser\n // state is extremely hard to debug, this seems like fair tradeoff for now.\n if (oldVersion !== newVersion) {\n console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`)\n // Delete any existing databases that are not the current version\n const objectStores = transaction.objectStoreNames\n for (const name of objectStores) {\n try {\n database.deleteObjectStore(name)\n } catch {\n console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`)\n }\n }\n }\n // Create the store\n const store = database.createObjectStore(storeName, {\n // If it isn't explicitly set, create a value by auto incrementing.\n autoIncrement: true,\n })\n // Name the store\n store.name = storeName\n // Create an index on the hash\n for (const { key, multiEntry, unique } of indexes) {\n const indexKeys = Object.keys(key)\n const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys\n const indexName = buildStandardIndexName({ key, unique })\n store.createIndex(indexName, keys, { multiEntry, unique })\n }\n },\n })\n return db\n }\n\n /**\n * Executes a callback with the initialized DB and then closes the db\n * @param callback The method to execute with the initialized DB\n * @returns\n */\n private async useDb<T>(callback: (db: IDBPDatabase<PayloadStore>) => Promise<T> | T): Promise<T> {\n // Get the initialized DB\n const db = await this.getInitializedDb()\n try {\n // Perform the callback\n return await callback(db)\n } finally {\n // Close the DB\n db.close()\n }\n }\n}\n","export type IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\nexport const IndexedDbArchivistSchema: IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\n","import { ArchivistConfig, IndexDescription } from '@xyo-network/archivist-model'\n\nimport { IndexedDbArchivistSchema } from './Schema'\n\nexport type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n /**\n * The version of the DB, defaults to 1\n */\n dbVersion?: number\n schema: IndexedDbArchivistConfigSchema\n /**\n * The storage configuration\n * // TODO: Hoist to main archivist config\n */\n storage?: {\n /**\n * The indexes to create on the object store\n */\n indexes?: IndexDescription[]\n }\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n"],"mappings":";;;;AAAA,SAASA,cAAc;AACvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,8BAEK;AACP,SAASC,qBAAqB;AAC9B,SAASC,uBAAuB;AAEhC,SAAuBC,cAAc;;;ACb9B,IAAMC,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFmB1E,IAAMC,qBAAN,MAAMA,4BAGHC,kBAAAA;SAAAA;;;EACR,OAAgBC,gBAAgB;IAACC;;EACjC,OAAgBC,gBAAgB;EAChC,OAAgBC,mBAAmB;EACnC,OAAgBC,mBAAmB;EACnC,OAAwBC,YAA8B;IAAEC,KAAK;MAAEC,OAAO;IAAE;IAAGC,YAAY;IAAOC,QAAQ;EAAK;EAC3G,OAAwBC,cAAgC;IAAEJ,KAAK;MAAEK,QAAQ;IAAE;IAAGH,YAAY;IAAOC,QAAQ;EAAM;;EAE/G,OAAgBG,gBAAgBC,uBAAuBf,oBAAmBO,SAAS;;EAEnF,OAAgBS,kBAAkBD,uBAAuBf,oBAAmBY,WAAW;;;;;;;;EASvF,IAAIK,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQnB,oBAAmBI;EACxE;;;;EAKA,IAAIgB,YAAY;AACd,WAAO,KAAKF,QAAQE,aAAapB,oBAAmBK;EACtD;EAEA,IAAagB,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;AACd,WAAO,KAAKR,QAAQQ,aAAa1B,oBAAmBM;EACtD;;;;EAKA,IAAYqB,UAAU;AACpB,WAAO;MAAC3B,oBAAmBO;MAAWP,oBAAmBY;SAAiB,KAAKM,QAAQU,SAASD,WAAW,CAAA;;EAC7G;EAEA,MAAyBE,aAAiC;AAExD,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKP,SAAS,CAAA;AAElE,WAAOI,SAASI,IAAI,CAACC,YAAYC,cAAcC,YAAYF,OAAAA,CAAAA;EAC7D;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKP,MAAM,CAACC,OAAOA,GAAGO,MAAM,KAAKb,SAAS,CAAA;EAClD;EAEA,MAAyBc,cAAcC,QAAqC;AAE1E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIF,MAAAA;;AACnC,WAAO,MAAM,KAAKV,MAAM,OAAOC,OAAAA;AAE7B,YAAMY,QAAQ,MAAMC,QAAQC,IAC1BJ,eAAeR,IAAI,OAAOa,SAAAA;AAExB,cAAMC,WAAW,MAAMhB,GAAGiB,gBAAgB,KAAKvB,WAAW1B,oBAAmBc,eAAeiC,IAAAA;AAE5F,YAAIC,UAAU;AAEZ,gBAAMhB,GAAGkB,OAAO,KAAKxB,WAAWsB,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOH,MAAMO,OAAOC,MAAAA;IACtB,CAAA;EACF;EAEA,MAAyBC,WAAWZ,QAAsC;AACxE,UAAMX,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCa,QAAQC,IAAIL,OAAOP,IAAI,CAACa,SAASf,GAAGsB,aAAa,KAAK5B,WAAW1B,oBAAmBc,eAAeiC,IAAAA,CAAAA,CAAAA,CAAAA;AAErG,WAAOjB,SAASqB,OAAOC,MAAAA;EACzB;EAEA,MAAyBG,cAAczB,UAAyC;AAC9E,UAAM0B,QAAQ,MAAMpB,cAAcqB,UAAU3B,QAAAA;AAC5C,UAAME,KAAK,MAAM,KAAK0B,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMd,QAAQC,IAC7BU,MAAMtB,IAAI,OAAO,CAACC,SAAS1B,KAAAA,MAAM;AAI/B,cAAMmD,KAAK5B,GAAG6B,YAAY,KAAKnC,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAMoC,QAAQF,GAAGG,YAAY,KAAKrC,SAAS;AAE3C,gBAAMsB,WAAW,MAAMc,MAAME,MAAMhE,oBAAmBc,aAAa,EAAEmD,IAAIxD,KAAAA;AAEzE,cAAI,CAACuC,UAAU;AAEb,kBAAMc,MAAMI,IAAI;cAAE,GAAG/B;cAAS1B;YAAM,CAAA;AAEpC,mBAAO0B;UACT;QACF,UAAA;AAEE,gBAAMyB,GAAGO;QACX;MACF,CAAA,CAAA;AAEF,aAAOR,SAASR,OAAOC,MAAAA;IACzB,UAAA;AACEpB,SAAGoC,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAKtC,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAc2B,mBAAwD;AACpE,UAAM,EAAEzC,QAAQG,WAAWO,SAASD,UAAS,IAAK;AAClD,UAAMM,KAAK,MAAMsC,OAAqBrD,QAAQG,WAAW;MACvDmD,QAAQC,gBAAgBC,gBAAgBC,OAAK;AAC3CC,gBAAQC,KAAK,mDAAmDJ,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACzG;MACAG,SAASL,gBAAgBC,gBAAgBC,OAAK;AAC5CC,gBAAQC,KAAK,6CAA6CJ,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACnG;MACAI,aAAAA;AACEH,gBAAQI,IAAI,gCAAA;MACd;MACAC,QAAQC,UAAUC,YAAYC,YAAYtB,aAAW;AAMnD,YAAIqB,eAAeC,YAAY;AAC7BR,kBAAQI,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE/E,gBAAMC,eAAevB,YAAYwB;AACjC,qBAAWlE,QAAQiE,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBnE,IAAAA;YAC7B,QAAQ;AACNwD,sBAAQI,IAAI,8DAA8D5D,IAAAA,EAAM;YAClF;UACF;QACF;AAEA,cAAM2C,QAAQmB,SAASM,kBAAkB7D,WAAW;;UAElD8D,eAAe;QACjB,CAAA;AAEA1B,cAAM3C,OAAOO;AAEb,mBAAW,EAAElB,KAAKE,YAAYC,OAAM,KAAMgB,SAAS;AACjD,gBAAM8D,YAAYC,OAAOC,KAAKnF,GAAAA;AAC9B,gBAAMmF,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMI,YAAY9E,uBAAuB;YAAEP;YAAKG;UAAO,CAAA;AACvDmD,gBAAMgC,YAAYD,WAAWF,MAAM;YAAEjF;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOqB;EACT;;;;;;EAOA,MAAcD,MAASgE,UAA0E;AAE/F,UAAM/D,KAAK,MAAM,KAAK0B,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMqC,SAAS/D,EAAAA;IACxB,UAAA;AAEEA,SAAGoC,MAAK;IACV;EACF;AACF;AA5MapE,qBAAAA,aAAAA;EADZgG,gBAAAA;GACYhG,kBAAAA;","names":["exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","buildStandardIndexName","PayloadHasher","creatableModule","openDB","IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","IndexedDbArchivistConfigSchema","defaultDbName","defaultDbVersion","defaultStoreName","hashIndex","key","_hash","multiEntry","unique","schemaIndex","schema","hashIndexName","buildStandardIndexName","schemaIndexName","dbName","config","name","dbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","indexes","storage","allHandler","payloads","useDb","db","getAll","map","payload","PayloadHasher","jsonPayload","clearHandler","clear","deleteHandler","hashes","distinctHashes","Set","found","Promise","all","hash","existing","getKeyFromIndex","delete","filter","exists","getHandler","getFromIndex","insertHandler","pairs","hashPairs","getInitializedDb","inserted","tx","transaction","store","objectStore","index","get","put","done","close","startHandler","openDB","blocked","currentVersion","blockedVersion","event","console","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","indexKeys","Object","keys","length","indexName","createIndex","callback","creatableModule"]}
|
|
@@ -14,7 +14,6 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
14
14
|
private static readonly schemaIndex;
|
|
15
15
|
static readonly hashIndexName: string;
|
|
16
16
|
static readonly schemaIndexName: string;
|
|
17
|
-
private _db;
|
|
18
17
|
/**
|
|
19
18
|
* The database name. If not supplied via config, it defaults
|
|
20
19
|
* to the module name (not guaranteed to be unique) and if module
|
|
@@ -33,7 +32,9 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
33
32
|
* to `payloads`.
|
|
34
33
|
*/
|
|
35
34
|
get storeName(): string;
|
|
36
|
-
|
|
35
|
+
/**
|
|
36
|
+
* The indexes to create on the store
|
|
37
|
+
*/
|
|
37
38
|
private get indexes();
|
|
38
39
|
protected allHandler(): Promise<Payload[]>;
|
|
39
40
|
protected clearHandler(): Promise<void>;
|
|
@@ -41,5 +42,16 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
41
42
|
protected getHandler(hashes: string[]): Promise<Payload[]>;
|
|
42
43
|
protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
|
|
43
44
|
protected startHandler(): Promise<boolean>;
|
|
45
|
+
/**
|
|
46
|
+
* Returns that the desired DB/Store initialized to the correct version
|
|
47
|
+
* @returns The initialized DB
|
|
48
|
+
*/
|
|
49
|
+
private getInitializedDb;
|
|
50
|
+
/**
|
|
51
|
+
* Executes a callback with the initialized DB and then closes the db
|
|
52
|
+
* @param callback The method to execute with the initialized DB
|
|
53
|
+
* @returns
|
|
54
|
+
*/
|
|
55
|
+
private useDb;
|
|
44
56
|
}
|
|
45
57
|
//# sourceMappingURL=Archivist.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAKL,wBAAwB,EAGzB,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAIpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAED,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,aAAa,6CAAmC;IAChE,MAAM,CAAC,QAAQ,CAAC,aAAa,eAAc;IAC3C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAI;IACpC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,cAAa;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAA2E;IAC5G,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAA6E;IAEhH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAAuD;IAEpF,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAyD;IAExF;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED,IAAa,OAAO,aAEnB;IAED;;;OAGG;IACH,IAAI,SAAS,WAEZ;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAElB;cAEwB,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAOhC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAsBlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAOhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAmCtD,YAAY;IAQrC;;;OAGG;YACW,gBAAgB;IAiD9B;;;;OAIG;YACW,KAAK;CAWpB"}
|
|
@@ -14,7 +14,6 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
14
14
|
private static readonly schemaIndex;
|
|
15
15
|
static readonly hashIndexName: string;
|
|
16
16
|
static readonly schemaIndexName: string;
|
|
17
|
-
private _db;
|
|
18
17
|
/**
|
|
19
18
|
* The database name. If not supplied via config, it defaults
|
|
20
19
|
* to the module name (not guaranteed to be unique) and if module
|
|
@@ -33,7 +32,9 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
33
32
|
* to `payloads`.
|
|
34
33
|
*/
|
|
35
34
|
get storeName(): string;
|
|
36
|
-
|
|
35
|
+
/**
|
|
36
|
+
* The indexes to create on the store
|
|
37
|
+
*/
|
|
37
38
|
private get indexes();
|
|
38
39
|
protected allHandler(): Promise<Payload[]>;
|
|
39
40
|
protected clearHandler(): Promise<void>;
|
|
@@ -41,5 +42,16 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
41
42
|
protected getHandler(hashes: string[]): Promise<Payload[]>;
|
|
42
43
|
protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
|
|
43
44
|
protected startHandler(): Promise<boolean>;
|
|
45
|
+
/**
|
|
46
|
+
* Returns that the desired DB/Store initialized to the correct version
|
|
47
|
+
* @returns The initialized DB
|
|
48
|
+
*/
|
|
49
|
+
private getInitializedDb;
|
|
50
|
+
/**
|
|
51
|
+
* Executes a callback with the initialized DB and then closes the db
|
|
52
|
+
* @param callback The method to execute with the initialized DB
|
|
53
|
+
* @returns
|
|
54
|
+
*/
|
|
55
|
+
private useDb;
|
|
44
56
|
}
|
|
45
57
|
//# sourceMappingURL=Archivist.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAKL,wBAAwB,EAGzB,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAIpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAED,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,aAAa,6CAAmC;IAChE,MAAM,CAAC,QAAQ,CAAC,aAAa,eAAc;IAC3C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAI;IACpC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,cAAa;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAA2E;IAC5G,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAA6E;IAEhH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAAuD;IAEpF,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAyD;IAExF;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED,IAAa,OAAO,aAEnB;IAED;;;OAGG;IACH,IAAI,SAAS,WAEZ;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAElB;cAEwB,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAOhC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAsBlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAOhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAmCtD,YAAY;IAQrC;;;OAGG;YACW,gBAAgB;IAiD9B;;;;OAIG;YACW,KAAK;CAWpB"}
|
package/dist/node/Archivist.d.ts
CHANGED
|
@@ -14,7 +14,6 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
14
14
|
private static readonly schemaIndex;
|
|
15
15
|
static readonly hashIndexName: string;
|
|
16
16
|
static readonly schemaIndexName: string;
|
|
17
|
-
private _db;
|
|
18
17
|
/**
|
|
19
18
|
* The database name. If not supplied via config, it defaults
|
|
20
19
|
* to the module name (not guaranteed to be unique) and if module
|
|
@@ -33,7 +32,9 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
33
32
|
* to `payloads`.
|
|
34
33
|
*/
|
|
35
34
|
get storeName(): string;
|
|
36
|
-
|
|
35
|
+
/**
|
|
36
|
+
* The indexes to create on the store
|
|
37
|
+
*/
|
|
37
38
|
private get indexes();
|
|
38
39
|
protected allHandler(): Promise<Payload[]>;
|
|
39
40
|
protected clearHandler(): Promise<void>;
|
|
@@ -41,5 +42,16 @@ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams
|
|
|
41
42
|
protected getHandler(hashes: string[]): Promise<Payload[]>;
|
|
42
43
|
protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
|
|
43
44
|
protected startHandler(): Promise<boolean>;
|
|
45
|
+
/**
|
|
46
|
+
* Returns that the desired DB/Store initialized to the correct version
|
|
47
|
+
* @returns The initialized DB
|
|
48
|
+
*/
|
|
49
|
+
private getInitializedDb;
|
|
50
|
+
/**
|
|
51
|
+
* Executes a callback with the initialized DB and then closes the db
|
|
52
|
+
* @param callback The method to execute with the initialized DB
|
|
53
|
+
* @returns
|
|
54
|
+
*/
|
|
55
|
+
private useDb;
|
|
44
56
|
}
|
|
45
57
|
//# sourceMappingURL=Archivist.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAKL,wBAAwB,EAGzB,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAIpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAED,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,aAAa,6CAAmC;IAChE,MAAM,CAAC,QAAQ,CAAC,aAAa,eAAc;IAC3C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAI;IACpC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,cAAa;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAA2E;IAC5G,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAA6E;IAEhH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAAuD;IAEpF,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAyD;IAExF;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED,IAAa,OAAO,aAEnB;IAED;;;OAGG;IACH,IAAI,SAAS,WAEZ;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAElB;cAEwB,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAOhC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAsBlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAOhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAmCtD,YAAY;IAQrC;;;OAGG;YACW,gBAAgB;IAiD9B;;;;OAIG;YACW,KAAK;CAWpB"}
|
package/dist/node/index.cjs
CHANGED
|
@@ -33,7 +33,6 @@ __export(src_exports, {
|
|
|
33
33
|
module.exports = __toCommonJS(src_exports);
|
|
34
34
|
|
|
35
35
|
// src/Archivist.ts
|
|
36
|
-
var import_assert = require("@xylabs/assert");
|
|
37
36
|
var import_exists = require("@xylabs/exists");
|
|
38
37
|
var import_archivist_abstract = require("@xyo-network/archivist-abstract");
|
|
39
38
|
var import_archivist_model = require("@xyo-network/archivist-model");
|
|
@@ -60,7 +59,6 @@ function _ts_decorate(decorators, target, key, desc) {
|
|
|
60
59
|
}
|
|
61
60
|
__name(_ts_decorate, "_ts_decorate");
|
|
62
61
|
var _IndexedDbArchivist = class _IndexedDbArchivist extends import_archivist_abstract.AbstractArchivist {
|
|
63
|
-
_db;
|
|
64
62
|
/**
|
|
65
63
|
* The database name. If not supplied via config, it defaults
|
|
66
64
|
* to the module name (not guaranteed to be unique) and if module
|
|
@@ -96,76 +94,108 @@ var _IndexedDbArchivist = class _IndexedDbArchivist extends import_archivist_abs
|
|
|
96
94
|
var _a;
|
|
97
95
|
return ((_a = this.config) == null ? void 0 : _a.storeName) ?? _IndexedDbArchivist.defaultStoreName;
|
|
98
96
|
}
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
97
|
+
/**
|
|
98
|
+
* The indexes to create on the store
|
|
99
|
+
*/
|
|
102
100
|
get indexes() {
|
|
103
101
|
var _a, _b;
|
|
104
|
-
return
|
|
102
|
+
return [
|
|
103
|
+
_IndexedDbArchivist.hashIndex,
|
|
104
|
+
_IndexedDbArchivist.schemaIndex,
|
|
105
|
+
...((_b = (_a = this.config) == null ? void 0 : _a.storage) == null ? void 0 : _b.indexes) ?? []
|
|
106
|
+
];
|
|
105
107
|
}
|
|
106
108
|
async allHandler() {
|
|
107
|
-
const payloads = await this.db.getAll(this.storeName);
|
|
109
|
+
const payloads = await this.useDb((db) => db.getAll(this.storeName));
|
|
108
110
|
return payloads.map((payload) => import_hash.PayloadHasher.jsonPayload(payload));
|
|
109
111
|
}
|
|
110
112
|
async clearHandler() {
|
|
111
|
-
await this.db.clear(this.storeName);
|
|
113
|
+
await this.useDb((db) => db.clear(this.storeName));
|
|
112
114
|
}
|
|
113
115
|
async deleteHandler(hashes) {
|
|
114
116
|
const distinctHashes = [
|
|
115
117
|
...new Set(hashes)
|
|
116
118
|
];
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
119
|
+
return await this.useDb(async (db) => {
|
|
120
|
+
const found = await Promise.all(distinctHashes.map(async (hash) => {
|
|
121
|
+
const existing = await db.getKeyFromIndex(this.storeName, _IndexedDbArchivist.hashIndexName, hash);
|
|
122
|
+
if (existing) {
|
|
123
|
+
await db.delete(this.storeName, existing);
|
|
124
|
+
return hash;
|
|
125
|
+
}
|
|
126
|
+
}));
|
|
127
|
+
return found.filter(import_exists.exists);
|
|
128
|
+
});
|
|
127
129
|
}
|
|
128
130
|
async getHandler(hashes) {
|
|
129
|
-
const payloads = await Promise.all(hashes.map((hash) =>
|
|
131
|
+
const payloads = await this.useDb((db) => Promise.all(hashes.map((hash) => db.getFromIndex(this.storeName, _IndexedDbArchivist.hashIndexName, hash))));
|
|
130
132
|
return payloads.filter(import_exists.exists);
|
|
131
133
|
}
|
|
132
134
|
async insertHandler(payloads) {
|
|
133
135
|
const pairs = await import_hash.PayloadHasher.hashPairs(payloads);
|
|
134
|
-
const
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
const
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
await store.
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
136
|
+
const db = await this.getInitializedDb();
|
|
137
|
+
try {
|
|
138
|
+
const inserted = await Promise.all(pairs.map(async ([payload, _hash]) => {
|
|
139
|
+
const tx = db.transaction(this.storeName, "readwrite");
|
|
140
|
+
try {
|
|
141
|
+
const store = tx.objectStore(this.storeName);
|
|
142
|
+
const existing = await store.index(_IndexedDbArchivist.hashIndexName).get(_hash);
|
|
143
|
+
if (!existing) {
|
|
144
|
+
await store.put({
|
|
145
|
+
...payload,
|
|
146
|
+
_hash
|
|
147
|
+
});
|
|
148
|
+
return payload;
|
|
149
|
+
}
|
|
150
|
+
} finally {
|
|
151
|
+
await tx.done;
|
|
145
152
|
}
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
153
|
+
}));
|
|
154
|
+
return inserted.filter(import_exists.exists);
|
|
155
|
+
} finally {
|
|
156
|
+
db.close();
|
|
157
|
+
}
|
|
151
158
|
}
|
|
152
159
|
async startHandler() {
|
|
153
160
|
await super.startHandler();
|
|
161
|
+
await this.useDb(() => {
|
|
162
|
+
});
|
|
163
|
+
return true;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Returns that the desired DB/Store initialized to the correct version
|
|
167
|
+
* @returns The initialized DB
|
|
168
|
+
*/
|
|
169
|
+
async getInitializedDb() {
|
|
154
170
|
const { dbName, dbVersion, indexes, storeName } = this;
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
171
|
+
const db = await (0, import_idb.openDB)(dbName, dbVersion, {
|
|
172
|
+
blocked(currentVersion, blockedVersion, event) {
|
|
173
|
+
console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
|
|
174
|
+
},
|
|
175
|
+
blocking(currentVersion, blockedVersion, event) {
|
|
176
|
+
console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
|
|
177
|
+
},
|
|
178
|
+
terminated() {
|
|
179
|
+
console.log("IndexedDbArchivist: Terminated");
|
|
180
|
+
},
|
|
181
|
+
upgrade(database, oldVersion, newVersion, transaction) {
|
|
182
|
+
if (oldVersion !== newVersion) {
|
|
183
|
+
console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
|
|
184
|
+
const objectStores = transaction.objectStoreNames;
|
|
185
|
+
for (const name of objectStores) {
|
|
186
|
+
try {
|
|
187
|
+
database.deleteObjectStore(name);
|
|
188
|
+
} catch {
|
|
189
|
+
console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
158
193
|
const store = database.createObjectStore(storeName, {
|
|
159
194
|
// If it isn't explicitly set, create a value by auto incrementing.
|
|
160
195
|
autoIncrement: true
|
|
161
196
|
});
|
|
162
197
|
store.name = storeName;
|
|
163
|
-
const
|
|
164
|
-
_IndexedDbArchivist.hashIndex,
|
|
165
|
-
_IndexedDbArchivist.schemaIndex,
|
|
166
|
-
...indexes
|
|
167
|
-
];
|
|
168
|
-
for (const { key, multiEntry, unique } of indexesToCreate) {
|
|
198
|
+
for (const { key, multiEntry, unique } of indexes) {
|
|
169
199
|
const indexKeys = Object.keys(key);
|
|
170
200
|
const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys;
|
|
171
201
|
const indexName = (0, import_archivist_model.buildStandardIndexName)({
|
|
@@ -179,7 +209,20 @@ var _IndexedDbArchivist = class _IndexedDbArchivist extends import_archivist_abs
|
|
|
179
209
|
}
|
|
180
210
|
}
|
|
181
211
|
});
|
|
182
|
-
return
|
|
212
|
+
return db;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Executes a callback with the initialized DB and then closes the db
|
|
216
|
+
* @param callback The method to execute with the initialized DB
|
|
217
|
+
* @returns
|
|
218
|
+
*/
|
|
219
|
+
async useDb(callback) {
|
|
220
|
+
const db = await this.getInitializedDb();
|
|
221
|
+
try {
|
|
222
|
+
return await callback(db);
|
|
223
|
+
} finally {
|
|
224
|
+
db.close();
|
|
225
|
+
}
|
|
183
226
|
}
|
|
184
227
|
};
|
|
185
228
|
__name(_IndexedDbArchivist, "IndexedDbArchivist");
|
package/dist/node/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts","../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["export * from './Archivist'\nexport * from './Config'\nexport * from './Params'\nexport * from './Schema'\n","import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n buildStandardIndexName,\n IndexDescription,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { IDBPDatabase, openDB } from 'idb'\n\nimport { IndexedDbArchivistConfigSchema } from './Config'\nimport { IndexedDbArchivistParams } from './Params'\n\nexport interface PayloadStore {\n [s: string]: Payload\n}\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static readonly defaultDbName = 'archivist'\n static readonly defaultDbVersion = 1\n static readonly defaultStoreName = 'payloads'\n private static readonly hashIndex: IndexDescription = { key: { _hash: 1 }, multiEntry: false, unique: true }\n private static readonly schemaIndex: IndexDescription = { key: { schema: 1 }, multiEntry: false, unique: false }\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly hashIndexName = buildStandardIndexName(IndexedDbArchivist.hashIndex)\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly schemaIndexName = buildStandardIndexName(IndexedDbArchivist.schemaIndex)\n\n private _db: IDBPDatabase<PayloadStore> | undefined\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n /**\n * The database version. If not supplied via config, it defaults to 1.\n */\n get dbVersion() {\n return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`.\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n private get db(): IDBPDatabase<PayloadStore> {\n return assertEx(this._db, 'DB not initialized')\n }\n\n private get indexes() {\n return this.config?.storage?.indexes ?? []\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n // Get all payloads from the store\n const payloads = await this.db.getAll(this.storeName)\n // Remove any metadata before returning to the client\n return payloads.map((payload) => PayloadHasher.jsonPayload(payload))\n }\n\n protected override async clearHandler(): Promise<void> {\n await this.db.clear(this.storeName)\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n const distinctHashes = [...new Set(hashes)]\n const found = await Promise.all(\n distinctHashes.map(async (hash) => {\n let existing: IDBValidKey | undefined\n do {\n existing = await this.db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)\n if (existing) await this.db.delete(this.storeName, existing)\n } while (!existing)\n return hash\n }),\n )\n // Return hashes removed\n return found.filter(exists)\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n const payloads = await Promise.all(hashes.map((hash) => this.db.getFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)))\n return payloads.filter(exists)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const pairs = await PayloadHasher.hashPairs(payloads)\n // Only return the payloads that were successfully inserted\n const inserted = await Promise.all(\n pairs.map(async ([payload, _hash]) => {\n const tx = this.db.transaction(this.storeName, 'readwrite')\n try {\n const store = tx.objectStore(this.storeName)\n const existing = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n if (!existing) {\n await store.put({ ...payload, _hash })\n return payload\n }\n } finally {\n await tx.done\n }\n }),\n )\n return inserted.filter(exists)\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n const { dbName, dbVersion, indexes, storeName } = this\n this._db = await openDB<PayloadStore>(dbName, dbVersion, {\n async upgrade(database) {\n await Promise.resolve() // Async to match spec\n // Create the store\n const store = database.createObjectStore(storeName, {\n // If it isn't explicitly set, create a value by auto incrementing.\n autoIncrement: true,\n })\n // Name the store\n store.name = storeName\n // Create an index on the hash\n const indexesToCreate = [IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...indexes]\n for (const { key, multiEntry, unique } of indexesToCreate) {\n const indexKeys = Object.keys(key)\n const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys\n const indexName = buildStandardIndexName({ key, unique })\n store.createIndex(indexName, keys, { multiEntry, unique })\n }\n },\n })\n return true\n }\n}\n","export type IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\nexport const IndexedDbArchivistSchema: IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\n","import { ArchivistConfig, IndexDescription } from '@xyo-network/archivist-model'\n\nimport { IndexedDbArchivistSchema } from './Schema'\n\nexport type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n /**\n * The version of the DB, defaults to 1\n */\n dbVersion?: number\n schema: IndexedDbArchivistConfigSchema\n /**\n * The storage configuration\n * // TODO: Hoist to main archivist config\n */\n storage?: {\n /**\n * The indexes to create on the object store\n */\n indexes?: IndexDescription[]\n }\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;ACAA,oBAAyB;AACzB,oBAAuB;AACvB,gCAAkC;AAClC,6BAQO;AACP,kBAA8B;AAC9B,0BAAgC;AAEhC,iBAAqC;;;ACd9B,IAAMA,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,sBAAN,MAAMA,4BAGHC,4CAAAA;EAYAC;;;;;;;;EASR,IAAIC,SAAS;;AACX,aAAO,UAAKC,WAAL,mBAAaD,aAAU,UAAKC,WAAL,mBAAaC,SAAQL,oBAAmBM;EACxE;;;;EAKA,IAAIC,YAAY;;AACd,aAAO,UAAKH,WAAL,mBAAaG,cAAaP,oBAAmBQ;EACtD;EAEA,IAAaC,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;;AACd,aAAO,UAAKV,WAAL,mBAAaU,cAAad,oBAAmBe;EACtD;EAEA,IAAYC,KAAiC;AAC3C,eAAOC,wBAAS,KAAKf,KAAK,oBAAA;EAC5B;EAEA,IAAYgB,UAAU;;AACpB,aAAO,gBAAKd,WAAL,mBAAae,YAAb,mBAAsBD,YAAW,CAAA;EAC1C;EAEA,MAAyBE,aAAiC;AAExD,UAAMC,WAAW,MAAM,KAAKL,GAAGM,OAAO,KAAKR,SAAS;AAEpD,WAAOO,SAASE,IAAI,CAACC,YAAYC,0BAAcC,YAAYF,OAAAA,CAAAA;EAC7D;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKX,GAAGY,MAAM,KAAKd,SAAS;EACpC;EAEA,MAAyBe,cAAcC,QAAqC;AAC1E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIF,MAAAA;;AACnC,UAAMG,QAAQ,MAAMC,QAAQC,IAC1BJ,eAAeR,IAAI,OAAOa,SAAAA;AACxB,UAAIC;AACJ,SAAG;AACDA,mBAAW,MAAM,KAAKrB,GAAGsB,gBAAgB,KAAKxB,WAAWd,oBAAmBuC,eAAeH,IAAAA;AAC3F,YAAIC;AAAU,gBAAM,KAAKrB,GAAGwB,OAAO,KAAK1B,WAAWuB,QAAAA;MACrD,SAAS,CAACA;AACV,aAAOD;IACT,CAAA,CAAA;AAGF,WAAOH,MAAMQ,OAAOC,oBAAAA;EACtB;EAEA,MAAyBC,WAAWb,QAAsC;AACxE,UAAMT,WAAW,MAAMa,QAAQC,IAAIL,OAAOP,IAAI,CAACa,SAAS,KAAKpB,GAAG4B,aAAa,KAAK9B,WAAWd,oBAAmBuC,eAAeH,IAAAA,CAAAA,CAAAA;AAC/H,WAAOf,SAASoB,OAAOC,oBAAAA;EACzB;EAEA,MAAyBG,cAAcxB,UAAyC;AAC9E,UAAMyB,QAAQ,MAAMrB,0BAAcsB,UAAU1B,QAAAA;AAE5C,UAAM2B,WAAW,MAAMd,QAAQC,IAC7BW,MAAMvB,IAAI,OAAO,CAACC,SAASyB,KAAAA,MAAM;AAC/B,YAAMC,KAAK,KAAKlC,GAAGmC,YAAY,KAAKrC,WAAW,WAAA;AAC/C,UAAI;AACF,cAAMsC,QAAQF,GAAGG,YAAY,KAAKvC,SAAS;AAC3C,cAAMuB,WAAW,MAAMe,MAAME,MAAMtD,oBAAmBuC,aAAa,EAAEgB,IAAIN,KAAAA;AACzE,YAAI,CAACZ,UAAU;AACb,gBAAMe,MAAMI,IAAI;YAAE,GAAGhC;YAASyB;UAAM,CAAA;AACpC,iBAAOzB;QACT;MACF,UAAA;AACE,cAAM0B,GAAGO;MACX;IACF,CAAA,CAAA;AAEF,WAAOT,SAASP,OAAOC,oBAAAA;EACzB;EAEA,MAAyBgB,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,EAAEvD,QAAQI,WAAWW,SAASJ,UAAS,IAAK;AAClD,SAAKZ,MAAM,UAAMyD,mBAAqBxD,QAAQI,WAAW;MACvD,MAAMqD,QAAQC,UAAQ;AACpB,cAAM3B,QAAQ4B,QAAO;AAErB,cAAMV,QAAQS,SAASE,kBAAkBjD,WAAW;;UAElDkD,eAAe;QACjB,CAAA;AAEAZ,cAAM/C,OAAOS;AAEb,cAAMmD,kBAAkB;UAACjE,oBAAmBkE;UAAWlE,oBAAmBmE;aAAgBjD;;AAC1F,mBAAW,EAAEkD,KAAKC,YAAYC,OAAM,KAAML,iBAAiB;AACzD,gBAAMM,YAAYC,OAAOC,KAAKL,GAAAA;AAC9B,gBAAMK,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMI,gBAAYC,+CAAuB;YAAER;YAAKE;UAAO,CAAA;AACvDlB,gBAAMyB,YAAYF,WAAWF,MAAM;YAAEJ;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAO;EACT;AACF;AApIUrE;AACR,cAJWD,qBAIK8E,iBAAgB;EAACC;;AACjC,cALW/E,qBAKKM,iBAAgB;AAChC,cANWN,qBAMKQ,oBAAmB;AACnC,cAPWR,qBAOKe,oBAAmB;AACnC,cARWf,qBAQakE,aAA8B;EAAEE,KAAK;IAAEnB,OAAO;EAAE;EAAGoB,YAAY;EAAOC,QAAQ;AAAK;AAC3G,cATWtE,qBASamE,eAAgC;EAAEC,KAAK;IAAEY,QAAQ;EAAE;EAAGX,YAAY;EAAOC,QAAQ;AAAM;;AAE/G,cAXWtE,qBAWKuC,qBAAgBqC,+CAAuB5E,oBAAmBkE,SAAS;;AAEnF,cAbWlE,qBAaKiF,uBAAkBL,+CAAuB5E,oBAAmBmE,WAAW;AAblF,IAAMnE,qBAAN;AAAMA,qBAAAA,aAAAA;MADZkF,qCAAAA;GACYlF,kBAAAA;","names":["IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","_db","dbName","config","name","defaultDbName","dbVersion","defaultDbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","db","assertEx","indexes","storage","allHandler","payloads","getAll","map","payload","PayloadHasher","jsonPayload","clearHandler","clear","deleteHandler","hashes","distinctHashes","Set","found","Promise","all","hash","existing","getKeyFromIndex","hashIndexName","delete","filter","exists","getHandler","getFromIndex","insertHandler","pairs","hashPairs","inserted","_hash","tx","transaction","store","objectStore","index","get","put","done","startHandler","openDB","upgrade","database","resolve","createObjectStore","autoIncrement","indexesToCreate","hashIndex","schemaIndex","key","multiEntry","unique","indexKeys","Object","keys","length","indexName","buildStandardIndexName","createIndex","configSchemas","IndexedDbArchivistConfigSchema","schema","schemaIndexName","creatableModule"]}
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts","../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["export * from './Archivist'\nexport * from './Config'\nexport * from './Params'\nexport * from './Schema'\n","import { exists } from '@xylabs/exists'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n buildStandardIndexName,\n IndexDescription,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { IDBPDatabase, openDB } from 'idb'\n\nimport { IndexedDbArchivistConfigSchema } from './Config'\nimport { IndexedDbArchivistParams } from './Params'\n\nexport interface PayloadStore {\n [s: string]: Payload\n}\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static readonly defaultDbName = 'archivist'\n static readonly defaultDbVersion = 1\n static readonly defaultStoreName = 'payloads'\n private static readonly hashIndex: IndexDescription = { key: { _hash: 1 }, multiEntry: false, unique: true }\n private static readonly schemaIndex: IndexDescription = { key: { schema: 1 }, multiEntry: false, unique: false }\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly hashIndexName = buildStandardIndexName(IndexedDbArchivist.hashIndex)\n // eslint-disable-next-line @typescript-eslint/member-ordering\n static readonly schemaIndexName = buildStandardIndexName(IndexedDbArchivist.schemaIndex)\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n /**\n * The database version. If not supplied via config, it defaults to 1.\n */\n get dbVersion() {\n return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`.\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n /**\n * The indexes to create on the store\n */\n private get indexes() {\n return [IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n // Get all payloads from the store\n const payloads = await this.useDb((db) => db.getAll(this.storeName))\n // Remove any metadata before returning to the client\n return payloads.map((payload) => PayloadHasher.jsonPayload(payload))\n }\n\n protected override async clearHandler(): Promise<void> {\n await this.useDb((db) => db.clear(this.storeName))\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n // Remove any duplicates\n const distinctHashes = [...new Set(hashes)]\n return await this.useDb(async (db) => {\n // Only return hashes that were successfully deleted\n const found = await Promise.all(\n distinctHashes.map(async (hash) => {\n // Check if the hash exists\n const existing = await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)\n // If it does exist\n if (existing) {\n // Delete it\n await db.delete(this.storeName, existing)\n // Return the hash so it gets added to the list of deleted hashes\n return hash\n }\n }),\n )\n return found.filter(exists)\n })\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => db.getFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n return payloads.filter(exists)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const pairs = await PayloadHasher.hashPairs(payloads)\n const db = await this.getInitializedDb()\n try {\n // Only return the payloads that were successfully inserted\n const inserted = await Promise.all(\n pairs.map(async ([payload, _hash]) => {\n // Perform each insert via a transaction to ensure it is atomic\n // with respect to checking for the pre-existence of the hash.\n // This is done to preserve iteration via insertion order.\n const tx = db.transaction(this.storeName, 'readwrite')\n try {\n // Get the object store\n const store = tx.objectStore(this.storeName)\n // Check if the hash already exists\n const existing = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existing) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n // Return it so it gets added to the list of inserted payloads\n return payload\n }\n } finally {\n // Close the transaction\n await tx.done\n }\n }),\n )\n return inserted.filter(exists)\n } finally {\n db.close()\n }\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n await this.useDb(() => {})\n return true\n }\n\n /**\n * Returns that the desired DB/Store initialized to the correct version\n * @returns The initialized DB\n */\n private async getInitializedDb(): Promise<IDBPDatabase<PayloadStore>> {\n const { dbName, dbVersion, indexes, storeName } = this\n const db = await openDB<PayloadStore>(dbName, dbVersion, {\n blocked(currentVersion, blockedVersion, event) {\n console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n blocking(currentVersion, blockedVersion, event) {\n console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n terminated() {\n console.log('IndexedDbArchivist: Terminated')\n },\n upgrade(database, oldVersion, newVersion, transaction) {\n // NOTE: This is called whenever the DB is created/updated. We could simply ensure the desired end\n // state but, out of an abundance of caution, we will just delete (so we know where we are starting\n // from a known good point) and recreate the desired state. This prioritizes resilience over data\n // retention but we can revisit that tradeoff when it becomes limiting. Because distributed browser\n // state is extremely hard to debug, this seems like fair tradeoff for now.\n if (oldVersion !== newVersion) {\n console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`)\n // Delete any existing databases that are not the current version\n const objectStores = transaction.objectStoreNames\n for (const name of objectStores) {\n try {\n database.deleteObjectStore(name)\n } catch {\n console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`)\n }\n }\n }\n // Create the store\n const store = database.createObjectStore(storeName, {\n // If it isn't explicitly set, create a value by auto incrementing.\n autoIncrement: true,\n })\n // Name the store\n store.name = storeName\n // Create an index on the hash\n for (const { key, multiEntry, unique } of indexes) {\n const indexKeys = Object.keys(key)\n const keys = indexKeys.length === 1 ? indexKeys[0] : indexKeys\n const indexName = buildStandardIndexName({ key, unique })\n store.createIndex(indexName, keys, { multiEntry, unique })\n }\n },\n })\n return db\n }\n\n /**\n * Executes a callback with the initialized DB and then closes the db\n * @param callback The method to execute with the initialized DB\n * @returns\n */\n private async useDb<T>(callback: (db: IDBPDatabase<PayloadStore>) => Promise<T> | T): Promise<T> {\n // Get the initialized DB\n const db = await this.getInitializedDb()\n try {\n // Perform the callback\n return await callback(db)\n } finally {\n // Close the DB\n db.close()\n }\n }\n}\n","export type IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\nexport const IndexedDbArchivistSchema: IndexedDbArchivistSchema = 'network.xyo.archivist.indexeddb'\n","import { ArchivistConfig, IndexDescription } from '@xyo-network/archivist-model'\n\nimport { IndexedDbArchivistSchema } from './Schema'\n\nexport type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n /**\n * The version of the DB, defaults to 1\n */\n dbVersion?: number\n schema: IndexedDbArchivistConfigSchema\n /**\n * The storage configuration\n * // TODO: Hoist to main archivist config\n */\n storage?: {\n /**\n * The indexes to create on the object store\n */\n indexes?: IndexDescription[]\n }\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;ACAA,oBAAuB;AACvB,gCAAkC;AAClC,6BAQO;AACP,kBAA8B;AAC9B,0BAAgC;AAEhC,iBAAqC;;;ACb9B,IAAMA,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFmB1E,IAAMC,sBAAN,MAAMA,4BAGHC,4CAAAA;;;;;;;;EAmBR,IAAIC,SAAS;;AACX,aAAO,UAAKC,WAAL,mBAAaD,aAAU,UAAKC,WAAL,mBAAaC,SAAQJ,oBAAmBK;EACxE;;;;EAKA,IAAIC,YAAY;;AACd,aAAO,UAAKH,WAAL,mBAAaG,cAAaN,oBAAmBO;EACtD;EAEA,IAAaC,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;;AACd,aAAO,UAAKV,WAAL,mBAAaU,cAAab,oBAAmBc;EACtD;;;;EAKA,IAAYC,UAAU;;AACpB,WAAO;MAACf,oBAAmBgB;MAAWhB,oBAAmBiB;WAAiB,gBAAKd,WAAL,mBAAae,YAAb,mBAAsBH,YAAW,CAAA;;EAC7G;EAEA,MAAyBI,aAAiC;AAExD,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKV,SAAS,CAAA;AAElE,WAAOO,SAASI,IAAI,CAACC,YAAYC,0BAAcC,YAAYF,OAAAA,CAAAA;EAC7D;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKP,MAAM,CAACC,OAAOA,GAAGO,MAAM,KAAKhB,SAAS,CAAA;EAClD;EAEA,MAAyBiB,cAAcC,QAAqC;AAE1E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIF,MAAAA;;AACnC,WAAO,MAAM,KAAKV,MAAM,OAAOC,OAAAA;AAE7B,YAAMY,QAAQ,MAAMC,QAAQC,IAC1BJ,eAAeR,IAAI,OAAOa,SAAAA;AAExB,cAAMC,WAAW,MAAMhB,GAAGiB,gBAAgB,KAAK1B,WAAWb,oBAAmBwC,eAAeH,IAAAA;AAE5F,YAAIC,UAAU;AAEZ,gBAAMhB,GAAGmB,OAAO,KAAK5B,WAAWyB,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOH,MAAMQ,OAAOC,oBAAAA;IACtB,CAAA;EACF;EAEA,MAAyBC,WAAWb,QAAsC;AACxE,UAAMX,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCa,QAAQC,IAAIL,OAAOP,IAAI,CAACa,SAASf,GAAGuB,aAAa,KAAKhC,WAAWb,oBAAmBwC,eAAeH,IAAAA,CAAAA,CAAAA,CAAAA;AAErG,WAAOjB,SAASsB,OAAOC,oBAAAA;EACzB;EAEA,MAAyBG,cAAc1B,UAAyC;AAC9E,UAAM2B,QAAQ,MAAMrB,0BAAcsB,UAAU5B,QAAAA;AAC5C,UAAME,KAAK,MAAM,KAAK2B,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMf,QAAQC,IAC7BW,MAAMvB,IAAI,OAAO,CAACC,SAAS0B,KAAAA,MAAM;AAI/B,cAAMC,KAAK9B,GAAG+B,YAAY,KAAKxC,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAMyC,QAAQF,GAAGG,YAAY,KAAK1C,SAAS;AAE3C,gBAAMyB,WAAW,MAAMgB,MAAME,MAAMxD,oBAAmBwC,aAAa,EAAEiB,IAAIN,KAAAA;AAEzE,cAAI,CAACb,UAAU;AAEb,kBAAMgB,MAAMI,IAAI;cAAE,GAAGjC;cAAS0B;YAAM,CAAA;AAEpC,mBAAO1B;UACT;QACF,UAAA;AAEE,gBAAM2B,GAAGO;QACX;MACF,CAAA,CAAA;AAEF,aAAOT,SAASR,OAAOC,oBAAAA;IACzB,UAAA;AACErB,SAAGsC,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAKxC,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAc4B,mBAAwD;AACpE,UAAM,EAAE/C,QAAQI,WAAWS,SAASF,UAAS,IAAK;AAClD,UAAMS,KAAK,UAAMwC,mBAAqB5D,QAAQI,WAAW;MACvDyD,QAAQC,gBAAgBC,gBAAgBC,OAAK;AAC3CC,gBAAQC,KAAK,mDAAmDJ,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACzG;MACAG,SAASL,gBAAgBC,gBAAgBC,OAAK;AAC5CC,gBAAQC,KAAK,6CAA6CJ,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACnG;MACAI,aAAAA;AACEH,gBAAQI,IAAI,gCAAA;MACd;MACAC,QAAQC,UAAUC,YAAYC,YAAYtB,aAAW;AAMnD,YAAIqB,eAAeC,YAAY;AAC7BR,kBAAQI,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE/E,gBAAMC,eAAevB,YAAYwB;AACjC,qBAAWzE,QAAQwE,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkB1E,IAAAA;YAC7B,QAAQ;AACN+D,sBAAQI,IAAI,8DAA8DnE,IAAAA,EAAM;YAClF;UACF;QACF;AAEA,cAAMkD,QAAQmB,SAASM,kBAAkBlE,WAAW;;UAElDmE,eAAe;QACjB,CAAA;AAEA1B,cAAMlD,OAAOS;AAEb,mBAAW,EAAEoE,KAAKC,YAAYC,OAAM,KAAMpE,SAAS;AACjD,gBAAMqE,YAAYC,OAAOC,KAAKL,GAAAA;AAC9B,gBAAMK,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMI,gBAAYC,+CAAuB;YAAER;YAAKE;UAAO,CAAA;AACvD7B,gBAAMoC,YAAYF,WAAWF,MAAM;YAAEJ;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAO7D;EACT;;;;;;EAOA,MAAcD,MAASsE,UAA0E;AAE/F,UAAMrE,KAAK,MAAM,KAAK2B,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAM0C,SAASrE,EAAAA;IACxB,UAAA;AAEEA,SAAGsC,MAAK;IACV;EACF;AACF;AAzMU3D;AACR,cAJWD,qBAIK4F,iBAAgB;EAACC;;AACjC,cALW7F,qBAKKK,iBAAgB;AAChC,cANWL,qBAMKO,oBAAmB;AACnC,cAPWP,qBAOKc,oBAAmB;AACnC,cARWd,qBAQagB,aAA8B;EAAEiE,KAAK;IAAE9B,OAAO;EAAE;EAAG+B,YAAY;EAAOC,QAAQ;AAAK;AAC3G,cATWnF,qBASaiB,eAAgC;EAAEgE,KAAK;IAAEa,QAAQ;EAAE;EAAGZ,YAAY;EAAOC,QAAQ;AAAM;;AAE/G,cAXWnF,qBAWKwC,qBAAgBiD,+CAAuBzF,oBAAmBgB,SAAS;;AAEnF,cAbWhB,qBAaK+F,uBAAkBN,+CAAuBzF,oBAAmBiB,WAAW;AAblF,IAAMjB,qBAAN;AAAMA,qBAAAA,aAAAA;MADZgG,qCAAAA;GACYhG,kBAAAA;","names":["IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","dbName","config","name","defaultDbName","dbVersion","defaultDbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","indexes","hashIndex","schemaIndex","storage","allHandler","payloads","useDb","db","getAll","map","payload","PayloadHasher","jsonPayload","clearHandler","clear","deleteHandler","hashes","distinctHashes","Set","found","Promise","all","hash","existing","getKeyFromIndex","hashIndexName","delete","filter","exists","getHandler","getFromIndex","insertHandler","pairs","hashPairs","getInitializedDb","inserted","_hash","tx","transaction","store","objectStore","index","get","put","done","close","startHandler","openDB","blocked","currentVersion","blockedVersion","event","console","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","key","multiEntry","unique","indexKeys","Object","keys","length","indexName","buildStandardIndexName","createIndex","callback","configSchemas","IndexedDbArchivistConfigSchema","schema","schemaIndexName","creatableModule"]}
|