@xyo-network/diviner-boundwitness-indexeddb 5.1.22 → 5.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-boundwitness-indexeddb",
-  "version": "5.1.22",
+  "version": "5.1.23",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,34 +30,37 @@
   "types": "dist/browser/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "src",
+    "!**/*.bench.*",
+    "!**/*.spec.*",
+    "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/array": "~5.0.24",
-    "@xylabs/assert": "~5.0.24",
-    "@xylabs/exists": "~5.0.24",
-    "@xyo-network/archivist-indexeddb": "~5.1.22",
-    "@xyo-network/archivist-model": "~5.1.22",
-    "@xyo-network/boundwitness-model": "~5.1.22",
-    "@xyo-network/diviner-boundwitness-abstract": "~5.1.22",
-    "@xyo-network/diviner-boundwitness-model": "~5.1.22",
-    "@xyo-network/diviner-model": "~5.1.22",
-    "@xyo-network/module-model": "~5.1.22",
-    "@xyo-network/payload-model": "~5.1.22",
+    "@xylabs/array": "~5.0.33",
+    "@xylabs/assert": "~5.0.33",
+    "@xylabs/exists": "~5.0.33",
+    "@xyo-network/archivist-indexeddb": "~5.1.23",
+    "@xyo-network/archivist-model": "~5.1.23",
+    "@xyo-network/boundwitness-model": "~5.1.23",
+    "@xyo-network/diviner-boundwitness-abstract": "~5.1.23",
+    "@xyo-network/diviner-boundwitness-model": "~5.1.23",
+    "@xyo-network/diviner-model": "~5.1.23",
+    "@xyo-network/module-model": "~5.1.23",
+    "@xyo-network/payload-model": "~5.1.23",
     "idb": "~8.0.3"
   },
   "devDependencies": {
-    "@xylabs/delay": "~5.0.24",
+    "@xylabs/delay": "~5.0.33",
     "@xylabs/ts-scripts-yarn3": "~7.2.8",
     "@xylabs/tsconfig": "~7.2.8",
-    "@xylabs/vitest-extended": "~5.0.24",
-    "@xyo-network/archivist-indexeddb": "~5.1.22",
-    "@xyo-network/boundwitness-builder": "~5.1.22",
-    "@xyo-network/node-memory": "~5.1.22",
-    "@xyo-network/payload-builder": "~5.1.22",
+    "@xylabs/vitest-extended": "~5.0.33",
+    "@xyo-network/archivist-indexeddb": "~5.1.23",
+    "@xyo-network/boundwitness-builder": "~5.1.23",
+    "@xyo-network/node-memory": "~5.1.23",
+    "@xyo-network/payload-builder": "~5.1.23",
     "fake-indexeddb": "~6.2.5",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.8"
+    "vitest": "~4.0.9"
   },
   "publishConfig": {
     "access": "public"

package/dist/browser/spec/Diviner.Error.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Diviner.Error.spec.d.ts.map

package/dist/browser/spec/Diviner.Error.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Diviner.Error.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Diviner.Error.spec.ts"],"names":[],"mappings":""}

package/dist/browser/spec/Diviner.spec.d.ts

@@ -1,2 +0,0 @@
-import '@xylabs/vitest-extended';
-//# sourceMappingURL=Diviner.spec.d.ts.map

package/dist/browser/spec/Diviner.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Diviner.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Diviner.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/src/spec/Diviner.Error.spec.ts

@@ -1,118 +0,0 @@
-import { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import { BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'
-import { MemoryNode } from '@xyo-network/node-memory'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import {
-  IDBCursor,
-  IDBCursorWithValue,
-  IDBDatabase,
-  IDBFactory,
-  IDBIndex,
-  IDBKeyRange,
-  IDBObjectStore,
-  IDBOpenDBRequest,
-  IDBRequest,
-  IDBTransaction,
-  IDBVersionChangeEvent,
-  indexedDB,
-} from 'fake-indexeddb'
-import {
-  beforeAll, describe, expect, it,
-} from 'vitest'
-
-import { IndexedDbBoundWitnessDiviner } from '../Diviner.ts'
-
-// Augment window with prototypes to ensure instance of comparisons work
-globalThis.IDBCursor = IDBCursor
-globalThis.IDBCursorWithValue = IDBCursorWithValue
-globalThis.IDBDatabase = IDBDatabase
-globalThis.IDBFactory = IDBFactory
-globalThis.IDBIndex = IDBIndex
-globalThis.IDBKeyRange = IDBKeyRange
-globalThis.IDBObjectStore = IDBObjectStore
-globalThis.IDBOpenDBRequest = IDBOpenDBRequest
-globalThis.IDBRequest = IDBRequest
-globalThis.IDBTransaction = IDBTransaction
-globalThis.IDBVersionChangeEvent = IDBVersionChangeEvent
-globalThis.indexedDB = indexedDB
-
-/**
- * @group module
- * @group diviner
- */
-describe('IndexedDbBoundWitnessDiviner.Errors', () => {
-  const dbName = 'testDb'
-  const storeName = 'testStore'
-  const values: BoundWitness[] = []
-  let archivist: IndexedDbArchivist
-  describe('divine', () => {
-    const createTestNode = async (testDbName = 'INCORRECT-DB-NAME', testStoreName = 'INCORRECT-STORE-NAME') => {
-      const sut = await IndexedDbBoundWitnessDiviner.create({
-        account: 'random',
-        config: {
-          archivist: archivist.address,
-          dbName: testDbName,
-          schema: IndexedDbBoundWitnessDiviner.defaultConfigSchema,
-          storeName: testStoreName,
-        },
-      })
-      const node = await MemoryNode.create({
-        account: 'random',
-        config: { schema: MemoryNode.defaultConfigSchema },
-      })
-      const modules = [archivist, sut]
-      await node.start()
-      await Promise.all(
-        modules.map(async (mod) => {
-          await node.register(mod)
-          await node.attach(mod.address, true)
-        }),
-      )
-      return sut
-    }
-    beforeAll(async () => {
-      archivist = await IndexedDbArchivist.create({
-        account: 'random',
-        config: {
-          dbName, schema: IndexedDbArchivist.defaultConfigSchema, storeName,
-        },
-      })
-      const [bw] = await new BoundWitnessBuilder().build()
-      values.push(bw)
-      await archivist.insert(values)
-    })
-    describe('when DB and store do not exist', () => {
-      let sut: IndexedDbBoundWitnessDiviner
-      beforeAll(async () => {
-        sut = await createTestNode('INCORRECT-DB-NAME', 'INCORRECT-STORE-NAME')
-      })
-      it('returns empty array', async () => {
-        const result = await sut.divine([{ schema: BoundWitnessDivinerQuerySchema }])
-        expect(result).toEqual([])
-      })
-    })
-    describe('when DB exists but store does not exist', () => {
-      let sut: IndexedDbBoundWitnessDiviner
-      beforeAll(async () => {
-        sut = await createTestNode(dbName, 'INCORRECT-STORE-NAME')
-      })
-      it('returns empty array', async () => {
-        const result = await sut.divine([{ schema: BoundWitnessDivinerQuerySchema }])
-        expect(result).toEqual([])
-      })
-    })
-    describe('when DB and store exist', () => {
-      let sut: IndexedDbBoundWitnessDiviner
-      beforeAll(async () => {
-        sut = await createTestNode(dbName, storeName)
-      })
-      it('returns values', async () => {
-        const result = await sut.divine([{ schema: BoundWitnessDivinerQuerySchema }])
-        const filtered = PayloadBuilder.omitStorageMeta(result)
-        expect(filtered).toEqual(values)
-      })
-    })
-  })
-})

package/src/spec/Diviner.spec.ts

@@ -1,213 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import { filterAs } from '@xylabs/array'
-import { delay } from '@xylabs/delay'
-import { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import { asOptionalBoundWitnessWithStorageMeta, isBoundWitness } from '@xyo-network/boundwitness-model'
-import type { BoundWitnessDivinerQueryPayload } from '@xyo-network/diviner-boundwitness-model'
-import { BoundWitnessDivinerQuerySchema } from '@xyo-network/diviner-boundwitness-model'
-import { MemoryNode } from '@xyo-network/node-memory'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { WithStorageMeta } from '@xyo-network/payload-model'
-import {
-  IDBCursor,
-  IDBCursorWithValue,
-  IDBDatabase,
-  IDBFactory,
-  IDBIndex,
-  IDBKeyRange,
-  IDBObjectStore,
-  IDBOpenDBRequest,
-  IDBRequest,
-  IDBTransaction,
-  IDBVersionChangeEvent,
-  indexedDB,
-} from 'fake-indexeddb'
-import {
-  beforeAll, describe, expect,
-  it,
-} from 'vitest'
-
-import { IndexedDbBoundWitnessDiviner } from '../Diviner.ts'
-
-// Augment window with prototypes to ensure instance of comparisons work
-globalThis.IDBCursor = IDBCursor
-globalThis.IDBCursorWithValue = IDBCursorWithValue
-globalThis.IDBDatabase = IDBDatabase
-globalThis.IDBFactory = IDBFactory
-globalThis.IDBIndex = IDBIndex
-globalThis.IDBKeyRange = IDBKeyRange
-globalThis.IDBObjectStore = IDBObjectStore
-globalThis.IDBOpenDBRequest = IDBOpenDBRequest
-globalThis.IDBRequest = IDBRequest
-globalThis.IDBTransaction = IDBTransaction
-globalThis.IDBVersionChangeEvent = IDBVersionChangeEvent
-globalThis.indexedDB = indexedDB
-
-/**
- * @group module
- * @group diviner
- */
-describe('IndexedDbBoundWitnessDiviner', () => {
-  const dbName = 'testDb'
-  const storeName = 'testStore'
-  let archivist: IndexedDbArchivist
-  let sut: IndexedDbBoundWitnessDiviner
-  let node: MemoryNode
-  const payloadA = {
-    schema: 'network.xyo.test',
-    url: 'https://xyo.network',
-  }
-  const payloadB = {
-    foo: ['bar', 'baz'],
-    schema: 'network.xyo.debug',
-  }
-  const boundWitnesses: WithStorageMeta<BoundWitness>[] = []
-  beforeAll(async () => {
-    const [boundWitnessA] = await (new BoundWitnessBuilder().payloads([payloadA])).build()
-    const [boundWitnessB] = await (new BoundWitnessBuilder().payloads([payloadB])).build()
-    const [boundWitnessC] = await (new BoundWitnessBuilder().payloads([payloadA, payloadB])).build()
-    archivist = await IndexedDbArchivist.create({
-      account: 'random',
-      config: {
-        dbName, schema: IndexedDbArchivist.defaultConfigSchema, storeName,
-      },
-    })
-    for (const [bw, payloads] of [
-      [boundWitnessA, [payloadA]],
-      [boundWitnessB, [payloadB]],
-      [boundWitnessC, [payloadA, payloadB]],
-    ] as const) {
-      await delay(2)
-      const inserted = await archivist.insert([bw, ...payloads])
-      const bwWithStorageMeta = filterAs(inserted, asOptionalBoundWitnessWithStorageMeta)
-      boundWitnesses.push(...bwWithStorageMeta)
-    }
-    sut = await IndexedDbBoundWitnessDiviner.create({
-      account: 'random',
-      config: {
-        archivist: archivist.address,
-        dbName,
-        schema: IndexedDbBoundWitnessDiviner.defaultConfigSchema,
-        storeName,
-      },
-    })
-    node = await MemoryNode.create({
-      account: 'random',
-      config: { schema: MemoryNode.defaultConfigSchema },
-    })
-    const modules = [archivist, sut]
-    await node.start()
-    await Promise.all(
-      modules.map(async (mod) => {
-        await node.register(mod)
-        await node.attach(mod.address, true)
-      }),
-    )
-  })
-  describe('with filter for', () => {
-    describe('payload_schemas', () => {
-      describe('single', () => {
-        it.each(['network.xyo.test', 'network.xyo.debug'])(
-          'returns only bound witnesses with payload_schemas that contain the schema',
-          async (schema) => {
-            const payload_schemas = [schema]
-            const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-              .fields({ payload_schemas })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            const bws = results.filter(isBoundWitness)
-            expect(bws.length).toBeGreaterThan(0)
-            for (const bw of bws) {
-              expect(bw.payload_schemas).toIncludeAllMembers(payload_schemas)
-            }
-          },
-        )
-      })
-      describe('multiple', () => {
-        it.each([
-          ['network.xyo.test', 'network.xyo.debug'],
-          ['network.xyo.test', 'network.xyo.debug'],
-        ])('returns only bound witnesses with payload_schemas that contain the all the schemas', async (...payload_schemas) => {
-          const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-            .fields({ payload_schemas })
-            .build()
-          const results = await sut.divine([query])
-          expect(results.length).toBeGreaterThan(0)
-          const bws = results.filter(isBoundWitness)
-          expect(bws.length).toBeGreaterThan(0)
-          for (const bw of bws) {
-            expect(bw.payload_schemas).toIncludeAllMembers(payload_schemas)
-          }
-        })
-      })
-    })
-  })
-  describe('with order', () => {
-    describe('not set', () => {
-      it('returns payloads in ascending order', async () => {
-        const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema }).build()
-        const results = await sut.divine([query])
-        expect(results).toEqual(boundWitnesses)
-      })
-    })
-    describe('asc', () => {
-      it('returns payloads in ascending order', async () => {
-        const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-          .fields({ order: 'asc' })
-          .build()
-        const results = await sut.divine([query])
-        expect(results).toEqual(boundWitnesses)
-      })
-    })
-    describe('desc', () => {
-      it('returns payloads in descending order', async () => {
-        const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-          .fields({ order: 'desc' })
-          .build()
-        const results = await sut.divine([query])
-        expect(results).toEqual([...boundWitnesses].toReversed())
-      })
-    })
-  })
-  describe('with cursor', () => {
-    describe('when ascending order', () => {
-      it('returns payloads from the beginning', async () => {
-        const iterator = boundWitnesses.entries()
-        iterator.next()
-        for (const [i, boundWitness] of iterator) {
-          const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-            .fields({
-              limit: 1, cursor: boundWitnesses[i - 1]._sequence, order: 'asc',
-            })
-            .build()
-          const results = await sut.divine([query])
-          expect(results).toBeArrayOfSize(1)
-          const [result] = results
-          expect(PayloadBuilder.omitMeta(result)).toEqual(PayloadBuilder.omitMeta(boundWitness))
-        }
-      })
-    })
-    describe('when descending order', () => {
-      it('returns payloads from the end', async () => {
-        const descendingBoundWitnesses = [...boundWitnesses].toReversed()
-        const iterator = [...descendingBoundWitnesses.entries()][Symbol.iterator]()
-        iterator.next()
-        for (const [i, boundWitness] of iterator) {
-          const query = new PayloadBuilder<BoundWitnessDivinerQueryPayload>({ schema: BoundWitnessDivinerQuerySchema })
-            .fields({
-              limit: 1, cursor: descendingBoundWitnesses[i - 1]._sequence, order: 'desc',
-            })
-            .build()
-          const results = await sut.divine([query])
-          expect(results).toBeArrayOfSize(1)
-          const [result] = results
-          expect(PayloadBuilder.omitMeta(result)).toEqual(PayloadBuilder.omitMeta(boundWitness))
-        }
-      })
-    })
-  })
-})