@xyo-network/archivist-storage 5.3.22 → 5.3.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-storage",
-  "version": "5.3.22",
+  "version": "5.3.25",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,56 +30,52 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*",
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-abstract": "~5.3.22",
-    "@xyo-network/archivist-model": "~5.3.22",
-    "@xyo-network/boundwitness-model": "~5.3.22",
-    "@xyo-network/module-model": "~5.3.22",
-    "@xyo-network/payload-builder": "~5.3.22",
-    "@xyo-network/payload-model": "~5.3.22",
-    "store2": "~2.14.4"
+    "store2": "~2.14.4",
+    "@xyo-network/archivist-abstract": "~5.3.25",
+    "@xyo-network/payload-builder": "~5.3.25",
+    "@xyo-network/boundwitness-model": "~5.3.25",
+    "@xyo-network/module-model": "~5.3.25",
+    "@xyo-network/payload-model": "~5.3.25",
+    "@xyo-network/archivist-model": "~5.3.25"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
     "@types/node": "^25.5.0",
-    "@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/account": "~5.3.22",
-    "@xyo-network/archivist-abstract": "~5.3.22",
-    "@xyo-network/archivist-acceptance-tests": "~5.3.22",
-    "@xyo-network/archivist-memory": "~5.3.22",
-    "@xyo-network/archivist-model": "~5.3.22",
-    "@xyo-network/boundwitness-model": "~5.3.22",
-    "@xyo-network/boundwitness-wrapper": "~5.3.22",
-    "@xyo-network/id-payload-plugin": "~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",
-    "@xyo-network/payload-wrapper": "~5.3.22",
+    "@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",
-    "rollup": "^4.60.1",
     "store2": "~2.14.4",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "uuid": "~13.0.0",
     "vite": "^8.0.3",
     "vitest": "~4.1.2",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/account": "~5.3.25",
+    "@xyo-network/archivist-abstract": "~5.3.25",
+    "@xyo-network/archivist-model": "~5.3.25",
+    "@xyo-network/boundwitness-model": "~5.3.25",
+    "@xyo-network/archivist-memory": "~5.3.25",
+    "@xyo-network/boundwitness-wrapper": "~5.3.25",
+    "@xyo-network/payload-builder": "~5.3.25",
+    "@xyo-network/module-model": "~5.3.25",
+    "@xyo-network/id-payload-plugin": "~5.3.25",
+    "@xyo-network/archivist-acceptance-tests": "~5.3.25",
+    "@xyo-network/node-memory": "~5.3.25",
+    "@xyo-network/payload-model": "~5.3.25",
+    "@xyo-network/payload-wrapper": "~5.3.25"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
@@ -90,4 +86,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/StorageArchivist.ts

