@xyo-network/payload-builder 3.6.0-rc.13 → 3.6.0-rc.15

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.
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["import type { Hash } from '@xylabs/hex'\nimport type { AnyObject, Compare } from '@xylabs/object'\nimport { ObjectHasher } from '@xyo-network/hash'\nimport {\n type Payload,\n type Sequence,\n SequenceComparer,\n SequenceParser,\n type WithHashMeta,\n type WithoutStorageMeta,\n type WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport { PayloadBuilderBase } from './BuilderBase.ts'\n\nexport class PayloadBuilder<\n T extends Payload = Payload<AnyObject>,\n> extends PayloadBuilderBase<T> {\n static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>\n static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>\n static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {\n if (Array.isArray(payloads)) {\n return await Promise.all(\n payloads.map(async (payload) => {\n return await this.addHashMeta(payload)\n }),\n )\n } else {\n const _hash = await PayloadBuilder.hash(payloads)\n const _dataHash = await PayloadBuilder.dataHash(payloads)\n return {\n ...payloads,\n _dataHash,\n _hash,\n }\n }\n }\n\n static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T): Promise<WithStorageMeta<T>> {\n const withHashMeta = await this.addHashMeta(payload)\n const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash).localSequence\n return {\n ...withHashMeta,\n _sequence,\n }\n }\n\n static async addStorageMeta<T extends Payload>(payload: T): Promise<WithStorageMeta<T>>\n static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>\n static async addStorageMeta<T extends Payload>(payloads: T | T[]): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {\n return Array.isArray(payloads)\n ? await (async () => {\n return await Promise.all(payloads.map(async payload => await this.addSequencedStorageMeta(\n payload,\n )))\n })()\n : this.addSequencedStorageMeta(\n payloads,\n )\n }\n\n static compareStorageMeta(\n a: WithStorageMeta<Payload>,\n b: WithStorageMeta<Payload>,\n comparer: Compare<Sequence> = SequenceComparer.local,\n ) {\n return comparer(a._sequence, b._sequence)\n }\n\n static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n return await ObjectHasher.hash(this.omitMeta(payload))\n }\n\n static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n return await Promise.all(\n payloads.map(async (payload) => {\n const dataHash = await this.dataHash(payload)\n return [payload, dataHash]\n }),\n )\n }\n\n static async dataHashes(payloads: undefined): Promise<undefined>\n static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return payloads\n ? await Promise.all(\n payloads.map(async (payload) => {\n return await PayloadBuilder.dataHash(payload)\n }),\n )\n : undefined\n }\n\n static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)\n }\n\n static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n }\n\n static async hash<T extends Payload>(payload: T): Promise<Hash> {\n return await ObjectHasher.hash(this.omitStorageMeta(payload))\n }\n\n /**\n * Creates an array of payload/hash tuples based on the payloads passed in\n * @param objs Any array of payloads\n * @returns An array of payload/hash tuples\n */\n static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n return await Promise.all(\n payloads.map<Promise<[T, Hash]>>(async (payload) => {\n return [payload, await PayloadBuilder.hash(payload)]\n }),\n )\n }\n\n static hashableFields<T extends Payload>(\n payload: T,\n ): WithoutStorageMeta<T> {\n return this.omitStorageMeta(payload)\n }\n\n static async hashes(payloads: undefined): Promise<undefined>\n static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return await ObjectHasher.hashes(payloads)\n }\n\n static sortByStorageMeta<T extends Payload>(\n payloads: WithStorageMeta<T>[],\n direction: -1 | 1 = 1,\n comparer: Compare<Sequence> = SequenceComparer.local,\n ) {\n return payloads.sort((a, b) => direction * comparer(a._sequence, b._sequence))\n }\n\n static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.hashPairs(payloads)) {\n const dataHash = await this.dataHash(pair[0])\n result[pair[1]] = pair[0]\n result[dataHash] = pair[0]\n }\n return result\n }\n\n static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.dataHashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n /**\n * Creates an object map of payload hashes to payloads based on the payloads passed in\n * @param objs Any array of payloads\n * @returns A map of hashes to payloads\n */\n static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.hashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n build(): T {\n return {\n schema: this._schema,\n ...this._fields,\n ...this._meta,\n } as T\n }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { AnyObject, EmptyObject } from '@xylabs/object'\nimport {\n isJsonObject, omitByPrefix, pickByPrefix, toJson,\n} from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { removeEmptyFields } from '@xyo-network/hash'\nimport type {\n Payload, Schema,\n WithOnlyClientMeta,\n WithOptionalSchema,\n WithoutClientMeta,\n WithoutMeta,\n WithoutPrivateStorageMeta,\n WithoutSchema,\n WithoutStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {\n const result = structuredClone(payload)\n delete result.schema\n return result\n}\n\nexport class PayloadBuilderBase<T extends Payload = Payload<AnyObject>> {\n protected _fields?: WithoutMeta<WithoutSchema<T>>\n protected _meta?: WithOnlyClientMeta<T>\n protected _schema: Schema\n\n constructor(readonly options: PayloadBuilderOptions) {\n const { schema } = options\n this._schema = schema\n }\n\n static dataHashableFields<T extends Payload>(\n schema: Schema,\n payload: WithoutSchema<T>,\n\n ): Promisable<WithoutMeta<T>> {\n const cleanFields = removeEmptyFields({ ...payload, schema })\n assertEx(\n cleanFields === undefined || isJsonObject(cleanFields),\n () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n )\n return this.omitMeta(cleanFields) as WithoutMeta<T>\n }\n\n static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>\n static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]\n static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))\n : omitByPrefix(payloads, '$', maxDepth)\n }\n\n static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>\n static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]\n static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitMeta(payload, maxDepth))\n : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>\n }\n\n static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>\n static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]\n static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))\n : omitByPrefix(payloads, '__', maxDepth)\n }\n\n static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>\n static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]\n static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))\n : omitByPrefix(payloads, '_', maxDepth)\n }\n\n async dataHashableFields() {\n return await PayloadBuilderBase.dataHashableFields(\n assertEx(this._schema, () => 'Payload: Missing Schema'),\n // TODO: Add verification that required fields are present\n this._fields as WithoutSchema<T>,\n )\n }\n\n fields(fields: WithoutMeta<WithoutSchema<T>>) {\n // we need to do the cast here since ts seems to not like nested, yet same, generics\n this._fields = omitSchema(PayloadBuilderBase.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>\n return this\n }\n\n meta(meta: WithOnlyClientMeta<T>) {\n // we need to do the cast here since ts seems to not like nested, yet same, generics\n this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>\n return this\n }\n\n schema(value: Schema) {\n this._schema = value\n }\n}\n"],"mappings":";AAEA,SAAS,oBAAoB;AAC7B;AAAA,EAGE;AAAA,EACA;AAAA,OAIK;;;ACXP,SAAS,gBAAgB;AAEzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAc;AAAA,EAAc;AAAA,OACrC;AAEP,SAAS,yBAAyB;AAc3B,IAAM,aAAa,CAA+B,YAAiC;AACxF,QAAM,SAAS,gBAAgB,OAAO;AACtC,SAAO,OAAO;AACd,SAAO;AACT;AAEO,IAAM,qBAAN,MAAM,oBAA2D;AAAA,EAKtE,YAAqB,SAAgC;AAAhC;AACnB,UAAM,EAAE,OAAO,IAAI;AACnB,SAAK,UAAU;AAAA,EACjB;AAAA,EAPU;AAAA,EACA;AAAA,EACA;AAAA,EAOV,OAAO,mBACL,QACA,SAE4B;AAC5B,UAAM,cAAc,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC;AAC5D;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,KAAK,SAAS,WAAW;AAAA,EAClC;AAAA,EAIA,OAAO,eAAsC,UAAmB,WAAW,KAAoD;AAC7H,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,eAAe,SAAS,QAAQ,CAAC,IAC9D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAIA,OAAO,SAAgC,UAAmB,WAAW,KAAwC;AAC3G,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,SAAS,SAAS,QAAQ,CAAC,IACxD,KAAK,gBAAgB,KAAK,eAAe,UAAU,QAAQ,GAAG,QAAQ;AAAA,EAC5E;AAAA,EAIA,OAAO,uBAA8C,UAAmB,WAAW,KAAoE;AACrJ,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,uBAAuB,SAAS,QAAQ,CAAC,IACtE,aAAa,UAAU,MAAM,QAAQ;AAAA,EAC3C;AAAA,EAIA,OAAO,gBAAuC,UAAmB,WAAW,KAAsD;AAChI,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,gBAAgB,SAAS,QAAQ,CAAC,IAC/D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,oBAAmB;AAAA,MAC9B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA;AAAA,MAEtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,OAAO,QAAuC;AAE5C,SAAK,UAAU,WAAW,oBAAmB,SAAS,kBAAkB,gBAAgB,MAAM,CAAC,CAAC,CAAC;AACjG,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,MAA6B;AAEhC,SAAK,QAAQ,aAAa,MAAM,GAAG;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AACF;;;ADzFO,IAAM,iBAAN,MAAM,wBAEH,mBAAsB;AAAA,EAG9B,aAAa,YAA+B,UAAiE;AAC3G,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,MAAM,QAAQ;AAAA,QACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,iBAAO,MAAM,KAAK,YAAY,OAAO;AAAA,QACvC,CAAC;AAAA,MACH;AAAA,IACF,OAAO;AACL,YAAM,QAAQ,MAAM,gBAAe,KAAK,QAAQ;AAChD,YAAM,YAAY,MAAM,gBAAe,SAAS,QAAQ;AACxD,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAa,wBAAqD,SAAyC;AACzG,UAAM,eAAe,MAAM,KAAK,YAAY,OAAO;AACnD,UAAM,YAAY,eAAe,KAAK,KAAK,IAAI,GAAG,aAAa,KAAK,EAAE;AACtE,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAIA,aAAa,eAAkC,UAAuE;AACpH,WAAO,MAAM,QAAQ,QAAQ,IACzB,OAAO,YAAY;AACnB,aAAO,MAAM,QAAQ,IAAI,SAAS,IAAI,OAAM,YAAW,MAAM,KAAK;AAAA,QAChE;AAAA,MACF,CAAC,CAAC;AAAA,IACJ,GAAG,IACD,KAAK;AAAA,MACH;AAAA,IACF;AAAA,EACN;AAAA,EAEA,OAAO,mBACL,GACA,GACA,WAA8B,iBAAiB,OAC/C;AACA,WAAO,SAAS,EAAE,WAAW,EAAE,SAAS;AAAA,EAC1C;AAAA,EAEA,aAAa,SAA4B,SAA2B;AAClE,WAAO,MAAM,aAAa,KAAK,KAAK,SAAS,OAAO,CAAC;AAAA,EACvD;AAAA,EAEA,aAAa,cAAiC,UAAqC;AACjF,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,WAAW,MAAM,KAAK,SAAS,OAAO;AAC5C,eAAO,CAAC,SAAS,QAAQ;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAIA,aAAa,WAA8B,UAA6C;AACtF,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,eAAO,MAAM,gBAAe,SAAS,OAAO;AAAA,MAC9C,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,aAAa,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACxG;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACtH;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACrH;AAAA,EAEA,aAAa,eAAkC,WAAgB,CAAC,GAAG,MAAoC;AACrG,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,OAAO,MAAM,YAAY,IAAI,IAAI,CAAC;AAAA,EAC1F;AAAA,EAEA,aAAa,KAAwB,SAA2B;AAC9D,WAAO,MAAM,aAAa,KAAK,KAAK,gBAAgB,OAAO,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAqC;AAC7E,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAwB,OAAO,YAAY;AAClD,eAAO,CAAC,SAAS,MAAM,gBAAe,KAAK,OAAO,CAAC;AAAA,MACrD,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,eACL,SACuB;AACvB,WAAO,KAAK,gBAAgB,OAAO;AAAA,EACrC;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,EAC3C;AAAA,EAEA,OAAO,kBACL,UACA,YAAoB,GACpB,WAA8B,iBAAiB,OAC/C;AACA,WAAO,SAAS,KAAK,CAAC,GAAG,MAAM,YAAY,SAAS,EAAE,WAAW,EAAE,SAAS,CAAC;AAAA,EAC/E;AAAA,EAEA,aAAa,aAAgC,UAAyC;AACpF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,QAAQ,GAAG;AACjD,YAAM,WAAW,MAAM,KAAK,SAAS,KAAK,CAAC,CAAC;AAC5C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,QAAQ,IAAI,KAAK,CAAC;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAAqC;AACjF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,cAAc,IAAI,GAAG;AACjD,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,MAAqC;AAC7E,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAAW;AACT,WAAO;AAAA,MACL,QAAQ,KAAK;AAAA,MACb,GAAG,KAAK;AAAA,MACR,GAAG,KAAK;AAAA,IACV;AAAA,EACF;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/Builder.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type {\n AnyObject, Compare, EmptyObject,\n} from '@xylabs/object'\nimport {\n isJsonObject, omitByPrefix, pickByPrefix, toJson,\n} from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { ObjectHasher, removeEmptyFields } from '@xyo-network/hash'\nimport {\n type Payload, type Schema,\n type Sequence,\n SequenceComparer,\n SequenceParser,\n type WithHashMeta,\n type WithOnlyClientMeta,\n type WithOptionalSchema,\n type WithoutClientMeta,\n type WithoutMeta,\n type WithoutPrivateStorageMeta,\n type WithoutSchema,\n type WithoutStorageMeta,\n type WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {\n const result = structuredClone(payload)\n delete result.schema\n return result\n}\n\nexport class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {\n protected _fields?: WithoutMeta<WithoutSchema<T>>\n protected _meta?: WithOnlyClientMeta<T>\n protected _schema: Schema\n\n constructor(readonly options: PayloadBuilderOptions) {\n const { schema } = options\n this._schema = schema\n }\n\n static async addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>\n static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>\n static async addStorageMeta<T extends Payload>(payloads: T | T[], index = 0): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {\n return Array.isArray(payloads)\n ? await (async () => {\n return await Promise.all(payloads.map(async (payload, i) => await this.addSequencedStorageMeta(\n payload,\n i,\n )))\n })()\n : this.addSequencedStorageMeta(\n payloads,\n index,\n )\n }\n\n static compareStorageMeta(\n a: WithStorageMeta<Payload>,\n b: WithStorageMeta<Payload>,\n comparer: Compare<Sequence> = SequenceComparer.local,\n ) {\n return comparer(a._sequence, b._sequence)\n }\n\n static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n return await ObjectHasher.hash(this.omitMeta(payload))\n }\n\n static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n return await Promise.all(\n payloads.map(async (payload) => {\n const dataHash = await this.dataHash(payload)\n return [payload, dataHash]\n }),\n )\n }\n\n static dataHashableFields<T extends Payload>(\n schema: Schema,\n payload: WithoutSchema<T>,\n\n ): Promisable<WithoutMeta<T>> {\n const cleanFields = removeEmptyFields({ ...payload, schema })\n assertEx(\n cleanFields === undefined || isJsonObject(cleanFields),\n () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n )\n return this.omitMeta(cleanFields) as WithoutMeta<T>\n }\n\n static async dataHashes(payloads: undefined): Promise<undefined>\n static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return payloads\n ? await Promise.all(\n payloads.map(async (payload) => {\n return await this.dataHash(payload)\n }),\n )\n : undefined\n }\n\n static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)\n }\n\n static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n }\n\n static async hash<T extends Payload>(payload: T): Promise<Hash> {\n return await ObjectHasher.hash(this.omitStorageMeta(payload))\n }\n\n /**\n * Creates an array of payload/hash tuples based on the payloads passed in\n * @param objs Any array of payloads\n * @returns An array of payload/hash tuples\n */\n static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n return await Promise.all(\n payloads.map<Promise<[T, Hash]>>(async (payload) => {\n return [payload, await this.hash(payload)]\n }),\n )\n }\n\n static hashableFields<T extends Payload>(\n payload: T,\n ): WithoutStorageMeta<T> {\n return this.omitStorageMeta(payload)\n }\n\n static async hashes(payloads: undefined): Promise<undefined>\n static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return await ObjectHasher.hashes(payloads)\n }\n\n static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>\n static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]\n static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))\n : omitByPrefix(payloads, '$', maxDepth)\n }\n\n static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>\n static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]\n static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitMeta(payload, maxDepth))\n : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>\n }\n\n static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>\n static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]\n static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))\n : omitByPrefix(payloads, '__', maxDepth)\n }\n\n static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>\n static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]\n static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))\n : omitByPrefix(payloads, '_', maxDepth)\n }\n\n static sortByStorageMeta<T extends Payload>(\n payloads: WithStorageMeta<T>[],\n direction: -1 | 1 = 1,\n comparer: Compare<Sequence> = SequenceComparer.local,\n ) {\n return payloads.sort((a, b) => direction * comparer(a._sequence, b._sequence))\n }\n\n static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.hashPairs(payloads)) {\n const dataHash = await this.dataHash(pair[0])\n result[pair[1]] = pair[0]\n result[dataHash] = pair[0]\n }\n return result\n }\n\n static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.dataHashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n /**\n * Creates an object map of payload hashes to payloads based on the payloads passed in\n * @param objs Any array of payloads\n * @returns A map of hashes to payloads\n */\n static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.hashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n private static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>\n private static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>\n private static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {\n if (Array.isArray(payloads)) {\n return await Promise.all(\n payloads.map(async (payload) => {\n return await this.addHashMeta(payload)\n }),\n )\n } else {\n const _hash = await this.hash(payloads)\n const _dataHash = await this.dataHash(payloads)\n return {\n ...payloads,\n _dataHash,\n _hash,\n }\n }\n }\n\n private static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T, index = 0): Promise<WithStorageMeta<T>> {\n const withHashMeta = await this.addHashMeta(payload)\n const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash, index).localSequence\n return {\n ...withHashMeta,\n _sequence,\n }\n }\n\n build(): R {\n return {\n schema: this._schema,\n ...this._fields,\n ...this._meta,\n } as R\n }\n\n async dataHashableFields() {\n return await PayloadBuilder.dataHashableFields(\n assertEx(this._schema, () => 'Payload: Missing Schema'),\n // TODO: Add verification that required fields are present\n this._fields as WithoutSchema<T>,\n )\n }\n\n fields(fields: WithoutMeta<WithoutSchema<T>>) {\n // we need to do the cast here since ts seems to not like nested, yet same, generics\n this._fields = omitSchema(PayloadBuilder.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>\n return this\n }\n\n meta(meta: WithOnlyClientMeta<T>) {\n // we need to do the cast here since ts seems to not like nested, yet same, generics\n this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>\n return this\n }\n\n schema(value: Schema) {\n this._schema = value\n }\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AAKzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAc;AAAA,EAAc;AAAA,OACrC;AAEP,SAAS,cAAc,yBAAyB;AAChD;AAAA,EAGE;AAAA,EACA;AAAA,OAUK;AAIA,IAAM,aAAa,CAA+B,YAAiC;AACxF,QAAM,SAAS,gBAAgB,OAAO;AACtC,SAAO,OAAO;AACd,SAAO;AACT;AAEO,IAAM,iBAAN,MAAM,gBAA8D;AAAA,EAKzE,YAAqB,SAAgC;AAAhC;AACnB,UAAM,EAAE,OAAO,IAAI;AACnB,SAAK,UAAU;AAAA,EACjB;AAAA,EAPU;AAAA,EACA;AAAA,EACA;AAAA,EASV,aAAa,eAAkC,UAAmB,QAAQ,GAAuD;AAC/H,WAAO,MAAM,QAAQ,QAAQ,IACzB,OAAO,YAAY;AACnB,aAAO,MAAM,QAAQ,IAAI,SAAS,IAAI,OAAO,SAAS,MAAM,MAAM,KAAK;AAAA,QACrE;AAAA,QACA;AAAA,MACF,CAAC,CAAC;AAAA,IACJ,GAAG,IACD,KAAK;AAAA,MACH;AAAA,MACA;AAAA,IACF;AAAA,EACN;AAAA,EAEA,OAAO,mBACL,GACA,GACA,WAA8B,iBAAiB,OAC/C;AACA,WAAO,SAAS,EAAE,WAAW,EAAE,SAAS;AAAA,EAC1C;AAAA,EAEA,aAAa,SAA4B,SAA2B;AAClE,WAAO,MAAM,aAAa,KAAK,KAAK,SAAS,OAAO,CAAC;AAAA,EACvD;AAAA,EAEA,aAAa,cAAiC,UAAqC;AACjF,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,WAAW,MAAM,KAAK,SAAS,OAAO;AAC5C,eAAO,CAAC,SAAS,QAAQ;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,mBACL,QACA,SAE4B;AAC5B,UAAM,cAAc,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC;AAC5D;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,KAAK,SAAS,WAAW;AAAA,EAClC;AAAA,EAIA,aAAa,WAA8B,UAA6C;AACtF,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,eAAO,MAAM,KAAK,SAAS,OAAO;AAAA,MACpC,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,aAAa,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACxG;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACtH;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACrH;AAAA,EAEA,aAAa,eAAkC,WAAgB,CAAC,GAAG,MAAoC;AACrG,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,OAAO,MAAM,YAAY,IAAI,IAAI,CAAC;AAAA,EAC1F;AAAA,EAEA,aAAa,KAAwB,SAA2B;AAC9D,WAAO,MAAM,aAAa,KAAK,KAAK,gBAAgB,OAAO,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAqC;AAC7E,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAwB,OAAO,YAAY;AAClD,eAAO,CAAC,SAAS,MAAM,KAAK,KAAK,OAAO,CAAC;AAAA,MAC3C,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,eACL,SACuB;AACvB,WAAO,KAAK,gBAAgB,OAAO;AAAA,EACrC;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,EAC3C;AAAA,EAIA,OAAO,eAAsC,UAAmB,WAAW,KAAoD;AAC7H,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,eAAe,SAAS,QAAQ,CAAC,IAC9D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAIA,OAAO,SAAgC,UAAmB,WAAW,KAAwC;AAC3G,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,SAAS,SAAS,QAAQ,CAAC,IACxD,KAAK,gBAAgB,KAAK,eAAe,UAAU,QAAQ,GAAG,QAAQ;AAAA,EAC5E;AAAA,EAIA,OAAO,uBAA8C,UAAmB,WAAW,KAAoE;AACrJ,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,uBAAuB,SAAS,QAAQ,CAAC,IACtE,aAAa,UAAU,MAAM,QAAQ;AAAA,EAC3C;AAAA,EAIA,OAAO,gBAAuC,UAAmB,WAAW,KAAsD;AAChI,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,gBAAgB,SAAS,QAAQ,CAAC,IAC/D,aAAa,UAAU,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAEA,OAAO,kBACL,UACA,YAAoB,GACpB,WAA8B,iBAAiB,OAC/C;AACA,WAAO,SAAS,KAAK,CAAC,GAAG,MAAM,YAAY,SAAS,EAAE,WAAW,EAAE,SAAS,CAAC;AAAA,EAC/E;AAAA,EAEA,aAAa,aAAgC,UAAyC;AACpF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,QAAQ,GAAG;AACjD,YAAM,WAAW,MAAM,KAAK,SAAS,KAAK,CAAC,CAAC;AAC5C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,QAAQ,IAAI,KAAK,CAAC;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAAqC;AACjF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,cAAc,IAAI,GAAG;AACjD,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,MAAqC;AAC7E,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAIA,aAAqB,YAA+B,UAAiE;AACnH,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,MAAM,QAAQ;AAAA,QACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,iBAAO,MAAM,KAAK,YAAY,OAAO;AAAA,QACvC,CAAC;AAAA,MACH;AAAA,IACF,OAAO;AACL,YAAM,QAAQ,MAAM,KAAK,KAAK,QAAQ;AACtC,YAAM,YAAY,MAAM,KAAK,SAAS,QAAQ;AAC9C,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAqB,wBAAqD,SAAY,QAAQ,GAAgC;AAC5H,UAAM,eAAe,MAAM,KAAK,YAAY,OAAO;AACnD,UAAM,YAAY,eAAe,KAAK,KAAK,IAAI,GAAG,aAAa,OAAO,KAAK,EAAE;AAC7E,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAEA,QAAW;AACT,WAAO;AAAA,MACL,QAAQ,KAAK;AAAA,MACb,GAAG,KAAK;AAAA,MACR,GAAG,KAAK;AAAA,IACV;AAAA,EACF;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,gBAAe;AAAA,MAC1B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA;AAAA,MAEtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,OAAO,QAAuC;AAE5C,SAAK,UAAU,WAAW,gBAAe,SAAS,kBAAkB,gBAAgB,MAAM,CAAC,CAAC,CAAC;AAC7F,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,MAA6B;AAEhC,SAAK,QAAQ,aAAa,MAAM,GAAG;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AACF;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/payload-builder",
3
- "version": "3.6.0-rc.13",
3
+ "version": "3.6.0-rc.15",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -34,8 +34,8 @@
34
34
  "@xylabs/logger": "^4.4.25",
