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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-indexeddb",
-  "version": "5.1.22",
+  "version": "5.1.23",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,32 +30,35 @@
   "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",
-    "@xylabs/object": "~5.0.24",
-    "@xyo-network/archivist-indexeddb": "~5.1.22",
-    "@xyo-network/archivist-model": "~5.1.22",
-    "@xyo-network/diviner-model": "~5.1.22",
-    "@xyo-network/diviner-payload-abstract": "~5.1.22",
-    "@xyo-network/diviner-payload-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",
+    "@xylabs/object": "~5.0.33",
+    "@xyo-network/archivist-indexeddb": "~5.1.23",
+    "@xyo-network/archivist-model": "~5.1.23",
+    "@xyo-network/diviner-model": "~5.1.23",
+    "@xyo-network/diviner-payload-abstract": "~5.1.23",
+    "@xyo-network/diviner-payload-model": "~5.1.23",
+    "@xyo-network/module-model": "~5.1.23",
+    "@xyo-network/payload-model": "~5.1.23",
     "idb": "~8.0.3"
   },
   "devDependencies": {
     "@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/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/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":"AAGA,OAAO,yBAAyB,CAAA"}

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

@@ -1,117 +0,0 @@
-import { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'
-import { PayloadDivinerQuerySchema } from '@xyo-network/diviner-payload-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 { IndexedDbPayloadDiviner } 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('IndexedDbPayloadDiviner.Errors', () => {
-  const dbName = 'testDb-IndexedDbPayloadDiviner.Errors'
-  const storeName = 'testStore-IndexedDbPayloadDiviner.Errors'
-  let sut: IndexedDbPayloadDiviner
-  const values = [
-    {
-      schema: 'network.xyo.test',
-      url: 'https://xyo.network',
-    },
-  ]
-  describe('divine', () => {
-    const createTestNode = async (testDbName = 'INCORRECT-DB-NAME', testStoreName = 'INCORRECT-STORE-NAME') => {
-      const archivist = await IndexedDbArchivist.create({
-        account: 'random',
-        config: {
-          dbName, schema: IndexedDbArchivist.defaultConfigSchema, storeName,
-        },
-      })
-      await archivist.clear?.()
-      await archivist.insert(values)
-      const sut = await IndexedDbPayloadDiviner.create({
-        account: 'random',
-        config: {
-          archivist: archivist.address,
-          dbName: testDbName,
-          schema: IndexedDbPayloadDiviner.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
-    }
-    describe('when DB and store do not exist', () => {
-      beforeAll(async () => {
-        sut = await createTestNode('INCORRECT-DB-NAME', 'INCORRECT-STORE-NAME')
-      })
-      it('returns empty array', async () => {
-        const result = await sut.divine([{ schema: PayloadDivinerQuerySchema }])
-        expect(result).toEqual([])
-      })
-    })
-    describe('when DB exists but store does not exist', () => {
-      beforeAll(async () => {
-        sut = await createTestNode(dbName, 'INCORRECT-STORE-NAME')
-      })
-      it('returns empty array', async () => {
-        const result = await sut.divine([{ schema: PayloadDivinerQuerySchema }])
-        expect(result).toEqual([])
-      })
-    })
-    describe('when DB and store exist', () => {
-      beforeAll(async () => {
-        sut = await createTestNode(dbName, storeName)
-      })
-      it('returns values', async () => {
-        const result = await sut.divine([{ schema: PayloadDivinerQuerySchema }])
-        expect(result.map(i => PayloadBuilder.omitMeta(i))).toMatchObject(
-          values.map(i => PayloadBuilder.omitMeta(i)),
-        )
-      })
-    })
-  })
-})

package/src/spec/Diviner.spec.ts

@@ -1,181 +0,0 @@
-/// <reference lib="dom" />
-/* eslint-disable max-nested-callbacks */
-
-import '@xylabs/vitest-extended'
-
-import { IndexedDbArchivist } from '@xyo-network/archivist-indexeddb'
-import type { IndexDescription } from '@xyo-network/archivist-model'
-import type { PayloadDivinerQueryPayload } from '@xyo-network/diviner-payload-model'
-import { PayloadDivinerQuerySchema } from '@xyo-network/diviner-payload-model'
-import { MemoryNode } from '@xyo-network/node-memory'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { Payload, 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 { IndexedDbPayloadDiviner } 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('IndexedDbPayloadDiviner', () => {
-  const dbName = 'testDb'
-  const storeName = 'testStore'
-  let archivist: IndexedDbArchivist
-  let sut: IndexedDbPayloadDiviner
-  let node: MemoryNode
-  const urlIndex: IndexDescription = { key: { url: 1 }, name: 'IX_url' }
-  let payloadA: Payload<{ url: string }> = {
-    schema: 'network.xyo.test',
-    url: 'https://xyo.network',
-  }
-  let payloadB: Payload<{ foo: string[]; other: string }> = {
-    foo: ['bar', 'baz'],
-    other: 'value',
-    schema: 'network.xyo.debug',
-  }
-  let insertedPayloads: WithStorageMeta<Payload>[] = []
-  beforeAll(async () => {
-    archivist = await IndexedDbArchivist.create({
-      account: 'random',
-      config: {
-        dbName, schema: IndexedDbArchivist.defaultConfigSchema, storage: { indexes: [urlIndex] }, storeName,
-      },
-    })
-    insertedPayloads = await archivist.insert([payloadA, payloadB])
-    sut = await IndexedDbPayloadDiviner.create({
-      account: 'random',
-      config: {
-        archivist: archivist.address,
-        dbName,
-        schema: IndexedDbPayloadDiviner.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('schema', () => {
-      describe('single', () => {
-        it.each(['network.xyo.test', 'network.xyo.debug'])('only returns payloads of that schema', async (schema) => {
-          const schemas = [schema]
-          const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema }).fields({ schemas }).build()
-          const results = await sut.divine([query])
-          expect(results.length).toBeGreaterThan(0)
-          expect(results.every(result => result.schema === schema)).toBe(true)
-        })
-      })
-      describe.skip('multiple', () => {
-        it('only returns payloads of that schema', async () => {
-          const schemas = ['network.xyo.test', 'network.xyo.debug']
-          const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema }).fields({ schemas }).build()
-          const results = await sut.divine([query])
-          expect(results.length).toBeGreaterThan(0)
-          expect(results.every(result => schemas.includes(result.schema))).toBe(true)
-        })
-      })
-    })
-    describe('custom field', () => {
-      describe('property', () => {
-        describe('with index', () => {
-          it('only returns payloads with that property', async () => {
-            type WithUrl = { url?: string }
-            const url = payloadA.url
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload & WithUrl>({ schema: PayloadDivinerQuerySchema })
-              .fields({ url })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(result => (result as WithUrl)?.url === url)).toBe(true)
-          })
-        })
-        describe('without index', () => {
-          it('only returns payloads with that property', async () => {
-            type WithOther = { other?: string }
-            const other = payloadB.other
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload & WithOther>({ schema: PayloadDivinerQuerySchema })
-              .fields({ other })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(result => (result as WithOther)?.other === other)).toBe(true)
-          })
-        })
-      })
-      describe.skip('array', () => {
-        const cases: string[][] = [['bar'], ['baz'], ['bar', 'baz']]
-        it.each(cases)('only returns payloads that have an array containing all the values supplied', async (...foo) => {
-          type WithFoo = { foo?: string[] }
-          const query = new PayloadBuilder<PayloadDivinerQueryPayload & WithFoo>({ schema: PayloadDivinerQuerySchema }).fields({ foo }).build()
-          const results = await sut.divine([query])
-          expect(results.length).toBeGreaterThan(0)
-          expect(results.every(result => foo.every(v => (result as unknown as WithFoo)?.foo?.includes(v)))).toBe(true)
-        })
-      })
-    })
-  })
-  describe('with order', () => {
-    describe('not set', () => {
-      it('returns payloads in ascending order', async () => {
-        const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema }).build()
-        const results = await sut.divine([query])
-        expect(results).toEqual(insertedPayloads)
-      })
-    })
-    describe('asc', () => {
-      it('returns payloads in ascending order', async () => {
-        const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema }).fields({ order: 'asc' }).build()
-        const results = await sut.divine([query])
-        expect(results).toEqual(insertedPayloads)
-      })
-    })
-    describe('desc', () => {
-      it('returns payloads in descending order', async () => {
-        const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema }).fields({ order: 'desc' }).build()
-        const results = await sut.divine([query])
-        expect(results).toEqual([...insertedPayloads].toReversed())
-      })
-    })
-  })
-})