@xyo-network/archivist-indexeddb 2.92.0 → 2.92.2

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.
@@ -246,26 +246,26 @@ var IndexedDbArchivist = class _IndexedDbArchivist extends import_archivist_abst
246
246
  * @returns The initialized DB
247
247
  */
248
248
  async getInitializedDb() {
249
- const { dbName, dbVersion, indexes, storeName } = this;
249
+ const { dbName, dbVersion, indexes, storeName, logger } = this;
250
250
  const db = await (0, import_idb.openDB)(dbName, dbVersion, {
251
251
  blocked(currentVersion, blockedVersion, event) {
252
- console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
252
+ logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
253
253
  },
254
254
  blocking(currentVersion, blockedVersion, event) {
255
- console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
255
+ logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
256
256
  },
257
257
  terminated() {
258
- console.log("IndexedDbArchivist: Terminated");
258
+ logger.log("IndexedDbArchivist: Terminated");
259
259
  },
260
260
  upgrade(database, oldVersion, newVersion, transaction) {
261
261
  if (oldVersion !== newVersion) {
262
- console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
262
+ logger.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
263
263
  const objectStores = transaction.objectStoreNames;
264
264
  for (const name of objectStores) {
265
265
  try {
266
266
  database.deleteObjectStore(name);
267
267
  } catch {
268
- console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
268
+ logger.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
269
269
  }
270
270
  }
271
271
  }
@@ -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 { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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;AAEvB,gCAAkC;AAClC,6BAQO;AACP,0BAAgC;AAChC,6BAA+B;AAE/B,iBAAqC;;;ACd9B,IAAMA,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,qBAAN,MAAMA,4BAGHC,4CAAAA;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,gBAAkC;IAAEJ,KAAK;MAAEK,OAAO;IAAE;IAAGH,YAAY;IAAOC,QAAQ;EAAM;EAChH,OAAwBG,cAAgC;IAAEN,KAAK;MAAEO,QAAQ;IAAE;IAAGL,YAAY;IAAOC,QAAQ;EAAM;;EAE/G,OAAgBK,oBAAgBC,+CAAuBjB,oBAAmBO,SAAS;;EAEnF,OAAgBW,wBAAoBD,+CAAuBjB,oBAAmBY,aAAa;;EAE3F,OAAgBO,sBAAkBF,+CAAuBjB,oBAAmBc,WAAW;;;;;;;;EASvF,IAAIM,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQtB,oBAAmBI;EACxE;;;;EAKA,IAAImB,YAAY;AACd,WAAO,KAAKF,QAAQE,aAAavB,oBAAmBK;EACtD;EAEA,IAAamB,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;AACd,WAAO,KAAKR,QAAQQ,aAAa7B,oBAAmBM;EACtD;;;;EAKA,IAAYwB,UAAU;AACpB,WAAO;MAAC9B,oBAAmBY;MAAeZ,oBAAmBO;MAAWP,oBAAmBc;SAAiB,KAAKO,QAAQU,SAASD,WAAW,CAAA;;EAC/I;EAEA,MAAyBE,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKP,SAAS,CAAA;AAElE,WAAO,MAAMQ,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,sCAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKf,SAAS,CAAA;EAClD;EAEA,MAAyBgB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,sCAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGvC;MAAOuC,KAAK,CAAA;KAAG;AAE7E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIJ,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMoB,QAAQ,MAAMlB,QAAQC,IAC1Be,eAAed,IAAI,OAAOiB,SAAAA;AAExB,cAAMC,WACH,MAAMtB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBgB,eAAewC,IAAAA,KAC3E,MAAMrB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMtB,GAAGwB,OAAO,KAAK9B,WAAW4B,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMK,OAAOC,oBAAAA,EAAQD,OAAO,CAACJ,SAASV,OAAOgB,SAASN,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBO,2BACd5B,IACAN,WACAmC,WACAxD,KACgD;AAChD,UAAMyD,cAAc9B,GAAG8B,YAAYpC,WAAW,UAAA;AAC9C,UAAMqC,QAAQD,YAAYE,YAAYtC,SAAAA;AACtC,UAAMuC,QAAQF,MAAME,MAAMJ,SAAAA;AAC1B,UAAMK,SAAS,MAAMD,MAAME,WAAW9D,GAAAA;AACtC,QAAI6D,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyBtB,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBgB,eAAewC,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMkB,yBAAyB,MAAM,KAAKxC,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMqB,mBAAmB1C,SAAS2B,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACtE,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAMkE,uBAAuBL,uBAAuBd,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACxF,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI8D;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B3C,IAAI,CAAC,CAACqC,MAAMpC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB2C,cAAclD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,sCAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMhD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAAS/B,KAAAA,MAAM;AAI/B,cAAM6E,KAAKnD,GAAG8B,YAAY,KAAKpC,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAMqC,QAAQoB,GAAGnB,YAAY,KAAKtC,SAAS;AAG3C,gBAAM0D,kBAAkB,MAAMrB,MAAME,MAAMpE,oBAAmBgB,aAAa,EAAEwE,IAAI/E,KAAAA;AAEhF,cAAI,CAAC8E,iBAAiB;AAEpB,kBAAMrB,MAAMuB,IAAI;cAAE,GAAGjD;cAAS/B;YAAM,CAAA;UACtC;AAGA,iBAAO+B;QACT,UAAA;AAEE,gBAAM8C,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAOL,SAASzB,OAAOC,oBAAAA;IACzB,UAAA;AACE1B,SAAGwD,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK1D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAckD,mBAAwD;AACpE,UAAM,EAAEhE,QAAQG,WAAWO,SAASD,UAAS,IAAK;AAClD,UAAMM,KAAK,UAAM0D,mBAAqBzE,QAAQG,WAAW;MACvDuE,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,YAAYzC,aAAW;AAMnD,YAAIwC,eAAeC,YAAY;AAC7BR,kBAAQI,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE/E,gBAAMC,eAAe1C,YAAY2C;AACjC,qBAAWtF,QAAQqF,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBvF,IAAAA;YAC7B,QAAQ;AACN4E,sBAAQI,IAAI,8DAA8DhF,IAAAA,EAAM;YAClF;UACF;QACF;AAEA,cAAM4C,QAAQsC,SAASM,kBAAkBjF,WAAW;;UAElDkF,eAAe;QACjB,CAAA;AAEA7C,cAAM5C,OAAOO;AAEb,mBAAW,EAAErB,KAAKE,YAAYC,OAAM,KAAMmB,SAAS;AACjD,gBAAMkF,YAAYC,OAAOC,KAAK1G,GAAAA;AAC9B,gBAAM0G,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMhD,gBAAY/C,+CAAuB;YAAET;YAAKG;UAAO,CAAA;AACvDuD,gBAAMkD,YAAYpD,WAAWkD,MAAM;YAAExG;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOwB;EACT;;;;;;EAOA,MAAcD,MAASmF,UAA0E;AAE/F,UAAMlF,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMiC,SAASlF,EAAAA;IACxB,UAAA;AAEEA,SAAGwD,MAAK;IACV;EACF;AACF;AA5Qa3F,qBAAAA,aAAAA;MADZsH,qCAAAA;GACYtH,kBAAAA;","names":["IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","IndexedDbArchivistConfigSchema","defaultDbName","defaultDbVersion","defaultStoreName","hashIndex","key","_hash","multiEntry","unique","dataHashIndex","$hash","schemaIndex","schema","hashIndexName","buildStandardIndexName","dataHashIndexName","schemaIndexName","dbName","config","name","dbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","indexes","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","distinctHashes","Set","found","hash","existing","getKeyFromIndex","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","tx","existingTopHash","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","createIndex","callback","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 { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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, logger } = this\n const db = await openDB<PayloadStore>(dbName, dbVersion, {\n blocked(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n blocking(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n terminated() {\n logger.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 logger.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 logger.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;AAEvB,gCAAkC;AAClC,6BAQO;AACP,0BAAgC;AAChC,6BAA+B;AAE/B,iBAAqC;;;ACd9B,IAAMA,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,qBAAN,MAAMA,4BAGHC,4CAAAA;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,gBAAkC;IAAEJ,KAAK;MAAEK,OAAO;IAAE;IAAGH,YAAY;IAAOC,QAAQ;EAAM;EAChH,OAAwBG,cAAgC;IAAEN,KAAK;MAAEO,QAAQ;IAAE;IAAGL,YAAY;IAAOC,QAAQ;EAAM;;EAE/G,OAAgBK,oBAAgBC,+CAAuBjB,oBAAmBO,SAAS;;EAEnF,OAAgBW,wBAAoBD,+CAAuBjB,oBAAmBY,aAAa;;EAE3F,OAAgBO,sBAAkBF,+CAAuBjB,oBAAmBc,WAAW;;;;;;;;EASvF,IAAIM,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQtB,oBAAmBI;EACxE;;;;EAKA,IAAImB,YAAY;AACd,WAAO,KAAKF,QAAQE,aAAavB,oBAAmBK;EACtD;EAEA,IAAamB,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;AACd,WAAO,KAAKR,QAAQQ,aAAa7B,oBAAmBM;EACtD;;;;EAKA,IAAYwB,UAAU;AACpB,WAAO;MAAC9B,oBAAmBY;MAAeZ,oBAAmBO;MAAWP,oBAAmBc;SAAiB,KAAKO,QAAQU,SAASD,WAAW,CAAA;;EAC/I;EAEA,MAAyBE,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKP,SAAS,CAAA;AAElE,WAAO,MAAMQ,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,sCAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKf,SAAS,CAAA;EAClD;EAEA,MAAyBgB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,sCAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGvC;MAAOuC,KAAK,CAAA;KAAG;AAE7E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIJ,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMoB,QAAQ,MAAMlB,QAAQC,IAC1Be,eAAed,IAAI,OAAOiB,SAAAA;AAExB,cAAMC,WACH,MAAMtB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBgB,eAAewC,IAAAA,KAC3E,MAAMrB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMtB,GAAGwB,OAAO,KAAK9B,WAAW4B,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMK,OAAOC,oBAAAA,EAAQD,OAAO,CAACJ,SAASV,OAAOgB,SAASN,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBO,2BACd5B,IACAN,WACAmC,WACAxD,KACgD;AAChD,UAAMyD,cAAc9B,GAAG8B,YAAYpC,WAAW,UAAA;AAC9C,UAAMqC,QAAQD,YAAYE,YAAYtC,SAAAA;AACtC,UAAMuC,QAAQF,MAAME,MAAMJ,SAAAA;AAC1B,UAAMK,SAAS,MAAMD,MAAME,WAAW9D,GAAAA;AACtC,QAAI6D,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyBtB,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBgB,eAAewC,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMkB,yBAAyB,MAAM,KAAKxC,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMqB,mBAAmB1C,SAAS2B,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACtE,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAMkE,uBAAuBL,uBAAuBd,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACxF,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI8D;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B3C,IAAI,CAAC,CAACqC,MAAMpC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB2C,cAAclD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,sCAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMhD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAAS/B,KAAAA,MAAM;AAI/B,cAAM6E,KAAKnD,GAAG8B,YAAY,KAAKpC,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAMqC,QAAQoB,GAAGnB,YAAY,KAAKtC,SAAS;AAG3C,gBAAM0D,kBAAkB,MAAMrB,MAAME,MAAMpE,oBAAmBgB,aAAa,EAAEwE,IAAI/E,KAAAA;AAEhF,cAAI,CAAC8E,iBAAiB;AAEpB,kBAAMrB,MAAMuB,IAAI;cAAE,GAAGjD;cAAS/B;YAAM,CAAA;UACtC;AAGA,iBAAO+B;QACT,UAAA;AAEE,gBAAM8C,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAOL,SAASzB,OAAOC,oBAAAA;IACzB,UAAA;AACE1B,SAAGwD,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK1D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAckD,mBAAwD;AACpE,UAAM,EAAEhE,QAAQG,WAAWO,SAASD,WAAWgE,OAAM,IAAK;AAC1D,UAAM1D,KAAK,UAAM2D,mBAAqB1E,QAAQG,WAAW;MACvDwE,QAAQC,gBAAgBC,gBAAgBC,OAAK;AAC3CL,eAAOM,KAAK,mDAAmDH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACxG;MACAE,SAASJ,gBAAgBC,gBAAgBC,OAAK;AAC5CL,eAAOM,KAAK,6CAA6CH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MAClG;MACAG,aAAAA;AACER,eAAOS,IAAI,gCAAA;MACb;MACAC,QAAQC,UAAUC,YAAYC,YAAYzC,aAAW;AAMnD,YAAIwC,eAAeC,YAAY;AAC7Bb,iBAAOS,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE9E,gBAAMC,eAAe1C,YAAY2C;AACjC,qBAAWtF,QAAQqF,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBvF,IAAAA;YAC7B,QAAQ;AACNuE,qBAAOS,IAAI,8DAA8DhF,IAAAA,EAAM;YACjF;UACF;QACF;AAEA,cAAM4C,QAAQsC,SAASM,kBAAkBjF,WAAW;;UAElDkF,eAAe;QACjB,CAAA;AAEA7C,cAAM5C,OAAOO;AAEb,mBAAW,EAAErB,KAAKE,YAAYC,OAAM,KAAMmB,SAAS;AACjD,gBAAMkF,YAAYC,OAAOC,KAAK1G,GAAAA;AAC9B,gBAAM0G,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMhD,gBAAY/C,+CAAuB;YAAET;YAAKG;UAAO,CAAA;AACvDuD,gBAAMkD,YAAYpD,WAAWkD,MAAM;YAAExG;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOwB;EACT;;;;;;EAOA,MAAcD,MAASmF,UAA0E;AAE/F,UAAMlF,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMiC,SAASlF,EAAAA;IACxB,UAAA;AAEEA,SAAGwD,MAAK;IACV;EACF;AACF;AA5Qa3F,qBAAAA,aAAAA;MADZsH,qCAAAA;GACYtH,kBAAAA;","names":["IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","IndexedDbArchivistConfigSchema","defaultDbName","defaultDbVersion","defaultStoreName","hashIndex","key","_hash","multiEntry","unique","dataHashIndex","$hash","schemaIndex","schema","hashIndexName","buildStandardIndexName","dataHashIndexName","schemaIndexName","dbName","config","name","dbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","indexes","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","distinctHashes","Set","found","hash","existing","getKeyFromIndex","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","tx","existingTopHash","get","put","done","close","startHandler","logger","openDB","blocked","currentVersion","blockedVersion","event","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","indexKeys","Object","keys","length","createIndex","callback","creatableModule"]}
@@ -220,26 +220,26 @@ var IndexedDbArchivist = class _IndexedDbArchivist extends AbstractArchivist {
220
220
  * @returns The initialized DB
221
221
  */
222
222
  async getInitializedDb() {
223
- const { dbName, dbVersion, indexes, storeName } = this;
223
+ const { dbName, dbVersion, indexes, storeName, logger } = this;
224
224
  const db = await openDB(dbName, dbVersion, {
225
225
  blocked(currentVersion, blockedVersion, event) {
226
- console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
226
+ logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
227
227
  },
228
228
  blocking(currentVersion, blockedVersion, event) {
229
- console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
229
+ logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
230
230
  },
231
231
  terminated() {
232
- console.log("IndexedDbArchivist: Terminated");
232
+ logger.log("IndexedDbArchivist: Terminated");
233
233
  },
234
234
  upgrade(database, oldVersion, newVersion, transaction) {
235
235
  if (oldVersion !== newVersion) {
236
- console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
236
+ logger.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
237
237
  const objectStores = transaction.objectStoreNames;
238
238
  for (const name of objectStores) {
239
239
  try {
240
240
  database.deleteObjectStore(name);
241
241
  } catch {
242
- console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
242
+ logger.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
243
243
  }
244
244
  }
245
245
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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;AAEvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,8BAEK;AACP,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;AAE/B,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,gBAAkC;IAAEJ,KAAK;MAAEK,OAAO;IAAE;IAAGH,YAAY;IAAOC,QAAQ;EAAM;EAChH,OAAwBG,cAAgC;IAAEN,KAAK;MAAEO,QAAQ;IAAE;IAAGL,YAAY;IAAOC,QAAQ;EAAM;;EAE/G,OAAgBK,gBAAgBC,uBAAuBjB,oBAAmBO,SAAS;;EAEnF,OAAgBW,oBAAoBD,uBAAuBjB,oBAAmBY,aAAa;;EAE3F,OAAgBO,kBAAkBF,uBAAuBjB,oBAAmBc,WAAW;;;;;;;;EASvF,IAAIM,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQtB,oBAAmBI;EACxE;;;;EAKA,IAAImB,YAAY;AACd,WAAO,KAAKF,QAAQE,aAAavB,oBAAmBK;EACtD;EAEA,IAAamB,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;AACd,WAAO,KAAKR,QAAQQ,aAAa7B,oBAAmBM;EACtD;;;;EAKA,IAAYwB,UAAU;AACpB,WAAO;MAAC9B,oBAAmBY;MAAeZ,oBAAmBO;MAAWP,oBAAmBc;SAAiB,KAAKO,QAAQU,SAASD,WAAW,CAAA;;EAC/I;EAEA,MAAyBE,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKP,SAAS,CAAA;AAElE,WAAO,MAAMQ,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,eAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKf,SAAS,CAAA;EAClD;EAEA,MAAyBgB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,eAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGvC;MAAOuC,KAAK,CAAA;KAAG;AAE7E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIJ,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMoB,QAAQ,MAAMlB,QAAQC,IAC1Be,eAAed,IAAI,OAAOiB,SAAAA;AAExB,cAAMC,WACH,MAAMtB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBgB,eAAewC,IAAAA,KAC3E,MAAMrB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMtB,GAAGwB,OAAO,KAAK9B,WAAW4B,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMK,OAAOC,MAAAA,EAAQD,OAAO,CAACJ,SAASV,OAAOgB,SAASN,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBO,2BACd5B,IACAN,WACAmC,WACAxD,KACgD;AAChD,UAAMyD,cAAc9B,GAAG8B,YAAYpC,WAAW,UAAA;AAC9C,UAAMqC,QAAQD,YAAYE,YAAYtC,SAAAA;AACtC,UAAMuC,QAAQF,MAAME,MAAMJ,SAAAA;AAC1B,UAAMK,SAAS,MAAMD,MAAME,WAAW9D,GAAAA;AACtC,QAAI6D,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyBtB,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBgB,eAAewC,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMkB,yBAAyB,MAAM,KAAKxC,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMqB,mBAAmB1C,SAAS2B,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACtE,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAMkE,uBAAuBL,uBAAuBd,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACxF,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI8D;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B3C,IAAI,CAAC,CAACqC,MAAMpC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB2C,cAAclD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,eAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMhD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAAS/B,KAAAA,MAAM;AAI/B,cAAM6E,KAAKnD,GAAG8B,YAAY,KAAKpC,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAMqC,QAAQoB,GAAGnB,YAAY,KAAKtC,SAAS;AAG3C,gBAAM0D,kBAAkB,MAAMrB,MAAME,MAAMpE,oBAAmBgB,aAAa,EAAEwE,IAAI/E,KAAAA;AAEhF,cAAI,CAAC8E,iBAAiB;AAEpB,kBAAMrB,MAAMuB,IAAI;cAAE,GAAGjD;cAAS/B;YAAM,CAAA;UACtC;AAGA,iBAAO+B;QACT,UAAA;AAEE,gBAAM8C,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAOL,SAASzB,OAAOC,MAAAA;IACzB,UAAA;AACE1B,SAAGwD,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK1D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAckD,mBAAwD;AACpE,UAAM,EAAEhE,QAAQG,WAAWO,SAASD,UAAS,IAAK;AAClD,UAAMM,KAAK,MAAM0D,OAAqBzE,QAAQG,WAAW;MACvDuE,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,YAAYzC,aAAW;AAMnD,YAAIwC,eAAeC,YAAY;AAC7BR,kBAAQI,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE/E,gBAAMC,eAAe1C,YAAY2C;AACjC,qBAAWtF,QAAQqF,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBvF,IAAAA;YAC7B,QAAQ;AACN4E,sBAAQI,IAAI,8DAA8DhF,IAAAA,EAAM;YAClF;UACF;QACF;AAEA,cAAM4C,QAAQsC,SAASM,kBAAkBjF,WAAW;;UAElDkF,eAAe;QACjB,CAAA;AAEA7C,cAAM5C,OAAOO;AAEb,mBAAW,EAAErB,KAAKE,YAAYC,OAAM,KAAMmB,SAAS;AACjD,gBAAMkF,YAAYC,OAAOC,KAAK1G,GAAAA;AAC9B,gBAAM0G,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMhD,YAAY/C,uBAAuB;YAAET;YAAKG;UAAO,CAAA;AACvDuD,gBAAMkD,YAAYpD,WAAWkD,MAAM;YAAExG;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOwB;EACT;;;;;;EAOA,MAAcD,MAASmF,UAA0E;AAE/F,UAAMlF,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMiC,SAASlF,EAAAA;IACxB,UAAA;AAEEA,SAAGwD,MAAK;IACV;EACF;AACF;AA5Qa3F,qBAAAA,aAAAA;EADZsH,gBAAAA;GACYtH,kBAAAA;","names":["exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","buildStandardIndexName","creatableModule","PayloadBuilder","openDB","IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","IndexedDbArchivistConfigSchema","defaultDbName","defaultDbVersion","defaultStoreName","hashIndex","key","_hash","multiEntry","unique","dataHashIndex","$hash","schemaIndex","schema","hashIndexName","buildStandardIndexName","dataHashIndexName","schemaIndexName","dbName","config","name","dbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","indexes","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","distinctHashes","Set","found","hash","existing","getKeyFromIndex","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","tx","existingTopHash","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","createIndex","callback","creatableModule"]}
1
+ {"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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, logger } = this\n const db = await openDB<PayloadStore>(dbName, dbVersion, {\n blocked(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n blocking(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n terminated() {\n logger.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 logger.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 logger.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;AAEvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,8BAEK;AACP,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;AAE/B,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,gBAAkC;IAAEJ,KAAK;MAAEK,OAAO;IAAE;IAAGH,YAAY;IAAOC,QAAQ;EAAM;EAChH,OAAwBG,cAAgC;IAAEN,KAAK;MAAEO,QAAQ;IAAE;IAAGL,YAAY;IAAOC,QAAQ;EAAM;;EAE/G,OAAgBK,gBAAgBC,uBAAuBjB,oBAAmBO,SAAS;;EAEnF,OAAgBW,oBAAoBD,uBAAuBjB,oBAAmBY,aAAa;;EAE3F,OAAgBO,kBAAkBF,uBAAuBjB,oBAAmBc,WAAW;;;;;;;;EASvF,IAAIM,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQtB,oBAAmBI;EACxE;;;;EAKA,IAAImB,YAAY;AACd,WAAO,KAAKF,QAAQE,aAAavB,oBAAmBK;EACtD;EAEA,IAAamB,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;EAMA,IAAIK,YAAY;AACd,WAAO,KAAKR,QAAQQ,aAAa7B,oBAAmBM;EACtD;;;;EAKA,IAAYwB,UAAU;AACpB,WAAO;MAAC9B,oBAAmBY;MAAeZ,oBAAmBO;MAAWP,oBAAmBc;SAAiB,KAAKO,QAAQU,SAASD,WAAW,CAAA;;EAC/I;EAEA,MAAyBE,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKP,SAAS,CAAA;AAElE,WAAO,MAAMQ,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,eAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKf,SAAS,CAAA;EAClD;EAEA,MAAyBgB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,eAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGvC;MAAOuC,KAAK,CAAA;KAAG;AAE7E,UAAMC,iBAAiB;SAAI,IAAIC,IAAIJ,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMoB,QAAQ,MAAMlB,QAAQC,IAC1Be,eAAed,IAAI,OAAOiB,SAAAA;AAExB,cAAMC,WACH,MAAMtB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBgB,eAAewC,IAAAA,KAC3E,MAAMrB,GAAGuB,gBAAgB,KAAK7B,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMtB,GAAGwB,OAAO,KAAK9B,WAAW4B,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMK,OAAOC,MAAAA,EAAQD,OAAO,CAACJ,SAASV,OAAOgB,SAASN,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBO,2BACd5B,IACAN,WACAmC,WACAxD,KACgD;AAChD,UAAMyD,cAAc9B,GAAG8B,YAAYpC,WAAW,UAAA;AAC9C,UAAMqC,QAAQD,YAAYE,YAAYtC,SAAAA;AACtC,UAAMuC,QAAQF,MAAME,MAAMJ,SAAAA;AAC1B,UAAMK,SAAS,MAAMD,MAAME,WAAW9D,GAAAA;AACtC,QAAI6D,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyBtB,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBgB,eAAewC,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMkB,yBAAyB,MAAM,KAAKxC,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACiB,SAAS,KAAKO,2BAA2B5B,IAAI,KAAKN,WAAW7B,oBAAmBkB,mBAAmBsC,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMqB,mBAAmB1C,SAAS2B,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACtE,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAMkE,uBAAuBL,uBAAuBd,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACgB,MAAMpC,OAAAA,MAAQ;AACxF,UAAIe,MAAMsB,IAAIrC,QAAQ3B,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACL0C,cAAMuB,IAAItC,QAAQ3B,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI8D;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B3C,IAAI,CAAC,CAACqC,MAAMpC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB2C,cAAclD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,eAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMhD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAAS/B,KAAAA,MAAM;AAI/B,cAAM6E,KAAKnD,GAAG8B,YAAY,KAAKpC,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAMqC,QAAQoB,GAAGnB,YAAY,KAAKtC,SAAS;AAG3C,gBAAM0D,kBAAkB,MAAMrB,MAAME,MAAMpE,oBAAmBgB,aAAa,EAAEwE,IAAI/E,KAAAA;AAEhF,cAAI,CAAC8E,iBAAiB;AAEpB,kBAAMrB,MAAMuB,IAAI;cAAE,GAAGjD;cAAS/B;YAAM,CAAA;UACtC;AAGA,iBAAO+B;QACT,UAAA;AAEE,gBAAM8C,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAOL,SAASzB,OAAOC,MAAAA;IACzB,UAAA;AACE1B,SAAGwD,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK1D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAckD,mBAAwD;AACpE,UAAM,EAAEhE,QAAQG,WAAWO,SAASD,WAAWgE,OAAM,IAAK;AAC1D,UAAM1D,KAAK,MAAM2D,OAAqB1E,QAAQG,WAAW;MACvDwE,QAAQC,gBAAgBC,gBAAgBC,OAAK;AAC3CL,eAAOM,KAAK,mDAAmDH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACxG;MACAE,SAASJ,gBAAgBC,gBAAgBC,OAAK;AAC5CL,eAAOM,KAAK,6CAA6CH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MAClG;MACAG,aAAAA;AACER,eAAOS,IAAI,gCAAA;MACb;MACAC,QAAQC,UAAUC,YAAYC,YAAYzC,aAAW;AAMnD,YAAIwC,eAAeC,YAAY;AAC7Bb,iBAAOS,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE9E,gBAAMC,eAAe1C,YAAY2C;AACjC,qBAAWtF,QAAQqF,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBvF,IAAAA;YAC7B,QAAQ;AACNuE,qBAAOS,IAAI,8DAA8DhF,IAAAA,EAAM;YACjF;UACF;QACF;AAEA,cAAM4C,QAAQsC,SAASM,kBAAkBjF,WAAW;;UAElDkF,eAAe;QACjB,CAAA;AAEA7C,cAAM5C,OAAOO;AAEb,mBAAW,EAAErB,KAAKE,YAAYC,OAAM,KAAMmB,SAAS;AACjD,gBAAMkF,YAAYC,OAAOC,KAAK1G,GAAAA;AAC9B,gBAAM0G,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMhD,YAAY/C,uBAAuB;YAAET;YAAKG;UAAO,CAAA;AACvDuD,gBAAMkD,YAAYpD,WAAWkD,MAAM;YAAExG;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOwB;EACT;;;;;;EAOA,MAAcD,MAASmF,UAA0E;AAE/F,UAAMlF,KAAK,MAAM,KAAKiD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMiC,SAASlF,EAAAA;IACxB,UAAA;AAEEA,SAAGwD,MAAK;IACV;EACF;AACF;AA5Qa3F,qBAAAA,aAAAA;EADZsH,gBAAAA;GACYtH,kBAAAA;","names":["exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","buildStandardIndexName","creatableModule","PayloadBuilder","openDB","IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","IndexedDbArchivistConfigSchema","defaultDbName","defaultDbVersion","defaultStoreName","hashIndex","key","_hash","multiEntry","unique","dataHashIndex","$hash","schemaIndex","schema","hashIndexName","buildStandardIndexName","dataHashIndexName","schemaIndexName","dbName","config","name","dbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","indexes","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","distinctHashes","Set","found","hash","existing","getKeyFromIndex","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","tx","existingTopHash","get","put","done","close","startHandler","logger","openDB","blocked","currentVersion","blockedVersion","event","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","indexKeys","Object","keys","length","createIndex","callback","creatableModule"]}
@@ -219,26 +219,26 @@ var _IndexedDbArchivist = class _IndexedDbArchivist extends import_archivist_abs
219
219
  * @returns The initialized DB
220
220
  */
221
221
  async getInitializedDb() {
222
- const { dbName, dbVersion, indexes, storeName } = this;
222
+ const { dbName, dbVersion, indexes, storeName, logger } = this;
223
223
  const db = await (0, import_idb.openDB)(dbName, dbVersion, {
224
224
  blocked(currentVersion, blockedVersion, event) {
225
- console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
225
+ logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
226
226
  },
227
227
  blocking(currentVersion, blockedVersion, event) {
228
- console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
228
+ logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
229
229
  },
230
230
  terminated() {
231
- console.log("IndexedDbArchivist: Terminated");
231
+ logger.log("IndexedDbArchivist: Terminated");
232
232
  },
233
233
  upgrade(database, oldVersion, newVersion, transaction) {
234
234
  if (oldVersion !== newVersion) {
235
- console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
235
+ logger.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
236
236
  const objectStores = transaction.objectStoreNames;
237
237
  for (const name of objectStores) {
238
238
  try {
239
239
  database.deleteObjectStore(name);
240
240
  } catch {
241
- console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
241
+ logger.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
242
242
  }
243
243
  }
244
244
  }
@@ -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 { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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;AAEvB,gCAAkC;AAClC,6BAQO;AACP,0BAAgC;AAChC,6BAA+B;AAE/B,iBAAqC;;;ACd9B,IAAMA,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,sBAAN,MAAMA,4BAGHC,4CAAAA;;;;;;;;EAsBR,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;MAAehB,oBAAmBiB;MAAWjB,oBAAmBkB;WAAiB,gBAAKf,WAAL,mBAAagB,YAAb,mBAAsBJ,YAAW,CAAA;;EAC/I;EAEA,MAAyBK,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKX,SAAS,CAAA;AAElE,WAAO,MAAMY,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,sCAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKnB,SAAS,CAAA;EAClD;EAEA,MAAyBoB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,sCAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGC;MAAOD,KAAK,CAAA;KAAG;AAE7E,UAAME,iBAAiB;SAAI,IAAIC,IAAIL,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMqB,QAAQ,MAAMnB,QAAQC,IAC1BgB,eAAef,IAAI,OAAOkB,SAAAA;AAExB,cAAMC,WACH,MAAMvB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBgD,eAAeH,IAAAA,KAC3E,MAAMtB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMvB,GAAG2B,OAAO,KAAKrC,WAAWiC,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMO,OAAOC,oBAAAA,EAAQD,OAAO,CAACN,SAASX,OAAOmB,SAASR,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBS,2BACd/B,IACAV,WACA0C,WACAC,KACgD;AAChD,UAAMC,cAAclC,GAAGkC,YAAY5C,WAAW,UAAA;AAC9C,UAAM6C,QAAQD,YAAYE,YAAY9C,SAAAA;AACtC,UAAM+C,QAAQF,MAAME,MAAML,SAAAA;AAC1B,UAAMM,SAAS,MAAMD,MAAME,WAAWN,GAAAA;AACtC,QAAIK,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyB1B,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBgD,eAAeH,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMqB,yBAAyB,MAAM,KAAK5C,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMwB,mBAAmB9C,SAAS8B,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACtE,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAM8B,uBAAuBL,uBAAuBf,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACxF,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI0B;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B/C,IAAI,CAAC,CAACyC,MAAMxC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB+C,cAActD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,sCAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMpD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAASkD,KAAAA,MAAM;AAI/B,cAAMC,KAAKxD,GAAGkC,YAAY,KAAK5C,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAM6C,QAAQqB,GAAGpB,YAAY,KAAK9C,SAAS;AAG3C,gBAAMmE,kBAAkB,MAAMtB,MAAME,MAAM5D,oBAAmBgD,aAAa,EAAEiC,IAAIH,KAAAA;AAEhF,cAAI,CAACE,iBAAiB;AAEpB,kBAAMtB,MAAMwB,IAAI;cAAE,GAAGtD;cAASkD;YAAM,CAAA;UACtC;AAGA,iBAAOlD;QACT,UAAA;AAEE,gBAAMmD,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAON,SAAS1B,OAAOC,oBAAAA;IACzB,UAAA;AACE7B,SAAG6D,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK/D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAcsD,mBAAwD;AACpE,UAAM,EAAE1E,QAAQI,WAAWS,SAASF,UAAS,IAAK;AAClD,UAAMU,KAAK,UAAM+D,mBAAqBpF,QAAQI,WAAW;MACvDiF,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,YAAY1C,aAAW;AAMnD,YAAIyC,eAAeC,YAAY;AAC7BR,kBAAQI,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE/E,gBAAMC,eAAe3C,YAAY4C;AACjC,qBAAWjG,QAAQgG,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBlG,IAAAA;YAC7B,QAAQ;AACNuF,sBAAQI,IAAI,8DAA8D3F,IAAAA,EAAM;YAClF;UACF;QACF;AAEA,cAAMsD,QAAQuC,SAASM,kBAAkB1F,WAAW;;UAElD2F,eAAe;QACjB,CAAA;AAEA9C,cAAMtD,OAAOS;AAEb,mBAAW,EAAE2C,KAAKiD,YAAYC,OAAM,KAAM3F,SAAS;AACjD,gBAAM4F,YAAYC,OAAOC,KAAKrD,GAAAA;AAC9B,gBAAMqD,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMpD,gBAAYwD,+CAAuB;YAAEvD;YAAKkD;UAAO,CAAA;AACvDhD,gBAAMsD,YAAYzD,WAAWsD,MAAM;YAAEJ;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOnF;EACT;;;;;;EAOA,MAAcD,MAAS2F,UAA0E;AAE/F,UAAM1F,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMqC,SAAS1F,EAAAA;IACxB,UAAA;AAEEA,SAAG6D,MAAK;IACV;EACF;AACF;AAzQUnF;AACR,cAJWD,qBAIKkH,iBAAgB;EAACC;;AACjC,cALWnH,qBAKKK,iBAAgB;AAChC,cANWL,qBAMKO,oBAAmB;AACnC,cAPWP,qBAOKc,oBAAmB;AACnC,cARWd,qBAQaiB,aAA8B;EAAEuC,KAAK;IAAEsB,OAAO;EAAE;EAAG2B,YAAY;EAAOC,QAAQ;AAAK;AAC3G,cATW1G,qBASagB,iBAAkC;EAAEwC,KAAK;IAAEf,OAAO;EAAE;EAAGgE,YAAY;EAAOC,QAAQ;AAAM;AAChH,cAVW1G,qBAUakB,eAAgC;EAAEsC,KAAK;IAAE4D,QAAQ;EAAE;EAAGX,YAAY;EAAOC,QAAQ;AAAM;;AAE/G,cAZW1G,qBAYKgD,qBAAgB+D,+CAAuB/G,oBAAmBiB,SAAS;;AAEnF,cAdWjB,qBAcKiD,yBAAoB8D,+CAAuB/G,oBAAmBgB,aAAa;;AAE3F,cAhBWhB,qBAgBKqH,uBAAkBN,+CAAuB/G,oBAAmBkB,WAAW;AAhBlF,IAAMlB,qBAAN;AAAMA,qBAAAA,aAAAA;MADZsH,qCAAAA;GACYtH,kBAAAA;","names":["IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","dbName","config","name","defaultDbName","dbVersion","defaultDbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","indexes","dataHashIndex","hashIndex","schemaIndex","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","$hash","distinctHashes","Set","found","hash","existing","getKeyFromIndex","hashIndexName","dataHashIndexName","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","key","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","_hash","tx","existingTopHash","get","put","done","close","startHandler","openDB","blocked","currentVersion","blockedVersion","event","console","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","multiEntry","unique","indexKeys","Object","keys","length","buildStandardIndexName","createIndex","callback","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 { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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, logger } = this\n const db = await openDB<PayloadStore>(dbName, dbVersion, {\n blocked(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n blocking(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n terminated() {\n logger.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 logger.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 logger.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;AAEvB,gCAAkC;AAClC,6BAQO;AACP,0BAAgC;AAChC,6BAA+B;AAE/B,iBAAqC;;;ACd9B,IAAMA,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,sBAAN,MAAMA,4BAGHC,4CAAAA;;;;;;;;EAsBR,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;MAAehB,oBAAmBiB;MAAWjB,oBAAmBkB;WAAiB,gBAAKf,WAAL,mBAAagB,YAAb,mBAAsBJ,YAAW,CAAA;;EAC/I;EAEA,MAAyBK,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKX,SAAS,CAAA;AAElE,WAAO,MAAMY,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,sCAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKnB,SAAS,CAAA;EAClD;EAEA,MAAyBoB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,sCAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGC;MAAOD,KAAK,CAAA;KAAG;AAE7E,UAAME,iBAAiB;SAAI,IAAIC,IAAIL,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMqB,QAAQ,MAAMnB,QAAQC,IAC1BgB,eAAef,IAAI,OAAOkB,SAAAA;AAExB,cAAMC,WACH,MAAMvB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBgD,eAAeH,IAAAA,KAC3E,MAAMtB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMvB,GAAG2B,OAAO,KAAKrC,WAAWiC,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMO,OAAOC,oBAAAA,EAAQD,OAAO,CAACN,SAASX,OAAOmB,SAASR,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBS,2BACd/B,IACAV,WACA0C,WACAC,KACgD;AAChD,UAAMC,cAAclC,GAAGkC,YAAY5C,WAAW,UAAA;AAC9C,UAAM6C,QAAQD,YAAYE,YAAY9C,SAAAA;AACtC,UAAM+C,QAAQF,MAAME,MAAML,SAAAA;AAC1B,UAAMM,SAAS,MAAMD,MAAME,WAAWN,GAAAA;AACtC,QAAIK,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyB1B,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBgD,eAAeH,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMqB,yBAAyB,MAAM,KAAK5C,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMwB,mBAAmB9C,SAAS8B,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACtE,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAM8B,uBAAuBL,uBAAuBf,OAAOC,oBAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACxF,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI0B;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B/C,IAAI,CAAC,CAACyC,MAAMxC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB+C,cAActD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,sCAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMpD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAASkD,KAAAA,MAAM;AAI/B,cAAMC,KAAKxD,GAAGkC,YAAY,KAAK5C,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAM6C,QAAQqB,GAAGpB,YAAY,KAAK9C,SAAS;AAG3C,gBAAMmE,kBAAkB,MAAMtB,MAAME,MAAM5D,oBAAmBgD,aAAa,EAAEiC,IAAIH,KAAAA;AAEhF,cAAI,CAACE,iBAAiB;AAEpB,kBAAMtB,MAAMwB,IAAI;cAAE,GAAGtD;cAASkD;YAAM,CAAA;UACtC;AAGA,iBAAOlD;QACT,UAAA;AAEE,gBAAMmD,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAON,SAAS1B,OAAOC,oBAAAA;IACzB,UAAA;AACE7B,SAAG6D,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK/D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAcsD,mBAAwD;AACpE,UAAM,EAAE1E,QAAQI,WAAWS,SAASF,WAAWyE,OAAM,IAAK;AAC1D,UAAM/D,KAAK,UAAMgE,mBAAqBrF,QAAQI,WAAW;MACvDkF,QAAQC,gBAAgBC,gBAAgBC,OAAK;AAC3CL,eAAOM,KAAK,mDAAmDH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACxG;MACAE,SAASJ,gBAAgBC,gBAAgBC,OAAK;AAC5CL,eAAOM,KAAK,6CAA6CH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MAClG;MACAG,aAAAA;AACER,eAAOS,IAAI,gCAAA;MACb;MACAC,QAAQC,UAAUC,YAAYC,YAAY1C,aAAW;AAMnD,YAAIyC,eAAeC,YAAY;AAC7Bb,iBAAOS,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE9E,gBAAMC,eAAe3C,YAAY4C;AACjC,qBAAWjG,QAAQgG,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBlG,IAAAA;YAC7B,QAAQ;AACNkF,qBAAOS,IAAI,8DAA8D3F,IAAAA,EAAM;YACjF;UACF;QACF;AAEA,cAAMsD,QAAQuC,SAASM,kBAAkB1F,WAAW;;UAElD2F,eAAe;QACjB,CAAA;AAEA9C,cAAMtD,OAAOS;AAEb,mBAAW,EAAE2C,KAAKiD,YAAYC,OAAM,KAAM3F,SAAS;AACjD,gBAAM4F,YAAYC,OAAOC,KAAKrD,GAAAA;AAC9B,gBAAMqD,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMpD,gBAAYwD,+CAAuB;YAAEvD;YAAKkD;UAAO,CAAA;AACvDhD,gBAAMsD,YAAYzD,WAAWsD,MAAM;YAAEJ;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOnF;EACT;;;;;;EAOA,MAAcD,MAAS2F,UAA0E;AAE/F,UAAM1F,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMqC,SAAS1F,EAAAA;IACxB,UAAA;AAEEA,SAAG6D,MAAK;IACV;EACF;AACF;AAzQUnF;AACR,cAJWD,qBAIKkH,iBAAgB;EAACC;;AACjC,cALWnH,qBAKKK,iBAAgB;AAChC,cANWL,qBAMKO,oBAAmB;AACnC,cAPWP,qBAOKc,oBAAmB;AACnC,cARWd,qBAQaiB,aAA8B;EAAEuC,KAAK;IAAEsB,OAAO;EAAE;EAAG2B,YAAY;EAAOC,QAAQ;AAAK;AAC3G,cATW1G,qBASagB,iBAAkC;EAAEwC,KAAK;IAAEf,OAAO;EAAE;EAAGgE,YAAY;EAAOC,QAAQ;AAAM;AAChH,cAVW1G,qBAUakB,eAAgC;EAAEsC,KAAK;IAAE4D,QAAQ;EAAE;EAAGX,YAAY;EAAOC,QAAQ;AAAM;;AAE/G,cAZW1G,qBAYKgD,qBAAgB+D,+CAAuB/G,oBAAmBiB,SAAS;;AAEnF,cAdWjB,qBAcKiD,yBAAoB8D,+CAAuB/G,oBAAmBgB,aAAa;;AAE3F,cAhBWhB,qBAgBKqH,uBAAkBN,+CAAuB/G,oBAAmBkB,WAAW;AAhBlF,IAAMlB,qBAAN;AAAMA,qBAAAA,aAAAA;MADZsH,qCAAAA;GACYtH,kBAAAA;","names":["IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","dbName","config","name","defaultDbName","dbVersion","defaultDbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","indexes","dataHashIndex","hashIndex","schemaIndex","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","$hash","distinctHashes","Set","found","hash","existing","getKeyFromIndex","hashIndexName","dataHashIndexName","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","key","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","_hash","tx","existingTopHash","get","put","done","close","startHandler","logger","openDB","blocked","currentVersion","blockedVersion","event","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","multiEntry","unique","indexKeys","Object","keys","length","buildStandardIndexName","createIndex","callback","configSchemas","IndexedDbArchivistConfigSchema","schema","schemaIndexName","creatableModule"]}
@@ -193,26 +193,26 @@ var _IndexedDbArchivist = class _IndexedDbArchivist extends AbstractArchivist {
193
193
  * @returns The initialized DB
194
194
  */
195
195
  async getInitializedDb() {
196
- const { dbName, dbVersion, indexes, storeName } = this;
196
+ const { dbName, dbVersion, indexes, storeName, logger } = this;
197
197
  const db = await openDB(dbName, dbVersion, {
198
198
  blocked(currentVersion, blockedVersion, event) {
199
- console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
199
+ logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event);
200
200
  },
201
201
  blocking(currentVersion, blockedVersion, event) {
202
- console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
202
+ logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event);
203
203
  },
204
204
  terminated() {
205
- console.log("IndexedDbArchivist: Terminated");
205
+ logger.log("IndexedDbArchivist: Terminated");
206
206
  },
207
207
  upgrade(database, oldVersion, newVersion, transaction) {
208
208
  if (oldVersion !== newVersion) {
209
- console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
209
+ logger.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`);
210
210
  const objectStores = transaction.objectStoreNames;
211
211
  for (const name of objectStores) {
212
212
  try {
213
213
  database.deleteObjectStore(name);
214
214
  } catch {
215
- console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
215
+ logger.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`);
216
216
  }
217
217
  }
218
218
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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;AAEvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,8BAEK;AACP,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;AAE/B,SAAuBC,cAAc;;;ACd9B,IAAMC,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,sBAAN,MAAMA,4BAGHC,kBAAAA;;;;;;;;EAsBR,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;MAAehB,oBAAmBiB;MAAWjB,oBAAmBkB;WAAiB,gBAAKf,WAAL,mBAAagB,YAAb,mBAAsBJ,YAAW,CAAA;;EAC/I;EAEA,MAAyBK,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKX,SAAS,CAAA;AAElE,WAAO,MAAMY,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,eAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKnB,SAAS,CAAA;EAClD;EAEA,MAAyBoB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,eAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGC;MAAOD,KAAK,CAAA;KAAG;AAE7E,UAAME,iBAAiB;SAAI,IAAIC,IAAIL,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMqB,QAAQ,MAAMnB,QAAQC,IAC1BgB,eAAef,IAAI,OAAOkB,SAAAA;AAExB,cAAMC,WACH,MAAMvB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBgD,eAAeH,IAAAA,KAC3E,MAAMtB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMvB,GAAG2B,OAAO,KAAKrC,WAAWiC,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMO,OAAOC,MAAAA,EAAQD,OAAO,CAACN,SAASX,OAAOmB,SAASR,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBS,2BACd/B,IACAV,WACA0C,WACAC,KACgD;AAChD,UAAMC,cAAclC,GAAGkC,YAAY5C,WAAW,UAAA;AAC9C,UAAM6C,QAAQD,YAAYE,YAAY9C,SAAAA;AACtC,UAAM+C,QAAQF,MAAME,MAAML,SAAAA;AAC1B,UAAMM,SAAS,MAAMD,MAAME,WAAWN,GAAAA;AACtC,QAAIK,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyB1B,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBgD,eAAeH,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMqB,yBAAyB,MAAM,KAAK5C,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMwB,mBAAmB9C,SAAS8B,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACtE,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAM8B,uBAAuBL,uBAAuBf,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACxF,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI0B;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B/C,IAAI,CAAC,CAACyC,MAAMxC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB+C,cAActD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,eAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMpD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAASkD,KAAAA,MAAM;AAI/B,cAAMC,KAAKxD,GAAGkC,YAAY,KAAK5C,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAM6C,QAAQqB,GAAGpB,YAAY,KAAK9C,SAAS;AAG3C,gBAAMmE,kBAAkB,MAAMtB,MAAME,MAAM5D,oBAAmBgD,aAAa,EAAEiC,IAAIH,KAAAA;AAEhF,cAAI,CAACE,iBAAiB;AAEpB,kBAAMtB,MAAMwB,IAAI;cAAE,GAAGtD;cAASkD;YAAM,CAAA;UACtC;AAGA,iBAAOlD;QACT,UAAA;AAEE,gBAAMmD,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAON,SAAS1B,OAAOC,MAAAA;IACzB,UAAA;AACE7B,SAAG6D,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK/D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAcsD,mBAAwD;AACpE,UAAM,EAAE1E,QAAQI,WAAWS,SAASF,UAAS,IAAK;AAClD,UAAMU,KAAK,MAAM+D,OAAqBpF,QAAQI,WAAW;MACvDiF,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,YAAY1C,aAAW;AAMnD,YAAIyC,eAAeC,YAAY;AAC7BR,kBAAQI,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE/E,gBAAMC,eAAe3C,YAAY4C;AACjC,qBAAWjG,QAAQgG,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBlG,IAAAA;YAC7B,QAAQ;AACNuF,sBAAQI,IAAI,8DAA8D3F,IAAAA,EAAM;YAClF;UACF;QACF;AAEA,cAAMsD,QAAQuC,SAASM,kBAAkB1F,WAAW;;UAElD2F,eAAe;QACjB,CAAA;AAEA9C,cAAMtD,OAAOS;AAEb,mBAAW,EAAE2C,KAAKiD,YAAYC,OAAM,KAAM3F,SAAS;AACjD,gBAAM4F,YAAYC,OAAOC,KAAKrD,GAAAA;AAC9B,gBAAMqD,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMpD,YAAYwD,uBAAuB;YAAEvD;YAAKkD;UAAO,CAAA;AACvDhD,gBAAMsD,YAAYzD,WAAWsD,MAAM;YAAEJ;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOnF;EACT;;;;;;EAOA,MAAcD,MAAS2F,UAA0E;AAE/F,UAAM1F,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMqC,SAAS1F,EAAAA;IACxB,UAAA;AAEEA,SAAG6D,MAAK;IACV;EACF;AACF;AAzQUnF;AACR,cAJWD,qBAIKkH,iBAAgB;EAACC;;AACjC,cALWnH,qBAKKK,iBAAgB;AAChC,cANWL,qBAMKO,oBAAmB;AACnC,cAPWP,qBAOKc,oBAAmB;AACnC,cARWd,qBAQaiB,aAA8B;EAAEuC,KAAK;IAAEsB,OAAO;EAAE;EAAG2B,YAAY;EAAOC,QAAQ;AAAK;AAC3G,cATW1G,qBASagB,iBAAkC;EAAEwC,KAAK;IAAEf,OAAO;EAAE;EAAGgE,YAAY;EAAOC,QAAQ;AAAM;AAChH,cAVW1G,qBAUakB,eAAgC;EAAEsC,KAAK;IAAE4D,QAAQ;EAAE;EAAGX,YAAY;EAAOC,QAAQ;AAAM;;AAE/G,cAZW1G,qBAYKgD,iBAAgB+D,uBAAuB/G,oBAAmBiB,SAAS;;AAEnF,cAdWjB,qBAcKiD,qBAAoB8D,uBAAuB/G,oBAAmBgB,aAAa;;AAE3F,cAhBWhB,qBAgBKqH,mBAAkBN,uBAAuB/G,oBAAmBkB,WAAW;AAhBlF,IAAMlB,qBAAN;AAAMA,qBAAAA,aAAAA;EADZsH,gBAAAA;GACYtH,kBAAAA;","names":["exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","buildStandardIndexName","creatableModule","PayloadBuilder","openDB","IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","dbName","config","name","defaultDbName","dbVersion","defaultDbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","indexes","dataHashIndex","hashIndex","schemaIndex","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","$hash","distinctHashes","Set","found","hash","existing","getKeyFromIndex","hashIndexName","dataHashIndexName","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","key","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","_hash","tx","existingTopHash","get","put","done","close","startHandler","openDB","blocked","currentVersion","blockedVersion","event","console","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","multiEntry","unique","indexKeys","Object","keys","length","buildStandardIndexName","createIndex","callback","configSchemas","IndexedDbArchivistConfigSchema","schema","schemaIndexName","creatableModule"]}
1
+ {"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\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 { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload, PayloadWithMeta } 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 dataHashIndex: IndexDescription = { key: { $hash: 1 }, multiEntry: false, unique: false }\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 dataHashIndexName = buildStandardIndexName(IndexedDbArchivist.dataHashIndex)\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.dataHashIndex, IndexedDbArchivist.hashIndex, IndexedDbArchivist.schemaIndex, ...(this.config?.storage?.indexes ?? [])]\n }\n\n protected override async allHandler(): Promise<PayloadWithMeta[]> {\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 await Promise.all(payloads.map((payload) => PayloadBuilder.build(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: Hash[]): Promise<Hash[]> {\n const pairs = await PayloadBuilder.hashPairs(await this.getHandler(hashes))\n const hashesToDelete = pairs.flatMap<Hash>((pair) => [pair[0].$hash, pair[1]])\n // Remove any duplicates\n const distinctHashes = [...new Set(hashesToDelete)]\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 =\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.hashIndexName, hash)) ??\n (await db.getKeyFromIndex(this.storeName, IndexedDbArchivist.dataHashIndexName, 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).filter((hash) => hashes.includes(hash))\n })\n }\n\n /**\n * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)\n * @param db The db instance to use\n * @param storeName The name of the store to use\n * @param indexName The index to use\n * @param key The key to get from the index\n * @returns The primary key and the payload, or undefined if not found\n */\n protected async getFromIndexWithPrimaryKey(\n db: IDBPDatabase<PayloadStore>,\n storeName: string,\n indexName: string,\n key: IDBValidKey,\n ): Promise<[number, PayloadWithMeta] | undefined> {\n const transaction = db.transaction(storeName, 'readonly')\n const store = transaction.objectStore(storeName)\n const index = store.index(indexName)\n const cursor = await index.openCursor(key)\n if (cursor) {\n const singleValue = cursor.value\n // NOTE: It's known to be a number because we are using IndexedDB supplied auto-incrementing keys\n const primaryKey = cursor.primaryKey as number\n return [primaryKey, singleValue]\n }\n }\n\n protected override async getHandler(hashes: string[]): Promise<PayloadWithMeta[]> {\n const payloads = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.hashIndexName, hash))),\n )\n const payloadsFromDataHashes = await this.useDb((db) =>\n Promise.all(hashes.map((hash) => this.getFromIndexWithPrimaryKey(db, this.storeName, IndexedDbArchivist.dataHashIndexName, hash))),\n )\n //filter out duplicates\n const found = new Set<string>()\n const payloadsFromHash = payloads.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n const payloadsFromDataHash = payloadsFromDataHashes.filter(exists).filter(([_key, payload]) => {\n if (found.has(payload.$hash)) {\n return false\n } else {\n found.add(payload.$hash)\n return true\n }\n })\n return (\n // Merge what we found from the hash and data hash indexes\n [...payloadsFromHash, ...payloadsFromDataHash]\n // Sort in ascending order by primary key (for semi-predictable ordering in terms of insertion order)\n .sort((a, b) => a[0] - b[0])\n // Return just the payloads\n .map(([_key, payload]) => payload)\n )\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<PayloadWithMeta[]> {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n\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\n // Check if the hash already exists\n const existingTopHash = await store.index(IndexedDbArchivist.hashIndexName).get(_hash)\n // If it does not already exist\n if (!existingTopHash) {\n // Insert the payload\n await store.put({ ...payload, _hash })\n }\n\n // Return it so it gets added to the list of inserted payloads\n return payload\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, logger } = this\n const db = await openDB<PayloadStore>(dbName, dbVersion, {\n blocked(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)\n },\n blocking(currentVersion, blockedVersion, event) {\n logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)\n },\n terminated() {\n logger.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 logger.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 logger.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;AAEvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,8BAEK;AACP,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;AAE/B,SAAuBC,cAAc;;;ACd9B,IAAMC,2BAAqD;;;ACI3D,IAAMC,iCAAiE,GAAGC,wBAAAA;;;;;;;;;;;;;;AFoB1E,IAAMC,sBAAN,MAAMA,4BAGHC,kBAAAA;;;;;;;;EAsBR,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;MAAehB,oBAAmBiB;MAAWjB,oBAAmBkB;WAAiB,gBAAKf,WAAL,mBAAagB,YAAb,mBAAsBJ,YAAW,CAAA;;EAC/I;EAEA,MAAyBK,aAAyC;AAEhE,UAAMC,WAAW,MAAM,KAAKC,MAAM,CAACC,OAAOA,GAAGC,OAAO,KAAKX,SAAS,CAAA;AAElE,WAAO,MAAMY,QAAQC,IAAIL,SAASM,IAAI,CAACC,YAAYC,eAAeC,MAAMF,OAAAA,CAAAA,CAAAA;EAC1E;EAEA,MAAyBG,eAA8B;AACrD,UAAM,KAAKT,MAAM,CAACC,OAAOA,GAAGS,MAAM,KAAKnB,SAAS,CAAA;EAClD;EAEA,MAAyBoB,cAAcC,QAAiC;AACtE,UAAMC,QAAQ,MAAMN,eAAeO,UAAU,MAAM,KAAKC,WAAWH,MAAAA,CAAAA;AACnE,UAAMI,iBAAiBH,MAAMI,QAAc,CAACC,SAAS;MAACA,KAAK,CAAA,EAAGC;MAAOD,KAAK,CAAA;KAAG;AAE7E,UAAME,iBAAiB;SAAI,IAAIC,IAAIL,cAAAA;;AACnC,WAAO,MAAM,KAAKhB,MAAM,OAAOC,OAAAA;AAE7B,YAAMqB,QAAQ,MAAMnB,QAAQC,IAC1BgB,eAAef,IAAI,OAAOkB,SAAAA;AAExB,cAAMC,WACH,MAAMvB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBgD,eAAeH,IAAAA,KAC3E,MAAMtB,GAAGwB,gBAAgB,KAAKlC,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA;AAElF,YAAIC,UAAU;AAEZ,gBAAMvB,GAAG2B,OAAO,KAAKrC,WAAWiC,QAAAA;AAEhC,iBAAOD;QACT;MACF,CAAA,CAAA;AAEF,aAAOD,MAAMO,OAAOC,MAAAA,EAAQD,OAAO,CAACN,SAASX,OAAOmB,SAASR,IAAAA,CAAAA;IAC/D,CAAA;EACF;;;;;;;;;EAUA,MAAgBS,2BACd/B,IACAV,WACA0C,WACAC,KACgD;AAChD,UAAMC,cAAclC,GAAGkC,YAAY5C,WAAW,UAAA;AAC9C,UAAM6C,QAAQD,YAAYE,YAAY9C,SAAAA;AACtC,UAAM+C,QAAQF,MAAME,MAAML,SAAAA;AAC1B,UAAMM,SAAS,MAAMD,MAAME,WAAWN,GAAAA;AACtC,QAAIK,QAAQ;AACV,YAAME,cAAcF,OAAOG;AAE3B,YAAMC,aAAaJ,OAAOI;AAC1B,aAAO;QAACA;QAAYF;;IACtB;EACF;EAEA,MAAyB1B,WAAWH,QAA8C;AAChF,UAAMb,WAAW,MAAM,KAAKC,MAAM,CAACC,OACjCE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBgD,eAAeH,IAAAA,CAAAA,CAAAA,CAAAA;AAEzH,UAAMqB,yBAAyB,MAAM,KAAK5C,MAAM,CAACC,OAC/CE,QAAQC,IAAIQ,OAAOP,IAAI,CAACkB,SAAS,KAAKS,2BAA2B/B,IAAI,KAAKV,WAAWb,oBAAmBiD,mBAAmBJ,IAAAA,CAAAA,CAAAA,CAAAA;AAG7H,UAAMD,QAAQ,oBAAID,IAAAA;AAClB,UAAMwB,mBAAmB9C,SAAS8B,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACtE,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA,UAAM8B,uBAAuBL,uBAAuBf,OAAOC,MAAAA,EAAQD,OAAO,CAAC,CAACiB,MAAMxC,OAAAA,MAAQ;AACxF,UAAIgB,MAAMyB,IAAIzC,QAAQa,KAAK,GAAG;AAC5B,eAAO;MACT,OAAO;AACLG,cAAM0B,IAAI1C,QAAQa,KAAK;AACvB,eAAO;MACT;IACF,CAAA;AACA;;MAEE;WAAI0B;WAAqBI;QAEtBC,KAAK,CAACC,GAAGC,MAAMD,EAAE,CAAA,IAAKC,EAAE,CAAA,CAAE,EAE1B/C,IAAI,CAAC,CAACyC,MAAMxC,OAAAA,MAAaA,OAAAA;;EAEhC;EAEA,MAAyB+C,cAActD,UAAiD;AACtF,UAAMc,QAAQ,MAAMN,eAAeO,UAAUf,QAAAA;AAE7C,UAAME,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,YAAMC,WAAW,MAAMpD,QAAQC,IAC7BS,MAAMR,IAAI,OAAO,CAACC,SAASkD,KAAAA,MAAM;AAI/B,cAAMC,KAAKxD,GAAGkC,YAAY,KAAK5C,WAAW,WAAA;AAC1C,YAAI;AAEF,gBAAM6C,QAAQqB,GAAGpB,YAAY,KAAK9C,SAAS;AAG3C,gBAAMmE,kBAAkB,MAAMtB,MAAME,MAAM5D,oBAAmBgD,aAAa,EAAEiC,IAAIH,KAAAA;AAEhF,cAAI,CAACE,iBAAiB;AAEpB,kBAAMtB,MAAMwB,IAAI;cAAE,GAAGtD;cAASkD;YAAM,CAAA;UACtC;AAGA,iBAAOlD;QACT,UAAA;AAEE,gBAAMmD,GAAGI;QACX;MACF,CAAA,CAAA;AAEF,aAAON,SAAS1B,OAAOC,MAAAA;IACzB,UAAA;AACE7B,SAAG6D,MAAK;IACV;EACF;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,UAAM,KAAK/D,MAAM,MAAA;IAAO,CAAA;AACxB,WAAO;EACT;;;;;EAMA,MAAcsD,mBAAwD;AACpE,UAAM,EAAE1E,QAAQI,WAAWS,SAASF,WAAWyE,OAAM,IAAK;AAC1D,UAAM/D,KAAK,MAAMgE,OAAqBrF,QAAQI,WAAW;MACvDkF,QAAQC,gBAAgBC,gBAAgBC,OAAK;AAC3CL,eAAOM,KAAK,mDAAmDH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MACxG;MACAE,SAASJ,gBAAgBC,gBAAgBC,OAAK;AAC5CL,eAAOM,KAAK,6CAA6CH,cAAAA,OAAqBC,cAAAA,IAAkBC,KAAAA;MAClG;MACAG,aAAAA;AACER,eAAOS,IAAI,gCAAA;MACb;MACAC,QAAQC,UAAUC,YAAYC,YAAY1C,aAAW;AAMnD,YAAIyC,eAAeC,YAAY;AAC7Bb,iBAAOS,IAAI,sCAAsCG,UAAAA,OAAiBC,UAAAA,EAAY;AAE9E,gBAAMC,eAAe3C,YAAY4C;AACjC,qBAAWjG,QAAQgG,cAAc;AAC/B,gBAAI;AACFH,uBAASK,kBAAkBlG,IAAAA;YAC7B,QAAQ;AACNkF,qBAAOS,IAAI,8DAA8D3F,IAAAA,EAAM;YACjF;UACF;QACF;AAEA,cAAMsD,QAAQuC,SAASM,kBAAkB1F,WAAW;;UAElD2F,eAAe;QACjB,CAAA;AAEA9C,cAAMtD,OAAOS;AAEb,mBAAW,EAAE2C,KAAKiD,YAAYC,OAAM,KAAM3F,SAAS;AACjD,gBAAM4F,YAAYC,OAAOC,KAAKrD,GAAAA;AAC9B,gBAAMqD,OAAOF,UAAUG,WAAW,IAAIH,UAAU,CAAA,IAAKA;AACrD,gBAAMpD,YAAYwD,uBAAuB;YAAEvD;YAAKkD;UAAO,CAAA;AACvDhD,gBAAMsD,YAAYzD,WAAWsD,MAAM;YAAEJ;YAAYC;UAAO,CAAA;QAC1D;MACF;IACF,CAAA;AACA,WAAOnF;EACT;;;;;;EAOA,MAAcD,MAAS2F,UAA0E;AAE/F,UAAM1F,KAAK,MAAM,KAAKqD,iBAAgB;AACtC,QAAI;AAEF,aAAO,MAAMqC,SAAS1F,EAAAA;IACxB,UAAA;AAEEA,SAAG6D,MAAK;IACV;EACF;AACF;AAzQUnF;AACR,cAJWD,qBAIKkH,iBAAgB;EAACC;;AACjC,cALWnH,qBAKKK,iBAAgB;AAChC,cANWL,qBAMKO,oBAAmB;AACnC,cAPWP,qBAOKc,oBAAmB;AACnC,cARWd,qBAQaiB,aAA8B;EAAEuC,KAAK;IAAEsB,OAAO;EAAE;EAAG2B,YAAY;EAAOC,QAAQ;AAAK;AAC3G,cATW1G,qBASagB,iBAAkC;EAAEwC,KAAK;IAAEf,OAAO;EAAE;EAAGgE,YAAY;EAAOC,QAAQ;AAAM;AAChH,cAVW1G,qBAUakB,eAAgC;EAAEsC,KAAK;IAAE4D,QAAQ;EAAE;EAAGX,YAAY;EAAOC,QAAQ;AAAM;;AAE/G,cAZW1G,qBAYKgD,iBAAgB+D,uBAAuB/G,oBAAmBiB,SAAS;;AAEnF,cAdWjB,qBAcKiD,qBAAoB8D,uBAAuB/G,oBAAmBgB,aAAa;;AAE3F,cAhBWhB,qBAgBKqH,mBAAkBN,uBAAuB/G,oBAAmBkB,WAAW;AAhBlF,IAAMlB,qBAAN;AAAMA,qBAAAA,aAAAA;EADZsH,gBAAAA;GACYtH,kBAAAA;","names":["exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","buildStandardIndexName","creatableModule","PayloadBuilder","openDB","IndexedDbArchivistSchema","IndexedDbArchivistConfigSchema","IndexedDbArchivistSchema","IndexedDbArchivist","AbstractArchivist","dbName","config","name","defaultDbName","dbVersion","defaultDbVersion","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","defaultStoreName","indexes","dataHashIndex","hashIndex","schemaIndex","storage","allHandler","payloads","useDb","db","getAll","Promise","all","map","payload","PayloadBuilder","build","clearHandler","clear","deleteHandler","hashes","pairs","hashPairs","getHandler","hashesToDelete","flatMap","pair","$hash","distinctHashes","Set","found","hash","existing","getKeyFromIndex","hashIndexName","dataHashIndexName","delete","filter","exists","includes","getFromIndexWithPrimaryKey","indexName","key","transaction","store","objectStore","index","cursor","openCursor","singleValue","value","primaryKey","payloadsFromDataHashes","payloadsFromHash","_key","has","add","payloadsFromDataHash","sort","a","b","insertHandler","getInitializedDb","inserted","_hash","tx","existingTopHash","get","put","done","close","startHandler","logger","openDB","blocked","currentVersion","blockedVersion","event","warn","blocking","terminated","log","upgrade","database","oldVersion","newVersion","objectStores","objectStoreNames","deleteObjectStore","createObjectStore","autoIncrement","multiEntry","unique","indexKeys","Object","keys","length","buildStandardIndexName","createIndex","callback","configSchemas","IndexedDbArchivistConfigSchema","schema","schemaIndexName","creatableModule"]}
package/package.json CHANGED
@@ -10,23 +10,23 @@
10
10
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
11
  },
12
12
  "dependencies": {
13
- "@xylabs/exists": "^3.0.6",
14
- "@xylabs/hex": "^3.0.6",
15
- "@xyo-network/archivist-abstract": "~2.92.0",
16
- "@xyo-network/archivist-model": "~2.92.0",
17
- "@xyo-network/module-model": "~2.92.0",
18
- "@xyo-network/payload-builder": "~2.92.0",
19
- "@xyo-network/payload-model": "~2.92.0",
13
+ "@xylabs/exists": "^3.0.11",
14
+ "@xylabs/hex": "^3.0.11",
15
+ "@xyo-network/archivist-abstract": "~2.92.2",
16
+ "@xyo-network/archivist-model": "~2.92.2",
17
+ "@xyo-network/module-model": "~2.92.2",
18
+ "@xyo-network/payload-builder": "~2.92.2",
19
+ "@xyo-network/payload-model": "~2.92.2",
20
20
  "idb": "^8.0.0"
21
21
  },
22
22
  "devDependencies": {
23
- "@xylabs/ts-scripts-yarn3": "^3.4.1",
24
- "@xylabs/tsconfig": "^3.4.1",
25
- "@xyo-network/account": "~2.92.0",
26
- "@xyo-network/id-payload-plugin": "~2.92.0",
27
- "@xyo-network/payload-wrapper": "~2.92.0",
23
+ "@xylabs/ts-scripts-yarn3": "^3.5.2",
24
+ "@xylabs/tsconfig": "^3.5.2",
25
+ "@xyo-network/account": "~2.92.2",
26
+ "@xyo-network/id-payload-plugin": "~2.92.2",
27
+ "@xyo-network/payload-wrapper": "~2.92.2",
28
28
  "fake-indexeddb": "^5.0.2",
29
- "typescript": "^5.3.3"
29
+ "typescript": "^5.4.2"
30
30
  },
31
31
  "description": "Primary SDK for using XYO Protocol 2.0",
32
32
  "types": "dist/node/index.d.ts",
@@ -67,6 +67,6 @@
67
67
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
68
68
  },
69
69
  "sideEffects": false,
70
- "version": "2.92.0",
70
+ "version": "2.92.2",
71
71
  "type": "module"
72
72
  }
package/src/Archivist.ts CHANGED
@@ -227,16 +227,16 @@ export class IndexedDbArchivist<
227
227
  * @returns The initialized DB
228
228
  */
229
229
  private async getInitializedDb(): Promise<IDBPDatabase<PayloadStore>> {
230
- const { dbName, dbVersion, indexes, storeName } = this
230
+ const { dbName, dbVersion, indexes, storeName, logger } = this
231
231
  const db = await openDB<PayloadStore>(dbName, dbVersion, {
232
232
  blocked(currentVersion, blockedVersion, event) {
233
- console.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)
233
+ logger.warn(`IndexedDbArchivist: Blocked from upgrading from ${currentVersion} to ${blockedVersion}`, event)
234
234
  },
235
235
  blocking(currentVersion, blockedVersion, event) {
236
- console.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)
236
+ logger.warn(`IndexedDbArchivist: Blocking upgrade from ${currentVersion} to ${blockedVersion}`, event)
237
237
  },
238
238
  terminated() {
239
- console.log('IndexedDbArchivist: Terminated')
239
+ logger.log('IndexedDbArchivist: Terminated')
240
240
  },
241
241
  upgrade(database, oldVersion, newVersion, transaction) {
242
242
  // NOTE: This is called whenever the DB is created/updated. We could simply ensure the desired end
@@ -245,14 +245,14 @@ export class IndexedDbArchivist<
245
245
  // retention but we can revisit that tradeoff when it becomes limiting. Because distributed browser
246
246
  // state is extremely hard to debug, this seems like fair tradeoff for now.
247
247
  if (oldVersion !== newVersion) {
248
- console.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`)
248
+ logger.log(`IndexedDbArchivist: Upgrading from ${oldVersion} to ${newVersion}`)
249
249
  // Delete any existing databases that are not the current version
250
250
  const objectStores = transaction.objectStoreNames
251
251
  for (const name of objectStores) {
252
252
  try {
253
253
  database.deleteObjectStore(name)
254
254
  } catch {
255
- console.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`)
255
+ logger.log(`IndexedDbArchivist: Failed to delete existing object store ${name}`)
256
256
  }
257
257
  }
258
258
  }