35
35
  "@xylabs/object": "^4.4.25",
36
36
  "@xylabs/promise": "^4.4.25",
37
- "@xyo-network/hash": "^3.6.0-rc.13",
38
- "@xyo-network/payload-model": "^3.6.0-rc.13"
37
+ "@xyo-network/hash": "^3.6.0-rc.15",
38
+ "@xyo-network/payload-model": "^3.6.0-rc.15"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@xylabs/ts-scripts-yarn3": "^4.2.6",
package/src/Builder.ts CHANGED
@@ -1,61 +1,60 @@
1
+ import { assertEx } from '@xylabs/assert'
1
2
  import type { Hash } from '@xylabs/hex'
2
- import type { AnyObject, Compare } from '@xylabs/object'
3
- import { ObjectHasher } from '@xyo-network/hash'
3
+ import type {
4
+ AnyObject, Compare, EmptyObject,
5
+ } from '@xylabs/object'
4
6
  import {
5
- type Payload,
7
+ isJsonObject, omitByPrefix, pickByPrefix, toJson,
8
+ } from '@xylabs/object'
9
+ import type { Promisable } from '@xylabs/promise'
10
+ import { ObjectHasher, removeEmptyFields } from '@xyo-network/hash'
11
+ import {
12
+ type Payload, type Schema,
6
13
  type Sequence,
7
14
  SequenceComparer,
8
15
  SequenceParser,
9
16
  type WithHashMeta,
17
+ type WithOnlyClientMeta,
18
+ type WithOptionalSchema,
19
+ type WithoutClientMeta,
20
+ type WithoutMeta,
21
+ type WithoutPrivateStorageMeta,
22
+ type WithoutSchema,
10
23
  type WithoutStorageMeta,
11
24
  type WithStorageMeta,
12
25
  } from '@xyo-network/payload-model'
