@xyo-network/archivist-lmdb 5.3.20 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-lmdb",
-  "version": "5.3.20",
+  "version": "5.3.24",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,39 +30,54 @@
   "types": "dist/browser/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
-    "!**/*.test.*"
+    "!**/*.test.*",
+    "README.md"
   ],
   "dependencies": {
-    "@xyo-network/archivist-abstract": "~5.3.20",
-    "@xyo-network/archivist-model": "~5.3.20",
-    "@xyo-network/boundwitness-model": "~5.3.20",
-    "@xyo-network/module-model": "~5.3.20",
-    "@xyo-network/payload-builder": "~5.3.20",
-    "@xyo-network/payload-model": "~5.3.20"
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/archivist-abstract": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24"
   },
   "devDependencies": {
-    "@xylabs/sdk-js": "^5.0.90",
-    "@xylabs/ts-scripts-common": "~7.5.6",
-    "@xylabs/ts-scripts-yarn3": "~7.5.6",
-    "@xylabs/tsconfig": "~7.5.6",
-    "@xylabs/vitest-extended": "~5.0.90",
-    "@xyo-network/account": "~5.3.20",
-    "@xyo-network/account-model": "~5.3.20",
-    "@xyo-network/archivist-acceptance-tests": "~5.3.20",
-    "@xyo-network/id-payload-plugin": "~5.3.20",
-    "@xyo-network/payload-wrapper": "~5.3.20",
-    "@xyo-network/wallet": "~5.3.20",
+    "@opentelemetry/api": "^1.9.1",
+    "@types/node": "^25.5.0",
+    "@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",
+    "esbuild": "^0.28.0",
+    "ethers": "^6.16.0",
     "lmdb": "^3.5.2",
+    "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/archivist-abstract": "~5.3.24",
+    "@xyo-network/account": "~5.3.24",
+    "@xyo-network/account-model": "~5.3.24",
+    "@xyo-network/archivist-acceptance-tests": "~5.3.24",
+    "@xyo-network/archivist-model": "~5.3.24",
+    "@xyo-network/module-model": "~5.3.24",
+    "@xyo-network/boundwitness-model": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/id-payload-plugin": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/payload-wrapper": "~5.3.24",
+    "@xyo-network/wallet": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
+    "ethers": "^6",
     "lmdb": "^3",
     "tslib": "^2.8.1",
     "zod": "^4"
@@ -70,4 +85,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Archivist.ts

@@ -1,183 +0,0 @@
-import {
-  assertEx,
-  exists,
-  fulfilled, Hash, Hex,
-} from '@xylabs/sdk-js'
-import { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'
-import {
-  ArchivistAllQuerySchema,
-  ArchivistClearQuerySchema,
-  ArchivistCommitQuerySchema,
-  ArchivistDeleteQuerySchema,
-  ArchivistInsertQuery,
-  ArchivistInsertQuerySchema,
-  ArchivistModuleEventData,
-  ArchivistNextOptions,
-  ArchivistNextQuerySchema,
-  IndexDescription,
-} from '@xyo-network/archivist-model'
-import { BoundWitness } from '@xyo-network/boundwitness-model'
-import { creatableModule } from '@xyo-network/module-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import {
-  Payload, Schema, SequenceConstants,
-  WithStorageMeta,
-} from '@xyo-network/payload-model'
-import {
-  Database, open,
-  RangeOptions, RootDatabase,
-} from 'lmdb'
-
-import { LmdbArchivistConfigSchema } from './Config.ts'
-import { LmdbArchivistParams } from './Params.ts'
-
-@creatableModule()
-export class LmdbArchivist<
-  TParams extends LmdbArchivistParams = LmdbArchivistParams,
-  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
-> extends AbstractArchivist<TParams, TEventData> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, LmdbArchivistConfigSchema]
-  static override readonly defaultConfigSchema: Schema = LmdbArchivistConfigSchema
-  static override readonly labels = { ...super.labels, [StorageClassLabel]: 'disk' }
-
-  protected static readonly dataHashIndex: IndexDescription = {
-    key: { _dataHash: 1 }, multiEntry: false, unique: false,
-  }
-
-  protected static readonly sequenceIndex: IndexDescription = {
-    key: { _sequence: 1 }, multiEntry: false, unique: true,
-  }
-
-  protected dataHashIndex!: Database<Hash, string>
-  protected db!: RootDatabase
-  protected hashIndex!: Database<WithStorageMeta<Payload>, Hash>
-  protected sequenceIndex!: Database<Hash, Hex>
-
-  get dbName() {
-    return assertEx(this.config.dbName, () => 'No dbName specified')
-  }
-
-  get folderPath() {
-    return `${this.location}/${this.config.dbName}/${this.storeName}`
-  }
-
-  get location() {
-    return assertEx(this.config.location, () => 'No location specified')
-  }
-
-  override get queries() {
-    return [
-      ArchivistAllQuerySchema,
-      ArchivistDeleteQuerySchema,
-      ArchivistClearQuerySchema,
-      ArchivistInsertQuerySchema,
-      ArchivistCommitQuerySchema,
-      ArchivistNextQuerySchema,
-      ...super.queries,
-    ]
-  }
-
-  get storeName() {
-    return assertEx(this.config.storeName, () => 'No storeName specified')
-  }
-
-  override async startHandler() {
-    await super.startHandler()
-
-    // Open LMDB database
-    this.db = open({
-      path: this.folderPath,
-      maxDbs: 3, // Payloads, dataHashIndex, sequenceIndex
-    })
-
-    // Open sub-databases
-    this.hashIndex = this.db.openDB<WithStorageMeta<Payload>, Hash>({ name: 'payloads' })
-    this.dataHashIndex = this.db.openDB<Hash, string>({ name: 'dataHashIndex' })
-    this.sequenceIndex = this.db.openDB<Hash, Hex>({ name: 'sequenceIndex' })
-
-    if (this.config.clearStoreOnStart) {
-      await this.clearHandler()
-    }
-  }
-
-  protected override allHandler(): WithStorageMeta<Payload>[] {
-    return [...this.hashIndex.getRange({})].map(entry => entry.value).toSorted(PayloadBuilder.compareStorageMeta)
-  }
-
-  protected override async clearHandler(): Promise<void> {
-    // Ensure all operations are synchronous within transaction
-    await this.db.transaction(() => {
-      this.hashIndex.clearSync()
-      this.dataHashIndex.clearSync()
-      this.sequenceIndex.clearSync()
-    })
-    return this.emit('cleared', { mod: this })
-  }
-
-  protected override async commitHandler(): Promise<BoundWitness[]> {
-    const payloads = this.allHandler()
-    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),
-    )
-    await this.clearHandler()
-    return settled.filter(fulfilled).map(result => result.value).filter(exists)
-  }
-
-  protected override async deleteHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]> {
-    return (await this.db.transaction(() => {
-      return hashes.map((hash) => {
-        const payload = this.hashIndex.get(hash)
-        if (payload) {
-          this.hashIndex.removeSync(hash)
-          this.dataHashIndex.removeSync(payload._dataHash)
-          this.sequenceIndex.removeSync(payload._sequence)
-          return payload
-        }
-      })
-    })).filter(exists)
-  }
-
-  protected override getHandler(hashes: Hash[]): WithStorageMeta<Payload>[] {
-    return hashes.map((hash) => {
-      const byHash = this.hashIndex.get(hash)
-      if (byHash) return byHash
-      const byDataHash = this.dataHashIndex.get(hash)
-      if (byDataHash) return this.hashIndex.get(byDataHash)
-    }).filter(exists)
-  }
-
-  protected override async insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]> {
-    await this.db.transaction(() => {
-      for (const payload of payloads) {
-        this.hashIndex.putSync(payload._hash, payload)
-        this.dataHashIndex.putSync(payload._dataHash, payload._hash)
-        this.sequenceIndex.putSync(payload._sequence, payload._hash)
-      }
-    })
-    return payloads
-  }
-
-  protected override nextHandler(options?: ArchivistNextOptions): WithStorageMeta<Payload>[] {
-    const {
-      limit = 100, cursor, order, open = cursor ? true : false,
-    } = options ?? {}
-
-    // Determine search range based on order (ascending or descending)
-    const rangeOptions: RangeOptions = order === 'desc'
-      ? { start: cursor ?? SequenceConstants.maxLocalSequence, reverse: true }
-      : { start: cursor ?? SequenceConstants.minLocalSequence }
-
-    // Get range of sequence-indexed hashes
-    const sequenceEntries = [...this.sequenceIndex.getRange(rangeOptions)]
-      .slice(open ? 1 : 0, limit + (open ? 1 : 0)) // Apply cursor offset and limit
-
-    // Fetch full payloads using hashes retrieved from sequence index
-    return sequenceEntries
-      .map(({ value: hash }) => this.hashIndex.get(hash))
-      .filter(exists)
-  }
-}

