@xyo-network/archivist-model 3.5.2 → 3.6.0-rc.2

package/dist/neutral/EventModels/Inserted.d.ts

@@ -1,8 +1,8 @@
 import type { EventData } from '@xyo-network/module-events';
 import type { Module, ModuleEventArgs } from '@xyo-network/module-model';
-import type { Payload, WithMeta } from '@xyo-network/payload-model';
+import type { Payload } from '@xyo-network/payload-model';
 export type InsertedEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
-    payloads: WithMeta<Payload>[];
+    payloads: Payload[];
 }>;
 export interface InsertedEventData<T extends Module = Module> extends EventData {
     inserted: InsertedEventArgs<T>;

package/dist/neutral/EventModels/Inserted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Inserted.d.ts","sourceRoot":"","sources":["../../../src/EventModels/Inserted.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,eAAe,CACxE,CAAC,EACD;IACE,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAA;CAC9B,CACF,CAAA;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,SAAS;IAC7E,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAA;CAC/B"}
+{"version":3,"file":"Inserted.d.ts","sourceRoot":"","sources":["../../../src/EventModels/Inserted.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,eAAe,CACxE,CAAC,EACD;IACE,QAAQ,EAAE,OAAO,EAAE,CAAA;CACpB,CACF,CAAA;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,SAAS;IAC7E,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAA;CAC/B"}

package/dist/neutral/Instance.d.ts

@@ -1,10 +1,10 @@
 import type { ModuleInstance } from '@xyo-network/module-model';
-import type { Payload, WithMeta } from '@xyo-network/payload-model';
+import type { Payload } from '@xyo-network/payload-model';
 import type { ArchivistModuleEventData } from './EventData.ts';
 import type { ArchivistModule } from './Module.ts';
 import type { ArchivistParams } from './Params.ts';
 import type { ArchivistQueryFunctions } from './QueryFunctions.ts';
 import type { ArchivistRawQueryFunctions } from './RawQueryFunctions.ts';
-export interface ArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModule<TParams, TEventData>, ArchivistQueryFunctions<TPayload, WithMeta<TPayload>>, ModuleInstance<TParams, TEventData>, ArchivistRawQueryFunctions {
+export interface ArchivistInstance<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData, TPayload extends Payload = Payload> extends ArchivistModule<TParams, TEventData>, ArchivistQueryFunctions<TPayload, TPayload>, ModuleInstance<TParams, TEventData>, ArchivistRawQueryFunctions {
 }
 //# sourceMappingURL=Instance.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Instance.d.ts","sourceRoot":"","sources":["../../src/Instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAA;AAExE,MAAM,WAAW,iBAAiB,CAChC,OAAO,SAAS,eAAe,GAAG,eAAe,EACjD,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,EACtE,QAAQ,SAAS,OAAO,GAAG,OAAO,CAClC,SAAQ,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,EAC5C,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EACrD,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,EACnC,0BAA0B;CAAG"}
+{"version":3,"file":"Instance.d.ts","sourceRoot":"","sources":["../../src/Instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAA;AAExE,MAAM,WAAW,iBAAiB,CAChC,OAAO,SAAS,eAAe,GAAG,eAAe,EACjD,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,EACtE,QAAQ,SAAS,OAAO,GAAG,OAAO,CAClC,SAAQ,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,EAC5C,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAC3C,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,EACnC,0BAA0B;CAAG"}

package/dist/neutral/QueryFunctions.d.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, WithMeta } from '@xyo-network/payload-model';
+import type { Payload } from '@xyo-network/payload-model';
 import type { NextOptions } from './NextOptions.ts';
 export interface ReadArchivist<TReadResponse, TId = string> {
     all(): PromisableArray<TReadResponse>;
@@ -16,7 +16,7 @@ export interface WriteArchivist<TReadResponse, TWriteResponse = TReadResponse, T
 export interface StashArchivist<TWriteResponse> {
     commit(): PromisableArray<TWriteResponse>;
 }
-export interface Archivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends ReadArchivist<WithMeta<TReadResponse>, TId>, WriteArchivist<WithMeta<TReadResponse>, WithMeta<TWriteResponse>, TWrite, TId>, StashArchivist<WithMeta<TWriteResponse>> {
+export interface Archivist<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends ReadArchivist<TReadResponse, TId>, WriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>, StashArchivist<TWriteResponse> {
 }
 export interface ArchivistQueryFunctions<TReadResponse extends Payload = Payload, TWriteResponse extends Payload = Payload, TWrite extends Payload = TReadResponse & Payload, TId = Hash> extends Archivist<TReadResponse, TWriteResponse, TWrite, TId>, ModuleQueryFunctions {
 }

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

@@ -1 +1 @@
-{"version":3,"file":"QueryFunctions.d.ts","sourceRoot":"","sources":["../../src/QueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,MAAM,WAAW,aAAa,CAAC,aAAa,EAAE,GAAG,GAAG,MAAM;IACxD,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAA;IACrC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC,aAAa,CAAC,CAAA;IAC/C,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,aAAa,CAAC,CAAA;CACjE;AAED,MAAM,WAAW,cAAc,CAAC,aAAa,EAAE,cAAc,GAAG,aAAa,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,GAAG,MAAM;IACjH,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;IACxC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,cAAc,CAAC,CAAA;CACxD;AAED,MAAM,WAAW,cAAc,CAAC,cAAc;IAC5C,MAAM,IAAI,eAAe,CAAC,cAAc,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,SAAS,CACxB,aAAa,SAAS,OAAO,GAAG,OAAO,EACvC,cAAc,SAAS,OAAO,GAAG,OAAO,EACxC,MAAM,SAAS,OAAO,GAAG,aAAa,GAAG,OAAO,EAChD,GAAG,GAAG,IAAI,CACV,SAAQ,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,GAAG,CAAC,EACnD,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAC9E,cAAc,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;CAAG;AAE7C,MAAM,WAAW,uBAAuB,CACtC,aAAa,SAAS,OAAO,GAAG,OAAO,EACvC,cAAc,SAAS,OAAO,GAAG,OAAO,EACxC,MAAM,SAAS,OAAO,GAAG,aAAa,GAAG,OAAO,EAChD,GAAG,GAAG,IAAI,CACV,SAAQ,SAAS,CAAC,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,CAAC,EAC7D,oBAAoB;CAAG"}
+{"version":3,"file":"QueryFunctions.d.ts","sourceRoot":"","sources":["../../src/QueryFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,MAAM,WAAW,aAAa,CAAC,aAAa,EAAE,GAAG,GAAG,MAAM;IACxD,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAA;IACrC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC,aAAa,CAAC,CAAA;IAC/C,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,aAAa,CAAC,CAAA;CACjE;AAED,MAAM,WAAW,cAAc,CAAC,aAAa,EAAE,cAAc,GAAG,aAAa,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,GAAG,MAAM;IACjH,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;IACxC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,cAAc,CAAC,CAAA;CACxD;AAED,MAAM,WAAW,cAAc,CAAC,cAAc;IAC5C,MAAM,IAAI,eAAe,CAAC,cAAc,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,SAAS,CACxB,aAAa,SAAS,OAAO,GAAG,OAAO,EACvC,cAAc,SAAS,OAAO,GAAG,OAAO,EACxC,MAAM,SAAS,OAAO,GAAG,aAAa,GAAG,OAAO,EAChD,GAAG,GAAG,IAAI,CACV,SAAQ,aAAa,CAAC,aAAa,EAAE,GAAG,CAAC,EACzC,cAAc,CAAC,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,CAAC,EAC1D,cAAc,CAAC,cAAc,CAAC;CAAG;AAEnC,MAAM,WAAW,uBAAuB,CACtC,aAAa,SAAS,OAAO,GAAG,OAAO,EACvC,cAAc,SAAS,OAAO,GAAG,OAAO,EACxC,MAAM,SAAS,OAAO,GAAG,aAAa,GAAG,OAAO,EAChD,GAAG,GAAG,IAAI,CACV,SAAQ,SAAS,CAAC,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,CAAC,EAC7D,oBAAoB;CAAG"}

package/dist/neutral/StorageMeta.d.ts

@@ -0,0 +1,18 @@
+import type { Hash, Hex } from '@xylabs/hex';
+import type { Payload } from '@xyo-network/payload-model';
+export interface StorageMeta {
+    _dataHash: Hash;
+    _hash: Hash;
+    _sequence: Hex;
+}
+export type WithPartialStorageMeta<T extends Payload = Payload> = Partial<WithStorageMeta<T>>;
+export type WithStorageMeta<T extends Payload = Payload> = T & StorageMeta;
+export declare const StorageMetaConstants: {
+    epochBytes: number;
+    nonceBytes: number;
+    addressBytes: number;
+    maxEpoch: number;
+    localSequenceBytes: number;
+    qualifiedSequenceBytes: number;
+};
+//# sourceMappingURL=StorageMeta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageMeta.d.ts","sourceRoot":"","sources":["../../src/StorageMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEzD,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,IAAI,CAAA;IACf,KAAK,EAAE,IAAI,CAAA;IAEX,SAAS,EAAE,GAAG,CAAA;CACf;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;AAE7F,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,GAAG,WAAW,CAAA;AAc1E,eAAO,MAAM,oBAAoB;;;;;;;CAGhC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-model",
-  "version": "3.5.2",
+  "version": "3.6.0-rc.2",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,14 +29,14 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/hex": "^4.4.9",
-    "@xylabs/object": "^4.4.9",
-    "@xylabs/promise": "^4.4.9",
-    "@xylabs/typeof": "^4.4.9",
-    "@xyo-network/account-model": "^3.5.2",
-    "@xyo-network/module-events": "^3.5.2",
-    "@xyo-network/module-model": "^3.5.2",
-    "@xyo-network/payload-model": "^3.5.2"
+    "@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.2",
+    "@xyo-network/module-events": "^3.6.0-rc.2",
+    "@xyo-network/module-model": "^3.6.0-rc.2",
+    "@xyo-network/payload-model": "^3.6.0-rc.2"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^4.2.4",
@@ -45,5 +45,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "stableVersion": "3.5.2"
 }

package/src/EventModels/Inserted.ts

@@ -1,11 +1,11 @@
 import type { EventData } from '@xyo-network/module-events'
 import type { Module, ModuleEventArgs } from '@xyo-network/module-model'
-import type { Payload, WithMeta } from '@xyo-network/payload-model'
+import type { Payload } from '@xyo-network/payload-model'
 
 export type InsertedEventArgs<T extends Module = Module> = ModuleEventArgs<
   T,
   {
-    payloads: WithMeta<Payload>[]
+    payloads: Payload[]
   }
 >
 

package/src/Instance.ts

@@ -1,5 +1,5 @@
 import type { ModuleInstance } from '@xyo-network/module-model'
-import type { Payload, WithMeta } from '@xyo-network/payload-model'
+import type { Payload } from '@xyo-network/payload-model'
 
 import type { ArchivistModuleEventData } from './EventData.ts'
 import type { ArchivistModule } from './Module.ts'
@@ -12,6 +12,6 @@ export interface ArchivistInstance<
   TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
   TPayload extends Payload = Payload,
 > extends ArchivistModule<TParams, TEventData>,
-  ArchivistQueryFunctions<TPayload, WithMeta<TPayload>>,
+  ArchivistQueryFunctions<TPayload, TPayload>,
   ModuleInstance<TParams, TEventData>,
   ArchivistRawQueryFunctions {}

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, WithMeta } from '@xyo-network/payload-model'
+import type { Payload } from '@xyo-network/payload-model'
 
 import type { NextOptions } from './NextOptions.ts'
 
@@ -26,9 +26,9 @@ export interface Archivist<
   TWriteResponse extends Payload = Payload,
   TWrite extends Payload = TReadResponse & Payload,
   TId = Hash,
-> extends ReadArchivist<WithMeta<TReadResponse>, TId>,
-  WriteArchivist<WithMeta<TReadResponse>, WithMeta<TWriteResponse>, TWrite, TId>,
-  StashArchivist<WithMeta<TWriteResponse>> {}
+> extends ReadArchivist<TReadResponse, TId>,
+  WriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>,
+  StashArchivist<TWriteResponse> {}
 
 export interface ArchivistQueryFunctions<
   TReadResponse extends Payload = Payload,

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 StorageMetaConstants = {
+  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"