@xyo-network/archivist-model 3.6.0-rc.1 → 3.6.0-rc.11

package/dist/neutral/typeChecks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typeChecks.d.ts","sourceRoot":"","sources":["../../src/typeChecks.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAGlD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;wDAA6F,CAAA;AAC7H,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;sDAA2E,CAAA;AAEzG,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;yEANG,iBAAiB,iCACjB,gBAAmB;;;;;;;;;;;;;;;;;;;yEAEiB,iBAAiB;;;;;;;;;;;;;;;;;;4EAC9B,gBAAoB;CAEF,CAAA;AAC1E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;2EAPC,iBAAiB,iCACjB,gBAAmB;;;;;;;;;;;;;;;;;;;;;2EAEiB,iBAAiB;;;;;;;;;;;;;;;;;;;;8EAC9B,gBAAoB;CAGE,CAAA;AAC9E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;6EAAwC,CAAA;AACxE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;+EAA0C,CAAA"}
+{"version":3,"file":"typeChecks.d.ts","sourceRoot":"","sources":["../../src/typeChecks.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAGlD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAA6F,CAAA;AAC7H,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sDAA2E,CAAA;AAEzG,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yEANE,iBAAiB,iCAClB,gBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yEAEiB,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAC9B,gBAAoB;CAED,CAAA;AAC1E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAPA,iBAAiB,iCAClB,gBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAEiB,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAC9B,gBAAoB;CAGG,CAAA;AAC9E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6EAAwC,CAAA;AACxE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAA0C,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-model",
-  "version": "3.6.0-rc.1",
+  "version": "3.6.0-rc.11",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,18 +29,18 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/hex": "^4.4.12",
-    "@xylabs/object": "^4.4.12",
-    "@xylabs/promise": "^4.4.12",
-    "@xylabs/typeof": "^4.4.12",
-    "@xyo-network/account-model": "^3.6.0-rc.1",
-    "@xyo-network/module-events": "^3.6.0-rc.1",
-    "@xyo-network/module-model": "^3.6.0-rc.1",
-    "@xyo-network/payload-model": "^3.6.0-rc.1"
+    "@xylabs/hex": "^4.4.24",
+    "@xylabs/object": "^4.4.24",
+    "@xylabs/promise": "^4.4.24",
+    "@xylabs/typeof": "^4.4.24",
+    "@xyo-network/account-model": "^3.6.0-rc.11",
+    "@xyo-network/module-events": "^3.6.0-rc.11",
+    "@xyo-network/module-model": "^3.6.0-rc.11",
+    "@xyo-network/payload-model": "^3.6.0-rc.11"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.4",
-    "@xylabs/tsconfig": "^4.2.4",
+    "@xylabs/ts-scripts-yarn3": "^4.2.6",
+    "@xylabs/tsconfig": "^4.2.6",
     "typescript": "^5.7.2"
   },
   "publishConfig": {

package/src/IndexDescription.ts

@@ -10,11 +10,7 @@ export type IndexDescription = {
   /**
    * The key(s) to index
    */
-  key:
-    | {
-      [key: string]: IndexDirection
-    }
-    | Map<string, IndexDirection>
+  key: Record<string, IndexDirection>
   /**
    * Is the indexed value an array
    */

package/src/NextOptions.ts

@@ -1,8 +1,8 @@
-import type { Hash } from '@xylabs/hex'
+import type { Hash, Hex } from '@xylabs/hex'
 
-export interface NextOptions<TId = string> {
+export interface NextOptions<TId = Hex> {
+  cursor?: TId
   limit?: number
-  offset?: TId
   order?: 'asc' | 'desc'
 }
 

package/src/QueryFunctions.ts

@@ -1,7 +1,7 @@
 import type { Hash } from '@xylabs/hex'
 import type { Promisable, PromisableArray } from '@xylabs/promise'
 import type { ModuleQueryFunctions } from '@xyo-network/module-model'
-import type { Payload } from '@xyo-network/payload-model'
+import type { Payload, WithStorageMeta } from '@xyo-network/payload-model'
 
 import type { NextOptions } from './NextOptions.ts'
 
@@ -26,8 +26,8 @@ export interface Archivist<
   TWriteResponse extends Payload = Payload,
   TWrite extends Payload = TReadResponse & Payload,
   TId = Hash,
-> extends ReadArchivist<TReadResponse, TId>,
-  WriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>,
+> extends ReadArchivist<WithStorageMeta<TReadResponse>, TId>,
+  WriteArchivist<WithStorageMeta<TReadResponse>, WithStorageMeta<TWriteResponse>, TWrite, TId>,
   StashArchivist<TWriteResponse> {}
 
 export interface ArchivistQueryFunctions<

package/src/StorageMeta.ts

@@ -0,0 +1,37 @@
+import type { Hash, Hex } from '@xylabs/hex'
+import type { Payload } from '@xyo-network/payload-model'
+
+export interface StorageMeta {
+  _dataHash: Hash
+  _hash: Hash
+  // this sequence number must be a 0 padded string representation of a 18 byte sequence number
+  _sequence: Hex // zero padded epoch/index (when returned, has address as suffix) - to be used as a universal cursor
+}
+
+export type WithPartialStorageMeta<T extends Payload = Payload> = Partial<WithStorageMeta<T>>
+
+export type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta
+
+const StorageMetaComponentConstants = {
+  epochBytes: 8,
+  nonceBytes: 8,
+  addressBytes: 20,
+}
+
+const StorageMetaLocalConstants = {
+  maxEpoch: Math.pow(256, StorageMetaComponentConstants.epochBytes) - 1,
+  localSequenceBytes: StorageMetaComponentConstants.epochBytes + StorageMetaComponentConstants.nonceBytes,
+  ...StorageMetaComponentConstants,
+}
+
+export const SequenceConstants = {
+  qualifiedSequenceBytes: StorageMetaLocalConstants.localSequenceBytes + StorageMetaComponentConstants.addressBytes,
+  ...StorageMetaLocalConstants,
+}
+
+// "00005a7f354762f3ac1bc5ddc6cfd08d14" is and example of a local sequence string
+
+// "00005a7f354762f3ac1bc5ddc6cfd08d14a123456789abcdef0123" is and example of a local sequence string
+// epoch = "00005a7f354762f3ac"
+// nonce = "1bc5ddc6cfd08d14"
+// address = "a123456789abcdef0123"