@xyo-network/diviner-payload-memory 5.1.21 → 5.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-payload-memory",
-  "version": "5.1.21",
+  "version": "5.1.23",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,23 +30,26 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "src",
+    "!**/*.bench.*",
+    "!**/*.spec.*",
+    "!**/*.test.*"
   ],
   "dependencies": {
-    "@xyo-network/diviner-payload-generic": "~5.1.21"
+    "@xyo-network/diviner-payload-generic": "~5.1.23"
   },
   "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-memory": "~5.1.21",
-    "@xyo-network/diviner-payload-model": "~5.1.21",
-    "@xyo-network/node-memory": "~5.1.21",
-    "@xyo-network/payload-builder": "~5.1.21",
-    "@xyo-network/payload-model": "~5.1.21",
+    "@xylabs/vitest-extended": "~5.0.33",
+    "@xyo-network/archivist-memory": "~5.1.23",
+    "@xyo-network/diviner-payload-model": "~5.1.23",
+    "@xyo-network/node-memory": "~5.1.23",
+    "@xyo-network/payload-builder": "~5.1.23",
+    "@xyo-network/payload-model": "~5.1.23",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.8"
+    "vitest": "~4.0.9"
   },
   "publishConfig": {
     "access": "public"

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

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

package/dist/neutral/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":"AAEA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/MemoryPayloadDiviner.spec.d.ts

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

package/dist/neutral/spec/MemoryPayloadDiviner.spec.d.ts.map

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

package/src/spec/Diviner.spec.ts

@@ -1,155 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-
-import '@xylabs/vitest-extended'
-
-import { delay } from '@xylabs/delay'
-import { MemoryArchivist } from '@xyo-network/archivist-memory'
-import { GenericPayloadDivinerConfigSchema } from '@xyo-network/diviner-payload-generic'
-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 {
-  beforeAll, describe, expect, it,
-} from 'vitest'
-
-import { MemoryPayloadDiviner } from '../MemoryPayloadDiviner.ts'
-
-/**
- * @group module
- * @group diviner
- */
-
-describe('GenericPayloadDiviner', () => {
-  let archivist: MemoryArchivist
-  let sut: MemoryPayloadDiviner
-  let node: MemoryNode
-  const payloadA: Payload<{ schema: string; url: string }> = {
-    schema: 'network.xyo.test',
-    url: 'https://xyo.network',
-  }
-  const payloadB: Payload<{ foo: string[]; schema: string }> = {
-    foo: ['bar', 'baz'],
-    schema: 'network.xyo.debug',
-  }
-  const payloadC: Payload<{ foo: string[]; schema: string }> = {
-    foo: ['one', 'two'],
-    schema: 'network.xyo.debug',
-  }
-  const payloadD: Payload<{ foo: string[]; schema: string }> = {
-    foo: ['aaa', 'bbb'],
-    schema: 'network.xyo.debug',
-  }
-  const insertedPayloads: WithStorageMeta<Payload>[] = []
-  beforeAll(async () => {
-    archivist = await MemoryArchivist.create({
-      account: 'random',
-      config: { name: 'test', schema: MemoryArchivist.defaultConfigSchema },
-    })
-    for (const payload of [payloadA, payloadB, payloadC, payloadD]) {
-      await delay(2)
-      const [insertedPayload] = await archivist.insert([payload])
-      insertedPayloads.push(insertedPayload)
-    }
-    sut = await MemoryPayloadDiviner.create({
-      account: 'random',
-      config: {
-        archivist: archivist.address,
-        schema: GenericPayloadDivinerConfigSchema,
-      },
-    })
-    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)
-      }),
-    )
-    await sut.start()
-  })
-  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)
-        })
-        it('only return single payload of that schema', async () => {
-          const schemas = ['network.xyo.debug']
-          const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-            .fields({ limit: 1, schemas })
-            .build()
-          const results = await sut.divine([query])
-          expect(results.length).toBe(1)
-          expect(await PayloadBuilder.dataHash(results[0])).toBe(await PayloadBuilder.dataHash(insertedPayloads[3]))
-          expect(results.every(result => result.schema === 'network.xyo.debug')).toBe(true)
-        })
-        it('only return single payload of that schema (desc)', async () => {
-          const schemas = ['network.xyo.debug']
-          const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-            .fields({
-              limit: 1, order: 'desc', schemas,
-            })
-            .build()
-          const results = await sut.divine([query])
-          expect(results.length).toBe(1)
-          expect(PayloadBuilder.omitStorageMeta(results[0])).toEqual(PayloadBuilder.omitStorageMeta(insertedPayloads[3]))
-          expect(await PayloadBuilder.dataHash(results[0])).toBe(await PayloadBuilder.dataHash(insertedPayloads[3]))
-          expect(results.every(result => result.schema === 'network.xyo.debug')).toBe(true)
-        })
-        it('only return single payload of that schema (asc)', async () => {
-          const schemas = ['network.xyo.debug']
-          const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-            .fields({
-              limit: 1, order: 'asc', schemas,
-            })
-            .build()
-          const results = await sut.divine([query])
-          expect(results.length).toBe(1)
-          expect(await PayloadBuilder.dataHash(results[0])).toBe(await PayloadBuilder.dataHash(payloadB))
-          expect(results.every(result => result.schema === 'network.xyo.debug')).toBe(true)
-        })
-      })
-      describe('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', () => {
-        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('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)
-        })
-      })
-    })
-  })
-})

