@xyo-network/diviner-payload-indexeddb 5.3.22 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-indexeddb",
-  "version": "5.3.22",
+  "version": "5.3.24",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,53 +30,49 @@
   "types": "dist/browser/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*",
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-indexeddb": "~5.3.22",
-    "@xyo-network/archivist-model": "~5.3.22",
-    "@xyo-network/diviner-model": "~5.3.22",
-    "@xyo-network/diviner-payload-abstract": "~5.3.22",
-    "@xyo-network/diviner-payload-model": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22"
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/archivist-indexeddb": "~5.3.24",
+    "@xyo-network/diviner-model": "~5.3.24",
+    "@xyo-network/diviner-payload-abstract": "~5.3.24",
+    "@xyo-network/diviner-payload-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@types/node": "^25.5.0",
-    "@xylabs/indexed-db": "^5.0.91",
-    "@xylabs/sdk-js": "^5.0.91",
-    "@xylabs/ts-scripts-common": "~7.6.8",
-    "@xylabs/ts-scripts-yarn3": "~7.6.8",
-    "@xylabs/tsconfig": "~7.6.8",
-    "@xylabs/vitest-extended": "~5.0.91",
-    "@xyo-network/archivist-indexeddb": "~5.3.22",
-    "@xyo-network/archivist-model": "~5.3.22",
-    "@xyo-network/diviner-model": "~5.3.22",
-    "@xyo-network/diviner-payload-abstract": "~5.3.22",
-    "@xyo-network/diviner-payload-model": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/node-memory": "~5.3.22",
-    "@xyo-network/payload-builder": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
+    "@xylabs/indexed-db": "^5.0.93",
+    "@xylabs/sdk-js": "^5.0.93",
+    "@xylabs/ts-scripts-common": "~7.6.16",
+    "@xylabs/ts-scripts-pnpm": "~7.6.16",
+    "@xylabs/tsconfig": "~7.6.16",
+    "@xylabs/vitest-extended": "~5.0.93",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
-    "cosmiconfig": "^9.0.1",
-    "esbuild": "^0.27.4",
-    "eslint": "^10.1.0",
+    "esbuild": "^0.28.0",
     "ethers": "^6.16.0",
     "fake-indexeddb": "~6.2.5",
     "idb": "^8.0.3",
-    "rollup": "^4.60.1",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/archivist-indexeddb": "~5.3.24",
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/diviner-model": "~5.3.24",
+    "@xyo-network/diviner-payload-abstract": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/diviner-payload-model": "~5.3.24",
+    "@xyo-network/node-memory": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/indexed-db": "^5",
@@ -89,4 +85,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Config.ts

@@ -1,34 +0,0 @@
-import type { IndexDescription } from '@xyo-network/archivist-model'
-import type { DivinerConfig } from '@xyo-network/diviner-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-import { IndexedDbPayloadDivinerSchema } from './Schema.ts'
-
-export const IndexedDbPayloadDivinerConfigSchema = asSchema(`${IndexedDbPayloadDivinerSchema}.config`, true)
-export type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema
-
-export type IndexedDbPayloadDivinerConfig = DivinerConfig<{
-  /**
-   * The database name
-   */
-  dbName?: string
-  /**
-   * The version of the DB, defaults to 1
-   */
-  dbVersion?: number
-  schema: IndexedDbPayloadDivinerConfigSchema
-  /**
-   * The storage configuration
-   * // TODO: Hoist to main diviner config
-   */
-  storage?: {
-    /**
-     * The indexes to create on the object store
-     */
-    indexes?: IndexDescription[]
-  }
-  /**
-   * The name of the object store
-   */
-  storeName?: string
-}>

package/src/Diviner.ts

