@xyo-network/payload-builder 2.89.0-rc.8 → 2.89.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/Builder.d.cts +5 -15
- package/dist/browser/Builder.d.cts.map +1 -1
- package/dist/browser/Builder.d.mts +5 -15
- package/dist/browser/Builder.d.mts.map +1 -1
- package/dist/browser/Builder.d.ts +5 -15
- package/dist/browser/Builder.d.ts.map +1 -1
- package/dist/browser/BuilderBase.d.cts +17 -0
- package/dist/browser/BuilderBase.d.cts.map +1 -0
- package/dist/browser/BuilderBase.d.mts +17 -0
- package/dist/browser/BuilderBase.d.mts.map +1 -0
- package/dist/browser/BuilderBase.d.ts +17 -0
- package/dist/browser/BuilderBase.d.ts.map +1 -0
- package/dist/browser/Options.d.cts +10 -0
- package/dist/browser/Options.d.cts.map +1 -0
- package/dist/browser/Options.d.mts +10 -0
- package/dist/browser/Options.d.mts.map +1 -0
- package/dist/browser/Options.d.ts +10 -0
- package/dist/browser/Options.d.ts.map +1 -0
- package/dist/browser/index.cjs +65 -32
- package/dist/browser/index.cjs.map +1 -1
- package/dist/browser/index.d.cts +2 -0
- package/dist/browser/index.d.cts.map +1 -1
- package/dist/browser/index.d.mts +2 -0
- package/dist/browser/index.d.mts.map +1 -1
- package/dist/browser/index.d.ts +2 -0
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.js +63 -30
- package/dist/browser/index.js.map +1 -1
- package/dist/node/Builder.d.cts +5 -15
- package/dist/node/Builder.d.cts.map +1 -1
- package/dist/node/Builder.d.mts +5 -15
- package/dist/node/Builder.d.mts.map +1 -1
- package/dist/node/Builder.d.ts +5 -15
- package/dist/node/Builder.d.ts.map +1 -1
- package/dist/node/BuilderBase.d.cts +17 -0
- package/dist/node/BuilderBase.d.cts.map +1 -0
- package/dist/node/BuilderBase.d.mts +17 -0
- package/dist/node/BuilderBase.d.mts.map +1 -0
- package/dist/node/BuilderBase.d.ts +17 -0
- package/dist/node/BuilderBase.d.ts.map +1 -0
- package/dist/node/Options.d.cts +10 -0
- package/dist/node/Options.d.cts.map +1 -0
- package/dist/node/Options.d.mts +10 -0
- package/dist/node/Options.d.mts.map +1 -0
- package/dist/node/Options.d.ts +10 -0
- package/dist/node/Options.d.ts.map +1 -0
- package/dist/node/index.cjs +65 -32
- package/dist/node/index.cjs.map +1 -1
- package/dist/node/index.d.cts +2 -0
- package/dist/node/index.d.cts.map +1 -1
- package/dist/node/index.d.mts +2 -0
- package/dist/node/index.d.mts.map +1 -1
- package/dist/node/index.d.ts +2 -0
- package/dist/node/index.d.ts.map +1 -1
- package/dist/node/index.js +61 -29
- package/dist/node/index.js.map +1 -1
- package/package.json +6 -5
- package/src/Builder.ts +18 -44
- package/src/BuilderBase.ts +57 -0
- package/src/Options.ts +10 -0
- package/src/index.ts +2 -0
package/dist/node/index.cjs.map
CHANGED
|
@@ -1 +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 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 $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;AACnG,WAAO,MAAMC,0BAAcC,oBAAoB,MAAM,KAAKC,wBAAwBX,UAAUQ,IAAAA,GAAOA,IAAAA;EACrG;EAEA,aAAaG,wBAA2CX,WAAgB,CAAA,GAAIQ,MAAmC;AAjEjH;AAkEI,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;AAtEjH;AAuEI,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;AA3EzG;AA4EI,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWsB,KAAK,CAAC,CAACN,GAAGC,OAAAA,MAAaA,YAAYT,IAAAA,MAAvE,mBAA+E;EACzF;EAEA,aAAaA,KAAwBd,SAA2B;AAC9D,WAAO,MAAMe,0BAAcD,KAAKd,OAAAA;EAClC;;;;;;EAOA,aAAa6B,UAA6BvB,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,aAAaQ,OAA0BZ,UAA6C;AAClF,WAAO,MAAMS,0BAAcG,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;EAEA9B,MAAMJ,MAAmB;AACvB,SAAKN,SAASM;AACd,WAAO;EACT;EAEA,MAAMC,QAA8B;AAClC,UAAMmC,qBAAqB,KAAKA,mBAAkB;AAClD,UAAMjC,QAAQ,MAAMV,gBAAeuB,KAAKoB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBjC;IAAM;AAGvE,QAAI,KAAKT,UAAU4C,OAAOC,KAAK,KAAK7C,MAAM,EAAE8C,SAAS,GAAG;AACtDH,qBAAe,OAAA,IAAW,KAAK3C;IACjC;AACA,WAAO2C;EACT;EAEAD,qBAAqB;AACnB,WAAO;MACL,OAAGK,mCAAkBC,wCAAuBA,oCAAuB,KAAK/C,SAAS,GAAA,GAAM,GAAA,CAAA;MACvFG,YAAQ6C,wBAAS,KAAK7C,QAAQ,yBAAA;IAChC;EACF;EAEAC,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,OAAG8C,+BAAkB1C,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;AACF;AA9IaN;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","PayloadHasher","filterExcludeByHash","filterExcludeByDataHash","hashes","Array","isArray","filter","_","objHash","includes","pair","filterIncludeByDataHash","findByDataHash","find","hashPairs","toDataHashMap","objs","result","toHashMap","dataHashableFields","hashableFields","Object","keys","length","removeEmptyFields","deepOmitPrefixedFields","assertEx"]}
|
|
1
|
+
{"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 toAllHashMap<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 result[pair[0].$hash] = 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 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' | '$meta'> & Partial<Pick<WithMeta<T>, '$hash' | 'schema' | '$meta'>>) {\n if (fields) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, $hash, schema, ...fieldsOnly } = fields\n if ($meta) {\n this.$meta($meta)\n }\n if (schema) {\n this.schema(schema)\n }\n this._fields = { ...this._fields, ...removeEmptyFields(fieldsOnly) } as T\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,QAAoH;AACzH,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,aAAgCC,MAAqC;AAChF,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKI,UAAUE,IAAAA,GAAO;AAC7CC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;AACvBO,aAAOP,KAAK,CAAA,EAAG1B,KAAK,IAAI0B,KAAK,CAAA;IAC/B;AACA,WAAOO;EACT;EAEA,aAAaC,cAAiCF,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,aAAaE,UAA6BH,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,UAAMuC,qBAAqB,MAAM,KAAKA,mBAAkB;AACxD,UAAMpC,QAAQ,MAAML,gBAAeoB,KAAKqB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBpC;IAAM;AAGvE,QAAI,KAAKsC,UAAUC,OAAOC,KAAK,KAAKF,MAAM,EAAEG,SAAS,GAAG;AACtDJ,qBAAe,OAAA,IAAW,KAAKC;IACjC;AACA,WAAOD;EACT;AACF;AArHUzC;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","toAllHashMap","objs","result","toDataHashMap","toHashMap","dataHashableFields","hashableFields","_$meta","Object","keys","length"]}
|
package/dist/node/index.d.cts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
|
|
1
|
+
{"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
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
|
|
1
|
+
{"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
CHANGED
package/dist/node/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
|
|
1
|
+
{"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
CHANGED
|
@@ -2,21 +2,63 @@ var __defProp = Object.defineProperty;
|
|
|
2
2
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
3
3
|
|
|
4
4
|
// src/Builder.ts
|
|
5
|
+
import { PayloadHasher } from "@xyo-network/hash";
|
|
6
|
+
|
|
7
|
+
// src/BuilderBase.ts
|
|
5
8
|
import { assertEx } from "@xylabs/assert";
|
|
6
|
-
import { deepOmitPrefixedFields,
|
|
7
|
-
var
|
|
9
|
+
import { deepOmitPrefixedFields, removeEmptyFields } from "@xyo-network/hash";
|
|
10
|
+
var _PayloadBuilderBase = class _PayloadBuilderBase {
|
|
11
|
+
options;
|
|
8
12
|
_$meta;
|
|
9
|
-
_fields
|
|
13
|
+
_fields;
|
|
10
14
|
_schema;
|
|
11
|
-
constructor(
|
|
15
|
+
constructor(options) {
|
|
16
|
+
this.options = options;
|
|
17
|
+
const { schema, fields, meta } = options;
|
|
12
18
|
this._schema = schema;
|
|
13
|
-
this._fields = fields
|
|
19
|
+
this._fields = fields;
|
|
14
20
|
this._$meta = meta;
|
|
15
21
|
}
|
|
16
|
-
|
|
17
|
-
this.
|
|
18
|
-
return this
|
|
22
|
+
$meta(meta) {
|
|
23
|
+
this._$meta = meta ?? this._fields.$meta;
|
|
24
|
+
return this;
|
|
25
|
+
}
|
|
26
|
+
async dataHashableFields() {
|
|
27
|
+
return deepOmitPrefixedFields(await this.hashableFields(), "$");
|
|
28
|
+
}
|
|
29
|
+
//we do not require sending in $hash since it will be generated anyway
|
|
30
|
+
fields(fields) {
|
|
31
|
+
if (fields) {
|
|
32
|
+
const { $meta, $hash, schema, ...fieldsOnly } = fields;
|
|
33
|
+
if ($meta) {
|
|
34
|
+
this.$meta($meta);
|
|
35
|
+
}
|
|
36
|
+
if (schema) {
|
|
37
|
+
this.schema(schema);
|
|
38
|
+
}
|
|
39
|
+
this._fields = {
|
|
40
|
+
...this._fields,
|
|
41
|
+
...removeEmptyFields(fieldsOnly)
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
return this;
|
|
45
|
+
}
|
|
46
|
+
hashableFields() {
|
|
47
|
+
const schema = assertEx(this._schema, "Payload: Missing Schema");
|
|
48
|
+
return {
|
|
49
|
+
...removeEmptyFields(deepOmitPrefixedFields(this._fields ?? {}, "_")),
|
|
50
|
+
schema
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
schema(value) {
|
|
54
|
+
this._schema = value;
|
|
19
55
|
}
|
|
56
|
+
};
|
|
57
|
+
__name(_PayloadBuilderBase, "PayloadBuilderBase");
|
|
58
|
+
var PayloadBuilderBase = _PayloadBuilderBase;
|
|
59
|
+
|
|
60
|
+
// src/Builder.ts
|
|
61
|
+
var _PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
|
|
20
62
|
static async build(payload) {
|
|
21
63
|
const { schema, $hash, $meta, ...fields } = payload;
|
|
22
64
|
const builder = new _PayloadBuilder({
|
|
@@ -85,6 +127,14 @@ var _PayloadBuilder = class _PayloadBuilder {
|
|
|
85
127
|
static async hashes(payloads) {
|
|
86
128
|
return await PayloadHasher.hashes(payloads);
|
|
87
129
|
}
|
|
130
|
+
static async toAllHashMap(objs) {
|
|
131
|
+
const result = {};
|
|
132
|
+
for (const pair of await this.hashPairs(objs)) {
|
|
133
|
+
result[pair[1]] = pair[0];
|
|
134
|
+
result[pair[0].$hash] = pair[0];
|
|
135
|
+
}
|
|
136
|
+
return result;
|
|
137
|
+
}
|
|
88
138
|
static async toDataHashMap(objs) {
|
|
89
139
|
const result = {};
|
|
90
140
|
for (const pair of await this.dataHashPairs(objs)) {
|
|
@@ -104,12 +154,8 @@ var _PayloadBuilder = class _PayloadBuilder {
|
|
|
104
154
|
}
|
|
105
155
|
return result;
|
|
106
156
|
}
|
|
107
|
-
$meta(meta) {
|
|
108
|
-
this._$meta = meta;
|
|
109
|
-
return this;
|
|
110
|
-
}
|
|
111
157
|
async build() {
|
|
112
|
-
const dataHashableFields = this.dataHashableFields();
|
|
158
|
+
const dataHashableFields = await this.dataHashableFields();
|
|
113
159
|
const $hash = await _PayloadBuilder.hash(dataHashableFields);
|
|
114
160
|
const hashableFields = {
|
|
115
161
|
...dataHashableFields,
|
|
@@ -120,25 +166,11 @@ var _PayloadBuilder = class _PayloadBuilder {
|
|
|
120
166
|
}
|
|
121
167
|
return hashableFields;
|
|
122
168
|
}
|
|
123
|
-
dataHashableFields() {
|
|
124
|
-
return {
|
|
125
|
-
...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, "$"), "_")),
|
|
126
|
-
schema: assertEx(this.schema, "Payload: Missing Schema")
|
|
127
|
-
};
|
|
128
|
-
}
|
|
129
|
-
fields(fields) {
|
|
130
|
-
if (fields) {
|
|
131
|
-
this._fields = {
|
|
132
|
-
...this._fields,
|
|
133
|
-
...removeEmptyFields(fields)
|
|
134
|
-
};
|
|
135
|
-
}
|
|
136
|
-
return this;
|
|
137
|
-
}
|
|
138
169
|
};
|
|
139
170
|
__name(_PayloadBuilder, "PayloadBuilder");
|
|
140
171
|
var PayloadBuilder = _PayloadBuilder;
|
|
141
172
|
export {
|
|
142
|
-
PayloadBuilder
|
|
173
|
+
PayloadBuilder,
|
|
174
|
+
PayloadBuilderBase
|
|
143
175
|
};
|
|
144
176
|
//# sourceMappingURL=index.js.map
|
package/dist/node/index.js.map
CHANGED
|
@@ -1 +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 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 $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;AACnG,WAAO,MAAMC,cAAcC,oBAAoB,MAAM,KAAKC,wBAAwBX,UAAUQ,IAAAA,GAAOA,IAAAA;EACrG;EAEA,aAAaG,wBAA2CX,WAAgB,CAAA,GAAIQ,MAAmC;AAjEjH;AAkEI,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;AAtEjH;AAuEI,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;AA3EzG;AA4EI,YAAQ,YAAM,KAAKT,cAAcC,QAAAA,GAAWsB,KAAK,CAAC,CAACN,GAAGC,OAAAA,MAAaA,YAAYT,IAAAA,MAAvE,mBAA+E;EACzF;EAEA,aAAaA,KAAwBd,SAA2B;AAC9D,WAAO,MAAMe,cAAcD,KAAKd,OAAAA;EAClC;;;;;;EAOA,aAAa6B,UAA6BvB,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,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;EAEA9B,MAAMJ,MAAmB;AACvB,SAAKN,SAASM;AACd,WAAO;EACT;EAEA,MAAMC,QAA8B;AAClC,UAAMmC,qBAAqB,KAAKA,mBAAkB;AAClD,UAAMjC,QAAQ,MAAMV,gBAAeuB,KAAKoB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBjC;IAAM;AAGvE,QAAI,KAAKT,UAAU4C,OAAOC,KAAK,KAAK7C,MAAM,EAAE8C,SAAS,GAAG;AACtDH,qBAAe,OAAA,IAAW,KAAK3C;IACjC;AACA,WAAO2C;EACT;EAEAD,qBAAqB;AACnB,WAAO;MACL,GAAGK,kBAAkBC,uBAAuBA,uBAAuB,KAAK/C,SAAS,GAAA,GAAM,GAAA,CAAA;MACvFG,QAAQ6C,SAAS,KAAK7C,QAAQ,yBAAA;IAChC;EACF;EAEAC,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,GAAG8C,kBAAkB1C,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;AACF;AA9IaN;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","PayloadHasher","filterExcludeByHash","filterExcludeByDataHash","hashes","Array","isArray","filter","_","objHash","includes","pair","filterIncludeByDataHash","findByDataHash","find","hashPairs","toDataHashMap","objs","result","toHashMap","dataHashableFields","hashableFields","Object","keys","length","removeEmptyFields","deepOmitPrefixedFields","assertEx"]}
|
|
1
|
+
{"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 toAllHashMap<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 result[pair[0].$hash] = 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 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' | '$meta'> & Partial<Pick<WithMeta<T>, '$hash' | 'schema' | '$meta'>>) {\n if (fields) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, $hash, schema, ...fieldsOnly } = fields\n if ($meta) {\n this.$meta($meta)\n }\n if (schema) {\n this.schema(schema)\n }\n this._fields = { ...this._fields, ...removeEmptyFields(fieldsOnly) } as T\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,QAAoH;AACzH,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,aAAgCC,MAAqC;AAChF,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKI,UAAUE,IAAAA,GAAO;AAC7CC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;AACvBO,aAAOP,KAAK,CAAA,EAAG1B,KAAK,IAAI0B,KAAK,CAAA;IAC/B;AACA,WAAOO;EACT;EAEA,aAAaC,cAAiCF,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,aAAaE,UAA6BH,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,UAAMuC,qBAAqB,MAAM,KAAKA,mBAAkB;AACxD,UAAMpC,QAAQ,MAAML,gBAAeoB,KAAKqB,kBAAAA;AACxC,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBpC;IAAM;AAGvE,QAAI,KAAKsC,UAAUC,OAAOC,KAAK,KAAKF,MAAM,EAAEG,SAAS,GAAG;AACtDJ,qBAAe,OAAA,IAAW,KAAKC;IACjC;AACA,WAAOD;EACT;AACF;AArHUzC;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","toAllHashMap","objs","result","toDataHashMap","toHashMap","dataHashableFields","hashableFields","_$meta","Object","keys","length"]}
|
package/package.json
CHANGED
|
@@ -12,9 +12,11 @@
|
|
|
12
12
|
"dependencies": {
|
|
13
13
|
"@xylabs/assert": "^2.14.0",
|
|
14
14
|
"@xylabs/hex": "^2.14.0",
|
|
15
|
+
"@xylabs/logger": "^2.14.0",
|
|
15
16
|
"@xylabs/object": "^2.89.0",
|
|
16
|
-
"@
|
|
17
|
-
"@xyo-network/
|
|
17
|
+
"@xylabs/promise": "^2.14.0",
|
|
18
|
+
"@xyo-network/hash": "~2.89.0",
|
|
19
|
+
"@xyo-network/payload-model": "~2.89.0"
|
|
18
20
|
},
|
|
19
21
|
"devDependencies": {
|
|
20
22
|
"@xylabs/ts-scripts-yarn3": "^3.2.42",
|
|
@@ -60,7 +62,6 @@
|
|
|
60
62
|
},
|
|
61
63
|
"sideEffects": false,
|
|
62
64
|
"types": "dist/node/index.d.ts",
|
|
63
|
-
"version": "2.89.0
|
|
64
|
-
"type": "module"
|
|
65
|
-
"stableVersion": "2.88.3"
|
|
65
|
+
"version": "2.89.0",
|
|
66
|
+
"type": "module"
|
|
66
67
|
}
|
package/src/Builder.ts
CHANGED
|
@@ -1,31 +1,15 @@
|
|
|
1
|
-
import { assertEx } from '@xylabs/assert'
|
|
2
1
|
import { Hash } from '@xylabs/hex'
|
|
3
|
-
import { AnyObject
|
|
4
|
-
import {
|
|
2
|
+
import { AnyObject } from '@xylabs/object'
|
|
3
|
+
import { PayloadHasher } from '@xyo-network/hash'
|
|
5
4
|
import { Payload, PayloadWithMeta, WithMeta } from '@xyo-network/payload-model'
|
|
6
5
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
meta?: JsonObject
|
|
10
|
-
schema: string
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
|
|
14
|
-
private _$meta?: JsonObject
|
|
15
|
-
private _fields: Partial<T> = {}
|
|
16
|
-
private _schema: string
|
|
17
|
-
|
|
18
|
-
constructor({ schema, fields, meta }: PayloadBuilderOptions<T>) {
|
|
19
|
-
this._schema = schema
|
|
20
|
-
this._fields = fields ?? {}
|
|
21
|
-
this._$meta = meta
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
get schema() {
|
|
25
|
-
this._schema = this._schema ?? this._fields['schema']
|
|
26
|
-
return this._schema
|
|
27
|
-
}
|
|
6
|
+
import { PayloadBuilderBase } from './BuilderBase'
|
|
7
|
+
import { PayloadBuilderOptions } from './Options'
|
|
28
8
|
|
|
9
|
+
export class PayloadBuilder<
|
|
10
|
+
T extends Payload = Payload<AnyObject>,
|
|
11
|
+
O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>,
|
|
12
|
+
> extends PayloadBuilderBase<T, O> {
|
|
29
13
|
static async build<T extends Payload>(payload: T) {
|
|
30
14
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
31
15
|
const { schema, $hash, $meta, ...fields } = payload as WithMeta<T>
|
|
@@ -101,6 +85,15 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
|
|
|
101
85
|
return await PayloadHasher.hashes(payloads)
|
|
102
86
|
}
|
|
103
87
|
|
|
88
|
+
static async toAllHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {
|
|
89
|
+
const result: Record<Hash, T> = {}
|
|
90
|
+
for (const pair of await this.hashPairs(objs)) {
|
|
91
|
+
result[pair[1]] = pair[0]
|
|
92
|
+
result[pair[0].$hash] = pair[0]
|
|
93
|
+
}
|
|
94
|
+
return result
|
|
95
|
+
}
|
|
96
|
+
|
|
104
97
|
static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {
|
|
105
98
|
const result: Record<Hash, T> = {}
|
|
106
99
|
for (const pair of await this.dataHashPairs(objs)) {
|
|
@@ -122,13 +115,8 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
|
|
|
122
115
|
return result
|
|
123
116
|
}
|
|
124
117
|
|
|
125
|
-
$meta(meta?: JsonObject) {
|
|
126
|
-
this._$meta = meta
|
|
127
|
-
return this
|
|
128
|
-
}
|
|
129
|
-
|
|
130
118
|
async build(): Promise<WithMeta<T>> {
|
|
131
|
-
const dataHashableFields = this.dataHashableFields()
|
|
119
|
+
const dataHashableFields = await this.dataHashableFields()
|
|
132
120
|
const $hash = await PayloadBuilder.hash(dataHashableFields)
|
|
133
121
|
const hashableFields: PayloadWithMeta = { ...dataHashableFields, $hash }
|
|
134
122
|
|
|
@@ -138,18 +126,4 @@ export class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
|
|
|
138
126
|
}
|
|
139
127
|
return hashableFields as WithMeta<T>
|
|
140
128
|
}
|
|
141
|
-
|
|
142
|
-
dataHashableFields() {
|
|
143
|
-
return {
|
|
144
|
-
...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, '$'), '_')),
|
|
145
|
-
schema: assertEx(this.schema, 'Payload: Missing Schema'),
|
|
146
|
-
} as T
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
fields(fields?: Partial<T>) {
|
|
150
|
-
if (fields) {
|
|
151
|
-
this._fields = { ...this._fields, ...removeEmptyFields(fields) }
|
|
152
|
-
}
|
|
153
|
-
return this
|
|
154
|
-
}
|
|
155
129
|
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { assertEx } from '@xylabs/assert'
|
|
2
|
+
import { AnyObject, JsonObject } from '@xylabs/object'
|
|
3
|
+
import { Promisable } from '@xylabs/promise'
|
|
4
|
+
import { deepOmitPrefixedFields, removeEmptyFields } from '@xyo-network/hash'
|
|
5
|
+
import { Payload, Schema, WithMeta } from '@xyo-network/payload-model'
|
|
6
|
+
|
|
7
|
+
import { PayloadBuilderOptions } from './Options'
|
|
8
|
+
|
|
9
|
+
export class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
|
|
10
|
+
protected _$meta?: JsonObject
|
|
11
|
+
protected _fields?: Omit<T, 'schema' | '$hash' | '$meta'>
|
|
12
|
+
protected _schema: Schema
|
|
13
|
+
|
|
14
|
+
constructor(readonly options: O) {
|
|
15
|
+
const { schema, fields, meta } = options
|
|
16
|
+
this._schema = schema
|
|
17
|
+
this._fields = fields
|
|
18
|
+
this._$meta = meta
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
$meta(meta?: JsonObject) {
|
|
22
|
+
this._$meta = meta ?? (this._fields as WithMeta<T>).$meta
|
|
23
|
+
return this
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
async dataHashableFields(): Promise<T> {
|
|
27
|
+
return deepOmitPrefixedFields(await this.hashableFields(), '$')
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
//we do not require sending in $hash since it will be generated anyway
|
|
31
|
+
fields(fields: Omit<WithMeta<T>, '$hash' | 'schema' | '$meta'> & Partial<Pick<WithMeta<T>, '$hash' | 'schema' | '$meta'>>) {
|
|
32
|
+
if (fields) {
|
|
33
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
34
|
+
const { $meta, $hash, schema, ...fieldsOnly } = fields
|
|
35
|
+
if ($meta) {
|
|
36
|
+
this.$meta($meta)
|
|
37
|
+
}
|
|
38
|
+
if (schema) {
|
|
39
|
+
this.schema(schema)
|
|
40
|
+
}
|
|
41
|
+
this._fields = { ...this._fields, ...removeEmptyFields(fieldsOnly) } as T
|
|
42
|
+
}
|
|
43
|
+
return this
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
hashableFields(): Promisable<T> {
|
|
47
|
+
const schema = assertEx(this._schema, 'Payload: Missing Schema')
|
|
48
|
+
return {
|
|
49
|
+
...removeEmptyFields(deepOmitPrefixedFields(this._fields ?? {}, '_')),
|
|
50
|
+
schema,
|
|
51
|
+
} as T
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
schema(value: Schema) {
|
|
55
|
+
this._schema = value
|
|
56
|
+
}
|
|
57
|
+
}
|
package/src/Options.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Logger } from '@xylabs/logger'
|
|
2
|
+
import { JsonObject } from '@xylabs/object'
|
|
3
|
+
import { Schema } from '@xyo-network/payload-model'
|
|
4
|
+
|
|
5
|
+
export interface PayloadBuilderOptions<T> {
|
|
6
|
+
readonly fields?: Omit<T, 'schema' | '$hash' | '$meta'>
|
|
7
|
+
readonly logger?: Logger
|
|
8
|
+
readonly meta?: JsonObject
|
|
9
|
+
readonly schema: Schema
|
|
10
|
+
}
|
package/src/index.ts
CHANGED