13
26
 
14
- import { PayloadBuilderBase } from './BuilderBase.ts'
27
+ import type { PayloadBuilderOptions } from './Options.ts'
15
28
 
16
- export class PayloadBuilder<
17
- T extends Payload = Payload<AnyObject>,
18
- > extends PayloadBuilderBase<T> {
19
- static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>
20
- static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>
21
- static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {
22
- if (Array.isArray(payloads)) {
23
- return await Promise.all(
24
- payloads.map(async (payload) => {
25
- return await this.addHashMeta(payload)
26
- }),
27
- )
28
- } else {
29
- const _hash = await PayloadBuilder.hash(payloads)
30
- const _dataHash = await PayloadBuilder.dataHash(payloads)
31
- return {
32
- ...payloads,
33
- _dataHash,
34
- _hash,
35
- }
36
- }
37
- }
29
+ export const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {
30
+ const result = structuredClone(payload)
31
+ delete result.schema
32
+ return result
33
+ }
38
34
 
39
- static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T): Promise<WithStorageMeta<T>> {
40
- const withHashMeta = await this.addHashMeta(payload)
41
- const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash).localSequence
42
- return {
43
- ...withHashMeta,
44
- _sequence,
45
- }
35
+ export class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {
36
+ protected _fields?: WithoutMeta<WithoutSchema<T>>
37
+ protected _meta?: WithOnlyClientMeta<T>
38
+ protected _schema: Schema
39
+
40
+ constructor(readonly options: PayloadBuilderOptions) {
41
+ const { schema } = options
42
+ this._schema = schema
46
43
  }
47
44
 
48
- static async addStorageMeta<T extends Payload>(payload: T): Promise<WithStorageMeta<T>>
45
+ static async addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>
49
46
  static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>
50
- static async addStorageMeta<T extends Payload>(payloads: T | T[]): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {
47
+ static async addStorageMeta<T extends Payload>(payloads: T | T[], index = 0): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {
51
48
  return Array.isArray(payloads)
52
49
  ? await (async () => {
53
- return await Promise.all(payloads.map(async payload => await this.addSequencedStorageMeta(
50
+ return await Promise.all(payloads.map(async (payload, i) => await this.addSequencedStorageMeta(
54
51
  payload,
52
+ i,
55
53
  )))
56
54
  })()
57
55
  : this.addSequencedStorageMeta(
58
56
  payloads,
57
+ index,
59
58
  )
60
59
  }
61
60
 
@@ -80,13 +79,26 @@ export class PayloadBuilder<
80
79
  )
81
80
  }
82
81
 
82
+ static dataHashableFields<T extends Payload>(
83
+ schema: Schema,
84
+ payload: WithoutSchema<T>,
85
+
86
+ ): Promisable<WithoutMeta<T>> {
87
+ const cleanFields = removeEmptyFields({ ...payload, schema })
88
+ assertEx(
89
+ cleanFields === undefined || isJsonObject(cleanFields),
90
+ () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,
91
+ )
92
+ return this.omitMeta(cleanFields) as WithoutMeta<T>
93
+ }
94
+
83
95
  static async dataHashes(payloads: undefined): Promise<undefined>
84
96
  static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>
85
97
  static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {
86
98
  return payloads
87
99
  ? await Promise.all(
88
100
  payloads.map(async (payload) => {
89
- return await PayloadBuilder.dataHash(payload)
101
+ return await this.dataHash(payload)
90
102
  }),
91
103
  )
92
104
  : undefined
@@ -122,7 +134,7 @@ export class PayloadBuilder<
122
134
  static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {
123
135
  return await Promise.all(
124
136
  payloads.map<Promise<[T, Hash]>>(async (payload) => {
125
- return [payload, await PayloadBuilder.hash(payload)]
137
+ return [payload, await this.hash(payload)]
126
138
  }),
127
139
  )
128
140
  }
@@ -139,6 +151,38 @@ export class PayloadBuilder<
139
151
  return await ObjectHasher.hashes(payloads)
140
152
  }
141
153
 
154
+ static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>
155
+ static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]
156
+ static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {
157
+ return Array.isArray(payloads)
158
+ ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))
159
+ : omitByPrefix(payloads, '$', maxDepth)
160
+ }
161
+
162
+ static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>
163
+ static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]
164
+ static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {
165
+ return Array.isArray(payloads)
166
+ ? payloads.map(payload => this.omitMeta(payload, maxDepth))
167
+ : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>
168
+ }
169
+
170
+ static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>
171
+ static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]
172
+ static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {
173
+ return Array.isArray(payloads)
174
+ ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))
175
+ : omitByPrefix(payloads, '__', maxDepth)
176
+ }
177
+
178
+ static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>
179
+ static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]
180
+ static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {
181
+ return Array.isArray(payloads)
182
+ ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))
183
+ : omitByPrefix(payloads, '_', maxDepth)
184
+ }
185
+
142
186
  static sortByStorageMeta<T extends Payload>(
143
187
  payloads: WithStorageMeta<T>[],
144
188
  direction: -1 | 1 = 1,
@@ -178,11 +222,64 @@ export class PayloadBuilder<
178
222
  return result
179
223
  }
