@xyo-network/payload-builder 3.6.0-rc.8 → 3.6.0

package/dist/node/index.mjs

@@ -1,114 +1,45 @@
 // src/Builder.ts
-import { ObjectHasher } from "@xyo-network/hash";
-import {
-  SequenceParser
-} from "@xyo-network/payload-model";
-
-// src/BuilderBase.ts
 import { assertEx } from "@xylabs/assert";
 import {
   isJsonObject,
-  omitBy,
+  omitByPrefix,
+  pickByPrefix,
   toJson
 } from "@xylabs/object";
-import { removeEmptyFields } from "@xyo-network/hash";
-var omitByPrefix = (payload, prefix, maxDepth = 100) => {
-  return omitBy(payload, omitByPrefixPredicate(prefix), maxDepth);
-};
+import { ObjectHasher, removeEmptyFields } from "@xyo-network/hash";
+import {
+  SequenceComparer,
+  SequenceParser
+} from "@xyo-network/payload-model";
 var omitSchema = (payload) => {
   const result = structuredClone(payload);
   delete result.schema;
   return result;
 };
-var omitByPrefixPredicate = (prefix) => (_, key) => {
-  assertEx(typeof key === "string", () => `Invalid key type [${key}, ${typeof key}]`);
-  return key.startsWith(prefix);
-};
-var PayloadBuilderBase = class _PayloadBuilderBase {
+var PayloadBuilder = class _PayloadBuilder {
   constructor(options) {
     this.options = options;
-    const { schema, fields } = options;
+    const { schema } = options;
     this._schema = schema;
-    if (fields) {
-      this.fields(fields);
-    }
   }
   _fields;
+  _meta;
   _schema;
-  static dataHashableFields(schema, payload) {
-    const cleanFields = removeEmptyFields({ ...payload, schema });
-    assertEx(
-      cleanFields === void 0 || isJsonObject(cleanFields),
-      () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`
-    );
-    return this.omitMeta(cleanFields);
-  }
-  static omitClientMeta(payloads, maxDepth = 100) {
-    return Array.isArray(payloads) ? payloads.map((payload) => this.omitClientMeta(payload, maxDepth)) : omitByPrefix(payloads, "$", maxDepth);
-  }
-  static omitMeta(payloads, maxDepth = 100) {
-    return Array.isArray(payloads) ? payloads.map((payload) => this.omitMeta(payload, maxDepth)) : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth);
-  }
-  static omitPrivateStorageMeta(payloads, maxDepth = 100) {
-    return Array.isArray(payloads) ? payloads.map((payload) => this.omitPrivateStorageMeta(payload, maxDepth)) : omitByPrefix(payloads, "__", maxDepth);
-  }
-  static omitStorageMeta(payloads, maxDepth = 100) {
-    return Array.isArray(payloads) ? payloads.map((payload) => this.omitStorageMeta(payload, maxDepth)) : omitByPrefix(payloads, "_", maxDepth);
-  }
-  async dataHashableFields() {
-    return await _PayloadBuilderBase.dataHashableFields(
-      assertEx(this._schema, () => "Payload: Missing Schema"),
-      // TODO: Add verification that required fields are present
-      this._fields
-    );
-  }
-  fields(fields) {
-    this._fields = omitSchema(_PayloadBuilderBase.omitMeta(removeEmptyFields(structuredClone(fields))));
-    return this;
-  }
-  schema(value) {
-    this._schema = value;
-  }
-};
-
-// src/Builder.ts
-var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
-  static async addHashMeta(payloads) {
-    if (Array.isArray(payloads)) {
-      return await Promise.all(
-        payloads.map(async (payload) => {
-          return await this.addHashMeta(payload);
-        })
-      );
-    } else {
-      const _hash = await _PayloadBuilder.hash(payloads);
-      const _dataHash = await _PayloadBuilder.dataHash(payloads);
-      return {
-        ...payloads,
-        _dataHash,
-        _hash
-      };
-    }
-  }
-  static async addSequencedStorageMeta(payload) {
-    const withHashMeta = await this.addHashMeta(payload);
-    const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash).localSequence;
-    return {
-      ...withHashMeta,
-      _sequence
-    };
-  }
-  static async addStorageMeta(payloads) {
+  static async addStorageMeta(payloads, index = 0) {
     return Array.isArray(payloads) ? await (async () => {
-      return await Promise.all(payloads.map(async (payload) => await this.addSequencedStorageMeta(
-        payload
+      const timestamp = Date.now();
+      return await Promise.all(payloads.map(async (payload, i) => await this.addSequencedStorageMeta(
+        payload,
+        timestamp,
+        i
       )));
     })() : this.addSequencedStorageMeta(
-      payloads
+      payloads,
+      index
     );
   }
-  static compareStorageMeta(a, b) {
-    return a._sequence > b._sequence ? 1 : a._sequence < b._sequence ? -1 : 0;
+  static compareStorageMeta(a, b, comparer = SequenceComparer.local) {
+    return comparer(a._sequence, b._sequence);
   }
   static async dataHash(payload) {
     return await ObjectHasher.hash(this.omitMeta(payload));
@@ -121,10 +52,18 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
       })
     );
   }
+  static dataHashableFields(schema, payload) {
+    const cleanFields = removeEmptyFields({ ...payload, schema });
+    assertEx(
+      cleanFields === void 0 || isJsonObject(cleanFields),
+      () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`
+    );
+    return this.omitMeta(cleanFields);
+  }
   static async dataHashes(payloads) {
     return payloads ? await Promise.all(
       payloads.map(async (payload) => {
-        return await _PayloadBuilder.dataHash(payload);
+        return await this.dataHash(payload);
       })
     ) : void 0;
   }
@@ -153,7 +92,7 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
   static async hashPairs(payloads) {
     return await Promise.all(
       payloads.map(async (payload) => {
-        return [payload, await _PayloadBuilder.hash(payload)];
+        return [payload, await this.hash(payload)];
       })
     );
   }
@@ -163,8 +102,20 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
   static async hashes(payloads) {
     return await ObjectHasher.hashes(payloads);
   }
-  static sortByStorageMeta(payloads, direction = 1) {
-    return payloads.sort((a, b) => a._sequence < b._sequence ? -direction : a._sequence > b._sequence ? direction : 0);
+  static omitClientMeta(payloads, maxDepth = 100) {
+    return Array.isArray(payloads) ? payloads.map((payload) => this.omitClientMeta(payload, maxDepth)) : omitByPrefix(payloads, "$", maxDepth);
+  }
+  static omitMeta(payloads, maxDepth = 100) {
+    return Array.isArray(payloads) ? payloads.map((payload) => this.omitMeta(payload, maxDepth)) : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth);
+  }
+  static omitPrivateStorageMeta(payloads, maxDepth = 100) {
+    return Array.isArray(payloads) ? payloads.map((payload) => this.omitPrivateStorageMeta(payload, maxDepth)) : omitByPrefix(payloads, "__", maxDepth);
+  }
+  static omitStorageMeta(payloads, maxDepth = 100) {
+    return Array.isArray(payloads) ? payloads.map((payload) => this.omitStorageMeta(payload, maxDepth)) : omitByPrefix(payloads, "_", maxDepth);
+  }
+  static sortByStorageMeta(payloads, direction = 1, comparer = SequenceComparer.local) {
+    return payloads.sort((a, b) => direction * comparer(a._sequence, b._sequence));
   }
   static async toAllHashMap(payloads) {
     const result = {};
@@ -194,17 +145,59 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
     }
     return result;
   }
+  static async addHashMeta(payloads) {
+    if (Array.isArray(payloads)) {
+      return await Promise.all(
+        payloads.map(async (payload) => {
+          return await this.addHashMeta(payload);
+        })
+      );
+    } else {
+      const _hash = await this.hash(payloads);
+      const _dataHash = await this.dataHash(payloads);
+      return {
+        ...payloads,
+        _dataHash,
+        _hash
+      };
+    }
+  }
+  static async addSequencedStorageMeta(payload, timestamp, index = 0) {
+    const withHashMeta = await this.addHashMeta(payload);
+    const _sequence = SequenceParser.from(timestamp, withHashMeta._hash, index).localSequence;
+    return {
+      ...withHashMeta,
+      _sequence
+    };
+  }
   build() {
     return {
       schema: this._schema,
-      ...this._fields
+      ...this._fields,
+      ...this._meta
     };
   }
+  async dataHashableFields() {
+    return await _PayloadBuilder.dataHashableFields(
+      assertEx(this._schema, () => "Payload: Missing Schema"),
+      // TODO: Add verification that required fields are present
+      this._fields
+    );
+  }
+  fields(fields) {
+    this._fields = omitSchema(_PayloadBuilder.omitMeta(removeEmptyFields(structuredClone(fields))));
+    return this;
+  }
+  meta(meta) {
+    this._meta = pickByPrefix(meta, "$");
+    return this;
+  }
+  schema(value) {
+    this._schema = value;
+  }
 };
 export {
   PayloadBuilder,
-  PayloadBuilderBase,
-  omitByPrefix,
   omitSchema
 };
 //# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["import type { Hash } from '@xylabs/hex'\nimport type { AnyObject } from '@xylabs/object'\nimport { ObjectHasher } from '@xyo-network/hash'\nimport {\n  type Payload,\n  SequenceParser,\n  type WithHashMeta,\n  type WithoutStorageMeta,\n  type WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport { PayloadBuilderBase } from './BuilderBase.ts'\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport class PayloadBuilder<\n  T extends Payload = Payload<AnyObject>,\n  O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>,\n> extends PayloadBuilderBase<T, O> {\n  static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>\n  static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>\n  static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {\n    if (Array.isArray(payloads)) {\n      return await Promise.all(\n        payloads.map(async (payload) => {\n          return await this.addHashMeta(payload)\n        }),\n      )\n    } else {\n      const _hash = await PayloadBuilder.hash(payloads)\n      const _dataHash = await PayloadBuilder.dataHash(payloads)\n      return {\n        ...payloads,\n        _dataHash,\n        _hash,\n      }\n    }\n  }\n\n  static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T): Promise<WithStorageMeta<T>> {\n    const withHashMeta = await this.addHashMeta(payload)\n    const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash).localSequence\n    return {\n      ...withHashMeta,\n      _sequence,\n    }\n  }\n\n  static async addStorageMeta<T extends Payload>(payload: T): Promise<WithStorageMeta<T>>\n  static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>\n  static async addStorageMeta<T extends Payload>(payloads: T | T[]): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {\n    return Array.isArray(payloads)\n      ? await (async () => {\n        return await Promise.all(payloads.map(async payload => await this.addSequencedStorageMeta(\n          payload,\n        )))\n      })()\n      : this.addSequencedStorageMeta(\n          payloads,\n        )\n  }\n\n  static compareStorageMeta(a: WithStorageMeta<Payload>, b: WithStorageMeta<Payload>) {\n    return a._sequence > b._sequence ? 1 : a._sequence < b._sequence ? -1 : 0\n  }\n\n  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n    return await ObjectHasher.hash(this.omitMeta(payload))\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const dataHash = await this.dataHash(payload)\n        return [payload, dataHash]\n      }),\n    )\n  }\n\n  static async dataHashes(payloads: undefined): Promise<undefined>\n  static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n  static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n    return payloads\n      ? await Promise.all(\n        payloads.map(async (payload) => {\n          return await PayloadBuilder.dataHash(payload)\n        }),\n      )\n      : undefined\n  }\n\n  static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)\n  }\n\n  static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map(pair => pair[0])\n  }\n\n  static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map(pair => pair[0])\n  }\n\n  static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n    return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n  }\n\n  static async hash<T extends Payload>(payload: T): Promise<Hash> {\n    return await ObjectHasher.hash(this.omitStorageMeta(payload))\n  }\n\n  /**\n   * Creates an array of payload/hash tuples based on the payloads passed in\n   * @param objs Any array of payloads\n   * @returns An array of payload/hash tuples\n   */\n  static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[T, Hash]>>(async (payload) => {\n        return [payload, await PayloadBuilder.hash(payload)]\n      }),\n    )\n  }\n\n  static hashableFields<T extends Payload>(\n    payload: T,\n  ): WithoutStorageMeta<T> {\n    return this.omitStorageMeta(payload)\n  }\n\n  static async hashes(payloads: undefined): Promise<undefined>\n  static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n  static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n    return await ObjectHasher.hashes(payloads)\n  }\n\n  static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction: -1 | 1 = 1) {\n    return payloads.sort((a, b) =>\n      a._sequence < b._sequence\n        ? -direction\n        : a._sequence > b._sequence\n          ? direction\n          : 0)\n  }\n\n  static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {\n    const result: Record<Hash, T> = {}\n    for (const pair of await this.hashPairs(payloads)) {\n      const dataHash = await this.dataHash(pair[0])\n      result[pair[1]] = pair[0]\n      result[dataHash] = pair[0]\n    }\n    return result\n  }\n\n  static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n    const result: Record<Hash, T> = {}\n    for (const pair of await this.dataHashPairs(objs)) {\n      result[pair[1]] = pair[0]\n    }\n    return result\n  }\n\n  /**\n   * Creates an object map of payload hashes to payloads based on the payloads passed in\n   * @param objs Any array of payloads\n   * @returns A map of hashes to payloads\n   */\n  static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n    const result: Record<Hash, T> = {}\n    for (const pair of await this.hashPairs(objs)) {\n      result[pair[1]] = pair[0]\n    }\n    return result\n  }\n\n  build(): T {\n    return {\n      schema: this._schema,\n      ...this._fields,\n    } as T\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type {\n  AnyObject, DeepOmitStartsWith, EmptyObject,\n} from '@xylabs/object'\nimport {\n  isJsonObject, omitBy, toJson,\n} from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { removeEmptyFields } from '@xyo-network/hash'\nimport type {\n  Payload, Schema,\n  WithOptionalSchema,\n  WithoutClientMeta,\n  WithoutMeta,\n  WithoutPrivateStorageMeta,\n  WithoutSchema,\n  WithoutStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport const omitByPrefix = <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth = 100): DeepOmitStartsWith<T, P> => {\n  return omitBy(payload, omitByPrefixPredicate(prefix), maxDepth) as unknown as DeepOmitStartsWith<T, P>\n}\n\nexport const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {\n  const result = structuredClone(payload)\n  delete result.schema\n  return result\n}\n\nconst omitByPrefixPredicate = (prefix: string) => (_: unknown, key: string) => {\n  assertEx(typeof key === 'string', () => `Invalid key type [${key}, ${typeof key}]`)\n  return key.startsWith(prefix)\n}\n\nexport class PayloadBuilderBase<T extends Payload = Payload<AnyObject>,\n  O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n  protected _fields?: WithoutMeta<WithoutSchema<T>>\n  protected _schema: Schema\n\n  constructor(readonly options: O) {\n    const { schema, fields } = options\n    this._schema = schema\n    if (fields) {\n      this.fields(fields)\n    }\n  }\n\n  static dataHashableFields<T extends Payload>(\n    schema: Schema,\n    payload: WithoutSchema<T>,\n\n  ): Promisable<WithoutMeta<T>> {\n    const cleanFields = removeEmptyFields({ ...payload, schema })\n    assertEx(\n      cleanFields === undefined || isJsonObject(cleanFields),\n      () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n    )\n    return this.omitMeta(cleanFields) as WithoutMeta<T>\n  }\n\n  static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>\n  static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]\n  static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))\n      : omitByPrefix(payloads, '$', maxDepth)\n  }\n\n  static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>\n  static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]\n  static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitMeta(payload, maxDepth))\n      : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>\n  }\n\n  static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>\n  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]\n  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))\n      : omitByPrefix(payloads, '__', maxDepth)\n  }\n\n  static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>\n  static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]\n  static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))\n      : omitByPrefix(payloads, '_', maxDepth)\n  }\n\n  async dataHashableFields() {\n    return await PayloadBuilderBase.dataHashableFields(\n      assertEx(this._schema, () => 'Payload: Missing Schema'),\n      // TODO: Add verification that required fields are present\n      this._fields as WithoutSchema<T>,\n    )\n  }\n\n  fields(fields: WithoutMeta<WithoutSchema<T>>) {\n    // we need to do the cast here since ts seems to not like nested, yet same, generics\n    this._fields = omitSchema(PayloadBuilderBase.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>\n    return this\n  }\n\n  schema(value: Schema) {\n    this._schema = value\n  }\n}\n"],"mappings":";AAEA,SAAS,oBAAoB;AAC7B;AAAA,EAEE;AAAA,OAIK;;;ACTP,SAAS,gBAAgB;AAIzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAQ;AAAA,OACjB;AAEP,SAAS,yBAAyB;AAa3B,IAAM,eAAe,CAA0C,SAAY,QAAW,WAAW,QAAkC;AACxI,SAAO,OAAO,SAAS,sBAAsB,MAAM,GAAG,QAAQ;AAChE;AAEO,IAAM,aAAa,CAA+B,YAAiC;AACxF,QAAM,SAAS,gBAAgB,OAAO;AACtC,SAAO,OAAO;AACd,SAAO;AACT;AAEA,IAAM,wBAAwB,CAAC,WAAmB,CAAC,GAAY,QAAgB;AAC7E,WAAS,OAAO,QAAQ,UAAU,MAAM,qBAAqB,GAAG,KAAK,OAAO,GAAG,GAAG;AAClF,SAAO,IAAI,WAAW,MAAM;AAC9B;AAEO,IAAM,qBAAN,MAAM,oBACoD;AAAA,EAI/D,YAAqB,SAAY;AAAZ;AACnB,UAAM,EAAE,QAAQ,OAAO,IAAI;AAC3B,SAAK,UAAU;AACf,QAAI,QAAQ;AACV,WAAK,OAAO,MAAM;AAAA,IACpB;AAAA,EACF;AAAA,EATU;AAAA,EACA;AAAA,EAUV,OAAO,mBACL,QACA,SAE4B;AAC5B,UAAM,cAAc,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC;AAC5D;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,KAAK,SAAS,WAAW;AAAA,EAClC;AAAA,EAIA,OAAO,eAAsC,UAAmB,WAAW,KAAoD;AAC7H,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,eAAe,SAAS,QAAQ,CAAC,IAC9D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAIA,OAAO,SAAgC,UAAmB,WAAW,KAAwC;AAC3G,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,SAAS,SAAS,QAAQ,CAAC,IACxD,KAAK,gBAAgB,KAAK,eAAe,UAAU,QAAQ,GAAG,QAAQ;AAAA,EAC5E;AAAA,EAIA,OAAO,uBAA8C,UAAmB,WAAW,KAAoE;AACrJ,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,uBAAuB,SAAS,QAAQ,CAAC,IACtE,aAAa,UAAU,MAAM,QAAQ;AAAA,EAC3C;AAAA,EAIA,OAAO,gBAAuC,UAAmB,WAAW,KAAsD;AAChI,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,gBAAgB,SAAS,QAAQ,CAAC,IAC/D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,oBAAmB;AAAA,MAC9B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA;AAAA,MAEtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,OAAO,QAAuC;AAE5C,SAAK,UAAU,WAAW,oBAAmB,SAAS,kBAAkB,gBAAgB,MAAM,CAAC,CAAC,CAAC;AACjG,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AACF;;;ADjGO,IAAM,iBAAN,MAAM,wBAGH,mBAAyB;AAAA,EAGjC,aAAa,YAA+B,UAAiE;AAC3G,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,MAAM,QAAQ;AAAA,QACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,iBAAO,MAAM,KAAK,YAAY,OAAO;AAAA,QACvC,CAAC;AAAA,MACH;AAAA,IACF,OAAO;AACL,YAAM,QAAQ,MAAM,gBAAe,KAAK,QAAQ;AAChD,YAAM,YAAY,MAAM,gBAAe,SAAS,QAAQ;AACxD,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAa,wBAAqD,SAAyC;AACzG,UAAM,eAAe,MAAM,KAAK,YAAY,OAAO;AACnD,UAAM,YAAY,eAAe,KAAK,KAAK,IAAI,GAAG,aAAa,KAAK,EAAE;AACtE,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAIA,aAAa,eAAkC,UAAuE;AACpH,WAAO,MAAM,QAAQ,QAAQ,IACzB,OAAO,YAAY;AACnB,aAAO,MAAM,QAAQ,IAAI,SAAS,IAAI,OAAM,YAAW,MAAM,KAAK;AAAA,QAChE;AAAA,MACF,CAAC,CAAC;AAAA,IACJ,GAAG,IACD,KAAK;AAAA,MACH;AAAA,IACF;AAAA,EACN;AAAA,EAEA,OAAO,mBAAmB,GAA6B,GAA6B;AAClF,WAAO,EAAE,YAAY,EAAE,YAAY,IAAI,EAAE,YAAY,EAAE,YAAY,KAAK;AAAA,EAC1E;AAAA,EAEA,aAAa,SAA4B,SAA2B;AAClE,WAAO,MAAM,aAAa,KAAK,KAAK,SAAS,OAAO,CAAC;AAAA,EACvD;AAAA,EAEA,aAAa,cAAiC,UAAqC;AACjF,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,WAAW,MAAM,KAAK,SAAS,OAAO;AAC5C,eAAO,CAAC,SAAS,QAAQ;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAIA,aAAa,WAA8B,UAA6C;AACtF,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,eAAO,MAAM,gBAAe,SAAS,OAAO;AAAA,MAC9C,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,aAAa,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACxG;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACtH;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACrH;AAAA,EAEA,aAAa,eAAkC,WAAgB,CAAC,GAAG,MAAoC;AACrG,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,OAAO,MAAM,YAAY,IAAI,IAAI,CAAC;AAAA,EAC1F;AAAA,EAEA,aAAa,KAAwB,SAA2B;AAC9D,WAAO,MAAM,aAAa,KAAK,KAAK,gBAAgB,OAAO,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAqC;AAC7E,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAwB,OAAO,YAAY;AAClD,eAAO,CAAC,SAAS,MAAM,gBAAe,KAAK,OAAO,CAAC;AAAA,MACrD,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,eACL,SACuB;AACvB,WAAO,KAAK,gBAAgB,OAAO;AAAA,EACrC;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,EAC3C;AAAA,EAEA,OAAO,kBAAqC,UAAgC,YAAoB,GAAG;AACjG,WAAO,SAAS,KAAK,CAAC,GAAG,MACvB,EAAE,YAAY,EAAE,YACZ,CAAC,YACD,EAAE,YAAY,EAAE,YACd,YACA,CAAC;AAAA,EACX;AAAA,EAEA,aAAa,aAAgC,UAAyC;AACpF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,QAAQ,GAAG;AACjD,YAAM,WAAW,MAAM,KAAK,SAAS,KAAK,CAAC,CAAC;AAC5C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,QAAQ,IAAI,KAAK,CAAC;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAAqC;AACjF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,cAAc,IAAI,GAAG;AACjD,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,MAAqC;AAC7E,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAAW;AACT,WAAO;AAAA,MACL,QAAQ,KAAK;AAAA,MACb,GAAG,KAAK;AAAA,IACV;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/Builder.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type {\n  AnyObject, Compare, EmptyObject,\n} from '@xylabs/object'\nimport {\n  isJsonObject, omitByPrefix, pickByPrefix, toJson,\n} from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { ObjectHasher, removeEmptyFields } from '@xyo-network/hash'\nimport {\n  type Payload, type Schema,\n  type Sequence,\n  SequenceComparer,\n  SequenceParser,\n  type WithHashMeta,\n  type WithOnlyClientMeta,\n  type WithOptionalSchema,\n  type WithoutClientMeta,\n  type WithoutMeta,\n  type WithoutPrivateStorageMeta,\n  type WithoutSchema,\n  type WithoutStorageMeta,\n  type WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {\n  const result = structuredClone(payload)\n  delete result.schema\n  return result\n}\n\nexport class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {\n  protected _fields?: WithoutMeta<WithoutSchema<T>>\n  protected _meta?: WithOnlyClientMeta<T>\n  protected _schema: Schema\n\n  constructor(readonly options: PayloadBuilderOptions) {\n    const { schema } = options\n    this._schema = schema\n  }\n\n  static async addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>\n  static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>\n  static async addStorageMeta<T extends Payload>(payloads: T | T[], index = 0): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {\n    return Array.isArray(payloads)\n      ? await (async () => {\n        const timestamp = Date.now()\n        return await Promise.all(payloads.map(async (payload, i) => await this.addSequencedStorageMeta(\n          payload,\n          timestamp,\n          i,\n        )))\n      })()\n      : this.addSequencedStorageMeta(\n          payloads,\n          index,\n        )\n  }\n\n  static compareStorageMeta(\n    a: WithStorageMeta<Payload>,\n    b: WithStorageMeta<Payload>,\n    comparer: Compare<Sequence> = SequenceComparer.local,\n  ) {\n    return comparer(a._sequence, b._sequence)\n  }\n\n  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n    return await ObjectHasher.hash(this.omitMeta(payload))\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const dataHash = await this.dataHash(payload)\n        return [payload, dataHash]\n      }),\n    )\n  }\n\n  static dataHashableFields<T extends Payload>(\n    schema: Schema,\n    payload: WithoutSchema<T>,\n\n  ): Promisable<WithoutMeta<T>> {\n    const cleanFields = removeEmptyFields({ ...payload, schema })\n    assertEx(\n      cleanFields === undefined || isJsonObject(cleanFields),\n      () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n    )\n    return this.omitMeta(cleanFields) as WithoutMeta<T>\n  }\n\n  static async dataHashes(payloads: undefined): Promise<undefined>\n  static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n  static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n    return payloads\n      ? await Promise.all(\n        payloads.map(async (payload) => {\n          return await this.dataHash(payload)\n        }),\n      )\n      : undefined\n  }\n\n  static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)\n  }\n\n  static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map(pair => pair[0])\n  }\n\n  static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map(pair => pair[0])\n  }\n\n  static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n    return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n  }\n\n  static async hash<T extends Payload>(payload: T): Promise<Hash> {\n    return await ObjectHasher.hash(this.omitStorageMeta(payload))\n  }\n\n  /**\n   * Creates an array of payload/hash tuples based on the payloads passed in\n   * @param objs Any array of payloads\n   * @returns An array of payload/hash tuples\n   */\n  static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[T, Hash]>>(async (payload) => {\n        return [payload, await this.hash(payload)]\n      }),\n    )\n  }\n\n  static hashableFields<T extends Payload>(\n    payload: T,\n  ): WithoutStorageMeta<T> {\n    return this.omitStorageMeta(payload)\n  }\n\n  static async hashes(payloads: undefined): Promise<undefined>\n  static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n  static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n    return await ObjectHasher.hashes(payloads)\n  }\n\n  static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>\n  static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]\n  static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))\n      : omitByPrefix(payloads, '$', maxDepth)\n  }\n\n  static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>\n  static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]\n  static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitMeta(payload, maxDepth))\n      : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>\n  }\n\n  static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>\n  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]\n  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))\n      : omitByPrefix(payloads, '__', maxDepth)\n  }\n\n  static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>\n  static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]\n  static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {\n    return Array.isArray(payloads)\n      ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))\n      : omitByPrefix(payloads, '_', maxDepth)\n  }\n\n  static sortByStorageMeta<T extends Payload>(\n    payloads: WithStorageMeta<T>[],\n    direction: -1 | 1 = 1,\n    comparer: Compare<Sequence> = SequenceComparer.local,\n  ) {\n    return payloads.sort((a, b) => direction * comparer(a._sequence, b._sequence))\n  }\n\n  static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {\n    const result: Record<Hash, T> = {}\n    for (const pair of await this.hashPairs(payloads)) {\n      const dataHash = await this.dataHash(pair[0])\n      result[pair[1]] = pair[0]\n      result[dataHash] = pair[0]\n    }\n    return result\n  }\n\n  static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n    const result: Record<Hash, T> = {}\n    for (const pair of await this.dataHashPairs(objs)) {\n      result[pair[1]] = pair[0]\n    }\n    return result\n  }\n\n  /**\n   * Creates an object map of payload hashes to payloads based on the payloads passed in\n   * @param objs Any array of payloads\n   * @returns A map of hashes to payloads\n   */\n  static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n    const result: Record<Hash, T> = {}\n    for (const pair of await this.hashPairs(objs)) {\n      result[pair[1]] = pair[0]\n    }\n    return result\n  }\n\n  private static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>\n  private static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>\n  private static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {\n    if (Array.isArray(payloads)) {\n      return await Promise.all(\n        payloads.map(async (payload) => {\n          return await this.addHashMeta(payload)\n        }),\n      )\n    } else {\n      const _hash = await this.hash(payloads)\n      const _dataHash = await this.dataHash(payloads)\n      return {\n        ...payloads,\n        _dataHash,\n        _hash,\n      }\n    }\n  }\n\n  private static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T, timestamp: number, index = 0): Promise<WithStorageMeta<T>> {\n    const withHashMeta = await this.addHashMeta(payload)\n    const _sequence = SequenceParser.from(timestamp, withHashMeta._hash, index).localSequence\n    return {\n      ...withHashMeta,\n      _sequence,\n    }\n  }\n\n  build(): R {\n    return {\n      schema: this._schema,\n      ...this._fields,\n      ...this._meta,\n    } as R\n  }\n\n  async dataHashableFields() {\n    return await PayloadBuilder.dataHashableFields(\n      assertEx(this._schema, () => 'Payload: Missing Schema'),\n      // TODO: Add verification that required fields are present\n      this._fields as WithoutSchema<T>,\n    )\n  }\n\n  fields(fields: WithoutMeta<WithoutSchema<T>>) {\n    // we need to do the cast here since ts seems to not like nested, yet same, generics\n    this._fields = omitSchema(PayloadBuilder.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>\n    return this\n  }\n\n  meta(meta: WithOnlyClientMeta<T>) {\n    // we need to do the cast here since ts seems to not like nested, yet same, generics\n    this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>\n    return this\n  }\n\n  schema(value: Schema) {\n    this._schema = value\n  }\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AAKzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAc;AAAA,EAAc;AAAA,OACrC;AAEP,SAAS,cAAc,yBAAyB;AAChD;AAAA,EAGE;AAAA,EACA;AAAA,OAUK;AAIA,IAAM,aAAa,CAA+B,YAAiC;AACxF,QAAM,SAAS,gBAAgB,OAAO;AACtC,SAAO,OAAO;AACd,SAAO;AACT;AAEO,IAAM,iBAAN,MAAM,gBAA8D;AAAA,EAKzE,YAAqB,SAAgC;AAAhC;AACnB,UAAM,EAAE,OAAO,IAAI;AACnB,SAAK,UAAU;AAAA,EACjB;AAAA,EAPU;AAAA,EACA;AAAA,EACA;AAAA,EASV,aAAa,eAAkC,UAAmB,QAAQ,GAAuD;AAC/H,WAAO,MAAM,QAAQ,QAAQ,IACzB,OAAO,YAAY;AACnB,YAAM,YAAY,KAAK,IAAI;AAC3B,aAAO,MAAM,QAAQ,IAAI,SAAS,IAAI,OAAO,SAAS,MAAM,MAAM,KAAK;AAAA,QACrE;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC,CAAC;AAAA,IACJ,GAAG,IACD,KAAK;AAAA,MACH;AAAA,MACA;AAAA,IACF;AAAA,EACN;AAAA,EAEA,OAAO,mBACL,GACA,GACA,WAA8B,iBAAiB,OAC/C;AACA,WAAO,SAAS,EAAE,WAAW,EAAE,SAAS;AAAA,EAC1C;AAAA,EAEA,aAAa,SAA4B,SAA2B;AAClE,WAAO,MAAM,aAAa,KAAK,KAAK,SAAS,OAAO,CAAC;AAAA,EACvD;AAAA,EAEA,aAAa,cAAiC,UAAqC;AACjF,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,WAAW,MAAM,KAAK,SAAS,OAAO;AAC5C,eAAO,CAAC,SAAS,QAAQ;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,mBACL,QACA,SAE4B;AAC5B,UAAM,cAAc,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC;AAC5D;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,KAAK,SAAS,WAAW;AAAA,EAClC;AAAA,EAIA,aAAa,WAA8B,UAA6C;AACtF,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,eAAO,MAAM,KAAK,SAAS,OAAO;AAAA,MACpC,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,aAAa,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACxG;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACtH;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACrH;AAAA,EAEA,aAAa,eAAkC,WAAgB,CAAC,GAAG,MAAoC;AACrG,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,OAAO,MAAM,YAAY,IAAI,IAAI,CAAC;AAAA,EAC1F;AAAA,EAEA,aAAa,KAAwB,SAA2B;AAC9D,WAAO,MAAM,aAAa,KAAK,KAAK,gBAAgB,OAAO,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAqC;AAC7E,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAwB,OAAO,YAAY;AAClD,eAAO,CAAC,SAAS,MAAM,KAAK,KAAK,OAAO,CAAC;AAAA,MAC3C,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,eACL,SACuB;AACvB,WAAO,KAAK,gBAAgB,OAAO;AAAA,EACrC;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,EAC3C;AAAA,EAIA,OAAO,eAAsC,UAAmB,WAAW,KAAoD;AAC7H,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,eAAe,SAAS,QAAQ,CAAC,IAC9D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAIA,OAAO,SAAgC,UAAmB,WAAW,KAAwC;AAC3G,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,SAAS,SAAS,QAAQ,CAAC,IACxD,KAAK,gBAAgB,KAAK,eAAe,UAAU,QAAQ,GAAG,QAAQ;AAAA,EAC5E;AAAA,EAIA,OAAO,uBAA8C,UAAmB,WAAW,KAAoE;AACrJ,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,uBAAuB,SAAS,QAAQ,CAAC,IACtE,aAAa,UAAU,MAAM,QAAQ;AAAA,EAC3C;AAAA,EAIA,OAAO,gBAAuC,UAAmB,WAAW,KAAsD;AAChI,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,gBAAgB,SAAS,QAAQ,CAAC,IAC/D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAEA,OAAO,kBACL,UACA,YAAoB,GACpB,WAA8B,iBAAiB,OAC/C;AACA,WAAO,SAAS,KAAK,CAAC,GAAG,MAAM,YAAY,SAAS,EAAE,WAAW,EAAE,SAAS,CAAC;AAAA,EAC/E;AAAA,EAEA,aAAa,aAAgC,UAAyC;AACpF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,QAAQ,GAAG;AACjD,YAAM,WAAW,MAAM,KAAK,SAAS,KAAK,CAAC,CAAC;AAC5C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,QAAQ,IAAI,KAAK,CAAC;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAAqC;AACjF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,cAAc,IAAI,GAAG;AACjD,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,MAAqC;AAC7E,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAIA,aAAqB,YAA+B,UAAiE;AACnH,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,MAAM,QAAQ;AAAA,QACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,iBAAO,MAAM,KAAK,YAAY,OAAO;AAAA,QACvC,CAAC;AAAA,MACH;AAAA,IACF,OAAO;AACL,YAAM,QAAQ,MAAM,KAAK,KAAK,QAAQ;AACtC,YAAM,YAAY,MAAM,KAAK,SAAS,QAAQ;AAC9C,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAqB,wBAAqD,SAAY,WAAmB,QAAQ,GAAgC;AAC/I,UAAM,eAAe,MAAM,KAAK,YAAY,OAAO;AACnD,UAAM,YAAY,eAAe,KAAK,WAAW,aAAa,OAAO,KAAK,EAAE;AAC5E,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAEA,QAAW;AACT,WAAO;AAAA,MACL,QAAQ,KAAK;AAAA,MACb,GAAG,KAAK;AAAA,MACR,GAAG,KAAK;AAAA,IACV;AAAA,EACF;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,gBAAe;AAAA,MAC1B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA;AAAA,MAEtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,OAAO,QAAuC;AAE5C,SAAK,UAAU,WAAW,gBAAe,SAAS,kBAAkB,gBAAgB,MAAM,CAAC,CAAC,CAAC;AAC7F,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,MAA6B;AAEhC,SAAK,QAAQ,aAAa,MAAM,GAAG;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payload-builder",
