@xyo-network/archivist-storage 5.1.21 → 5.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-storage",
-  "version": "5.1.21",
+  "version": "5.1.23",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,36 +30,39 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "src",
+    "!**/*.bench.*",
+    "!**/*.spec.*",
+    "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.24",
-    "@xylabs/exists": "~5.0.24",
-    "@xylabs/hex": "~5.0.24",
-    "@xylabs/promise": "~5.0.24",
-    "@xyo-network/archivist-abstract": "~5.1.21",
-    "@xyo-network/archivist-model": "~5.1.21",
-    "@xyo-network/boundwitness-model": "~5.1.21",
-    "@xyo-network/module-model": "~5.1.21",
-    "@xyo-network/payload-builder": "~5.1.21",
-    "@xyo-network/payload-model": "~5.1.21",
+    "@xylabs/assert": "~5.0.33",
+    "@xylabs/exists": "~5.0.33",
+    "@xylabs/hex": "~5.0.33",
+    "@xylabs/promise": "~5.0.33",
+    "@xyo-network/archivist-abstract": "~5.1.23",
+    "@xyo-network/archivist-model": "~5.1.23",
+    "@xyo-network/boundwitness-model": "~5.1.23",
+    "@xyo-network/module-model": "~5.1.23",
+    "@xyo-network/payload-builder": "~5.1.23",
+    "@xyo-network/payload-model": "~5.1.23",
     "store2": "~2.14.4"
   },
   "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/account": "~5.1.21",
-    "@xyo-network/archivist-acceptance-tests": "~5.1.21",
-    "@xyo-network/archivist-memory": "~5.1.21",
-    "@xyo-network/boundwitness-wrapper": "~5.1.21",
-    "@xyo-network/id-payload-plugin": "~5.1.21",
-    "@xyo-network/node-memory": "~5.1.21",
-    "@xyo-network/payload-wrapper": "~5.1.21",
+    "@xylabs/vitest-extended": "~5.0.33",
+    "@xyo-network/account": "~5.1.23",
+    "@xyo-network/archivist-acceptance-tests": "~5.1.23",
+    "@xyo-network/archivist-memory": "~5.1.23",
+    "@xyo-network/boundwitness-wrapper": "~5.1.23",
+    "@xyo-network/id-payload-plugin": "~5.1.23",
+    "@xyo-network/node-memory": "~5.1.23",
+    "@xyo-network/payload-wrapper": "~5.1.23",
     "typescript": "~5.9.3",
     "uuid": "~13.0.0",