180
224
 
181
- build(): T {
225
+ private static async addHashMeta<T extends Payload>(payload: T): Promise<WithHashMeta<T>>
226
+ private static async addHashMeta<T extends Payload>(payloads: T[]): Promise<WithHashMeta<T>[]>
227
+ private static async addHashMeta<T extends Payload>(payloads: T | T[]): Promise<WithHashMeta<T>[] | WithHashMeta<T>> {
228
+ if (Array.isArray(payloads)) {
229
+ return await Promise.all(
230
+ payloads.map(async (payload) => {
231
+ return await this.addHashMeta(payload)
232
+ }),
233
+ )
234
+ } else {
235
+ const _hash = await this.hash(payloads)
236
+ const _dataHash = await this.dataHash(payloads)
237
+ return {
238
+ ...payloads,
239
+ _dataHash,
240
+ _hash,
241
+ }
242
+ }
243
+ }
244
+
245
+ private static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T, index = 0): Promise<WithStorageMeta<T>> {
246
+ const withHashMeta = await this.addHashMeta(payload)
247
+ const _sequence = SequenceParser.from(Date.now(), withHashMeta._hash, index).localSequence
248
+ return {
249
+ ...withHashMeta,
250
+ _sequence,
251
+ }
252
+ }
253
+
254
+ build(): R {
182
255
  return {
183
256
  schema: this._schema,
184
257
  ...this._fields,
185
258
  ...this._meta,
186
- } as T
259
+ } as R
260
+ }
261
+
262
+ async dataHashableFields() {
263
+ return await PayloadBuilder.dataHashableFields(
264
+ assertEx(this._schema, () => 'Payload: Missing Schema'),
265
+ // TODO: Add verification that required fields are present
266
+ this._fields as WithoutSchema<T>,
267
+ )
268
+ }
269
+
270
+ fields(fields: WithoutMeta<WithoutSchema<T>>) {
271
+ // we need to do the cast here since ts seems to not like nested, yet same, generics
272
+ this._fields = omitSchema(PayloadBuilder.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>
273
+ return this
274
+ }
275
+
276
+ meta(meta: WithOnlyClientMeta<T>) {
277
+ // we need to do the cast here since ts seems to not like nested, yet same, generics
278
+ this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>
279
+ return this
280
+ }
281
+
282
+ schema(value: Schema) {
283
+ this._schema = value
187
284
  }
188
285
  }