@@ -1,190 +0,0 @@
-/// <reference lib="dom" />
-
-import {
-  assertEx, containsAll,
-  exists, removeFields,
-} from '@xylabs/sdk-js'
-import { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'
-import type { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model'
-import { PayloadDiviner } from '@xyo-network/diviner-payload-abstract'
-import type { PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'
-import { isPayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'
-import type {
-  AnyPayload,
-  Payload, Schema, Sequence,
-} from '@xyo-network/payload-model'
-import type { IDBPCursorWithValue, IDBPDatabase } from 'idb'
-import { openDB } from 'idb'
-
-import { IndexedDbPayloadDivinerConfigSchema } from './Config.ts'
-import type { IndexedDbPayloadDivinerParams } from './Params.ts'
-
-interface PayloadStore {
-  [s: string]: Payload
-}
-
-type ValueFilter = (payload?: AnyPayload | null) => boolean
-
-const payloadValueFilter = (key: keyof AnyPayload, value?: unknown | unknown[]): ValueFilter | undefined => {
-  if (!value) return undefined
-  return (payload) => {
-    if (!payload) return false
-    const sourceValue = payload?.[key]
-    if (sourceValue === undefined) return false
-    return Array.isArray(sourceValue) && Array.isArray(value) ? containsAll(sourceValue, value) : sourceValue == value
-  }
-}
-
-export class IndexedDbPayloadDiviner<
-  TParams extends IndexedDbPayloadDivinerParams = IndexedDbPayloadDivinerParams,
-  TIn extends PayloadDivinerQueryPayload = PayloadDivinerQueryPayload,
-  TOut extends Payload = Payload,
-  TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<
-    DivinerInstance<TParams, TIn, TOut>,
-    TIn,
-    TOut
-  >,
-> extends PayloadDiviner<TParams, TIn, TOut, TEventData> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, IndexedDbPayloadDivinerConfigSchema]
-  static override readonly defaultConfigSchema: Schema = IndexedDbPayloadDivinerConfigSchema
-
-  /**
-   * The database name. If not supplied via config, it defaults
-   * to the archivist's name and if archivist's name is not supplied,
-   * it defaults to `archivist`. This behavior
-   * biases towards a single, isolated DB per archivist which seems to
-   * make the most sense for 99% of use cases.
-   */
-  get dbName() {
-    return this.config?.dbName ?? this.config?.archivist ?? IndexedDbArchivist.defaultDbName
-  }
-
-  /**
-   * The database version. If not supplied via config, it defaults to the archivist default version.
-   */
-  get dbVersion() {
-    return this.config?.dbVersion ?? IndexedDbArchivist.defaultDbVersion
-  }
-
-  /**
-   * The name of the object store. If not supplied via config, it defaults
-   * to `payloads`.
-   */
-  get storeName() {
-    return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName
-  }
-
-  protected override async divineHandler(payloads?: TIn[]): Promise<TOut[]> {
-    const query = payloads?.find(isPayloadDivinerQueryPayload)
-    if (!query) return []
-    const result = await this.tryUseDb(async (db) => {
-      const {
-        schemas, limit, cursor, order, ...props
-      } = removeFields(query, ['schema'])
-      const tx = db.transaction(this.storeName, 'readonly')
-      const store = tx.objectStore(this.storeName)
-      const results: TOut[] = []
-      let parsedCursor = cursor
-      const parsedLimit = limit ?? 10
-      assertEx((schemas?.length ?? 1) === 1, () => 'IndexedDbPayloadDiviner: Only one filter schema supported')
-      const filterSchema = schemas?.[0]
-      const filter = filterSchema ? { schema: filterSchema, ...props } : { ...props }
-      const valueFilters: ValueFilter[] = Object.entries(filter)
-        .map(([key, value]) => payloadValueFilter(key, value))
-        .filter(exists)
-      const direction: IDBCursorDirection = order === 'desc' ? 'prev' : 'next'
-
-      // Iterate all records using the sequence index
-      const sequenceIndex = assertEx(store.index(IndexedDbArchivist.sequenceIndexName), () => 'Failed to get sequence index')
-      let dbCursor: IDBPCursorWithValue<PayloadStore, [string], string, string, 'readonly'> | null
-        = await sequenceIndex.openCursor(null, direction)
-
-      // If a cursor was supplied
-      if (parsedCursor !== undefined) {
-        let currentSequence: Sequence | undefined
-        // Skip records until the supplied cursor offset is reached
-        while (dbCursor && currentSequence !== parsedCursor) {
-          // Find the sequence of the current record
-          currentSequence = await dbCursor.value?.sequence
-          // Advance one record beyond the cursor
-          dbCursor = await dbCursor.advance(1)
-        }
-      }
-
-      // Collect results up to the limit
-      while (dbCursor && results.length < parsedLimit) {
-        const value = dbCursor.value
-        if (value) {
-          // If we're filtering on more than just the schema
-          if (valueFilters.length > 0) {
-            // Ensure all filters pass
-            if (valueFilters.every(filter => filter(value))) {
-              // Then save the value
-              results.push(value)
-            }
-          } else {
-            // Otherwise just save the value
-            results.push(value)
-          }
-        }
-        try {
-          dbCursor = await dbCursor.continue()
-        } catch {
-          break
-        }
-      }
-      await tx.done
-      // Remove any metadata before returning to the client
-      return results
-    })
-    return result ?? []
-  }
-
-  /**
-   * Checks that the desired DB/objectStore exists and is initialized to the correct version
-   * @returns The initialized DB or undefined if it does not exist in the desired state
-   */
-  private async tryGetInitializedDb(): Promise<IDBPDatabase<PayloadStore> | undefined> {
-    // Enumerate the DBs
-    const dbs = await indexedDB.databases()
-    // Check that the DB exists
-    const dbExists = dbs.some((db) => {
-      return db.name === this.dbName
-    })
-    // If the DB exists
-    if (dbExists) {
-      // If the db does exist, open it
-      const db = await openDB<PayloadStore>(this.dbName)
-      // Check that the desired objectStore exists
-      const storeExists = db.objectStoreNames.contains(this.storeName)
-      // If the correct db/version/objectStore exists
-      if (storeExists) {
-        return db
-      } else {
-        // Otherwise close the db so the process that is going to update the
-        // db can open it
-        db.close()
-      }
-    }
-  }
-
-  /**
-   * Executes a callback with the initialized DB and then closes the db
-   * @param callback The method to execute with the initialized DB
-   * @returns
-   */
-  private async tryUseDb<T>(callback: (db: IDBPDatabase<PayloadStore>) => Promise<T> | T): Promise<T | undefined> {
-    // Get the initialized DB
-    const db = await this.tryGetInitializedDb()
-    if (db) {
-      try {
-        // Perform the callback
-        return await callback(db)
-      } finally {
-        // Close the DB
-        db.close()
-      }
-    }
-    return undefined
-  }
-}

package/src/Params.ts

@@ -1,6 +0,0 @@
-import type { DivinerParams } from '@xyo-network/diviner-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-
-import type { IndexedDbPayloadDivinerConfig } from './Config.ts'
-
-export type IndexedDbPayloadDivinerParams = DivinerParams<AnyConfigSchema<IndexedDbPayloadDivinerConfig>>

package/src/Schema.ts

@@ -1,5 +0,0 @@
-import { PayloadDivinerSchema } from '@xyo-network/diviner-payload-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-export const IndexedDbPayloadDivinerSchema = asSchema(`${PayloadDivinerSchema}.indexeddb`, true)
-export type IndexedDbPayloadDivinerSchema = typeof IndexedDbPayloadDivinerSchema

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './Config.ts'
-export * from './Diviner.ts'
-export * from './Params.ts'
-export * from './Schema.ts'