@@ -1,200 +0,0 @@
-import type {
-  Hash, Hex, Promisable, PromisableArray,
-} from '@xylabs/sdk-js'
-import {
-  assertEx, exists, fulfilled,
-} from '@xylabs/sdk-js'
-import { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'
-import type {
-  ArchivistConfig,
-  ArchivistInsertQuery,
-  ArchivistInstance,
-  ArchivistModuleEventData,
-  ArchivistNextOptions,
-  ArchivistParams,
-} from '@xyo-network/archivist-model'
-import {
-  ArchivistAllQuerySchema,
-  ArchivistClearQuerySchema,
-  ArchivistCommitQuerySchema,
-  ArchivistDeleteQuerySchema,
-  ArchivistInsertQuerySchema,
-  ArchivistNextQuerySchema,
-} from '@xyo-network/archivist-model'
-import type { BoundWitness } from '@xyo-network/boundwitness-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import {
-  asSchema,
-  type Payload, type Schema, type WithStorageMeta,
-} from '@xyo-network/payload-model'
-import type { StoreBase, StoreType } from 'store2'
-import store from 'store2'
-
-const storeTypes = store as unknown as StoreType
-
-export const StorageArchivistConfigSchema = asSchema('network.xyo.archivist.storage.config', true)
-export type StorageArchivistConfigSchema = typeof StorageArchivistConfigSchema
-
-export type StorageArchivistConfig = ArchivistConfig<{
-  maxEntries?: number
-  maxEntrySize?: number
-  namespace?: string
-  type?: 'local' | 'session' | 'page'
-}, StorageArchivistConfigSchema>
-
-export type StorageArchivistParams = ArchivistParams<AnyConfigSchema<StorageArchivistConfig>>
-export class StorageArchivist<
-  TParams extends StorageArchivistParams = StorageArchivistParams,
-  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
->
-  extends AbstractArchivist<TParams, TEventData>
-  implements ArchivistInstance {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, StorageArchivistConfigSchema]
-  static override readonly defaultConfigSchema: Schema = StorageArchivistConfigSchema
-  static override readonly labels = { ...super.labels, [StorageClassLabel]: 'disk' }
-
-  private _privateStorage: StoreBase | undefined
-  private _storage: StoreBase | undefined
-
-  get maxEntries() {
-    return this.config?.maxEntries ?? 1000
-  }
-
-  get maxEntrySize() {
-    return this.config?.maxEntrySize ?? 16_000
-  }
-
-  get namespace() {
-    return this.config?.namespace ?? 'xyo-archivist'
-  }
-
-  override get queries(): Schema[] {
-    return [
-      ArchivistAllQuerySchema,
-      ArchivistDeleteQuerySchema,
-      ArchivistClearQuerySchema,
-      ArchivistInsertQuerySchema,
-      ArchivistCommitQuerySchema,
-      ArchivistNextQuerySchema,
-      ...super.queries,
-    ]
-  }
-
-  get type() {
-    return this.config?.type ?? 'local'
-  }
-
-  /* This has to be a getter so that it can access it during construction */
-  private get privateStorage(): StoreBase {
-    this._privateStorage = this._storage ?? storeTypes[this.type].namespace(`${this.namespace}|private`)
-    return this._privateStorage
-  }
-
-  /* This has to be a getter so that it can access it during construction */
-  private get storage(): StoreBase {
-    this._storage = this._storage ?? storeTypes[this.type].namespace(this.namespace)
-    return this._storage
-  }
-
-  protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {
-    const found = new Set<string>()
-    this.logger?.log(`this.storage.length: ${this.storage.length}`)
-    return Object.entries(this.storage.getAll())
-      .map(([, value]) => value)
-      .filter((payload) => {
-        if (found.has(payload._dataHash)) {
-          return false
-        } else {
-          found.add(payload._dataHash)
-          return true
-        }
-      })
-      .toSorted(PayloadBuilder.compareStorageMeta)
-  }
-
-  protected override clearHandler(): void | Promise<void> {
-    this.logger?.log(`this.storage.length: ${this.storage.length}`)
-    this.storage.clear()
-    return this.emit('cleared', { mod: this })
-  }
-
-  protected override async commitHandler(): Promise<BoundWitness[]> {
-    this.logger?.log(`this.storage.length: ${this.storage.length}`)
-    const payloads = await this.next({ limit: Number.MAX_SAFE_INTEGER })
-    assertEx(payloads.length > 0, () => 'Nothing to commit')
-    const settled = (await Promise.allSettled(
-      Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {
-        const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }
-        const query = await this.bindQuery(queryPayload, payloads)
-        return (await parent?.query(query[0], query[1]))?.[0]
-      }),
-    )).filter(exists)
-    // TODO - rather than clear, delete the payloads that come back as successfully inserted
-    await this.clear()
-    return (settled.filter(fulfilled).map(result => result.value)).filter(exists)
-  }
-
-  protected override async deleteHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]> {
-    return (
-      await Promise.all(
-        hashes.map((hash) => {
-          const payload = this.storage.get(hash)
-          if (payload) {
-            this.storage.remove(hash)
-          }
-          return payload
-        }),
-      )
-    ).filter(exists)
-  }
-
-  protected getFromCursor(
-    order: 'asc' | 'desc' = 'asc',
-    limit: number = 10,
-    cursor?: Hex,
-    open?: boolean,
-  ): WithStorageMeta[] {
-    const all = Object.values(this.storage.getAll()) as WithStorageMeta[]
-    const payloads: WithStorageMeta[] = all
-      .map(value => value)
-      .toSorted((item1, item2) => {
-        return order === 'asc' ? PayloadBuilder.compareStorageMeta(item1, item2) : PayloadBuilder.compareStorageMeta(item2, item1)
-      })
-    const index = payloads.findIndex(payload => payload._sequence === cursor)
-    if (index !== -1) {
-      return payloads.slice(index + (open ? 1 : 0), index + (open ? 1 : 0) + limit)
-    }
-    return payloads.slice(0, limit)
-  }
-
-  protected override getHandler(hashes: string[]): Promisable<WithStorageMeta<Payload>[]> {
-    return (
-      hashes.map((hash) => {
-        return this.storage.get(hash)
-      })
-    ).filter(exists)
-  }
-
-  protected override async insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]> {
-    return await Promise.all(payloads.map((payload) => {
-      const value = JSON.stringify(payload)
-      // console.log('insert.storagePayloads:', storagePayload)
-      assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payload._hash}, ${value.length}]`)
-      this.storage.set(payload._hash, payload)
-      this.storage.set(payload._dataHash, payload)
-      return payload
-    }))
-  }
-
-  protected override nextHandler(options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]> {
-    const {
-      limit, cursor, order, open = true,
-    } = options ?? {}
-    return this.getFromCursor(order, limit ?? 10, cursor, open)
-  }
-
-  protected override async startHandler() {
-    await super.startHandler()
-  }
-}

package/src/index.ts

@@ -1 +0,0 @@
-export * from './StorageArchivist.ts'