package/src/Config.ts

@@ -1,27 +0,0 @@
-import type { ArchivistConfig } from '@xyo-network/archivist-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-import { LmdbArchivistSchema } from './Schema.ts'
-
-export const LmdbArchivistConfigSchema = asSchema(`${LmdbArchivistSchema}.config`, true)
-export type LmdbArchivistConfigSchema = typeof LmdbArchivistConfigSchema
-
-export type LmdbArchivistConfig<TStoreName extends string = string> = ArchivistConfig<{
-  /**
-   * If true, the store will be cleared on start
-   */
-  clearStoreOnStart?: boolean
-  /**
-   * The database name - also used as the filename for the db
-   */
-  dbName?: string
-  /**
-   * The location where the folder for the db will be created
-   */
-  location?: string
-  schema: LmdbArchivistConfigSchema
-  /**
-   * The name of the object store - becomes a sub-level
-   */
-  storeName?: TStoreName
-}>

package/src/Params.ts

@@ -1,8 +0,0 @@
-import type { ArchivistParams } from '@xyo-network/archivist-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-
-import type { LmdbArchivistConfig } from './Config.ts'
-
-export interface LmdbArchivistParams extends ArchivistParams<AnyConfigSchema<LmdbArchivistConfig>> {
-
-}

package/src/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const LmdbArchivistSchema = asSchema('network.xyo.archivist.lmdb', true)
-export type LmdbArchivistSchema = typeof LmdbArchivistSchema

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './Archivist.ts'
-export * from './Config.ts'
-export * from './Params.ts'
-export * from './Schema.ts'