-  "version": "3.6.0-rc.8",
+  "version": "3.6.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,23 +29,22 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.4.16",
-    "@xylabs/hex": "^4.4.16",
-    "@xylabs/logger": "^4.4.16",
-    "@xylabs/object": "^4.4.16",
-    "@xylabs/promise": "^4.4.16",
-    "@xyo-network/hash": "^3.6.0-rc.8",
-    "@xyo-network/payload-model": "^3.6.0-rc.8"
+    "@xylabs/assert": "^4.4.26",
+    "@xylabs/hex": "^4.4.26",
+    "@xylabs/logger": "^4.4.26",
+    "@xylabs/object": "^4.4.26",
+    "@xylabs/promise": "^4.4.26",
+    "@xyo-network/hash": "^3.6.0",
+    "@xyo-network/payload-model": "^3.6.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.4",
-    "@xylabs/tsconfig": "^4.2.4",
-    "@xylabs/vitest-extended": "^4.4.16",
+    "@xylabs/ts-scripts-yarn3": "^4.2.6",
+    "@xylabs/tsconfig": "^4.2.6",
+    "@xylabs/vitest-extended": "^4.4.26",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "stableVersion": "3.5.2"
+  }
 }

package/src/Builder.ts

@@ -1,66 +1,71 @@
+import { assertEx } from '@xylabs/assert'
 import type { Hash } from '@xylabs/hex'