package/src/index.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export * from './Builder.ts'
2
- export * from './BuilderBase.ts'
2
+ export * from './Builder.ts'
3
3
  export * from './Options.ts'
@@ -1,26 +0,0 @@
1
- import type { AnyObject, EmptyObject } from '@xylabs/object';
2
- import type { Promisable } from '@xylabs/promise';
3
- import type { Payload, Schema, WithOnlyClientMeta, WithOptionalSchema, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta } from '@xyo-network/payload-model';
4
- import type { PayloadBuilderOptions } from './Options.ts';
5
- export declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
6
- export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>> {
7
- readonly options: PayloadBuilderOptions;
8
- protected _fields?: WithoutMeta<WithoutSchema<T>>;
9
- protected _meta?: WithOnlyClientMeta<T>;
10
- protected _schema: Schema;
11
- constructor(options: PayloadBuilderOptions);
12
- static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
13
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
14
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
15
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
16
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
17
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
18
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
19
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
20
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
21
- dataHashableFields(): Promise<import("@xylabs/object").DeepOmitStartsWith<import("@xylabs/object").DeepOmitStartsWith<T, "_">, "$">>;
22
- fields(fields: WithoutMeta<WithoutSchema<T>>): this;
23
- meta(meta: WithOnlyClientMeta<T>): this;
24
- schema(value: Schema): void;
25
- }
26
- //# sourceMappingURL=BuilderBase.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"BuilderBase.d.ts","sourceRoot":"","sources":["../../src/BuilderBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAI5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EACf,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EACnB,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,kBAAkB,WAAW,CAAC,KAAG,aAAa,CAAC,CAAC,CAIpF,CAAA;AAED,qBAAa,kBAAkB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAKxD,QAAQ,CAAC,OAAO,EAAE,qBAAqB;IAJnD,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IACjD,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAA;IACvC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEJ,OAAO,EAAE,qBAAqB;IAKnD,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS,OAAO,EACzC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAExB,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAS7B,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IACjG,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,EAAE;IAOtG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IACrF,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE;IAO1F,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC;IACjH,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,EAAE;IAOtH,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;IACnG,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,EAAE;IAOlG,kBAAkB;IAQxB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAM5C,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAMhC,MAAM,CAAC,KAAK,EAAE,MAAM;CAGrB"}
@@ -1,26 +0,0 @@
1
- import type { AnyObject, EmptyObject } from '@xylabs/object';
2
- import type { Promisable } from '@xylabs/promise';
3
- import type { Payload, Schema, WithOnlyClientMeta, WithOptionalSchema, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta } from '@xyo-network/payload-model';
4
- import type { PayloadBuilderOptions } from './Options.ts';
5
- export declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
6
- export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>> {
7
- readonly options: PayloadBuilderOptions;
8
- protected _fields?: WithoutMeta<WithoutSchema<T>>;
9
- protected _meta?: WithOnlyClientMeta<T>;
10
- protected _schema: Schema;
11
- constructor(options: PayloadBuilderOptions);
12
- static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
13
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
14
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
15
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
16
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
17
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
18
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
19
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
20
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
21
- dataHashableFields(): Promise<import("@xylabs/object").DeepOmitStartsWith<import("@xylabs/object").DeepOmitStartsWith<T, "_">, "$">>;
22
- fields(fields: WithoutMeta<WithoutSchema<T>>): this;
23
- meta(meta: WithOnlyClientMeta<T>): this;
24
- schema(value: Schema): void;
25
- }
26
- //# sourceMappingURL=BuilderBase.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"BuilderBase.d.ts","sourceRoot":"","sources":["../../src/BuilderBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAI5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EACf,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EACnB,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,kBAAkB,WAAW,CAAC,KAAG,aAAa,CAAC,CAAC,CAIpF,CAAA;AAED,qBAAa,kBAAkB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAKxD,QAAQ,CAAC,OAAO,EAAE,qBAAqB;IAJnD,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IACjD,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAA;IACvC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEJ,OAAO,EAAE,qBAAqB;IAKnD,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS,OAAO,EACzC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAExB,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAS7B,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IACjG,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,EAAE;IAOtG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IACrF,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE;IAO1F,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC;IACjH,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,EAAE;IAOtH,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;IACnG,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,EAAE;IAOlG,kBAAkB;IAQxB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAM5C,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAMhC,MAAM,CAAC,KAAK,EAAE,MAAM;CAGrB"}
@@ -1,26 +0,0 @@
1
- import type { AnyObject, EmptyObject } from '@xylabs/object';
2
- import type { Promisable } from '@xylabs/promise';
3
- import type { Payload, Schema, WithOnlyClientMeta, WithOptionalSchema, WithoutClientMeta, WithoutMeta, WithoutPrivateStorageMeta, WithoutSchema, WithoutStorageMeta } from '@xyo-network/payload-model';
4
- import type { PayloadBuilderOptions } from './Options.ts';
5
- export declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
6
- export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>> {
7
- readonly options: PayloadBuilderOptions;
8
- protected _fields?: WithoutMeta<WithoutSchema<T>>;
9
- protected _meta?: WithOnlyClientMeta<T>;
10
- protected _schema: Schema;
11
- constructor(options: PayloadBuilderOptions);
12
- static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
13
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
14
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
15
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
16
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
17
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
18
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
19
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
20
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
21
- dataHashableFields(): Promise<import("@xylabs/object").DeepOmitStartsWith<import("@xylabs/object").DeepOmitStartsWith<T, "_">, "$">>;
22
- fields(fields: WithoutMeta<WithoutSchema<T>>): this;
23
- meta(meta: WithOnlyClientMeta<T>): this;
24
- schema(value: Schema): void;
25
- }
26
- //# sourceMappingURL=BuilderBase.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"BuilderBase.d.ts","sourceRoot":"","sources":["../../src/BuilderBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAI5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EACf,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EACnB,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,kBAAkB,WAAW,CAAC,KAAG,aAAa,CAAC,CAAC,CAIpF,CAAA;AAED,qBAAa,kBAAkB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAKxD,QAAQ,CAAC,OAAO,EAAE,qBAAqB;IAJnD,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IACjD,SAAS,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAA;IACvC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEJ,OAAO,EAAE,qBAAqB;IAKnD,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS,OAAO,EACzC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAExB,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAS7B,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IACjG,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,EAAE;IAOtG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;IACrF,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE;IAO1F,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC;IACjH,MAAM,CAAC,sBAAsB,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAC,CAAC,CAAC,EAAE;IAOtH,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC;IACnG,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,EAAE;IAOlG,kBAAkB;IAQxB,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAM5C,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAMhC,MAAM,CAAC,KAAK,EAAE,MAAM;CAGrB"}
@@ -1,105 +0,0 @@
1
- import { assertEx } from '@xylabs/assert'
2
- import type { AnyObject, EmptyObject } from '@xylabs/object'
3
- import {
4
- isJsonObject, omitByPrefix, pickByPrefix, toJson,
5
- } from '@xylabs/object'
6
- import type { Promisable } from '@xylabs/promise'
7
- import { removeEmptyFields } from '@xyo-network/hash'
8
- import type {
9
- Payload, Schema,
10
- WithOnlyClientMeta,
11
- WithOptionalSchema,
12
- WithoutClientMeta,
13
- WithoutMeta,
14
- WithoutPrivateStorageMeta,
15
- WithoutSchema,
16
- WithoutStorageMeta,
17
- } from '@xyo-network/payload-model'
18
-
19
- import type { PayloadBuilderOptions } from './Options.ts'
20
-
21
- export const omitSchema = <T extends WithOptionalSchema>(payload: T): WithoutSchema<T> => {
22
- const result = structuredClone(payload)
23
- delete result.schema
24
- return result
25
- }
26
-
27
- export class PayloadBuilderBase<T extends Payload = Payload<AnyObject>> {
28
- protected _fields?: WithoutMeta<WithoutSchema<T>>
29
- protected _meta?: WithOnlyClientMeta<T>
30
- protected _schema: Schema
31
-
32
- constructor(readonly options: PayloadBuilderOptions) {
33
- const { schema } = options
34
- this._schema = schema
35
- }
36
-
37
- static dataHashableFields<T extends Payload>(
38
- schema: Schema,
39
- payload: WithoutSchema<T>,
40
-
41
- ): Promisable<WithoutMeta<T>> {
42
- const cleanFields = removeEmptyFields({ ...payload, schema })
43
- assertEx(
44
- cleanFields === undefined || isJsonObject(cleanFields),
45
- () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,
46
- )
47
- return this.omitMeta(cleanFields) as WithoutMeta<T>
48
- }
49
-
50
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>
51
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[]
52
- static omitClientMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutClientMeta<T> | WithoutClientMeta<T>[] {
53
- return Array.isArray(payloads)
54
- ? payloads.map(payload => this.omitClientMeta(payload, maxDepth))
55
- : omitByPrefix(payloads, '$', maxDepth)
56
- }
57
-
58
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>
59
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[]
60
- static omitMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutMeta<T> | WithoutMeta<T>[] {
61
- return Array.isArray(payloads)
62
- ? payloads.map(payload => this.omitMeta(payload, maxDepth))
63
- : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) as unknown as WithoutMeta<T>
64
- }
65
-
66
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>
67
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[]
68
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutPrivateStorageMeta<T> | WithoutPrivateStorageMeta<T>[] {
69
- return Array.isArray(payloads)
70
- ? payloads.map(payload => this.omitPrivateStorageMeta(payload, maxDepth))
71
- : omitByPrefix(payloads, '__', maxDepth)
72
- }
73
-
74
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>
75
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[]
76
- static omitStorageMeta<T extends EmptyObject>(payloads: T | T[], maxDepth = 100): WithoutStorageMeta<T> | WithoutStorageMeta<T>[] {
77
- return Array.isArray(payloads)
78
- ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth))
79
- : omitByPrefix(payloads, '_', maxDepth)
80
- }
81
-
82
- async dataHashableFields() {
83
- return await PayloadBuilderBase.dataHashableFields(
84
- assertEx(this._schema, () => 'Payload: Missing Schema'),
85
- // TODO: Add verification that required fields are present
86
- this._fields as WithoutSchema<T>,
87
- )
88
- }
89
-
90
- fields(fields: WithoutMeta<WithoutSchema<T>>) {
91
- // we need to do the cast here since ts seems to not like nested, yet same, generics
92
- this._fields = omitSchema(PayloadBuilderBase.omitMeta(removeEmptyFields(structuredClone(fields)))) as unknown as WithoutMeta<WithoutSchema<T>>
93
- return this
94
- }
95
-
96
- meta(meta: WithOnlyClientMeta<T>) {
97
- // we need to do the cast here since ts seems to not like nested, yet same, generics
98
- this._meta = pickByPrefix(meta, '$') as WithOnlyClientMeta<T>
99
- return this
100
- }
101
-
102
- schema(value: Schema) {
103
- this._schema = value
104
- }
105
- }