package/src/spec/MemoryPayloadDiviner.spec.ts

@@ -1,183 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-
-import '@xylabs/vitest-extended'
-
-import { delay } from '@xylabs/delay'
-import { MemoryArchivist } from '@xyo-network/archivist-memory'
-import { GenericPayloadDivinerConfigSchema } from '@xyo-network/diviner-payload-generic'
-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 {
-  isSequenceStorageMeta,
-  SequenceConstants,
-} from '@xyo-network/payload-model'
-import {
-  beforeAll,
-  describe, expect, it,
-} from 'vitest'
-
-import { MemoryPayloadDiviner } from '../MemoryPayloadDiviner.ts'
-
-/**
- * @group module
- * @group diviner
- */
-
-describe('MemoryPayloadDiviner', () => {
-  let archivist: MemoryArchivist
-  let sut: MemoryPayloadDiviner
-  let node: MemoryNode
-  let payloadA: Payload<{ schema: string; url: string }>
-  let payloadB: Payload<{ foo: string[]; schema: string }>
-  let insertedPayloads: WithStorageMeta<Payload>[]
-  beforeAll(async () => {
-    payloadA = {
-      schema: 'network.xyo.test',
-      url: 'https://xyo.network',
-    }
-    await delay(2)
-    payloadB = {
-      foo: ['bar', 'baz'],
-      schema: 'network.xyo.debug',
-    }
-
-    archivist = await MemoryArchivist.create({
-      account: 'random',
-      config: { name: 'test', schema: MemoryArchivist.defaultConfigSchema },
-    })
-    insertedPayloads = await archivist.insert([payloadA, payloadB])
-    sut = await MemoryPayloadDiviner.create({
-      account: 'random',
-      config: {
-        archivist: archivist.address,
-        schema: GenericPayloadDivinerConfigSchema,
-      },
-    })
-    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('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('sequence', () => {
-      describe('when order supplied', () => {
-        describe('asc', () => {
-          const order = 'asc'
-          it('returns payloads greater than the supplied sequence', async () => {
-            const cursor = SequenceConstants.minLocalSequence
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-              .fields({ order, cursor })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(isSequenceStorageMeta)).toBeTruthy()
-            expect((results.filter(isSequenceStorageMeta)).every(result => result._sequence > cursor)).toBe(true)
-          })
-          it.skip('returns payloads equal to the supplied sequence (not a thing with _sequence)', async () => {
-            // eslint-disable-next-line sonarjs/no-alphabetical-sort
-            const cursor = insertedPayloads.toSorted()[1]._sequence
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-              .fields({ order, cursor })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(isSequenceStorageMeta)).toBeTruthy()
-            expect((results.filter(isSequenceStorageMeta)).every(result => result._sequence !== cursor)).toBe(true)
-          })
-        })
-        describe('desc', () => {
-          const order = 'desc'
-          it('returns payloads less than the supplied sequence', async () => {
-            const cursor = SequenceConstants.maxLocalSequence
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-              .fields({ order, cursor })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(isSequenceStorageMeta)).toBeTruthy()
-            expect((results.filter(isSequenceStorageMeta)).every(result => result._sequence < cursor)).toBe(true)
-          })
-          it.skip('returns payloads equal to the supplied sequence (not a thing with _sequence)', async () => {
-            // eslint-disable-next-line sonarjs/no-alphabetical-sort
-            const cursor = insertedPayloads.toSorted()[0]._sequence
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema })
-              .fields({ order, cursor })
-              .build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(isSequenceStorageMeta)).toBe(true)
-            expect((results.filter(isSequenceStorageMeta)).every(result => result._sequence !== cursor)).toBe(true)
-          })
-        })
-      })
-      describe('when order not supplied', () => {
-        it.skip('returns payloads equal to the supplied sequence (not a thing with _sequence)', async () => {
-          for (const payload of insertedPayloads) {
-            const cursor = payload._sequence
-            const query = new PayloadBuilder<PayloadDivinerQueryPayload>({ schema: PayloadDivinerQuerySchema }).fields({ cursor }).build()
-            const results = await sut.divine([query])
-            expect(results.length).toBeGreaterThan(0)
-            expect(results.every(isSequenceStorageMeta)).toBe(true)
-            expect((results.filter(isSequenceStorageMeta)).every(result => result._sequence !== cursor)).toBe(true)
-          }
-        })
-      })
-    })
-    describe('custom field', () => {
-      describe('property', () => {
-        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('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)
-        })
-      })
-    })
-  })
-})