-import type { AnyObject } from '@xylabs/object'
-import { ObjectHasher } from '@xyo-network/hash'
+import type {
+  AnyObject, Compare, EmptyObject,
+} from '@xylabs/object'
 import {
-  type Payload,
+  isJsonObject, omitByPrefix, pickByPrefix, toJson,
+} from '@xylabs/object'
+import type { Promisable } from '@xylabs/promise'
+import { ObjectHasher, removeEmptyFields } from '@xyo-network/hash'
+import {
+  type Payload, type Schema,
+  type Sequence,
+  SequenceComparer,
   SequenceParser,
   type WithHashMeta,
+  type WithOnlyClientMeta,
+  type WithOptionalSchema,
+  type WithoutClientMeta,
+  type WithoutMeta,
+  type WithoutPrivateStorageMeta,
+  type WithoutSchema,
   type WithoutStorageMeta,
   type WithStorageMeta,
 } from '@xyo-network/payload-model'
 
-import { PayloadBuilderBase } from './BuilderBase.ts'
 import type { PayloadBuilderOptions } from './Options.ts'
 
-export class PayloadBuilder<
-  T extends Payload = Payload<AnyObject>,
-  O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>,
-> extends PayloadBuilderBase<T, O> {
-  static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>
-  static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>
-  static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {
-    if (Array.isArray(payloads)) {
-      return await Promise.all(
-        payloads.map(async (payload) => {
-          return await this.addHashMeta(payload)
-        }),
-      )
-    } else {
-      const _hash = await PayloadBuilder.hash(payloads)
-      const _dataHash = await PayloadBuilder.dataHash(payloads)
-      return {
-        ...payloads,
-        _dataHash,
-        _hash,
-      }
-    }
-  }
+export const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {
+  const result = structuredClone(payload)
+  delete result.schema
+  return result
+}
 
-  static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T): Promise<WithStorageMeta<T>> {
-    const withHashMeta = await this.addHashMeta(payload)
-    const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash).localSequence
-    return {
-      ...withHashMeta,
-      _sequence,
-    }
+export class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {
+  protected _fields?: WithoutMeta<WithoutSchema<T>>
+  protected _meta?: WithOnlyClientMeta<T>
+  protected _schema: Schema
+
+  constructor(readonly options: PayloadBuilderOptions) {
+    const { schema } = options
+    this._schema = schema
   }
 
-  static async addStorageMeta<T extends Payload>(payload: T): Promise<WithStorageMeta<T>>
+  static async addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>
   static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>
-  static async addStorageMeta<T extends Payload>(payloads: T | T[]): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {
+  static async addStorageMeta<T extends Payload>(payloads: T | T[], index = 0): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {
     return Array.isArray(payloads)
       ? await (async () => {
-        return await Promise.all(payloads.map(async payload => await this.addSequencedStorageMeta(
+        const timestamp = Date.now()
+        return await Promise.all(payloads.map(async (payload, i) => await this.addSequencedStorageMeta(
           payload,
+          timestamp,
+          i,
         )))
       })()
       : this.addSequencedStorageMeta(
           payloads,
+          index,
         )
   }
 
-  static compareStorageMeta(a: WithStorageMeta<Payload>, b: WithStorageMeta<Payload>) {
-    return a._sequence > b._sequence ? 1 : a._sequence < b._sequence ? -1 : 0
+  static compareStorageMeta(
+    a: WithStorageMeta<Payload>,
+    b: WithStorageMeta<Payload>,
+    comparer: Compare<Sequence> = SequenceComparer.local,
+  ) {
+    return comparer(a._sequence, b._sequence)
   }
 
   static async dataHash<T extends Payload>(payload: T): Promise<Hash> {
@@ -76,13 +81,26 @@ export class PayloadBuilder<
     )
   }
 
+  static dataHashableFields<T extends Payload>(
+    schema: Schema,
+    payload: WithoutSchema<T>,
+
+  ): Promisable<WithoutMeta<T>> {
+    const cleanFields = removeEmptyFields({ ...payload, schema })
+    assertEx(
+      cleanFields === undefined || isJsonObject(cleanFields),
+      () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,
+    )
+    return this.omitMeta(cleanFields) as WithoutMeta<T>
+  }
+
   static async dataHashes(payloads: undefined): Promise<undefined>
   static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>
   static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {
     return payloads
       ? await Promise.all(
         payloads.map(async (payload) => {
-          return await PayloadBuilder.dataHash(payload)
+          return await this.dataHash(payload)
         }),
       )
       : undefined
@@ -118,7 +136,7 @@ export class PayloadBuilder<
   static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {
     return await Promise.all(
       payloads.map<Promise<[T, Hash]>>(async (payload) => {
-        return [payload, await PayloadBuilder.hash(payload)]
+        return [payload, await this.hash(payload)]
       }),
     )
   }
@@ -135,13 +153,44 @@ export class PayloadBuilder<
     return await ObjectHasher.hashes(payloads)
   }
 
-  static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction: -1 | 1 = 1) {
-    return payloads.sort((a, b) =>
-      a._sequence < b._sequence
-        ? -direction
-        : a._sequence > b._sequence
-          ? direction
-          : 0)
+  static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>
+  static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]
+  static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {
+    return Array.isArray(payloads)
+      ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))
+      : omitByPrefix(payloads, '$', maxDepth)
+  }
+
+  static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>
+  static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]
+  static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {
+    return Array.isArray(payloads)
+      ? payloads.map(payload => this.omitMeta(payload, maxDepth))
+      : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>
+  }
+
+  static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>
+  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]
+  static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {
+    return Array.isArray(payloads)
+      ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))
+      : omitByPrefix(payloads, '__', maxDepth)
+  }
+
+  static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>
+  static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]
+  static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {
+    return Array.isArray(payloads)
+      ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))
+      : omitByPrefix(payloads, '_', maxDepth)
+  }
+
+  static sortByStorageMeta<T extends Payload>(
+    payloads: WithStorageMeta<T>[],
+    direction: -1 | 1 = 1,
+    comparer: Compare<Sequence> = SequenceComparer.local,
+  ) {
+    return payloads.sort((a, b) => direction * comparer(a._sequence, b._sequence))
   }
 
   static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {
@@ -175,10 +224,64 @@ export class PayloadBuilder<
     return result
   }
 