-    "vitest": "~4.0.8"
+    "vitest": "~4.0.9"
   },
   "publishConfig": {
     "access": "public"

package/dist/neutral/spec/StorageArchivist.next.spec.d.ts

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

package/dist/neutral/spec/StorageArchivist.next.spec.d.ts.map

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

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

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

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

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

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

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

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

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

package/src/spec/StorageArchivist.next.spec.ts

@@ -1,111 +0,0 @@
-import { delay } from '@xylabs/delay'
-import { Account } from '@xyo-network/account'
-import { generateArchivistNextTests } from '@xyo-network/archivist-acceptance-tests'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { Payload, WithStorageMeta } from '@xyo-network/payload-model'
-import { v4 } from 'uuid'
-import {
-  describe, expect,
-  it,
-} from 'vitest'
-
-import { StorageArchivist, StorageArchivistConfigSchema } from '../StorageArchivist.ts'
-
-describe('next', () => {
-  it('next', async () => {
-    const archivist = await StorageArchivist.create({
-      account: 'random',
-      config: {
-        namespace: 'test-next',
-        schema: StorageArchivistConfigSchema,
-        type: 'local',
-      },
-    })
-
-    const account = await Account.random()
-
-    const payloads1 = [
-      { schema: 'network.xyo.test', value: 1 },
-      { schema: 'network.xyo.test', value: 2 },
-    ]
-
-    // console.log('Payloads1:', toSafeJsonString(await PayloadBuilder.hashPairs(payloads1), 10))
-
-    await delay(1)
-
-    const payloads2 = [
-      { schema: 'network.xyo.test', value: 3 },
-      { schema: 'network.xyo.test', value: 4 },
-    ]
-
-    // console.log('Payloads2:', toSafeJsonString(await PayloadBuilder.hashPairs(payloads2), 10))
-
-    const insertedPayloads1 = await archivist.insert(payloads1)
-    // console.log(toSafeJsonString(payloads1, 10))
-    const [bw, insertedPayloads2, errors] = await archivist.insertQuery(payloads2, account)
-    expect(bw).toBeDefined()
-    expect(insertedPayloads2).toBeDefined()
-    expect(errors).toBeDefined()
-
-    const sortedInsertedPayloads1 = insertedPayloads1.toSorted(PayloadBuilder.compareStorageMeta)
-    const sortedInsertedPayloads2 = (insertedPayloads2 as WithStorageMeta<Payload>[]).toSorted((PayloadBuilder.compareStorageMeta))
-
-    // console.log(toSafeJsonString([bw, payloads, errors], 10))
-
-    const batch1 = await archivist.next?.({ limit: 2 })
-    expect(batch1.length).toBe(2)
-    expect(await PayloadBuilder.dataHash(batch1?.[0])).toEqual(await PayloadBuilder.dataHash(sortedInsertedPayloads1[0]))
-
-    const batch2 = await archivist.next?.({ limit: 2, cursor: batch1?.[1]._sequence })
-    expect(batch2.length).toBe(2)
-    expect(await PayloadBuilder.dataHash(batch2?.[0])).toEqual(await PayloadBuilder.dataHash(sortedInsertedPayloads2[0]))
-
-    const batch3 = await archivist.next?.({ limit: 20, cursor: batch1?.[1]._sequence })
-    expect(batch3.length).toBe(2)
-    expect(await PayloadBuilder.dataHash(batch3?.[0])).toEqual(await PayloadBuilder.dataHash(sortedInsertedPayloads2[0]))
-
-    // desc
-    const batch1Desc = await archivist.next?.({ limit: 2, order: 'desc' })
-    expect(batch1Desc.length).toBe(2)
-    expect(await PayloadBuilder.dataHash(batch1Desc?.[0])).toEqual(await PayloadBuilder.dataHash(sortedInsertedPayloads2[1]))
-
-    const batch2Desc = await archivist.next?.({
-      limit: 2, cursor: batch1Desc?.[1]._sequence, order: 'desc',
-    })
-    expect(batch2Desc.length).toBe(2)
-    expect(await PayloadBuilder.dataHash(batch2Desc?.[1])).toEqual(await PayloadBuilder.dataHash(sortedInsertedPayloads1[0]))
-
-    const batch3Desc = await archivist.next?.({
-      limit: 20, cursor: batch1Desc?.[1]._sequence, order: 'desc',
-    })
-    expect(batch3Desc.length).toBe(2)
-    expect(await PayloadBuilder.dataHash(batch3Desc?.[1])).toEqual(await PayloadBuilder.dataHash(sortedInsertedPayloads1[0]))
-  })
-  generateArchivistNextTests(async () => {
-    const namespace = v4()
-    return await StorageArchivist.create({
-      account: 'random',
-      config: {
-        namespace, schema: StorageArchivistConfigSchema, type: 'local',
-      },
-    })
-  }, 'next [local]')
-  generateArchivistNextTests(async () => {
-    const namespace = v4()
-    return await StorageArchivist.create({
-      account: 'random',
-      config: {
-        namespace, schema: StorageArchivistConfigSchema, type: 'session',
-      },
-    })
-  }, 'next [session]')
-  generateArchivistNextTests(async () => {
-    const namespace = v4()
-    return await StorageArchivist.create({
-      account: 'random',
-      config: {
-        namespace, schema: StorageArchivistConfigSchema, type: 'page',
-      },
-    })
-  }, 'next [page]')
-})

package/src/spec/StorageArchivist.spec.ts

@@ -1,166 +0,0 @@
-import { delay } from '@xylabs/delay'
-import { Account } from '@xyo-network/account'
-import { MemoryArchivist } from '@xyo-network/archivist-memory'
-import type { ArchivistInstance } from '@xyo-network/archivist-model'
-import { isArchivistInstance, isArchivistModule } from '@xyo-network/archivist-model'
-import { IdSchema } from '@xyo-network/id-payload-plugin'
-import {
-  isModule, isModuleInstance, isModuleObject,
-} from '@xyo-network/module-model'
-import { MemoryNode } from '@xyo-network/node-memory'
-import type { Payload } from '@xyo-network/payload-model'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-import {
-  describe, expect,
-  it, test,
-} from 'vitest'
-
-import { StorageArchivist, StorageArchivistConfigSchema } from '../StorageArchivist.ts'
-
-/**
- * @group module
- * @group jsdom
- * @group archivist
- */
-
-describe('Various StorageArchivist types', () => {
-  const archivistTests: [string, Promise<ArchivistInstance>][] = [
-    [
-      'local',
-      (async () =>
-        await StorageArchivist.create({
-          account: 'random',
-          config: {
-            namespace: 'test', schema: StorageArchivistConfigSchema, type: 'local',
-          },
-        }))(),
-    ],
-    [
-      'session',
-      (async () =>
-        await StorageArchivist.create({
-          account: 'random',
-          config: {
-            namespace: 'test', schema: StorageArchivistConfigSchema, type: 'session',
-          },
-        }))(),
-    ],
-    [
-      'page',
-      (async () =>
-        await StorageArchivist.create({
-          account: 'random',
-          config: {
-            namespace: 'test', schema: StorageArchivistConfigSchema, type: 'page',
-          },
-        }))(),
-    ],
-  ]
-  it.each(archivistTests)('Archivist All', async (_name, archivistPromise) => {
-    const archivist = await archivistPromise
-    expect(isArchivistInstance(archivist)).toBeTruthy()
-    expect(isArchivistModule(archivist)).toBeTruthy()
-    const idPayload = {
-      salt: Date.now().toString(),
-      schema: IdSchema,
-    }
-    for (let x = 0; x < 10; x++) {
-      await archivist.insert([idPayload])
-      await delay(10)
-    }
-    const getResult = await archivist.all?.()
-    expect(getResult).toBeDefined()
-    expect(getResult?.length).toBe(1)
-  })
-  it.each(archivistTests)('Archivist RoundTrip', async (_name, archivistPromise) => {
-    const idPayload: Payload<{ salt: string }> = {
-      salt: Date.now().toString(),
-      schema: IdSchema,
-    }
-    const payloadWrapper = PayloadWrapper.wrap(idPayload)
-
-    const archivist = await archivistPromise
-    const insertResult = await archivist.insert([idPayload])
-    expect(insertResult).toBeDefined()
-
-    const getResult = await archivist.get([await payloadWrapper.dataHash()])
-    expect(getResult).toBeDefined()
-    expect(getResult.length).toBe(1)
-    const gottenPayload = getResult[0]
-    if (gottenPayload) {
-      const gottenPayloadWrapper = PayloadWrapper.wrap(gottenPayload)
-      expect(await gottenPayloadWrapper.dataHash()).toBe(await payloadWrapper.dataHash())
-    }
-  })
-})
-
-test('Archivist Private Key Save', async () => {
-  const account = await Account.random()
-  const storage = await StorageArchivist.create({
-    account,
-    config: {
-      namespace: 'test', schema: StorageArchivistConfigSchema, type: 'local',
-    },
-  })
-  const address = storage.address
-  const storage2 = await StorageArchivist.create({
-    account,
-    config: {
-      namespace: 'test', schema: StorageArchivistConfigSchema, type: 'local',
-    },
-  })
-  expect(storage2.address).toBe(address)
-})
-
-test('Archivist passed account', async () => {
-  const account = await Account.random()
-
-  const storage = (await StorageArchivist.create({
-    account,
-    config: {
-      namespace: 'main', schema: StorageArchivistConfigSchema, type: 'local',
-    },
-  })) as StorageArchivist
-
-  expect(storage['account'].address).toBe(account.address)
-})
-
-test('Archivist Parent Reads', async () => {
-  const parent = await MemoryArchivist.create({ account: 'random' })
-  const memoryNode = await MemoryNode.create({ account: 'random' })
-
-  expect(isModuleObject(parent)).toBe(true)
-
-  expect(isModule(parent)).toBe(true)
-
-  expect(isModuleInstance(parent)).toBe(true)
-
-  expect(isArchivistInstance(parent)).toBe(true)
-
-  await memoryNode.register(parent)
-  await memoryNode.attach(parent.address, true)
-
-  const storage = await StorageArchivist.create({
-    account: 'random',
-    config: {
-      namespace: 'test',
-      parents: { read: [parent.address] },
-      schema: StorageArchivistConfigSchema,
-      type: 'local',
-    },
-  })
-  await memoryNode.register(storage)
-  await memoryNode.attach(storage.address, true)
-
-  const wrapper = PayloadWrapper.wrap({ schema: 'network.xyo.test' })
-
-  expect(wrapper).toBeDefined()
-
-  const inserted = await parent.insert([wrapper.payload])
-
-  expect(inserted.length).toBe(1)
-
-  const fromStorage = await storage.get([await wrapper.dataHash()])
-
-  expect(fromStorage.length).toBe(1)
-})

package/src/spec/StorageArchivistParentWriteThrough.spec.ts

@@ -1,70 +0,0 @@
-import '@xylabs/vitest-extended'
-
-import { MemoryArchivist } from '@xyo-network/archivist-memory'
-import { asArchivistInstance } from '@xyo-network/archivist-model'
-import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
-import type { ModuleQueries } from '@xyo-network/module-model'
-import { MemoryNode } from '@xyo-network/node-memory'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-import {
-  expect,
-  test,
-} from 'vitest'
-
-import { StorageArchivist, StorageArchivistConfigSchema } from '../StorageArchivist.ts'
-
-/**
- * @group module
- * @group archivist
- */
-
-test('Archivist Parent Write Through', async () => {
-  const node = await MemoryNode.create({ account: 'random' })
-  const memory = await MemoryArchivist.create({ account: 'random' })
-
-  const storage = (await StorageArchivist.create({
-    account: 'random',
-    config: {
-      namespace: 'test',
-      parents: { write: [memory.address] },
-      schema: StorageArchivistConfigSchema,
-      type: 'local',
-    },
-  })) as StorageArchivist
-  await node.register(memory)
-  await node.attach(memory.address)
-  await node.register(storage)
-  await node.attach(storage.address)
-
-  const wrapper = PayloadWrapper.wrap({ schema: 'network.xyo.test' })
-
-  expect(wrapper).toBeDefined()
-
-  storage.on('inserted', ({ payloads }) => {
-    expect(payloads.length).toBeGreaterThan(0)
-  })
-
-  storage.on('moduleQueried', async ({ query, payloads }) => {
-    const wrapper = QueryBoundWitnessWrapper.parseQuery<ModuleQueries>(query, payloads)
-    expect(await wrapper.getQuery()).toBeDefined()
-    console.log(`Queried: ${(await wrapper.getQuery()).schema}`)
-  })
-
-  const inserted = await storage.insert([wrapper.payload])
-
-  expect(inserted).toBeArrayOfSize(1)
-
-  const fromStorage = await storage.get([await wrapper.dataHash()])
-  const fromMemory = await memory.get([await wrapper.dataHash()])
-
-  expect(fromStorage).toBeArrayOfSize(1)
-  expect(fromMemory).toBeArrayOfSize(1)
-
-  storage.on('cleared', async ({ mod }) => {
-    const all = await asArchivistInstance(mod)?.all?.()
-    expect(all).toBeEmpty()
-    console.log('Cleared Storage Archivist')
-  })
-
-  await storage.clear()
-})