@xyo-network/payload-builder 2.89.0-rc.7 → 2.89.0-rc.9

package/dist/node/index.cjs

@@ -21,26 +21,69 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  PayloadBuilder: () => PayloadBuilder
+  PayloadBuilder: () => PayloadBuilder,
+  PayloadBuilderBase: () => PayloadBuilderBase
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/Builder.ts
+var import_hash2 = require("@xyo-network/hash");
+
+// src/BuilderBase.ts
 var import_assert = require("@xylabs/assert");
 var import_hash = require("@xyo-network/hash");
-var _PayloadBuilder = class _PayloadBuilder {
+var _PayloadBuilderBase = class _PayloadBuilderBase {
+  options;
   _$meta;
-  _fields = {};
+  _fields;
   _schema;
-  constructor({ schema, fields, meta }) {
+  constructor(options) {
+    this.options = options;
+    const { schema, fields, meta } = options;
     this._schema = schema;
-    this._fields = fields ?? {};
+    this._fields = fields;
     this._$meta = meta;
   }
-  get schema() {
-    this._schema = this._schema ?? this._fields["schema"];
-    return this._schema;
+  $meta(meta) {
+    this._$meta = meta ?? this._fields.$meta;
+    return this;
+  }
+  async dataHashableFields() {
+    return (0, import_hash.deepOmitPrefixedFields)(await this.hashableFields(), "$");
+  }
+  //we do not require sending in $hash since it will be generated anyway
+  fields(fields) {
+    if (fields) {
+      const { $meta, $hash, schema, ...fieldsOnly } = fields;
+      if ($meta) {
+        this.$meta($meta);
+      }
+      if (schema) {
+        this.schema(schema);
+      }
+      this._fields = {
+        ...this._fields,
+        ...(0, import_hash.removeEmptyFields)(fieldsOnly)
+      };
+    }
+    return this;
+  }
+  hashableFields() {
+    const schema = (0, import_assert.assertEx)(this._schema, "Payload: Missing Schema");
+    return {
+      ...(0, import_hash.removeEmptyFields)((0, import_hash.deepOmitPrefixedFields)(this._fields ?? {}, "_")),
+      schema
+    };
+  }
+  schema(value) {
+    this._schema = value;
   }
+};
+__name(_PayloadBuilderBase, "PayloadBuilderBase");
+var PayloadBuilderBase = _PayloadBuilderBase;
+
+// src/Builder.ts
+var _PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
   static async build(payload) {
     const { schema, $hash, $meta, ...fields } = payload;
     const builder = new _PayloadBuilder({
@@ -69,25 +112,28 @@ var _PayloadBuilder = class _PayloadBuilder {
     })) : void 0;
   }
   static async filterExclude(payloads = [], hash) {
+    return await import_hash2.PayloadHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash);
+  }
+  static async filterExcludeByDataHash(payloads = [], hash) {
     var _a;
     const hashes = Array.isArray(hash) ? hash : [
       hash
     ];
-    return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
+    return (_a = (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
   }
-  static async filterInclude(payloads = [], hash) {
+  static async filterIncludeByDataHash(payloads = [], hash) {
     var _a;
     const hashes = Array.isArray(hash) ? hash : [
       hash
     ];
-    return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
+    return (_a = (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
   }
-  static async find(payloads = [], hash) {
+  static async findByDataHash(payloads = [], hash) {
     var _a;
-    return (_a = (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)) == null ? void 0 : _a[0];
+    return (_a = (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)) == null ? void 0 : _a[0];
   }
   static async hash(payload) {
-    return await import_hash.PayloadHasher.hash(payload);
+    return await import_hash2.PayloadHasher.hash(payload);
   }
   /**
   * Creates an array of payload/hash tuples based on the payloads passed in
@@ -104,7 +150,7 @@ var _PayloadBuilder = class _PayloadBuilder {
     }));
   }
   static async hashes(payloads) {
-    return await import_hash.PayloadHasher.hashes(payloads);
+    return await import_hash2.PayloadHasher.hashes(payloads);
   }
   static async toDataHashMap(objs) {
     const result = {};
@@ -125,12 +171,8 @@ var _PayloadBuilder = class _PayloadBuilder {
     }
     return result;
   }
-  $meta(meta) {
-    this._$meta = meta;
-    return this;
-  }
   async build() {
-    const dataHashableFields = this.dataHashableFields();
+    const dataHashableFields = await this.dataHashableFields();
     const $hash = await _PayloadBuilder.hash(dataHashableFields);
     const hashableFields = {
       ...dataHashableFields,
@@ -141,26 +183,12 @@ var _PayloadBuilder = class _PayloadBuilder {
     }
     return hashableFields;
   }
-  dataHashableFields() {
-    return {
-      ...(0, import_hash.removeEmptyFields)((0, import_hash.deepOmitPrefixedFields)((0, import_hash.deepOmitPrefixedFields)(this._fields, "$"), "_")),
-      schema: (0, import_assert.assertEx)(this.schema, "Payload: Missing Schema")
-    };
-  }
-  fields(fields) {
-    if (fields) {
-      this._fields = {
-        ...this._fields,
-        ...(0, import_hash.removeEmptyFields)(fields)
-      };
-    }
-    return this;
-  }
 };
 __name(_PayloadBuilder, "PayloadBuilder");
 var PayloadBuilder = _PayloadBuilder;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  PayloadBuilder
+  PayloadBuilder,
+  PayloadBuilderBase
 });
 //# sourceMappingURL=index.cjs.map

package/dist/node/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts","../../src/Builder.ts"],"sourcesContent":["export * from './Builder'\n","import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { AnyObject, JsonObject } from '@xylabs/object'\nimport { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'\nimport { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'\n\nexport interface PayloadBuilderOptions<T> {\n  fields?: Partial<T>\n  meta?: JsonObject\n  schema: string\n}\n\nexport class PayloadBuilder<T extends Payload = Payload<AnyObject>> {\n  private _$meta?: JsonObject\n  private _fields: Partial<T> = {}\n  private _schema: string\n\n  constructor({ schema, fields, meta }: PayloadBuilderOptions<T>) {\n    this._schema = schema\n    this._fields = fields ?? {}\n    this._$meta = meta\n  }\n\n  get schema() {\n    this._schema = this._schema ?? this._fields['schema']\n    return this._schema\n  }\n\n  static async build<T extends Payload>(payload: T) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { schema, $hash, $meta, ...fields } = payload as WithMeta<T>\n    const builder = new PayloadBuilder<T>({ fields: fields as T, meta: $meta, schema: payload.schema })\n    return await builder.build()\n  }\n\n  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n    return (await this.build(payload)).$hash\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, built.$hash]\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            const built = await PayloadBuilder.build(payload)\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    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async filterInclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async find<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n  }\n\n  static async hash<T extends Payload>(payload: T): Promise<Hash> {\n    return await PayloadHasher.hash(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<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, await PayloadBuilder.hash(built)]\n      }),\n    )\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 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  $meta(meta?: JsonObject) {\n    this._$meta = meta\n    return this\n  }\n\n  async build(): Promise<WithMeta<T>> {\n    const dataHashableFields = this.dataHashableFields()\n    const $hash = await PayloadBuilder.hash(dataHashableFields)\n    const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }\n\n    //only add $meta if it exists and has at least one field\n    if (this._$meta && Object.keys(this._$meta).length > 0) {\n      hashableFields['$meta'] = this._$meta\n    }\n    return hashableFields as WithMeta<T>\n  }\n\n  dataHashableFields() {\n    return {\n      ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, '$'), '_')),\n      schema: assertEx(this.schema, 'Payload: Missing Schema'),\n    } as T\n  }\n\n  fields(fields?: Partial<T>) {\n    if (fields) {\n      this._fields = { ...this._fields, ...removeEmptyFields(fields) }\n    }\n    return this\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACAA,oBAAyB;AAGzB,kBAAyE;AASlE,IAAMA,kBAAN,MAAMA,gBAAAA;EACHC;EACAC,UAAsB,CAAC;EACvBC;EAERC,YAAY,EAAEC,QAAQC,QAAQC,KAAI,GAA8B;AAC9D,SAAKJ,UAAUE;AACf,SAAKH,UAAUI,UAAU,CAAC;AAC1B,SAAKL,SAASM;EAChB;EAEA,IAAIF,SAAS;AACX,SAAKF,UAAU,KAAKA,WAAW,KAAKD,QAAQ,QAAA;AAC5C,WAAO,KAAKC;EACd;EAEA,aAAaK,MAAyBC,SAAY;AAEhD,UAAM,EAAEJ,QAAQK,OAAOC,OAAO,GAAGL,OAAAA,IAAWG;AAC5C,UAAMG,UAAU,IAAIZ,gBAAkB;MAAEM;MAAqBC,MAAMI;MAAON,QAAQI,QAAQJ;IAAO,CAAA;AACjG,WAAO,MAAMO,QAAQJ,MAAK;EAC5B;EAEA,aAAaK,SAA4BJ,SAA2B;AAClE,YAAQ,MAAM,KAAKD,MAAMC,OAAAA,GAAUC;EACrC;EAEA,aAAaI,cAAiCC,UAA+C;AAC3F,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAOT,YAAAA;AAClB,YAAMU,QAAQ,MAAMnB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACU;QAAOA,MAAMT;;IACvB,CAAA,CAAA;EAEJ;EAIA,aAAaU,WAA8BL,UAA6C;AACtF,WAAOA,WACH,MAAMC,QAAQC,IACZF,SAASG,IAAI,OAAOT,YAAAA;AAClB,YAAMU,QAAQ,MAAMnB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAOU,MAAMT;IACf,CAAA,CAAA,IAEFW;EACN;EAEA,aAAaC,cAAiCP,WAAgB,CAAA,GAAIQ,MAAmC;AA7DvG;AA8DI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACN,OAAOO,SAASD,OAAAA,CAAAA,MAA1E,mBAAqFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EAClH;EAEA,aAAaC,cAAiClB,WAAgB,CAAA,GAAIQ,MAAmC;AAlEvG;AAmEI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaN,OAAOO,SAASD,OAAAA,CAAAA,MAAzE,mBAAoFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EACjH;EAEA,aAAaE,KAAwBnB,WAAgB,CAAA,GAAIQ,MAAoC;AAvE/F;AAwEI,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWmB,KAAK,CAAC,CAACL,GAAGC,OAAAA,MAAaA,YAAYP,IAAAA,MAAnE,mBAA2E;EACrF;EAEA,aAAaA,KAAwBd,SAA2B;AAC9D,WAAO,MAAM0B,0BAAcZ,KAAKd,OAAAA;EAClC;;;;;;EAOA,aAAakB,UAA6BZ,UAA+C;AACvF,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAkC,OAAOT,YAAAA;AAChD,YAAMU,QAAQ,MAAMnB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACU;QAAO,MAAMnB,gBAAeuB,KAAKJ,KAAAA;;IAC3C,CAAA,CAAA;EAEJ;EAIA,aAAaK,OAA0BT,UAA6C;AAClF,WAAO,MAAMoB,0BAAcX,OAAOT,QAAAA;EACpC;EAEA,aAAaqB,cAAiCC,MAAqC;AACjF,UAAMC,SAA0B,CAAC;AACjC,eAAWN,QAAQ,MAAM,KAAKlB,cAAcuB,IAAAA,GAAO;AACjDC,aAAON,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOM;EACT;;;;;;EAOA,aAAaC,UAA6BF,MAAqC;AAC7E,UAAMC,SAA0B,CAAC;AACjC,eAAWN,QAAQ,MAAM,KAAKL,UAAUU,IAAAA,GAAO;AAC7CC,aAAON,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOM;EACT;EAEA3B,MAAMJ,MAAmB;AACvB,SAAKN,SAASM;AACd,WAAO;EACT;EAEA,MAAMC,QAA8B;AAClC,UAAMgC,qBAAqB,KAAKA,mBAAkB;AAClD,UAAM9B,QAAQ,MAAMV,gBAAeuB,KAAKiB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoB9B;IAAM;AAGvE,QAAI,KAAKT,UAAUyC,OAAOC,KAAK,KAAK1C,MAAM,EAAE2C,SAAS,GAAG;AACtDH,qBAAe,OAAA,IAAW,KAAKxC;IACjC;AACA,WAAOwC;EACT;EAEAD,qBAAqB;AACnB,WAAO;MACL,OAAGK,mCAAkBC,wCAAuBA,oCAAuB,KAAK5C,SAAS,GAAA,GAAM,GAAA,CAAA;MACvFG,YAAQ0C,wBAAS,KAAK1C,QAAQ,yBAAA;IAChC;EACF;EAEAC,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,OAAG2C,+BAAkBvC,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;AACF;AA1IaN;AAAN,IAAMA,iBAAN;","names":["PayloadBuilder","_$meta","_fields","_schema","constructor","schema","fields","meta","build","payload","$hash","$meta","builder","dataHash","dataHashPairs","payloads","Promise","all","map","built","dataHashes","undefined","filterExclude","hash","hashes","Array","isArray","hashPairs","filter","_","objHash","includes","pair","filterInclude","find","PayloadHasher","toDataHashMap","objs","result","toHashMap","dataHashableFields","hashableFields","Object","keys","length","removeEmptyFields","deepOmitPrefixedFields","assertEx"]}
+{"version":3,"sources":["../../src/index.ts","../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["export * from './Builder'\nexport * from './BuilderBase'\nexport * from './Options'\n","import { Hash } from '@xylabs/hex'\nimport { AnyObject } from '@xylabs/object'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'\n\nimport { PayloadBuilderBase } from './BuilderBase'\nimport { PayloadBuilderOptions } from './Options'\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: T) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { schema, $hash, $meta, ...fields } = payload as WithMeta<T>\n    const builder = new PayloadBuilder<T>({ fields: fields as T, meta: $meta, schema: payload.schema })\n    return await builder.build()\n  }\n\n  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n    return (await this.build(payload)).$hash\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, built.$hash]\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            const built = await PayloadBuilder.build(payload)\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): Promise<Hash> {\n    return await PayloadHasher.hash(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<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, await PayloadBuilder.hash(built)]\n      }),\n    )\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 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  async build(): Promise<WithMeta<T>> {\n    const dataHashableFields = await this.dataHashableFields()\n    const $hash = await PayloadBuilder.hash(dataHashableFields)\n    const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }\n\n    //only add $meta if it exists and has at least one field\n    if (this._$meta && Object.keys(this._$meta).length > 0) {\n      hashableFields['$meta'] = this._$meta\n    }\n    return hashableFields as WithMeta<T>\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport { AnyObject, JsonObject } from '@xylabs/object'\nimport { Promisable } from '@xylabs/promise'\nimport { deepOmitPrefixedFields, removeEmptyFields } from '@xyo-network/hash'\nimport { Payload, Schema, WithMeta } from '@xyo-network/payload-model'\n\nimport { PayloadBuilderOptions } from './Options'\n\nexport class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n  protected _$meta?: JsonObject\n  protected _fields?: Omit<T, 'schema' | '$hash' | '$meta'>\n  protected _schema: Schema\n\n  constructor(readonly options: O) {\n    const { schema, fields, meta } = options\n    this._schema = schema\n    this._fields = fields\n    this._$meta = 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(): Promise<T> {\n    return deepOmitPrefixedFields(await this.hashableFields(), '$')\n  }\n\n  //we do not require sending in $hash since it will be generated anyway\n  fields(fields: Omit<WithMeta<T>, '$hash' | 'schema'> & Partial<Pick<WithMeta<T>, '$hash' | 'schema'>>) {\n    if (fields) {\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      const { $meta, $hash, schema, ...fieldsOnly } = fields as WithMeta<T>\n      if ($meta) {\n        this.$meta($meta)\n      }\n      if (schema) {\n        this.schema(schema)\n      }\n      this._fields = { ...this._fields, ...removeEmptyFields(fieldsOnly) }\n    }\n    return this\n  }\n\n  hashableFields(): Promisable<T> {\n    const schema = assertEx(this._schema, 'Payload: Missing Schema')\n    return {\n      ...removeEmptyFields(deepOmitPrefixedFields(this._fields ?? {}, '_')),\n      schema,\n    } as T\n  }\n\n  schema(value: Schema) {\n    this._schema = value\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;ACEA,IAAAA,eAA8B;;;ACF9B,oBAAyB;AAGzB,kBAA0D;AAKnD,IAAMC,sBAAN,MAAMA,oBAAAA;;EACDC;EACAC;EACAC;EAEVC,YAAqBC,SAAY;SAAZA,UAAAA;AACnB,UAAM,EAAEC,QAAQC,QAAQC,KAAI,IAAKH;AACjC,SAAKF,UAAUG;AACf,SAAKJ,UAAUK;AACf,SAAKN,SAASO;EAChB;EAEAC,MAAMD,MAAmB;AACvB,SAAKP,SAASO,QAAS,KAAKN,QAAwBO;AACpD,WAAO;EACT;EAEA,MAAMC,qBAAiC;AACrC,eAAOC,oCAAuB,MAAM,KAAKC,eAAc,GAAI,GAAA;EAC7D;;EAGAL,OAAOA,QAAgG;AACrG,QAAIA,QAAQ;AAEV,YAAM,EAAEE,OAAOI,OAAOP,QAAQ,GAAGQ,WAAAA,IAAeP;AAChD,UAAIE,OAAO;AACT,aAAKA,MAAMA,KAAAA;MACb;AACA,UAAIH,QAAQ;AACV,aAAKA,OAAOA,MAAAA;MACd;AACA,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,OAAGa,+BAAkBD,UAAAA;MAAY;IACrE;AACA,WAAO;EACT;EAEAF,iBAAgC;AAC9B,UAAMN,aAASU,wBAAS,KAAKb,SAAS,yBAAA;AACtC,WAAO;MACL,OAAGY,mCAAkBJ,oCAAuB,KAAKT,WAAW,CAAC,GAAG,GAAA,CAAA;MAChEI;IACF;EACF;EAEAA,OAAOW,OAAe;AACpB,SAAKd,UAAUc;EACjB;AACF;AAhDajB;AAAN,IAAMA,qBAAN;;;ADAA,IAAMkB,kBAAN,MAAMA,wBAGHC,mBAAAA;EACR,aAAaC,MAAyBC,SAAY;AAEhD,UAAM,EAAEC,QAAQC,OAAOC,OAAO,GAAGC,OAAAA,IAAWJ;AAC5C,UAAMK,UAAU,IAAIR,gBAAkB;MAAEO;MAAqBE,MAAMH;MAAOF,QAAQD,QAAQC;IAAO,CAAA;AACjG,WAAO,MAAMI,QAAQN,MAAK;EAC5B;EAEA,aAAaQ,SAA4BP,SAA2B;AAClE,YAAQ,MAAM,KAAKD,MAAMC,OAAAA,GAAUE;EACrC;EAEA,aAAaM,cAAiCC,UAA+C;AAC3F,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAOZ,YAAAA;AAClB,YAAMa,QAAQ,MAAMhB,gBAAeE,MAAMC,OAAAA;AACzC,aAAO;QAACa;QAAOA,MAAMX;;IACvB,CAAA,CAAA;EAEJ;EAIA,aAAaY,WAA8BL,UAA6C;AACtF,WAAOA,WACH,MAAMC,QAAQC,IACZF,SAASG,IAAI,OAAOZ,YAAAA;AAClB,YAAMa,QAAQ,MAAMhB,gBAAeE,MAAMC,OAAAA;AACzC,aAAOa,MAAMX;IACf,CAAA,CAAA,IAEFa;EACN;EAEA,aAAaC,cAAiCP,WAAgB,CAAA,GAAIQ,MAAmC;AACnG,WAAO,MAAMC,2BAAcC,oBAAoB,MAAM,KAAKC,wBAAwBX,UAAUQ,IAAAA,GAAOA,IAAAA;EACrG;EAEA,aAAaG,wBAA2CX,WAAgB,CAAA,GAAIQ,MAAmC;AA/CjH;AAgDI,UAAMI,SAASC,MAAMC,QAAQN,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWe,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACL,OAAOM,SAASD,OAAAA,CAAAA,MAA9E,mBAAyFd,IAAI,CAACgB,SAASA,KAAK,CAAA;EACtH;EAEA,aAAaC,wBAA2CpB,WAAgB,CAAA,GAAIQ,MAAmC;AApDjH;AAqDI,UAAMI,SAASC,MAAMC,QAAQN,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWe,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaL,OAAOM,SAASD,OAAAA,CAAAA,MAA7E,mBAAwFd,IAAI,CAACgB,SAASA,KAAK,CAAA;EACrH;EAEA,aAAaE,eAAkCrB,WAAgB,CAAA,GAAIQ,MAAoC;AAzDzG;AA0DI,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWsB,KAAK,CAAC,CAACN,GAAGC,OAAAA,MAAaA,YAAYT,IAAAA,MAAvE,mBAA+E;EACzF;EAEA,aAAaA,KAAwBjB,SAA2B;AAC9D,WAAO,MAAMkB,2BAAcD,KAAKjB,OAAAA;EAClC;;;;;;EAOA,aAAagC,UAA6BvB,UAA+C;AACvF,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAkC,OAAOZ,YAAAA;AAChD,YAAMa,QAAQ,MAAMhB,gBAAeE,MAAMC,OAAAA;AACzC,aAAO;QAACa;QAAO,MAAMhB,gBAAeoB,KAAKJ,KAAAA;;IAC3C,CAAA,CAAA;EAEJ;EAIA,aAAaQ,OAA0BZ,UAA6C;AAClF,WAAO,MAAMS,2BAAcG,OAAOZ,QAAAA;EACpC;EAEA,aAAawB,cAAiCC,MAAqC;AACjF,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKpB,cAAc0B,IAAAA,GAAO;AACjDC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOO;EACT;;;;;;EAOA,aAAaC,UAA6BF,MAAqC;AAC7E,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKI,UAAUE,IAAAA,GAAO;AAC7CC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOO;EACT;EAEA,MAAMpC,QAA8B;AAClC,UAAMsC,qBAAqB,MAAM,KAAKA,mBAAkB;AACxD,UAAMnC,QAAQ,MAAML,gBAAeoB,KAAKoB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBnC;IAAM;AAGvE,QAAI,KAAKqC,UAAUC,OAAOC,KAAK,KAAKF,MAAM,EAAEG,SAAS,GAAG;AACtDJ,qBAAe,OAAA,IAAW,KAAKC;IACjC;AACA,WAAOD;EACT;AACF;AA5GUxC;AAHH,IAAMD,iBAAN;","names":["import_hash","PayloadBuilderBase","_$meta","_fields","_schema","constructor","options","schema","fields","meta","$meta","dataHashableFields","deepOmitPrefixedFields","hashableFields","$hash","fieldsOnly","removeEmptyFields","assertEx","value","PayloadBuilder","PayloadBuilderBase","build","payload","schema","$hash","$meta","fields","builder","meta","dataHash","dataHashPairs","payloads","Promise","all","map","built","dataHashes","undefined","filterExclude","hash","PayloadHasher","filterExcludeByHash","filterExcludeByDataHash","hashes","Array","isArray","filter","_","objHash","includes","pair","filterIncludeByDataHash","findByDataHash","find","hashPairs","toDataHashMap","objs","result","toHashMap","dataHashableFields","hashableFields","_$meta","Object","keys","length"]}

package/dist/node/index.d.cts

@@ -1,2 +1,4 @@
 export * from './Builder';
+export * from './BuilderBase';
+export * from './Options';
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}

package/dist/node/index.d.mts

@@ -1,2 +1,4 @@
 export * from './Builder';
+export * from './BuilderBase';
+export * from './Options';
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}

package/dist/node/index.d.ts

@@ -1,2 +1,4 @@
 export * from './Builder';
+export * from './BuilderBase';
+export * from './Options';
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}

package/dist/node/index.js

@@ -2,21 +2,63 @@ var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
 // src/Builder.ts
+import { PayloadHasher } from "@xyo-network/hash";
+
+// src/BuilderBase.ts
 import { assertEx } from "@xylabs/assert";
-import { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from "@xyo-network/hash";
-var _PayloadBuilder = class _PayloadBuilder {
+import { deepOmitPrefixedFields, removeEmptyFields } from "@xyo-network/hash";
+var _PayloadBuilderBase = class _PayloadBuilderBase {
+  options;
   _$meta;
-  _fields = {};
+  _fields;
   _schema;
-  constructor({ schema, fields, meta }) {
+  constructor(options) {
+    this.options = options;
+    const { schema, fields, meta } = options;
     this._schema = schema;
-    this._fields = fields ?? {};
+    this._fields = fields;
     this._$meta = meta;
   }
-  get schema() {
-    this._schema = this._schema ?? this._fields["schema"];
-    return this._schema;
+  $meta(meta) {
+    this._$meta = meta ?? this._fields.$meta;
+    return this;
+  }
+  async dataHashableFields() {
+    return deepOmitPrefixedFields(await this.hashableFields(), "$");
+  }
+  //we do not require sending in $hash since it will be generated anyway
+  fields(fields) {
+    if (fields) {
+      const { $meta, $hash, schema, ...fieldsOnly } = fields;
+      if ($meta) {
+        this.$meta($meta);
+      }
+      if (schema) {
+        this.schema(schema);
+      }
+      this._fields = {
+        ...this._fields,
+        ...removeEmptyFields(fieldsOnly)
+      };
+    }
+    return this;
+  }
+  hashableFields() {
+    const schema = assertEx(this._schema, "Payload: Missing Schema");
+    return {
+      ...removeEmptyFields(deepOmitPrefixedFields(this._fields ?? {}, "_")),
+      schema
+    };
+  }
+  schema(value) {
+    this._schema = value;
   }
+};
+__name(_PayloadBuilderBase, "PayloadBuilderBase");
+var PayloadBuilderBase = _PayloadBuilderBase;
+
+// src/Builder.ts
+var _PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
   static async build(payload) {
     const { schema, $hash, $meta, ...fields } = payload;
     const builder = new _PayloadBuilder({
@@ -45,22 +87,25 @@ var _PayloadBuilder = class _PayloadBuilder {
     })) : void 0;
   }
   static async filterExclude(payloads = [], hash) {
+    return await PayloadHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash);
+  }
+  static async filterExcludeByDataHash(payloads = [], hash) {
     var _a;
     const hashes = Array.isArray(hash) ? hash : [
       hash
     ];
-    return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
+    return (_a = (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
   }
-  static async filterInclude(payloads = [], hash) {
+  static async filterIncludeByDataHash(payloads = [], hash) {
     var _a;
     const hashes = Array.isArray(hash) ? hash : [
       hash
     ];
-    return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
+    return (_a = (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
   }
-  static async find(payloads = [], hash) {
+  static async findByDataHash(payloads = [], hash) {
     var _a;
-    return (_a = (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)) == null ? void 0 : _a[0];
+    return (_a = (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)) == null ? void 0 : _a[0];
   }
   static async hash(payload) {
     return await PayloadHasher.hash(payload);
@@ -101,12 +146,8 @@ var _PayloadBuilder = class _PayloadBuilder {
     }
     return result;
   }
-  $meta(meta) {
-    this._$meta = meta;
-    return this;
-  }
   async build() {
-    const dataHashableFields = this.dataHashableFields();
+    const dataHashableFields = await this.dataHashableFields();
     const $hash = await _PayloadBuilder.hash(dataHashableFields);
     const hashableFields = {
       ...dataHashableFields,
@@ -117,25 +158,11 @@ var _PayloadBuilder = class _PayloadBuilder {
     }
     return hashableFields;
   }
-  dataHashableFields() {
-    return {
-      ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, "$"), "_")),
-      schema: assertEx(this.schema, "Payload: Missing Schema")
-    };
-  }
-  fields(fields) {
-    if (fields) {
-      this._fields = {
-        ...this._fields,
-        ...removeEmptyFields(fields)
-      };
-    }
-    return this;
-  }
 };
 __name(_PayloadBuilder, "PayloadBuilder");
 var PayloadBuilder = _PayloadBuilder;
 export {
-  PayloadBuilder
+  PayloadBuilder,
+  PayloadBuilderBase
 };
 //# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Builder.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { AnyObject, JsonObject } from '@xylabs/object'\nimport { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'\nimport { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'\n\nexport interface PayloadBuilderOptions<T> {\n  fields?: Partial<T>\n  meta?: JsonObject\n  schema: string\n}\n\nexport class PayloadBuilder<T extends Payload = Payload<AnyObject>> {\n  private _$meta?: JsonObject\n  private _fields: Partial<T> = {}\n  private _schema: string\n\n  constructor({ schema, fields, meta }: PayloadBuilderOptions<T>) {\n    this._schema = schema\n    this._fields = fields ?? {}\n    this._$meta = meta\n  }\n\n  get schema() {\n    this._schema = this._schema ?? this._fields['schema']\n    return this._schema\n  }\n\n  static async build<T extends Payload>(payload: T) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { schema, $hash, $meta, ...fields } = payload as WithMeta<T>\n    const builder = new PayloadBuilder<T>({ fields: fields as T, meta: $meta, schema: payload.schema })\n    return await builder.build()\n  }\n\n  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n    return (await this.build(payload)).$hash\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, built.$hash]\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            const built = await PayloadBuilder.build(payload)\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    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async filterInclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async find<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n  }\n\n  static async hash<T extends Payload>(payload: T): Promise<Hash> {\n    return await PayloadHasher.hash(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<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, await PayloadBuilder.hash(built)]\n      }),\n    )\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 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  $meta(meta?: JsonObject) {\n    this._$meta = meta\n    return this\n  }\n\n  async build(): Promise<WithMeta<T>> {\n    const dataHashableFields = this.dataHashableFields()\n    const $hash = await PayloadBuilder.hash(dataHashableFields)\n    const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }\n\n    //only add $meta if it exists and has at least one field\n    if (this._$meta && Object.keys(this._$meta).length > 0) {\n      hashableFields['$meta'] = this._$meta\n    }\n    return hashableFields as WithMeta<T>\n  }\n\n  dataHashableFields() {\n    return {\n      ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, '$'), '_')),\n      schema: assertEx(this.schema, 'Payload: Missing Schema'),\n    } as T\n  }\n\n  fields(fields?: Partial<T>) {\n    if (fields) {\n      this._fields = { ...this._fields, ...removeEmptyFields(fields) }\n    }\n    return this\n  }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AAGzB,SAASC,wBAAwBC,eAAeC,yBAAyB;AASlE,IAAMC,kBAAN,MAAMA,gBAAAA;EACHC;EACAC,UAAsB,CAAC;EACvBC;EAERC,YAAY,EAAEC,QAAQC,QAAQC,KAAI,GAA8B;AAC9D,SAAKJ,UAAUE;AACf,SAAKH,UAAUI,UAAU,CAAC;AAC1B,SAAKL,SAASM;EAChB;EAEA,IAAIF,SAAS;AACX,SAAKF,UAAU,KAAKA,WAAW,KAAKD,QAAQ,QAAA;AAC5C,WAAO,KAAKC;EACd;EAEA,aAAaK,MAAyBC,SAAY;AAEhD,UAAM,EAAEJ,QAAQK,OAAOC,OAAO,GAAGL,OAAAA,IAAWG;AAC5C,UAAMG,UAAU,IAAIZ,gBAAkB;MAAEM;MAAqBC,MAAMI;MAAON,QAAQI,QAAQJ;IAAO,CAAA;AACjG,WAAO,MAAMO,QAAQJ,MAAK;EAC5B;EAEA,aAAaK,SAA4BJ,SAA2B;AAClE,YAAQ,MAAM,KAAKD,MAAMC,OAAAA,GAAUC;EACrC;EAEA,aAAaI,cAAiCC,UAA+C;AAC3F,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAOT,YAAAA;AAClB,YAAMU,QAAQ,MAAMnB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACU;QAAOA,MAAMT;;IACvB,CAAA,CAAA;EAEJ;EAIA,aAAaU,WAA8BL,UAA6C;AACtF,WAAOA,WACH,MAAMC,QAAQC,IACZF,SAASG,IAAI,OAAOT,YAAAA;AAClB,YAAMU,QAAQ,MAAMnB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAOU,MAAMT;IACf,CAAA,CAAA,IAEFW;EACN;EAEA,aAAaC,cAAiCP,WAAgB,CAAA,GAAIQ,MAAmC;AA7DvG;AA8DI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACN,OAAOO,SAASD,OAAAA,CAAAA,MAA1E,mBAAqFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EAClH;EAEA,aAAaC,cAAiClB,WAAgB,CAAA,GAAIQ,MAAmC;AAlEvG;AAmEI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaN,OAAOO,SAASD,OAAAA,CAAAA,MAAzE,mBAAoFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EACjH;EAEA,aAAaE,KAAwBnB,WAAgB,CAAA,GAAIQ,MAAoC;AAvE/F;AAwEI,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWmB,KAAK,CAAC,CAACL,GAAGC,OAAAA,MAAaA,YAAYP,IAAAA,MAAnE,mBAA2E;EACrF;EAEA,aAAaA,KAAwBd,SAA2B;AAC9D,WAAO,MAAM0B,cAAcZ,KAAKd,OAAAA;EAClC;;;;;;EAOA,aAAakB,UAA6BZ,UAA+C;AACvF,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAkC,OAAOT,YAAAA;AAChD,YAAMU,QAAQ,MAAMnB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACU;QAAO,MAAMnB,gBAAeuB,KAAKJ,KAAAA;;IAC3C,CAAA,CAAA;EAEJ;EAIA,aAAaK,OAA0BT,UAA6C;AAClF,WAAO,MAAMoB,cAAcX,OAAOT,QAAAA;EACpC;EAEA,aAAaqB,cAAiCC,MAAqC;AACjF,UAAMC,SAA0B,CAAC;AACjC,eAAWN,QAAQ,MAAM,KAAKlB,cAAcuB,IAAAA,GAAO;AACjDC,aAAON,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOM;EACT;;;;;;EAOA,aAAaC,UAA6BF,MAAqC;AAC7E,UAAMC,SAA0B,CAAC;AACjC,eAAWN,QAAQ,MAAM,KAAKL,UAAUU,IAAAA,GAAO;AAC7CC,aAAON,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOM;EACT;EAEA3B,MAAMJ,MAAmB;AACvB,SAAKN,SAASM;AACd,WAAO;EACT;EAEA,MAAMC,QAA8B;AAClC,UAAMgC,qBAAqB,KAAKA,mBAAkB;AAClD,UAAM9B,QAAQ,MAAMV,gBAAeuB,KAAKiB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoB9B;IAAM;AAGvE,QAAI,KAAKT,UAAUyC,OAAOC,KAAK,KAAK1C,MAAM,EAAE2C,SAAS,GAAG;AACtDH,qBAAe,OAAA,IAAW,KAAKxC;IACjC;AACA,WAAOwC;EACT;EAEAD,qBAAqB;AACnB,WAAO;MACL,GAAGK,kBAAkBC,uBAAuBA,uBAAuB,KAAK5C,SAAS,GAAA,GAAM,GAAA,CAAA;MACvFG,QAAQ0C,SAAS,KAAK1C,QAAQ,yBAAA;IAChC;EACF;EAEAC,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,GAAG2C,kBAAkBvC,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;AACF;AA1IaN;AAAN,IAAMA,iBAAN;","names":["assertEx","deepOmitPrefixedFields","PayloadHasher","removeEmptyFields","PayloadBuilder","_$meta","_fields","_schema","constructor","schema","fields","meta","build","payload","$hash","$meta","builder","dataHash","dataHashPairs","payloads","Promise","all","map","built","dataHashes","undefined","filterExclude","hash","hashes","Array","isArray","hashPairs","filter","_","objHash","includes","pair","filterInclude","find","PayloadHasher","toDataHashMap","objs","result","toHashMap","dataHashableFields","hashableFields","Object","keys","length","removeEmptyFields","deepOmitPrefixedFields","assertEx"]}
+{"version":3,"sources":["../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["import { Hash } from '@xylabs/hex'\nimport { AnyObject } from '@xylabs/object'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'\n\nimport { PayloadBuilderBase } from './BuilderBase'\nimport { PayloadBuilderOptions } from './Options'\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: T) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { schema, $hash, $meta, ...fields } = payload as WithMeta<T>\n    const builder = new PayloadBuilder<T>({ fields: fields as T, meta: $meta, schema: payload.schema })\n    return await builder.build()\n  }\n\n  static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n    return (await this.build(payload)).$hash\n  }\n\n  static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, built.$hash]\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            const built = await PayloadBuilder.build(payload)\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): Promise<Hash> {\n    return await PayloadHasher.hash(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<[WithMeta<T>, Hash][]> {\n    return await Promise.all(\n      payloads.map<Promise<[WithMeta<T>, Hash]>>(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return [built, await PayloadBuilder.hash(built)]\n      }),\n    )\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 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  async build(): Promise<WithMeta<T>> {\n    const dataHashableFields = await this.dataHashableFields()\n    const $hash = await PayloadBuilder.hash(dataHashableFields)\n    const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }\n\n    //only add $meta if it exists and has at least one field\n    if (this._$meta && Object.keys(this._$meta).length > 0) {\n      hashableFields['$meta'] = this._$meta\n    }\n    return hashableFields as WithMeta<T>\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport { AnyObject, JsonObject } from '@xylabs/object'\nimport { Promisable } from '@xylabs/promise'\nimport { deepOmitPrefixedFields, removeEmptyFields } from '@xyo-network/hash'\nimport { Payload, Schema, WithMeta } from '@xyo-network/payload-model'\n\nimport { PayloadBuilderOptions } from './Options'\n\nexport class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n  protected _$meta?: JsonObject\n  protected _fields?: Omit<T, 'schema' | '$hash' | '$meta'>\n  protected _schema: Schema\n\n  constructor(readonly options: O) {\n    const { schema, fields, meta } = options\n    this._schema = schema\n    this._fields = fields\n    this._$meta = 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(): Promise<T> {\n    return deepOmitPrefixedFields(await this.hashableFields(), '$')\n  }\n\n  //we do not require sending in $hash since it will be generated anyway\n  fields(fields: Omit<WithMeta<T>, '$hash' | 'schema'> & Partial<Pick<WithMeta<T>, '$hash' | 'schema'>>) {\n    if (fields) {\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      const { $meta, $hash, schema, ...fieldsOnly } = fields as WithMeta<T>\n      if ($meta) {\n        this.$meta($meta)\n      }\n      if (schema) {\n        this.schema(schema)\n      }\n      this._fields = { ...this._fields, ...removeEmptyFields(fieldsOnly) }\n    }\n    return this\n  }\n\n  hashableFields(): Promisable<T> {\n    const schema = assertEx(this._schema, 'Payload: Missing Schema')\n    return {\n      ...removeEmptyFields(deepOmitPrefixedFields(this._fields ?? {}, '_')),\n      schema,\n    } as T\n  }\n\n  schema(value: Schema) {\n    this._schema = value\n  }\n}\n"],"mappings":";;;;AAEA,SAASA,qBAAqB;;;ACF9B,SAASC,gBAAgB;AAGzB,SAASC,wBAAwBC,yBAAyB;AAKnD,IAAMC,sBAAN,MAAMA,oBAAAA;;EACDC;EACAC;EACAC;EAEVC,YAAqBC,SAAY;SAAZA,UAAAA;AACnB,UAAM,EAAEC,QAAQC,QAAQC,KAAI,IAAKH;AACjC,SAAKF,UAAUG;AACf,SAAKJ,UAAUK;AACf,SAAKN,SAASO;EAChB;EAEAC,MAAMD,MAAmB;AACvB,SAAKP,SAASO,QAAS,KAAKN,QAAwBO;AACpD,WAAO;EACT;EAEA,MAAMC,qBAAiC;AACrC,WAAOC,uBAAuB,MAAM,KAAKC,eAAc,GAAI,GAAA;EAC7D;;EAGAL,OAAOA,QAAgG;AACrG,QAAIA,QAAQ;AAEV,YAAM,EAAEE,OAAOI,OAAOP,QAAQ,GAAGQ,WAAAA,IAAeP;AAChD,UAAIE,OAAO;AACT,aAAKA,MAAMA,KAAAA;MACb;AACA,UAAIH,QAAQ;AACV,aAAKA,OAAOA,MAAAA;MACd;AACA,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,GAAGa,kBAAkBD,UAAAA;MAAY;IACrE;AACA,WAAO;EACT;EAEAF,iBAAgC;AAC9B,UAAMN,SAASU,SAAS,KAAKb,SAAS,yBAAA;AACtC,WAAO;MACL,GAAGY,kBAAkBJ,uBAAuB,KAAKT,WAAW,CAAC,GAAG,GAAA,CAAA;MAChEI;IACF;EACF;EAEAA,OAAOW,OAAe;AACpB,SAAKd,UAAUc;EACjB;AACF;AAhDajB;AAAN,IAAMA,qBAAN;;;ADAA,IAAMkB,kBAAN,MAAMA,wBAGHC,mBAAAA;EACR,aAAaC,MAAyBC,SAAY;AAEhD,UAAM,EAAEC,QAAQC,OAAOC,OAAO,GAAGC,OAAAA,IAAWJ;AAC5C,UAAMK,UAAU,IAAIR,gBAAkB;MAAEO;MAAqBE,MAAMH;MAAOF,QAAQD,QAAQC;IAAO,CAAA;AACjG,WAAO,MAAMI,QAAQN,MAAK;EAC5B;EAEA,aAAaQ,SAA4BP,SAA2B;AAClE,YAAQ,MAAM,KAAKD,MAAMC,OAAAA,GAAUE;EACrC;EAEA,aAAaM,cAAiCC,UAA+C;AAC3F,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAOZ,YAAAA;AAClB,YAAMa,QAAQ,MAAMhB,gBAAeE,MAAMC,OAAAA;AACzC,aAAO;QAACa;QAAOA,MAAMX;;IACvB,CAAA,CAAA;EAEJ;EAIA,aAAaY,WAA8BL,UAA6C;AACtF,WAAOA,WACH,MAAMC,QAAQC,IACZF,SAASG,IAAI,OAAOZ,YAAAA;AAClB,YAAMa,QAAQ,MAAMhB,gBAAeE,MAAMC,OAAAA;AACzC,aAAOa,MAAMX;IACf,CAAA,CAAA,IAEFa;EACN;EAEA,aAAaC,cAAiCP,WAAgB,CAAA,GAAIQ,MAAmC;AACnG,WAAO,MAAMC,cAAcC,oBAAoB,MAAM,KAAKC,wBAAwBX,UAAUQ,IAAAA,GAAOA,IAAAA;EACrG;EAEA,aAAaG,wBAA2CX,WAAgB,CAAA,GAAIQ,MAAmC;AA/CjH;AAgDI,UAAMI,SAASC,MAAMC,QAAQN,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWe,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACL,OAAOM,SAASD,OAAAA,CAAAA,MAA9E,mBAAyFd,IAAI,CAACgB,SAASA,KAAK,CAAA;EACtH;EAEA,aAAaC,wBAA2CpB,WAAgB,CAAA,GAAIQ,MAAmC;AApDjH;AAqDI,UAAMI,SAASC,MAAMC,QAAQN,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWe,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaL,OAAOM,SAASD,OAAAA,CAAAA,MAA7E,mBAAwFd,IAAI,CAACgB,SAASA,KAAK,CAAA;EACrH;EAEA,aAAaE,eAAkCrB,WAAgB,CAAA,GAAIQ,MAAoC;AAzDzG;AA0DI,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWsB,KAAK,CAAC,CAACN,GAAGC,OAAAA,MAAaA,YAAYT,IAAAA,MAAvE,mBAA+E;EACzF;EAEA,aAAaA,KAAwBjB,SAA2B;AAC9D,WAAO,MAAMkB,cAAcD,KAAKjB,OAAAA;EAClC;;;;;;EAOA,aAAagC,UAA6BvB,UAA+C;AACvF,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAkC,OAAOZ,YAAAA;AAChD,YAAMa,QAAQ,MAAMhB,gBAAeE,MAAMC,OAAAA;AACzC,aAAO;QAACa;QAAO,MAAMhB,gBAAeoB,KAAKJ,KAAAA;;IAC3C,CAAA,CAAA;EAEJ;EAIA,aAAaQ,OAA0BZ,UAA6C;AAClF,WAAO,MAAMS,cAAcG,OAAOZ,QAAAA;EACpC;EAEA,aAAawB,cAAiCC,MAAqC;AACjF,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKpB,cAAc0B,IAAAA,GAAO;AACjDC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOO;EACT;;;;;;EAOA,aAAaC,UAA6BF,MAAqC;AAC7E,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKI,UAAUE,IAAAA,GAAO;AAC7CC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOO;EACT;EAEA,MAAMpC,QAA8B;AAClC,UAAMsC,qBAAqB,MAAM,KAAKA,mBAAkB;AACxD,UAAMnC,QAAQ,MAAML,gBAAeoB,KAAKoB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBnC;IAAM;AAGvE,QAAI,KAAKqC,UAAUC,OAAOC,KAAK,KAAKF,MAAM,EAAEG,SAAS,GAAG;AACtDJ,qBAAe,OAAA,IAAW,KAAKC;IACjC;AACA,WAAOD;EACT;AACF;AA5GUxC;AAHH,IAAMD,iBAAN;","names":["PayloadHasher","assertEx","deepOmitPrefixedFields","removeEmptyFields","PayloadBuilderBase","_$meta","_fields","_schema","constructor","options","schema","fields","meta","$meta","dataHashableFields","deepOmitPrefixedFields","hashableFields","$hash","fieldsOnly","removeEmptyFields","assertEx","value","PayloadBuilder","PayloadBuilderBase","build","payload","schema","$hash","$meta","fields","builder","meta","dataHash","dataHashPairs","payloads","Promise","all","map","built","dataHashes","undefined","filterExclude","hash","PayloadHasher","filterExcludeByHash","filterExcludeByDataHash","hashes","Array","isArray","filter","_","objHash","includes","pair","filterIncludeByDataHash","findByDataHash","find","hashPairs","toDataHashMap","objs","result","toHashMap","dataHashableFields","hashableFields","_$meta","Object","keys","length"]}

package/package.json

@@ -10,11 +10,13 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.13.30",
-    "@xylabs/hex": "^2.13.30",
-    "@xylabs/object": "^2.88.6",
-    "@xyo-network/hash": "~2.89.0-rc.7",
-    "@xyo-network/payload-model": "~2.89.0-rc.7"
+    "@xylabs/assert": "^2.14.0",
+    "@xylabs/hex": "^2.14.0",
+    "@xylabs/logger": "^2.14.0",
+    "@xylabs/object": "^2.89.0",
+    "@xylabs/promise": "^2.14.0",
+    "@xyo-network/hash": "~2.89.0-rc.9",
+    "@xyo-network/payload-model": "~2.89.0-rc.9"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^3.2.42",
@@ -60,7 +62,7 @@
   },
   "sideEffects": false,
   "types": "dist/node/index.d.ts",
-  "version": "2.89.0-rc.7",
+  "version": "2.89.0-rc.9",
   "type": "module",
   "stableVersion": "2.88.3"
 }

package/src/Builder.ts

@@ -1,31 +1,15 @@
-import { assertEx } from '@xylabs/assert'
 import { Hash } from '@xylabs/hex'
-import { AnyObject, JsonObject } from '@xylabs/object'
-import { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'
+import { AnyObject } from '@xylabs/object'
+import { PayloadHasher } from '@xyo-network/hash'
 import { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'
 
-export interface PayloadBuilderOptions<T> {
-  fields?: Partial<T>
-  meta?: JsonObject
-  schema: string
-}
-
-export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
-  private _$meta?: JsonObject
-  private _fields: Partial<T> = {}
-  private _schema: string
-
-  constructor({ schema, fields, meta }: PayloadBuilderOptions<T>) {
-    this._schema = schema
-    this._fields = fields ?? {}
-    this._$meta = meta
-  }
-
-  get schema() {
-    this._schema = this._schema ?? this._fields['schema']
-    return this._schema
-  }
+import { PayloadBuilderBase } from './BuilderBase'
+import { PayloadBuilderOptions } from './Options'
 
+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: T) {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const { schema, $hash, $meta, ...fields } = payload as WithMeta<T>
@@ -60,17 +44,21 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
   }
 
   static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
+    return await PayloadHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)
+  }
+
+  static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
     const hashes = Array.isArray(hash) ? hash : [hash]
-    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])
+    return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])
   }
 
-  static async filterInclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
+  static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {
     const hashes = Array.isArray(hash) ? hash : [hash]
-    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])
+    return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])
   }
 
-  static async find<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {
-    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]
+  static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {
+    return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]
   }
 
   static async hash<T extends Payload>(payload: T): Promise<Hash> {
@@ -118,13 +106,8 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
     return result
   }
 
-  $meta(meta?: JsonObject) {
-    this._$meta = meta
-    return this
-  }
-
   async build(): Promise<WithMeta<T>> {
-    const dataHashableFields = this.dataHashableFields()
+    const dataHashableFields = await this.dataHashableFields()
     const $hash = await PayloadBuilder.hash(dataHashableFields)
     const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }
 
@@ -134,18 +117,4 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
     }
     return hashableFields as WithMeta<T>
   }
-
-  dataHashableFields() {
-    return {
-      ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, '$'), '_')),
-      schema: assertEx(this.schema, 'Payload: Missing Schema'),
-    } as T
-  }
-
-  fields(fields?: Partial<T>) {
-    if (fields) {
-      this._fields = { ...this._fields, ...removeEmptyFields(fields) }
-    }
-    return this
-  }
 }

package/src/BuilderBase.ts

@@ -0,0 +1,57 @@
+import { assertEx } from '@xylabs/assert'
+import { AnyObject, JsonObject } from '@xylabs/object'
+import { Promisable } from '@xylabs/promise'
+import { deepOmitPrefixedFields, removeEmptyFields } from '@xyo-network/hash'
+import { Payload, Schema, WithMeta } from '@xyo-network/payload-model'
+
+import { PayloadBuilderOptions } from './Options'
+
+export class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
+  protected _$meta?: JsonObject
+  protected _fields?: Omit<T, 'schema' | '$hash' | '$meta'>
+  protected _schema: Schema
+
+  constructor(readonly options: O) {
+    const { schema, fields, meta } = options
+    this._schema = schema
+    this._fields = fields
+    this._$meta = meta
+  }
+
+  $meta(meta?: JsonObject) {
+    this._$meta = meta ?? (this._fields as WithMeta<T>).$meta
+    return this
+  }
+
+  async dataHashableFields(): Promise<T> {
+    return deepOmitPrefixedFields(await this.hashableFields(), '$')
+  }
+
+  //we do not require sending in $hash since it will be generated anyway
+  fields(fields: Omit<WithMeta<T>, '$hash' | 'schema'> & Partial<Pick<WithMeta<T>, '$hash' | 'schema'>>) {
+    if (fields) {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      const { $meta, $hash, schema, ...fieldsOnly } = fields as WithMeta<T>
+      if ($meta) {
+        this.$meta($meta)
+      }
+      if (schema) {
+        this.schema(schema)
+      }
+      this._fields = { ...this._fields, ...removeEmptyFields(fieldsOnly) }
+    }
+    return this
+  }
+
+  hashableFields(): Promisable<T> {
+    const schema = assertEx(this._schema, 'Payload: Missing Schema')
+    return {
+      ...removeEmptyFields(deepOmitPrefixedFields(this._fields ?? {}, '_')),
+      schema,
+    } as T
+  }
+
+  schema(value: Schema) {
+    this._schema = value
+  }
+}

package/src/Options.ts

@@ -0,0 +1,10 @@
+import { Logger } from '@xylabs/logger'
+import { JsonObject } from '@xylabs/object'
+import { Schema } from '@xyo-network/payload-model'
+
+export interface PayloadBuilderOptions<T> {
+  readonly fields?: Omit<T, 'schema' | '$hash' | '$meta'>
+  readonly logger?: Logger
+  readonly meta?: JsonObject
+  readonly schema: Schema
+}

package/src/index.ts

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