-  build(): T {
+  private static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>
+  private static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>
+  private static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {
+    if (Array.isArray(payloads)) {
+      return await Promise.all(
+        payloads.map(async (payload) => {
+          return await this.addHashMeta(payload)
+        }),
+      )
+    } else {
+      const _hash = await this.hash(payloads)
+      const _dataHash = await this.dataHash(payloads)
+      return {
+        ...payloads,
+        _dataHash,
+        _hash,
+      }
+    }
+  }
+
+  private static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T, timestamp: number, index = 0): Promise<WithStorageMeta<T>> {
+    const withHashMeta = await this.addHashMeta(payload)
+    const _sequence = SequenceParser.from(timestamp, withHashMeta._hash, index).localSequence
+    return {
+      ...withHashMeta,
+      _sequence,
+    }
+  }
+
+  build(): R {
     return {
       schema: this._schema,
       ...this._fields,
-    } as T
+      ...this._meta,
+    } as R
+  }
+
+  async dataHashableFields() {
+    return await PayloadBuilder.dataHashableFields(
+      assertEx(this._schema, () => 'Payload: Missing Schema'),
+      // TODO: Add verification that required fields are present
+      this._fields as WithoutSchema<T>,
+    )
+  }
+
+  fields(fields: WithoutMeta<WithoutSchema<T>>) {
+    // we need to do the cast here since ts seems to not like nested, yet same, generics
+    this._fields = omitSchema(PayloadBuilder.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>
+    return this
+  }
+
+  meta(meta: WithOnlyClientMeta<T>) {
+    // we need to do the cast here since ts seems to not like nested, yet same, generics
+    this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>
+    return this
+  }
+
+  schema(value: Schema) {
+    this._schema = value
   }
 }

package/src/Options.ts

@@ -1,12 +1,7 @@
 import type { Logger } from '@xylabs/logger'
-import type { EmptyObject, JsonObject } from '@xylabs/object'
-import type {
-  Schema, WithoutMeta, WithoutSchema,
-} from '@xyo-network/payload-model'
+import type { Schema } from '@xyo-network/payload-model'
 
-export interface PayloadBuilderOptions<T extends EmptyObject = EmptyObject> {
-  readonly fields?: WithoutMeta<WithoutSchema<T>>
+export interface PayloadBuilderOptions {
   readonly logger?: Logger
-  readonly meta?: JsonObject
   readonly schema: Schema
 }

package/src/index.ts

@@ -1,3 +1,3 @@
 export * from './Builder.ts'
-export * from './BuilderBase.ts'
+export * from './Builder.ts'
 export * from './Options.ts'