@xyo-network/payload-builder 3.5.2 → 3.6.0-rc.1

package/dist/node/index.mjs

@@ -1,7 +1,5 @@
 // src/Builder.ts
-import { assertEx as assertEx2 } from "@xylabs/assert";
-import { isJsonObject as isJsonObject2, omitBy as omitBy2 } from "@xylabs/object";
-import { PayloadHasher } from "@xyo-network/hash";
+import { ObjectHasher } from "@xyo-network/hash";
 
 // src/BuilderBase.ts
 import { assertEx } from "@xylabs/assert";
@@ -12,143 +10,85 @@ import {
 } from "@xylabs/object";
 import { removeEmptyFields } from "@xyo-network/hash";
 var removeMetaAndSchema = (payload) => {
-  const { ...result } = payload;
-  delete result.$hash;
-  delete result.$meta;
+  const { ...result } = PayloadBuilder.omitMeta(payload);
   delete result.schema;
   return result;
 };
-var omitByPredicate = (prefix) => (_, key) => {
+var omitByPrefixPredicate = (prefix) => (_, key) => {
   assertEx(typeof key === "string", () => `Invalid key type [${key}, ${typeof key}]`);
   return key.startsWith(prefix);
 };
 var PayloadBuilderBase = class _PayloadBuilderBase {
   constructor(options) {
     this.options = options;
-    const {
-      schema,
-      fields,
-      meta
-    } = options;
+    const { schema, fields } = options;
     this._schema = schema;
-    this._fields = removeEmptyFields(fields ?? {});
-    this._$meta = meta;
+    this._fields = removeMetaAndSchema(removeEmptyFields(structuredClone(fields ?? {})));
   }
-  _$meta;
   _fields;
   _schema;
-  static dataHashableFields(schema, fields) {
-    const cleanFields = fields ? removeEmptyFields(fields) : void 0;
+  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 omitBy(omitBy({ schema, ...cleanFields }, omitByPredicate("$")), omitByPredicate("_"));
+    return this.omitMeta(cleanFields);
   }
-  static metaFields(dataHash, otherMeta, stamp = true) {
-    const meta = { ...otherMeta };
-    if (!meta.timestamp && stamp) {
-      meta.timestamp = meta.timestamp ?? Date.now();
-    }
-    return meta;
+  static omitClientMeta(payload, maxDepth = 100) {
+    return omitBy(payload, omitByPrefixPredicate("$"), maxDepth);
   }
-  $meta(meta) {
-    this._$meta = meta ?? this._fields.$meta;
-    return this;
+  static omitMeta(payload, maxDepth = 100) {
+    return this.omitStorageMeta(this.omitClientMeta(payload, maxDepth), maxDepth);
+  }
+  static omitStorageMeta(payload, maxDepth = 100) {
+    return omitBy(payload, omitByPrefixPredicate("_"), maxDepth);
   }
   async dataHashableFields() {
     return await _PayloadBuilderBase.dataHashableFields(
       assertEx(this._schema, () => "Payload: Missing Schema"),
+      // TDOD: Add verification that required fields are present
       this._fields
     );
   }
-  // we do not require sending in $hash since it will be generated anyway
   fields(fields) {
     if (fields) {
-      const {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        $meta,
-        $hash,
-        schema,
-        ...fieldsOnly
-      } = fields;
-      if ($meta) {
-        this.$meta($meta);
-      }
+      const fieldsClone = structuredClone(fields);
+      const { schema } = fieldsClone;
       if (schema) {
         this.schema(schema);
       }
-      this._fields = removeMetaAndSchema(fields);
+      this._fields = removeEmptyFields(removeMetaAndSchema(fieldsClone));
     }
     return this;
   }
   schema(value) {
     this._schema = value;
   }
-  async metaFields(dataHash, stamp = true) {
-    return await _PayloadBuilderBase.metaFields(dataHash, this._$meta, stamp);
-  }
 };
 
 // src/Builder.ts
-var omitByPredicate2 = (prefix) => (_, key) => {
-  assertEx2(typeof key === "string", () => `Invalid key type [${String(key)}, ${typeof key}]`);
-  return key.startsWith(prefix);
-};
 var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
-  static async build(payload, options = {}) {
-    if (Array.isArray(payload)) {
-      return await Promise.all(payload.map((payload2) => this.build(payload2, options)));
-    } else {
-      const { stamp = false, validate = true } = options;
-      const {
-        schema,
-        $hash: incomingDataHash,
-        $meta: incomingMeta = {}
-      } = payload;
-      const { _signatures } = payload;
-      if (_signatures && !incomingMeta.signatures) {
-        incomingMeta.signatures = _signatures;
-      }
-      const fields = removeMetaAndSchema(payload);
-      const dataHashableFields = await _PayloadBuilder.dataHashableFields(schema, fields);
-      const $hash = validate || incomingDataHash === void 0 ? await PayloadHasher.hash(dataHashableFields) : incomingDataHash;
-      const $meta = { ...incomingMeta };
-      if ($meta.timestamp === void 0 && stamp) {
-        $meta.timestamp = Date.now();
-      }
-      const hashableFields = {
-        ...dataHashableFields,
-        $hash,
-        schema
-      };
-      if (Object.keys($meta).length > 0) {
-        hashableFields.$meta = $meta;
-      }
-      return hashableFields;
-    }
-  }
-  static async dataHash(payload, options) {
-    return (await this.build(payload, options)).$hash;
+  static async dataHash(payload) {
+    return await ObjectHasher.hash(this.omitMeta(payload));
   }
-  static async dataHashPairs(payloads, options) {
+  static async dataHashPairs(payloads) {
     return await Promise.all(
       payloads.map(async (payload) => {
-        const built = await _PayloadBuilder.build(payload, options);
-        return [built, built.$hash];
+        const dataHash = await this.dataHash(payload);
+        return [payload, dataHash];
       })
     );
   }
-  static async dataHashes(payloads, options) {
+  static async dataHashes(payloads) {
     return payloads ? await Promise.all(
       payloads.map(async (payload) => {
-        const built = await _PayloadBuilder.build(payload, options);
-        return built.$hash;
+        return await _PayloadBuilder.dataHash(payload);
       })
     ) : void 0;
   }
   static async filterExclude(payloads = [], hash) {
-    return await PayloadHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash);
+    return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash);
   }
   static async filterExcludeByDataHash(payloads = [], hash) {
     const hashes = Array.isArray(hash) ? hash : [hash];
@@ -161,53 +101,33 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
   static async findByDataHash(payloads = [], hash) {
     return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0];
   }
-  static async hash(payload, options) {
-    return await PayloadHasher.hash(await _PayloadBuilder.build(payload, options));
+  static async hash(payload) {
+    return await ObjectHasher.hash(this.omitStorageMeta(payload));
   }
   /**
    * Creates an array of payload/hash tuples based on the payloads passed in
    * @param objs Any array of payloads
    * @returns An array of payload/hash tuples
    */
-  static async hashPairs(payloads, options) {
+  static async hashPairs(payloads) {
     return await Promise.all(
       payloads.map(async (payload) => {
-        const built = await _PayloadBuilder.build(payload, options);
-        return [built, await _PayloadBuilder.hash(built)];
+        return [payload, await _PayloadBuilder.hash(payload)];
       })
     );
   }
-  static async hashableFields(schema, fields, $meta, $hash, timestamp, stamp = false) {
-    const dataFields = await this.dataHashableFields(schema, fields);
-    assertEx2($meta === void 0 || isJsonObject2($meta), () => "$meta must be JsonObject");
-    const result = omitBy2(
-      {
-        ...dataFields,
-        $hash: $hash ?? await _PayloadBuilder.dataHash(dataFields),
-        schema
-      },
-      omitByPredicate2("_")
-    );
-    const clonedMeta = { ...$meta };
-    if (timestamp) {
-      clonedMeta.timestamp = timestamp;
-    }
-    if (clonedMeta.timestamp === void 0 && stamp) {
-      clonedMeta.timestamp = Date.now();
-    }
-    if (Object.keys(clonedMeta).length > 0) {
-      result.$meta = clonedMeta;
-    }
-    return result;
+  static hashableFields(payload) {
+    return this.omitStorageMeta(payload);
   }
   static async hashes(payloads) {
-    return await PayloadHasher.hashes(payloads);
+    return await ObjectHasher.hashes(payloads);
   }
-  static async toAllHashMap(objs) {
+  static async toAllHashMap(payloads) {
     const result = {};
-    for (const pair of await this.hashPairs(objs)) {
+    for (const pair of await this.hashPairs(payloads)) {
+      const dataHash = await this.dataHash(pair[0]);
       result[pair[1]] = pair[0];
-      result[pair[0].$hash] = pair[0];
+      result[dataHash] = pair[0];
     }
     return result;
   }
@@ -230,30 +150,11 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
     }
     return result;
   }
-  static withoutMeta(payloads) {
-    if (Array.isArray(payloads)) {
-      return payloads.map((payload) => this.withoutMeta(payload));
-    } else {
-      if (payloads) {
-        const { $meta, ...result } = payloads;
-        return result;
-      }
-    }
-  }
-  async build(options) {
-    const dataHashableFields = await this.dataHashableFields();
-    return await _PayloadBuilder.build({
-      ...dataHashableFields,
-      $meta: this._$meta,
-      schema: this._schema
-    }, options);
-  }
-  async hashableFields() {
-    return await _PayloadBuilder.hashableFields(
-      assertEx2(this._schema, () => "Payload: Missing Schema"),
-      this._fields,
-      this._$meta
-    );
+  build() {
+    return {
+      schema: this._schema,
+      ...this._fields
+    };
   }
 };
 export {

package/dist/node/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type {\n  AnyObject, JsonArray, JsonObject,\n} from '@xylabs/object'\nimport { isJsonObject, omitBy } from '@xylabs/object'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport type {\n  Payload, PayloadWithMeta, WithMeta,\n} from '@xyo-network/payload-model'\n\nimport type { WithoutMeta, WithoutSchema } from './BuilderBase.ts'\nimport { PayloadBuilderBase, removeMetaAndSchema } from './BuilderBase.ts'\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport interface BuildOptions {\n  stamp?: boolean\n  validate?: boolean\n}\n\nconst omitByPredicate = <T extends object>(prefix: string) => (_: T[keyof T], key: keyof T) => {\n  assertEx(typeof key === 'string', () => `Invalid key type [${String(key)}, ${typeof key}]`)\n  return (key as string).startsWith(prefix)\n}\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 build<T extends Payload = Payload<AnyObject>>(payload: T, options?: BuildOptions): Promise<WithMeta<T>>\n  static async build<T extends Payload = Payload<AnyObject>>(payload: T[], options?: BuildOptions): Promise<WithMeta<T>[]>\n  static async build<T extends Payload = Payload<AnyObject>>(payload: T | T[], options: BuildOptions = {}) {\n    if (Array.isArray(payload)) {\n      return await Promise.all(payload.map(payload => this.build(payload, options)))\n    } else {\n      const { stamp = false, validate = true } = options\n      const {\n        schema, $hash: incomingDataHash, $meta: incomingMeta = {},\n      } = payload as WithMeta<T>\n\n      // check for legacy signatures\n      const { _signatures } = payload as { _signatures?: JsonArray }\n      if (_signatures && !incomingMeta.signatures) {\n        incomingMeta.signatures = _signatures\n      }\n\n      const fields = removeMetaAndSchema(payload)\n      const dataHashableFields = await PayloadBuilder.dataHashableFields(schema, fields)\n      const $hash = validate || incomingDataHash === undefined ? await PayloadHasher.hash(dataHashableFields) : incomingDataHash\n      const $meta: JsonObject = { ...incomingMeta }\n      if ($meta.timestamp === undefined && stamp) {\n        $meta.timestamp = Date.now()\n      }\n      const hashableFields: WithMeta<Payload> = {\n        ...dataHashableFields, $hash, schema,\n      }\n\n      if (Object.keys($meta).length > 0) {\n        hashableFields.$meta = $meta\n      }\n\n      return hashableFields as WithMeta<T>\n    }\n  }\n\n  static async dataHash<T extends Payload>(payload: T, options?: BuildOptions): Promise<Hash> {\n    return (await this.build(payload, options)).$hash\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload, options)\n        return [built, built.$hash]\n      }),\n    )\n  }\n\n  static async dataHashes(payloads: undefined, options?: BuildOptions): Promise<undefined>\n  static async dataHashes<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<Hash[]>\n  static async dataHashes<T extends Payload>(payloads?: T[], options?: BuildOptions): Promise<Hash[] | undefined> {\n    return payloads\n      ? await Promise.all(\n        payloads.map(async (payload) => {\n          const built = await PayloadBuilder.build(payload, options)\n          return built.$hash\n        }),\n      )\n      : undefined\n  }\n\n  static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    return await PayloadHasher.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, options?: BuildOptions): Promise<Hash> {\n    return await PayloadHasher.hash(await PayloadBuilder.build(payload, options))\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[], options?: BuildOptions): Promise<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {\n        const built = await PayloadBuilder.build(payload, options)\n        return [built, await PayloadBuilder.hash(built)]\n      }),\n    )\n  }\n\n  static async hashableFields<T extends Payload = Payload<AnyObject>>(\n    schema: string,\n    fields?: WithoutSchema<WithoutMeta<T>>,\n    $meta?: JsonObject,\n    $hash?: Hash,\n    timestamp?: number,\n    stamp = false,\n  ): Promise<WithMeta<T>> {\n    const dataFields = await this.dataHashableFields<T>(schema, fields)\n    assertEx($meta === undefined || isJsonObject($meta), () => '$meta must be JsonObject')\n    const result: WithMeta<T> = omitBy(\n      {\n        ...dataFields,\n        $hash: $hash ?? (await PayloadBuilder.dataHash(dataFields)),\n        schema,\n      } as WithMeta<T>,\n      omitByPredicate('_'),\n    ) as WithMeta<T>\n\n    const clonedMeta = { ...$meta }\n\n    if (timestamp) {\n      clonedMeta.timestamp = timestamp\n    }\n\n    if (clonedMeta.timestamp === undefined && stamp) {\n      clonedMeta.timestamp = Date.now()\n    }\n\n    if (Object.keys(clonedMeta).length > 0) {\n      result.$meta = clonedMeta\n    }\n\n    return result\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 PayloadHasher.hashes(payloads)\n  }\n\n  static async toAllHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {\n    const result: Record<Hash, WithMeta<T>> = {}\n    for (const pair of await this.hashPairs(objs)) {\n      result[pair[1]] = pair[0]\n      result[pair[0].$hash] = pair[0]\n    }\n    return result\n  }\n\n  static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {\n    const result: Record<Hash, WithMeta<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, WithMeta<T>>> {\n    const result: Record<Hash, WithMeta<T>> = {}\n    for (const pair of await this.hashPairs(objs)) {\n      result[pair[1]] = pair[0]\n    }\n    return result\n  }\n\n  static withoutMeta(payload: undefined): undefined\n  static withoutMeta<T extends PayloadWithMeta>(payload: T): Omit<T, '$meta'>\n  static withoutMeta<T extends PayloadWithMeta>(payloads: T[]): Omit<T, '$meta'>[]\n  static withoutMeta<T extends PayloadWithMeta>(payloads: T | T[]) {\n    if (Array.isArray(payloads)) {\n      return payloads.map(payload => this.withoutMeta(payload))\n    } else {\n      if (payloads) {\n        // eslint-disable-next-line @typescript-eslint/no-unused-vars\n        const { $meta, ...result } = payloads\n        return result as Omit<T, '$meta'>\n      }\n    }\n  }\n\n  async build(options?: BuildOptions): Promise<WithMeta<T>> {\n    const dataHashableFields = await this.dataHashableFields()\n    return await PayloadBuilder.build<T>({\n      ...dataHashableFields, $meta: this._$meta, schema: this._schema,\n    } as Payload as T, options)\n  }\n\n  async hashableFields() {\n    return await PayloadBuilder.hashableFields(\n      assertEx(this._schema, () => 'Payload: Missing Schema'),\n      this._fields,\n      this._$meta,\n    )\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type { AnyObject, JsonObject } 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, WithMeta, WithOptionalMeta,\n} from '@xyo-network/payload-model'\n\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport type WithOptionalSchema<T extends Payload> = Omit<T, 'schema'> & Partial<T>\n\nexport type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>\n\nexport type WithoutMeta<T extends WithOptionalMeta<Payload>> = Omit<T, '$hash' | '$meta'>\n\nexport const removeMetaAndSchema = <T extends Payload>(payload: WithOptionalSchema<WithOptionalMeta<T>>): WithoutSchema<WithoutMeta<T>> => {\n  const { ...result } = payload\n  delete result.$hash\n  delete result.$meta\n  delete result.schema\n  return result as Omit<T, 'schema'>\n}\n\nconst omitByPredicate = (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>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n  protected _$meta?: JsonObject\n  protected _fields?: WithoutSchema<WithoutMeta<T>>\n  protected _schema: Schema\n\n  constructor(readonly options: O) {\n    const {\n      schema, fields, meta,\n    } = options\n    this._schema = schema\n    this._fields = removeEmptyFields(fields ?? {}) as WithoutSchema<WithoutMeta<T>>\n    this._$meta = meta\n  }\n\n  static dataHashableFields<T extends Payload = Payload<AnyObject>>(\n    schema: string,\n    fields?: WithoutSchema<WithoutMeta<T>>,\n  ): Promisable<Omit<T, '$hash' | '$meta'>> {\n    const cleanFields = fields ? removeEmptyFields(fields) : undefined\n    assertEx(\n      cleanFields === undefined || isJsonObject(cleanFields),\n      () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n    )\n    return omitBy(omitBy({ schema, ...cleanFields }, omitByPredicate('$')), omitByPredicate('_')) as unknown as T\n  }\n\n  protected static metaFields(dataHash: Hash, otherMeta?: JsonObject, stamp = true): Promisable<JsonObject> {\n    const meta: JsonObject = { ...otherMeta }\n\n    if (!meta.timestamp && stamp) {\n      meta.timestamp = meta.timestamp ?? Date.now()\n    }\n\n    return meta\n  }\n\n  $meta(meta?: JsonObject) {\n    this._$meta = meta ?? (this._fields as WithMeta<T>).$meta\n    return this\n  }\n\n  async dataHashableFields() {\n    return await PayloadBuilderBase.dataHashableFields(\n      assertEx(this._schema, () => 'Payload: Missing Schema'),\n      this._fields,\n    )\n  }\n\n  // we do not require sending in $hash since it will be generated anyway\n  fields(fields: WithOptionalSchema<WithOptionalMeta<T>>) {\n    if (fields) {\n      const {\n        // eslint-disable-next-line @typescript-eslint/no-unused-vars\n        $meta, $hash, schema, ...fieldsOnly\n      } = fields\n      if ($meta) {\n        this.$meta($meta)\n      }\n      if (schema) {\n        this.schema(schema)\n      }\n      this._fields = removeMetaAndSchema<T>(fields)\n    }\n    return this\n  }\n\n  schema(value: Schema) {\n    this._schema = value\n  }\n\n  protected async metaFields(dataHash: Hash, stamp = true): Promise<JsonObject> {\n    return await PayloadBuilderBase.metaFields(dataHash, this._$meta, stamp)\n  }\n}\n"],"mappings":";AAAA,SAAS,YAAAA,iBAAgB;AAKzB,SAAS,gBAAAC,eAAc,UAAAC,eAAc;AACrC,SAAS,qBAAqB;;;ACN9B,SAAS,gBAAgB;AAGzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAQ;AAAA,OACjB;AAEP,SAAS,yBAAyB;AAa3B,IAAM,sBAAsB,CAAoB,YAAoF;AACzI,QAAM,EAAE,GAAG,OAAO,IAAI;AACtB,SAAO,OAAO;AACd,SAAO,OAAO;AACd,SAAO,OAAO;AACd,SAAO;AACT;AAEA,IAAM,kBAAkB,CAAC,WAAmB,CAAC,GAAY,QAAgB;AACvE,WAAS,OAAO,QAAQ,UAAU,MAAM,qBAAqB,GAAG,KAAK,OAAO,GAAG,GAAG;AAClF,SAAO,IAAI,WAAW,MAAM;AAC9B;AAEO,IAAM,qBAAN,MAAM,oBAA0H;AAAA,EAKrI,YAAqB,SAAY;AAAZ;AACnB,UAAM;AAAA,MACJ;AAAA,MAAQ;AAAA,MAAQ;AAAA,IAClB,IAAI;AACJ,SAAK,UAAU;AACf,SAAK,UAAU,kBAAkB,UAAU,CAAC,CAAC;AAC7C,SAAK,SAAS;AAAA,EAChB;AAAA,EAXU;AAAA,EACA;AAAA,EACA;AAAA,EAWV,OAAO,mBACL,QACA,QACwC;AACxC,UAAM,cAAc,SAAS,kBAAkB,MAAM,IAAI;AACzD;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,OAAO,OAAO,EAAE,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,CAAC,GAAG,gBAAgB,GAAG,CAAC;AAAA,EAC9F;AAAA,EAEA,OAAiB,WAAW,UAAgB,WAAwB,QAAQ,MAA8B;AACxG,UAAM,OAAmB,EAAE,GAAG,UAAU;AAExC,QAAI,CAAC,KAAK,aAAa,OAAO;AAC5B,WAAK,YAAY,KAAK,aAAa,KAAK,IAAI;AAAA,IAC9C;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,MAAmB;AACvB,SAAK,SAAS,QAAS,KAAK,QAAwB;AACpD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,oBAAmB;AAAA,MAC9B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA,MACtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA;AAAA,EAGA,OAAO,QAAiD;AACtD,QAAI,QAAQ;AACV,YAAM;AAAA;AAAA,QAEJ;AAAA,QAAO;AAAA,QAAO;AAAA,QAAQ,GAAG;AAAA,MAC3B,IAAI;AACJ,UAAI,OAAO;AACT,aAAK,MAAM,KAAK;AAAA,MAClB;AACA,UAAI,QAAQ;AACV,aAAK,OAAO,MAAM;AAAA,MACpB;AACA,WAAK,UAAU,oBAAuB,MAAM;AAAA,IAC9C;AACA,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,MAAgB,WAAW,UAAgB,QAAQ,MAA2B;AAC5E,WAAO,MAAM,oBAAmB,WAAW,UAAU,KAAK,QAAQ,KAAK;AAAA,EACzE;AACF;;;ADtFA,IAAMC,mBAAkB,CAAmB,WAAmB,CAAC,GAAe,QAAiB;AAC7F,EAAAC,UAAS,OAAO,QAAQ,UAAU,MAAM,qBAAqB,OAAO,GAAG,CAAC,KAAK,OAAO,GAAG,GAAG;AAC1F,SAAQ,IAAe,WAAW,MAAM;AAC1C;AAEO,IAAM,iBAAN,MAAM,wBAGH,mBAAyB;AAAA,EAGjC,aAAa,MAA8C,SAAkB,UAAwB,CAAC,GAAG;AACvG,QAAI,MAAM,QAAQ,OAAO,GAAG;AAC1B,aAAO,MAAM,QAAQ,IAAI,QAAQ,IAAI,CAAAC,aAAW,KAAK,MAAMA,UAAS,OAAO,CAAC,CAAC;AAAA,IAC/E,OAAO;AACL,YAAM,EAAE,QAAQ,OAAO,WAAW,KAAK,IAAI;AAC3C,YAAM;AAAA,QACJ;AAAA,QAAQ,OAAO;AAAA,QAAkB,OAAO,eAAe,CAAC;AAAA,MAC1D,IAAI;AAGJ,YAAM,EAAE,YAAY,IAAI;AACxB,UAAI,eAAe,CAAC,aAAa,YAAY;AAC3C,qBAAa,aAAa;AAAA,MAC5B;AAEA,YAAM,SAAS,oBAAoB,OAAO;AAC1C,YAAM,qBAAqB,MAAM,gBAAe,mBAAmB,QAAQ,MAAM;AACjF,YAAM,QAAQ,YAAY,qBAAqB,SAAY,MAAM,cAAc,KAAK,kBAAkB,IAAI;AAC1G,YAAM,QAAoB,EAAE,GAAG,aAAa;AAC5C,UAAI,MAAM,cAAc,UAAa,OAAO;AAC1C,cAAM,YAAY,KAAK,IAAI;AAAA,MAC7B;AACA,YAAM,iBAAoC;AAAA,QACxC,GAAG;AAAA,QAAoB;AAAA,QAAO;AAAA,MAChC;AAEA,UAAI,OAAO,KAAK,KAAK,EAAE,SAAS,GAAG;AACjC,uBAAe,QAAQ;AAAA,MACzB;AAEA,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,aAAa,SAA4B,SAAY,SAAuC;AAC1F,YAAQ,MAAM,KAAK,MAAM,SAAS,OAAO,GAAG;AAAA,EAC9C;AAAA,EAEA,aAAa,cAAiC,UAAe,SAAwD;AACnH,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,QAAQ,MAAM,gBAAe,MAAM,SAAS,OAAO;AACzD,eAAO,CAAC,OAAO,MAAM,KAAK;AAAA,MAC5B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAIA,aAAa,WAA8B,UAAgB,SAAqD;AAC9G,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,QAAQ,MAAM,gBAAe,MAAM,SAAS,OAAO;AACzD,eAAO,MAAM;AAAA,MACf,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,cAAc,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACzG;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,SAAY,SAAuC;AACtF,WAAO,MAAM,cAAc,KAAK,MAAM,gBAAe,MAAM,SAAS,OAAO,CAAC;AAAA,EAC9E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAe,SAAwD;AAC/G,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAkC,OAAO,YAAY;AAC5D,cAAM,QAAQ,MAAM,gBAAe,MAAM,SAAS,OAAO;AACzD,eAAO,CAAC,OAAO,MAAM,gBAAe,KAAK,KAAK,CAAC;AAAA,MACjD,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,aAAa,eACX,QACA,QACA,OACA,OACA,WACA,QAAQ,OACc;AACtB,UAAM,aAAa,MAAM,KAAK,mBAAsB,QAAQ,MAAM;AAClE,IAAAD,UAAS,UAAU,UAAaE,cAAa,KAAK,GAAG,MAAM,0BAA0B;AACrF,UAAM,SAAsBC;AAAA,MAC1B;AAAA,QACE,GAAG;AAAA,QACH,OAAO,SAAU,MAAM,gBAAe,SAAS,UAAU;AAAA,QACzD;AAAA,MACF;AAAA,MACAJ,iBAAgB,GAAG;AAAA,IACrB;AAEA,UAAM,aAAa,EAAE,GAAG,MAAM;AAE9B,QAAI,WAAW;AACb,iBAAW,YAAY;AAAA,IACzB;AAEA,QAAI,WAAW,cAAc,UAAa,OAAO;AAC/C,iBAAW,YAAY,KAAK,IAAI;AAAA,IAClC;AAEA,QAAI,OAAO,KAAK,UAAU,EAAE,SAAS,GAAG;AACtC,aAAO,QAAQ;AAAA,IACjB;AAEA,WAAO;AAAA,EACT;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,cAAc,OAAO,QAAQ;AAAA,EAC5C;AAAA,EAEA,aAAa,aAAgC,MAA+C;AAC1F,UAAM,SAAoC,CAAC;AAC3C,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,KAAK,CAAC,EAAE,KAAK,IAAI,KAAK,CAAC;AAAA,IAChC;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAA+C;AAC3F,UAAM,SAAoC,CAAC;AAC3C,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,MAA+C;AACvF,UAAM,SAAoC,CAAC;AAC3C,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAKA,OAAO,YAAuC,UAAmB;AAC/D,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,SAAS,IAAI,aAAW,KAAK,YAAY,OAAO,CAAC;AAAA,IAC1D,OAAO;AACL,UAAI,UAAU;AAEZ,cAAM,EAAE,OAAO,GAAG,OAAO,IAAI;AAC7B,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAM,SAA8C;AACxD,UAAM,qBAAqB,MAAM,KAAK,mBAAmB;AACzD,WAAO,MAAM,gBAAe,MAAS;AAAA,MACnC,GAAG;AAAA,MAAoB,OAAO,KAAK;AAAA,MAAQ,QAAQ,KAAK;AAAA,IAC1D,GAAmB,OAAO;AAAA,EAC5B;AAAA,EAEA,MAAM,iBAAiB;AACrB,WAAO,MAAM,gBAAe;AAAA,MAC1BC,UAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA,MACtD,KAAK;AAAA,MACL,KAAK;AAAA,IACP;AAAA,EACF;AACF;","names":["assertEx","isJsonObject","omitBy","omitByPredicate","assertEx","payload","isJsonObject","omitBy"]}
+{"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 type { Payload } 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 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  ): 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 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 { AnyObject } 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 { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { PayloadBuilder } from './Builder.ts'\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport type WithOptionalSchema<T extends Payload> = Omit<T, 'schema'> & Partial<T>\n\nexport type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>\n\nexport const removeMetaAndSchema = <T extends Payload>(payload: Partial<WithOptionalSchema<T>>): WithoutSchema<T> => {\n  const { ...result } = PayloadBuilder.omitMeta(payload as T) as WithOptionalSchema<T>\n  delete result.schema\n  return result as Omit<T, 'schema'>\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>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n  protected _fields?: Partial<WithoutSchema<T>>\n  protected _schema: Schema\n\n  constructor(readonly options: O) {\n    const { schema, fields } = options\n    this._schema = schema\n    this._fields = removeMetaAndSchema(removeEmptyFields(structuredClone(fields ?? {})))\n  }\n\n  static dataHashableFields<T extends Payload>(\n    schema: Schema,\n    payload: WithoutSchema<T>,\n\n  ): Promisable<Payload> {\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 T\n  }\n\n  static omitClientMeta<T extends Payload>(payload: T, maxDepth = 100): T {\n    return omitBy(payload, omitByPrefixPredicate('$'), maxDepth) as T\n  }\n\n  static omitMeta<T extends Payload>(payload: T, maxDepth = 100): T {\n    return this.omitStorageMeta(this.omitClientMeta(payload, maxDepth), maxDepth)\n  }\n\n  static omitStorageMeta<T extends Payload>(payload: T, maxDepth = 100): T {\n    return omitBy(payload, omitByPrefixPredicate('_'), maxDepth) as T\n  }\n\n  async dataHashableFields() {\n    return await PayloadBuilderBase.dataHashableFields(\n      assertEx(this._schema, () => 'Payload: Missing Schema'),\n      // TDOD: Add verification that required fields are present\n      this._fields as T,\n    )\n  }\n\n  fields(fields: WithOptionalSchema<T>) {\n    if (fields) {\n      const fieldsClone = structuredClone(fields)\n      const { schema } = fieldsClone\n      if (schema) {\n        this.schema(schema)\n      }\n      this._fields = removeEmptyFields(removeMetaAndSchema<T>(fieldsClone))\n    }\n    return this\n  }\n\n  schema(value: Schema) {\n    this._schema = value\n  }\n}\n"],"mappings":";AAEA,SAAS,oBAAoB;;;ACF7B,SAAS,gBAAgB;AAEzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAQ;AAAA,OACjB;AAEP,SAAS,yBAAyB;AAU3B,IAAM,sBAAsB,CAAoB,YAA8D;AACnH,QAAM,EAAE,GAAG,OAAO,IAAI,eAAe,SAAS,OAAY;AAC1D,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,oBAA0H;AAAA,EAIrI,YAAqB,SAAY;AAAZ;AACnB,UAAM,EAAE,QAAQ,OAAO,IAAI;AAC3B,SAAK,UAAU;AACf,SAAK,UAAU,oBAAoB,kBAAkB,gBAAgB,UAAU,CAAC,CAAC,CAAC,CAAC;AAAA,EACrF;AAAA,EAPU;AAAA,EACA;AAAA,EAQV,OAAO,mBACL,QACA,SAEqB;AACrB,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,EAEA,OAAO,eAAkC,SAAY,WAAW,KAAQ;AACtE,WAAO,OAAO,SAAS,sBAAsB,GAAG,GAAG,QAAQ;AAAA,EAC7D;AAAA,EAEA,OAAO,SAA4B,SAAY,WAAW,KAAQ;AAChE,WAAO,KAAK,gBAAgB,KAAK,eAAe,SAAS,QAAQ,GAAG,QAAQ;AAAA,EAC9E;AAAA,EAEA,OAAO,gBAAmC,SAAY,WAAW,KAAQ;AACvE,WAAO,OAAO,SAAS,sBAAsB,GAAG,GAAG,QAAQ;AAAA,EAC7D;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,QAA+B;AACpC,QAAI,QAAQ;AACV,YAAM,cAAc,gBAAgB,MAAM;AAC1C,YAAM,EAAE,OAAO,IAAI;AACnB,UAAI,QAAQ;AACV,aAAK,OAAO,MAAM;AAAA,MACpB;AACA,WAAK,UAAU,kBAAkB,oBAAuB,WAAW,CAAC;AAAA,IACtE;AACA,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AACF;;;AD7EO,IAAM,iBAAN,MAAM,wBAGH,mBAAyB;AAAA,EACjC,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,SACG;AACH,WAAO,KAAK,gBAAgB,OAAO;AAAA,EACrC;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,EAC3C;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":[]}

package/package.json

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

package/src/Builder.ts

@@ -1,96 +1,42 @@
-import { assertEx } from '@xylabs/assert'
 import type { Hash } from '@xylabs/hex'
-import type {
-  AnyObject, JsonArray, JsonObject,
-} from '@xylabs/object'
-import { isJsonObject, omitBy } from '@xylabs/object'
-import { PayloadHasher } from '@xyo-network/hash'
-import type {
-  Payload, PayloadWithMeta, WithMeta,
-} from '@xyo-network/payload-model'
-
-import type { WithoutMeta, WithoutSchema } from './BuilderBase.ts'
-import { PayloadBuilderBase, removeMetaAndSchema } from './BuilderBase.ts'
-import type { PayloadBuilderOptions } from './Options.ts'
-
-export interface BuildOptions {
-  stamp?: boolean
-  validate?: boolean
-}
+import type { AnyObject } from '@xylabs/object'
+import { ObjectHasher } from '@xyo-network/hash'
+import type { Payload } from '@xyo-network/payload-model'
 
-const omitByPredicate = <T extends object>(prefix: string) => (_: T[keyof T], key: keyof T) => {
-  assertEx(typeof key === 'string', () => `Invalid key type [${String(key)}, ${typeof key}]`)
-  return (key as string).startsWith(prefix)
-}
+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 build<T extends Payload = Payload<AnyObject>>(payload: T, options?: BuildOptions): Promise<WithMeta<T>>
-  static async build<T extends Payload = Payload<AnyObject>>(payload: T[], options?: BuildOptions): Promise<WithMeta<T>[]>
-  static async build<T extends Payload = Payload<AnyObject>>(payload: T | T[], options: BuildOptions = {}) {
-    if (Array.isArray(payload)) {
-      return await Promise.all(payload.map(payload => this.build(payload, options)))
-    } else {
-      const { stamp = false, validate = true } = options
-      const {
-        schema, $hash: incomingDataHash, $meta: incomingMeta = {},
-      } = payload as WithMeta<T>
-
-      // check for legacy signatures
-      const { _signatures } = payload as { _signatures?: JsonArray }
-      if (_signatures && !incomingMeta.signatures) {
-        incomingMeta.signatures = _signatures
-      }
-
-      const fields = removeMetaAndSchema(payload)
-      const dataHashableFields = await PayloadBuilder.dataHashableFields(schema, fields)
-      const $hash = validate || incomingDataHash === undefined ? await PayloadHasher.hash(dataHashableFields) : incomingDataHash
-      const $meta: JsonObject = { ...incomingMeta }
-      if ($meta.timestamp === undefined && stamp) {
-        $meta.timestamp = Date.now()
-      }
-      const hashableFields: WithMeta<Payload> = {
-        ...dataHashableFields, $hash, schema,
-      }
-
-      if (Object.keys($meta).length > 0) {
-        hashableFields.$meta = $meta
-      }
-
-      return hashableFields as WithMeta<T>
-    }
+  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {
+    return await ObjectHasher.hash(this.omitMeta(payload))
   }
 
-  static async dataHash<T extends Payload>(payload: T, options?: BuildOptions): Promise<Hash> {
-    return (await this.build(payload, options)).$hash
-  }
-
-  static async dataHashPairs<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<[WithMeta<T>, Hash][]> {
+  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {
     return await Promise.all(
       payloads.map(async (payload) => {
-        const built = await PayloadBuilder.build(payload, options)
-        return [built, built.$hash]
+        const dataHash = await this.dataHash(payload)
+        return [payload, dataHash]
       }),
     )
   }
 
-  static async dataHashes(payloads: undefined, options?: BuildOptions): Promise<undefined>
-  static async dataHashes<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<Hash[]>
-  static async dataHashes<T extends Payload>(payloads?: T[], options?: BuildOptions): Promise<Hash[] | undefined> {
+  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) => {
-          const built = await PayloadBuilder.build(payload, options)
-          return built.$hash
+          return await PayloadBuilder.dataHash(payload)
         }),
       )
       : undefined
   }
 
   static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
-    return await PayloadHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)
+    return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)
   }
 
   static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
@@ -107,8 +53,8 @@ export class PayloadBuilder<
     return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]
   }
 
-  static async hash<T extends Payload>(payload: T, options?: BuildOptions): Promise<Hash> {
-    return await PayloadHasher.hash(await PayloadBuilder.build(payload, options))
+  static async hash<T extends Payload>(payload: T): Promise<Hash> {
+    return await ObjectHasher.hash(this.omitStorageMeta(payload))
   }
 
   /**
@@ -116,68 +62,38 @@ export class PayloadBuilder<
    * @param objs Any array of payloads
    * @returns An array of payload/hash tuples
    */
-  static async hashPairs<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<[WithMeta<T>, Hash][]> {
+  static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {
     return await Promise.all(
-      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {
-        const built = await PayloadBuilder.build(payload, options)
-        return [built, await PayloadBuilder.hash(built)]
+      payloads.map<Promise<[T, Hash]>>(async (payload) => {
+        return [payload, await PayloadBuilder.hash(payload)]
       }),
     )
   }
 
-  static async hashableFields<T extends Payload = Payload<AnyObject>>(
-    schema: string,
-    fields?: WithoutSchema<WithoutMeta<T>>,
-    $meta?: JsonObject,
-    $hash?: Hash,
-    timestamp?: number,
-    stamp = false,
-  ): Promise<WithMeta<T>> {
-    const dataFields = await this.dataHashableFields<T>(schema, fields)
-    assertEx($meta === undefined || isJsonObject($meta), () => '$meta must be JsonObject')
-    const result: WithMeta<T> = omitBy(
-      {
-        ...dataFields,
-        $hash: $hash ?? (await PayloadBuilder.dataHash(dataFields)),
-        schema,
-      } as WithMeta<T>,
-      omitByPredicate('_'),
-    ) as WithMeta<T>
-
-    const clonedMeta = { ...$meta }
-
-    if (timestamp) {
-      clonedMeta.timestamp = timestamp
-    }
-
-    if (clonedMeta.timestamp === undefined && stamp) {
-      clonedMeta.timestamp = Date.now()
-    }
-
-    if (Object.keys(clonedMeta).length > 0) {
-      result.$meta = clonedMeta
-    }
-
-    return result
+  static hashableFields<T extends Payload>(
+    payload: T,
+  ): T {
+    return this.omitStorageMeta(payload)
   }
 
   static async hashes(payloads: undefined): Promise<undefined>
   static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>
   static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {
-    return await PayloadHasher.hashes(payloads)
+    return await ObjectHasher.hashes(payloads)
   }
 
-  static async toAllHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {
-    const result: Record<Hash, WithMeta<T>> = {}
-    for (const pair of await this.hashPairs(objs)) {
+  static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {
+    const result: Record<Hash, T> = {}
+    for (const pair of await this.hashPairs(payloads)) {
+      const dataHash = await this.dataHash(pair[0])
       result[pair[1]] = pair[0]
-      result[pair[0].$hash] = pair[0]
+      result[dataHash] = pair[0]
     }
     return result
   }
 
-  static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {
-    const result: Record<Hash, WithMeta<T>> = {}
+  static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {
+    const result: Record<Hash, T> = {}
     for (const pair of await this.dataHashPairs(objs)) {
       result[pair[1]] = pair[0]
     }
@@ -189,41 +105,18 @@ export class PayloadBuilder<
    * @param objs Any array of payloads
    * @returns A map of hashes to payloads
    */
-  static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {
-    const result: Record<Hash, WithMeta<T>> = {}
+  static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {
+    const result: Record<Hash, T> = {}
     for (const pair of await this.hashPairs(objs)) {
       result[pair[1]] = pair[0]
     }
     return result
   }
 
-  static withoutMeta(payload: undefined): undefined
-  static withoutMeta<T extends PayloadWithMeta>(payload: T): Omit<T, '$meta'>
-  static withoutMeta<T extends PayloadWithMeta>(payloads: T[]): Omit<T, '$meta'>[]
-  static withoutMeta<T extends PayloadWithMeta>(payloads: T | T[]) {
-    if (Array.isArray(payloads)) {
-      return payloads.map(payload => this.withoutMeta(payload))
-    } else {
-      if (payloads) {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { $meta, ...result } = payloads
-        return result as Omit<T, '$meta'>
-      }
-    }
-  }
-
-  async build(options?: BuildOptions): Promise<WithMeta<T>> {
-    const dataHashableFields = await this.dataHashableFields()
-    return await PayloadBuilder.build<T>({
-      ...dataHashableFields, $meta: this._$meta, schema: this._schema,
-    } as Payload as T, options)
-  }
-
-  async hashableFields() {
-    return await PayloadBuilder.hashableFields(
-      assertEx(this._schema, () => 'Payload: Missing Schema'),
-      this._fields,
-      this._$meta,
-    )
+  build(): T {
+    return {
+      schema: this._schema,
+      ...this._fields,
+    } as T
   }
 }