@xyo-network/payload-builder 2.88.2 → 2.89.0-rc.1

package/dist/browser/Builder.d.cts

@@ -1,24 +1,39 @@
-import { AnyObject } from '@xyo-network/object';
-import { Payload } from '@xyo-network/payload-model';
-export interface PayloadBuilderOptions {
+import { Hash } from '@xylabs/hex';
+import { JsonObject } from '@xylabs/object';
+import { Payload, WithMeta } from '@xyo-network/payload-model';
+export interface PayloadBuilderOptions<T> {
+    fields?: Partial<T>;
+    meta?: JsonObject;
     schema: string;
 }
-export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
+export declare class PayloadBuilder<T extends Payload = Payload> {
     private _$meta?;
-    private _client;
     private _fields;
     private _schema;
-    private _timestamp;
-    constructor({ schema }: PayloadBuilderOptions);
-    get externalMeta(): {
-        _client: string;
-        _hash: Promise<string>;
-        _timestamp: number;
-    };
+    constructor({ schema, fields, meta }: PayloadBuilderOptions<T>);
     get schema(): string;
-    $meta(fields?: AnyObject): this;
-    build(withExternalMeta?: boolean): Promise<T>;
+    static build<T extends Payload>(payload: T): Promise<WithMeta<T>>;
+    static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
+    static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static filterInclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static find<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
+    /**
+     * Creates an array of payload/hash tuples based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns An array of payload/hash tuples
+     */
+    static hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    /**
+     * Creates an object map of payload hashes to payloads based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns A map of hashes to payloads
+     */
+    static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    $meta(fields?: JsonObject): this;
+    build(): Promise<WithMeta<T>>;
+    dataHashableFields(): T;
     fields(fields?: Partial<T>): this;
-    hashableFields(): T;
 }
 //# sourceMappingURL=Builder.d.ts.map

package/dist/browser/Builder.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAChE,OAAO,CAAC,MAAM,CAAC,CAAW;IAC1B,OAAO,CAAC,OAAO,CAAO;IACtB,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAa;gBAEnB,EAAE,MAAM,EAAE,EAAE,qBAAqB;IAI7C,IAAI,YAAY;;;;MAGf;IAED,IAAI,MAAM,WAGT;IAED,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS;IAKlB,KAAK,CAAC,gBAAgB,UAAQ;IASpC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAO1B,cAAc;CAMf"}
+{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,EAAE,OAAO,EAAmB,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAE/E,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACnB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO;IACrD,OAAO,CAAC,MAAM,CAAC,CAAY;IAC3B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAQ;gBAEX,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAM9D,IAAI,MAAM,WAGT;WAEY,KAAK,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC;WAMnC,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WAS/E,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;WAS7D,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKvF,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKvF,IAAI,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI5F;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WAS3E,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAQlF;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAQ9E,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU;IAKnB,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAYnC,kBAAkB;IAOlB,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CAM3B"}

package/dist/browser/Builder.d.mts

@@ -1,24 +1,39 @@
-import { AnyObject } from '@xyo-network/object';
-import { Payload } from '@xyo-network/payload-model';
-export interface PayloadBuilderOptions {
+import { Hash } from '@xylabs/hex';
+import { JsonObject } from '@xylabs/object';
+import { Payload, WithMeta } from '@xyo-network/payload-model';
+export interface PayloadBuilderOptions<T> {
+    fields?: Partial<T>;
+    meta?: JsonObject;
     schema: string;
 }
-export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
+export declare class PayloadBuilder<T extends Payload = Payload> {
     private _$meta?;
-    private _client;
     private _fields;
     private _schema;
-    private _timestamp;
-    constructor({ schema }: PayloadBuilderOptions);
-    get externalMeta(): {
-        _client: string;
-        _hash: Promise<string>;
-        _timestamp: number;
-    };
+    constructor({ schema, fields, meta }: PayloadBuilderOptions<T>);
     get schema(): string;
-    $meta(fields?: AnyObject): this;
-    build(withExternalMeta?: boolean): Promise<T>;
+    static build<T extends Payload>(payload: T): Promise<WithMeta<T>>;
+    static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
+    static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static filterInclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static find<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
+    /**
+     * Creates an array of payload/hash tuples based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns An array of payload/hash tuples
+     */
+    static hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    /**
+     * Creates an object map of payload hashes to payloads based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns A map of hashes to payloads
+     */
+    static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    $meta(fields?: JsonObject): this;
+    build(): Promise<WithMeta<T>>;
+    dataHashableFields(): T;
     fields(fields?: Partial<T>): this;
-    hashableFields(): T;
 }
 //# sourceMappingURL=Builder.d.ts.map

package/dist/browser/Builder.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAChE,OAAO,CAAC,MAAM,CAAC,CAAW;IAC1B,OAAO,CAAC,OAAO,CAAO;IACtB,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAa;gBAEnB,EAAE,MAAM,EAAE,EAAE,qBAAqB;IAI7C,IAAI,YAAY;;;;MAGf;IAED,IAAI,MAAM,WAGT;IAED,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS;IAKlB,KAAK,CAAC,gBAAgB,UAAQ;IASpC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAO1B,cAAc;CAMf"}
+{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,EAAE,OAAO,EAAmB,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAE/E,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACnB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO;IACrD,OAAO,CAAC,MAAM,CAAC,CAAY;IAC3B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAQ;gBAEX,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAM9D,IAAI,MAAM,WAGT;WAEY,KAAK,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC;WAMnC,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WAS/E,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;WAS7D,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKvF,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKvF,IAAI,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI5F;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WAS3E,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAQlF;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAQ9E,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU;IAKnB,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAYnC,kBAAkB;IAOlB,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CAM3B"}

package/dist/browser/Builder.d.ts

@@ -1,24 +1,39 @@
-import { AnyObject } from '@xyo-network/object';
-import { Payload } from '@xyo-network/payload-model';
-export interface PayloadBuilderOptions {
+import { Hash } from '@xylabs/hex';
+import { JsonObject } from '@xylabs/object';
+import { Payload, WithMeta } from '@xyo-network/payload-model';
+export interface PayloadBuilderOptions<T> {
+    fields?: Partial<T>;
+    meta?: JsonObject;
     schema: string;
 }
-export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
+export declare class PayloadBuilder<T extends Payload = Payload> {
     private _$meta?;
-    private _client;
     private _fields;
     private _schema;
-    private _timestamp;
-    constructor({ schema }: PayloadBuilderOptions);
-    get externalMeta(): {
-        _client: string;
-        _hash: Promise<string>;
-        _timestamp: number;
-    };
+    constructor({ schema, fields, meta }: PayloadBuilderOptions<T>);
     get schema(): string;
-    $meta(fields?: AnyObject): this;
-    build(withExternalMeta?: boolean): Promise<T>;
+    static build<T extends Payload>(payload: T): Promise<WithMeta<T>>;
+    static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
+    static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static filterInclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static find<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
+    /**
+     * Creates an array of payload/hash tuples based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns An array of payload/hash tuples
+     */
+    static hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    /**
+     * Creates an object map of payload hashes to payloads based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns A map of hashes to payloads
+     */
+    static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    $meta(fields?: JsonObject): this;
+    build(): Promise<WithMeta<T>>;
+    dataHashableFields(): T;
     fields(fields?: Partial<T>): this;
-    hashableFields(): T;
 }
 //# sourceMappingURL=Builder.d.ts.map

package/dist/browser/Builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAChE,OAAO,CAAC,MAAM,CAAC,CAAW;IAC1B,OAAO,CAAC,OAAO,CAAO;IACtB,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAa;gBAEnB,EAAE,MAAM,EAAE,EAAE,qBAAqB;IAI7C,IAAI,YAAY;;;;MAGf;IAED,IAAI,MAAM,WAGT;IAED,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS;IAKlB,KAAK,CAAC,gBAAgB,UAAQ;IASpC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAO1B,cAAc;CAMf"}
+{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE3C,OAAO,EAAE,OAAO,EAAmB,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAE/E,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACnB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO;IACrD,OAAO,CAAC,MAAM,CAAC,CAAY;IAC3B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAQ;gBAEX,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAM9D,IAAI,MAAM,WAGT;WAEY,KAAK,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC;WAMnC,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WAS/E,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;WAS7D,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKvF,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKvF,IAAI,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,iBAAU,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI5F;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WAS3E,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAQlF;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAQ9E,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU;IAKnB,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAYnC,kBAAkB;IAOlB,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;CAM3B"}

package/dist/browser/index.cjs

@@ -28,48 +28,113 @@ module.exports = __toCommonJS(src_exports);
 // src/Builder.ts
 var import_assert = require("@xylabs/assert");
 var import_hash = require("@xyo-network/hash");
-var PayloadBuilder = class {
+var PayloadBuilder = class _PayloadBuilder {
   static {
     __name(this, "PayloadBuilder");
   }
   _$meta;
-  _client = "js";
   _fields = {};
   _schema;
-  _timestamp = Date.now();
-  constructor({ schema }) {
+  constructor({ schema, fields, meta }) {
     this._schema = schema;
-  }
-  get externalMeta() {
-    const _hash = import_hash.PayloadHasher.hashAsync(this.hashableFields);
-    return {
-      _client: this._client,
-      _hash,
-      _timestamp: this._timestamp
-    };
+    this._fields = fields ?? {};
+    this._$meta = meta;
   }
   get schema() {
     this._schema = this._schema ?? this._fields["schema"];
     return this._schema;
   }
+  static async build(payload) {
+    const builder = new _PayloadBuilder({
+      schema: payload.schema
+    });
+    builder.fields(payload);
+    return await builder.build();
+  }
+  static async dataHashPairs(payloads) {
+    return await Promise.all(payloads.map(async (payload) => {
+      const built = await _PayloadBuilder.build(payload);
+      return [
+        built,
+        built.$hash
+      ];
+    }));
+  }
+  static async dataHashes(payloads) {
+    return await Promise.all(payloads.map(async (payload) => {
+      const built = await _PayloadBuilder.build(payload);
+      return built.$hash;
+    }));
+  }
+  static async filterExclude(payloads = [], hash) {
+    const hashes = Array.isArray(hash) ? hash : [
+      hash
+    ];
+    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0]);
+  }
+  static async filterInclude(payloads = [], hash) {
+    const hashes = Array.isArray(hash) ? hash : [
+      hash
+    ];
+    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0]);
+  }
+  static async find(payloads = [], hash) {
+    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0];
+  }
+  /**
+  * Creates an array of payload/hash tuples based on the payloads passed in
+  * @param objs Any array of payloads
+  * @returns An array of payload/hash tuples
+  */
+  static async hashPairs(payloads) {
+    return await Promise.all(payloads.map(async (payload) => {
+      const built = await _PayloadBuilder.build(payload);
+      return [
+        built,
+        await import_hash.PayloadHasher.hashAsync(built)
+      ];
+    }));
+  }
+  static async toDataHashMap(objs) {
+    const result = {};
+    for (const pair of await this.dataHashPairs(objs)) {
+      result[pair[1]] = pair[0];
+    }
+    return result;
+  }
+  /**
+  * Creates an object map of payload hashes to payloads based on the payloads passed in
+  * @param objs Any array of payloads
+  * @returns A map of hashes to payloads
+  */
+  static async toHashMap(objs) {
+    const result = {};
+    for (const pair of await this.hashPairs(objs)) {
+      result[pair[1]] = pair[0];
+    }
+    return result;
+  }
   $meta(fields) {
     this._$meta = fields;
     return this;
   }
-  async build(withExternalMeta = false) {
-    let hashableFields = this.hashableFields();
-    if (this._$meta) {
-      const $hash = await import_hash.PayloadHasher.hashAsync(hashableFields);
-      hashableFields = {
-        ...hashableFields,
-        $hash,
-        $meta: this._$meta
-      };
+  async build() {
+    const dataHashableFields = this.dataHashableFields();
+    const $hash = await import_hash.PayloadHasher.hashAsync(dataHashableFields);
+    const hashableFields = {
+      ...dataHashableFields,
+      $hash
+    };
+    if (this._$meta && Object.keys(this._$meta).length > 0) {
+      hashableFields["$meta"] = this._$meta;
     }
-    return withExternalMeta ? {
-      ...hashableFields,
-      ...this.externalMeta
-    } : hashableFields;
+    return hashableFields;
+  }
+  dataHashableFields() {
+    return {
+      ...(0, import_hash.removeEmptyFields)((0, import_hash.deepOmitPrefixedFields)((0, import_hash.deepOmitPrefixedFields)(this._fields, "$"), "_")),
+      schema: (0, import_assert.assertEx)(this.schema, "Payload: Missing Schema")
+    };
   }
   fields(fields) {
     if (fields) {
@@ -80,11 +145,5 @@ var PayloadBuilder = class {
     }
     return this;
   }
-  hashableFields() {
-    return {
-      ...(0, import_hash.removeEmptyFields)((0, import_hash.deepOmitUnderscoreFields)(this._fields)),
-      schema: (0, import_assert.assertEx)(this.schema, "Payload: Missing Schema")
-    };
-  }
 };
 //# sourceMappingURL=index.cjs.map

package/dist/browser/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts","../../src/Builder.ts"],"sourcesContent":["export * from './Builder'\n","import { assertEx } from '@xylabs/assert'\nimport { deepOmitUnderscoreFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'\nimport { AnyObject } from '@xyo-network/object'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport interface PayloadBuilderOptions {\n  schema: string\n}\n\nexport class PayloadBuilder<T extends Payload = Payload<AnyObject>> {\n  private _$meta?: AnyObject\n  private _client = 'js'\n  private _fields: Partial<T> = {}\n  private _schema: string\n  private _timestamp = Date.now()\n\n  constructor({ schema }: PayloadBuilderOptions) {\n    this._schema = schema\n  }\n\n  get externalMeta() {\n    const _hash = PayloadHasher.hashAsync(this.hashableFields)\n    return { _client: this._client, _hash, _timestamp: this._timestamp }\n  }\n\n  get schema() {\n    this._schema = this._schema ?? this._fields['schema']\n    return this._schema\n  }\n\n  $meta(fields?: AnyObject) {\n    this._$meta = fields\n    return this\n  }\n\n  async build(withExternalMeta = false) {\n    let hashableFields = this.hashableFields()\n    if (this._$meta) {\n      const $hash = await PayloadHasher.hashAsync(hashableFields)\n      hashableFields = { ...hashableFields, $hash, $meta: this._$meta }\n    }\n    return withExternalMeta ? { ...hashableFields, ...this.externalMeta } : hashableFields\n  }\n\n  fields(fields?: Partial<T>) {\n    if (fields) {\n      this._fields = { ...this._fields, ...removeEmptyFields(fields) }\n    }\n    return this\n  }\n\n  hashableFields() {\n    return {\n      ...removeEmptyFields(deepOmitUnderscoreFields(this._fields)),\n      schema: assertEx(this.schema, 'Payload: Missing Schema'),\n    } as T\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACAA,oBAAyB;AACzB,kBAA2E;AAQpE,IAAMA,iBAAN,MAAMA;EATb,OASaA;;;EACHC;EACAC,UAAU;EACVC,UAAsB,CAAC;EACvBC;EACAC,aAAaC,KAAKC,IAAG;EAE7BC,YAAY,EAAEC,OAAM,GAA2B;AAC7C,SAAKL,UAAUK;EACjB;EAEA,IAAIC,eAAe;AACjB,UAAMC,QAAQC,0BAAcC,UAAU,KAAKC,cAAc;AACzD,WAAO;MAAEZ,SAAS,KAAKA;MAASS;MAAON,YAAY,KAAKA;IAAW;EACrE;EAEA,IAAII,SAAS;AACX,SAAKL,UAAU,KAAKA,WAAW,KAAKD,QAAQ,QAAA;AAC5C,WAAO,KAAKC;EACd;EAEAW,MAAMC,QAAoB;AACxB,SAAKf,SAASe;AACd,WAAO;EACT;EAEA,MAAMC,MAAMC,mBAAmB,OAAO;AACpC,QAAIJ,iBAAiB,KAAKA,eAAc;AACxC,QAAI,KAAKb,QAAQ;AACf,YAAMkB,QAAQ,MAAMP,0BAAcC,UAAUC,cAAAA;AAC5CA,uBAAiB;QAAE,GAAGA;QAAgBK;QAAOJ,OAAO,KAAKd;MAAO;IAClE;AACA,WAAOiB,mBAAmB;MAAE,GAAGJ;MAAgB,GAAG,KAAKJ;IAAa,IAAII;EAC1E;EAEAE,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKb,UAAU;QAAE,GAAG,KAAKA;QAAS,OAAGiB,+BAAkBJ,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;EAEAF,iBAAiB;AACf,WAAO;MACL,OAAGM,mCAAkBC,sCAAyB,KAAKlB,OAAO,CAAA;MAC1DM,YAAQa,wBAAS,KAAKb,QAAQ,yBAAA;IAChC;EACF;AACF;","names":["PayloadBuilder","_$meta","_client","_fields","_schema","_timestamp","Date","now","constructor","schema","externalMeta","_hash","PayloadHasher","hashAsync","hashableFields","$meta","fields","build","withExternalMeta","$hash","removeEmptyFields","deepOmitUnderscoreFields","assertEx"]}
+{"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 { 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> {\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    const builder = new PayloadBuilder<T>({ schema: payload.schema })\n    builder.fields(payload)\n    return await builder.build()\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<T extends Payload>(payloads: T[]): Promise<Hash[]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return built.$hash\n      }),\n    )\n  }\n\n  static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async filterInclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async find<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n  }\n\n  /**\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 PayloadHasher.hashAsync(built)]\n      }),\n    )\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(fields?: JsonObject) {\n    this._$meta = fields\n    return this\n  }\n\n  async build(): Promise<WithMeta<T>> {\n    const dataHashableFields = this.dataHashableFields()\n    const $hash = await PayloadHasher.hashAsync(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,iBAAN,MAAMA,gBAAAA;EAZb,OAYaA;;;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;AAChD,UAAMC,UAAU,IAAIV,gBAAkB;MAAEK,QAAQI,QAAQJ;IAAO,CAAA;AAC/DK,YAAQJ,OAAOG,OAAAA;AACf,WAAO,MAAMC,QAAQF,MAAK;EAC5B;EAEA,aAAaG,cAAiCC,UAA+C;AAC3F,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAON,YAAAA;AAClB,YAAMO,QAAQ,MAAMhB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACO;QAAOA,MAAMC;;IACvB,CAAA,CAAA;EAEJ;EAEA,aAAaC,WAA8BN,UAAgC;AACzE,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAON,YAAAA;AAClB,YAAMO,QAAQ,MAAMhB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAOO,MAAMC;IACf,CAAA,CAAA;EAEJ;EAEA,aAAaE,cAAiCP,WAAgB,CAAA,GAAIQ,MAAmC;AACnG,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,MAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACN,OAAOO,SAASD,OAAAA,CAAAA,GAAWZ,IAAI,CAACc,SAASA,KAAK,CAAA,CAAE;EACpH;EAEA,aAAaC,cAAiClB,WAAgB,CAAA,GAAIQ,MAAmC;AACnG,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,MAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaN,OAAOO,SAASD,OAAAA,CAAAA,GAAWZ,IAAI,CAACc,SAASA,KAAK,CAAA,CAAE;EACnH;EAEA,aAAaE,KAAwBnB,WAAgB,CAAA,GAAIQ,MAAoC;AAC3F,YAAQ,MAAM,KAAKI,UAAUZ,QAAAA,GAAWmB,KAAK,CAAC,CAACL,GAAGC,OAAAA,MAAaA,YAAYP,IAAAA,IAAQ,CAAA;EACrF;;;;;;EAOA,aAAaI,UAA6BZ,UAA+C;AACvF,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAkC,OAAON,YAAAA;AAChD,YAAMO,QAAQ,MAAMhB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACO;QAAO,MAAMgB,0BAAcC,UAAUjB,KAAAA;;IAC/C,CAAA,CAAA;EAEJ;EAEA,aAAakB,cAAiCC,MAAqC;AACjF,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKlB,cAAcwB,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,KAAKL,UAAUW,IAAAA,GAAO;AAC7CC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOO;EACT;EAEAE,MAAMhC,QAAqB;AACzB,SAAKL,SAASK;AACd,WAAO;EACT;EAEA,MAAME,QAA8B;AAClC,UAAM+B,qBAAqB,KAAKA,mBAAkB;AAClD,UAAMtB,QAAQ,MAAMe,0BAAcC,UAAUM,kBAAAA;AAC5C,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBtB;IAAM;AAGvE,QAAI,KAAKhB,UAAUwC,OAAOC,KAAK,KAAKzC,MAAM,EAAE0C,SAAS,GAAG;AACtDH,qBAAe,OAAA,IAAW,KAAKvC;IACjC;AACA,WAAOuC;EACT;EAEAD,qBAAqB;AACnB,WAAO;MACL,OAAGK,mCAAkBC,wCAAuBA,oCAAuB,KAAK3C,SAAS,GAAA,GAAM,GAAA,CAAA;MACvFG,YAAQyC,wBAAS,KAAKzC,QAAQ,yBAAA;IAChC;EACF;EAEAC,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,OAAG0C,+BAAkBtC,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;AACF;","names":["PayloadBuilder","_$meta","_fields","_schema","constructor","schema","fields","meta","build","payload","builder","dataHashPairs","payloads","Promise","all","map","built","$hash","dataHashes","filterExclude","hash","hashes","Array","isArray","hashPairs","filter","_","objHash","includes","pair","filterInclude","find","PayloadHasher","hashAsync","toDataHashMap","objs","result","toHashMap","$meta","dataHashableFields","hashableFields","Object","keys","length","removeEmptyFields","deepOmitPrefixedFields","assertEx"]}

package/dist/browser/index.js

@@ -3,49 +3,114 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 
 // src/Builder.ts
 import { assertEx } from "@xylabs/assert";
-import { deepOmitUnderscoreFields, PayloadHasher, removeEmptyFields } from "@xyo-network/hash";
-var PayloadBuilder = class {
+import { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from "@xyo-network/hash";
+var PayloadBuilder = class _PayloadBuilder {
   static {
     __name(this, "PayloadBuilder");
   }
   _$meta;
-  _client = "js";
   _fields = {};
   _schema;
-  _timestamp = Date.now();
-  constructor({ schema }) {
+  constructor({ schema, fields, meta }) {
     this._schema = schema;
-  }
-  get externalMeta() {
-    const _hash = PayloadHasher.hashAsync(this.hashableFields);
-    return {
-      _client: this._client,
-      _hash,
-      _timestamp: this._timestamp
-    };
+    this._fields = fields ?? {};
+    this._$meta = meta;
   }
   get schema() {
     this._schema = this._schema ?? this._fields["schema"];
     return this._schema;
   }
+  static async build(payload) {
+    const builder = new _PayloadBuilder({
+      schema: payload.schema
+    });
+    builder.fields(payload);
+    return await builder.build();
+  }
+  static async dataHashPairs(payloads) {
+    return await Promise.all(payloads.map(async (payload) => {
+      const built = await _PayloadBuilder.build(payload);
+      return [
+        built,
+        built.$hash
+      ];
+    }));
+  }
+  static async dataHashes(payloads) {
+    return await Promise.all(payloads.map(async (payload) => {
+      const built = await _PayloadBuilder.build(payload);
+      return built.$hash;
+    }));
+  }
+  static async filterExclude(payloads = [], hash) {
+    const hashes = Array.isArray(hash) ? hash : [
+      hash
+    ];
+    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0]);
+  }
+  static async filterInclude(payloads = [], hash) {
+    const hashes = Array.isArray(hash) ? hash : [
+      hash
+    ];
+    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0]);
+  }
+  static async find(payloads = [], hash) {
+    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0];
+  }
+  /**
+  * Creates an array of payload/hash tuples based on the payloads passed in
+  * @param objs Any array of payloads
+  * @returns An array of payload/hash tuples
+  */
+  static async hashPairs(payloads) {
+    return await Promise.all(payloads.map(async (payload) => {
+      const built = await _PayloadBuilder.build(payload);
+      return [
+        built,
+        await PayloadHasher.hashAsync(built)
+      ];
+    }));
+  }
+  static async toDataHashMap(objs) {
+    const result = {};
+    for (const pair of await this.dataHashPairs(objs)) {
+      result[pair[1]] = pair[0];
+    }
+    return result;
+  }
+  /**
+  * Creates an object map of payload hashes to payloads based on the payloads passed in
+  * @param objs Any array of payloads
+  * @returns A map of hashes to payloads
+  */
+  static async toHashMap(objs) {
+    const result = {};
+    for (const pair of await this.hashPairs(objs)) {
+      result[pair[1]] = pair[0];
+    }
+    return result;
+  }
   $meta(fields) {
     this._$meta = fields;
     return this;
   }
-  async build(withExternalMeta = false) {
-    let hashableFields = this.hashableFields();
-    if (this._$meta) {
-      const $hash = await PayloadHasher.hashAsync(hashableFields);
-      hashableFields = {
-        ...hashableFields,
-        $hash,
-        $meta: this._$meta
-      };
+  async build() {
+    const dataHashableFields = this.dataHashableFields();
+    const $hash = await PayloadHasher.hashAsync(dataHashableFields);
+    const hashableFields = {
+      ...dataHashableFields,
+      $hash
+    };
+    if (this._$meta && Object.keys(this._$meta).length > 0) {
+      hashableFields["$meta"] = this._$meta;
     }
-    return withExternalMeta ? {
-      ...hashableFields,
-      ...this.externalMeta
-    } : hashableFields;
+    return hashableFields;
+  }
+  dataHashableFields() {
+    return {
+      ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, "$"), "_")),
+      schema: assertEx(this.schema, "Payload: Missing Schema")
+    };
   }
   fields(fields) {
     if (fields) {
@@ -56,12 +121,6 @@ var PayloadBuilder = class {
     }
     return this;
   }
-  hashableFields() {
-    return {
-      ...removeEmptyFields(deepOmitUnderscoreFields(this._fields)),
-      schema: assertEx(this.schema, "Payload: Missing Schema")
-    };
-  }
 };
 export {
   PayloadBuilder

package/dist/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Builder.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { deepOmitUnderscoreFields, PayloadHasher, removeEmptyFields } from '@xyo-network/hash'\nimport { AnyObject } from '@xyo-network/object'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport interface PayloadBuilderOptions {\n  schema: string\n}\n\nexport class PayloadBuilder<T extends Payload = Payload<AnyObject>> {\n  private _$meta?: AnyObject\n  private _client = 'js'\n  private _fields: Partial<T> = {}\n  private _schema: string\n  private _timestamp = Date.now()\n\n  constructor({ schema }: PayloadBuilderOptions) {\n    this._schema = schema\n  }\n\n  get externalMeta() {\n    const _hash = PayloadHasher.hashAsync(this.hashableFields)\n    return { _client: this._client, _hash, _timestamp: this._timestamp }\n  }\n\n  get schema() {\n    this._schema = this._schema ?? this._fields['schema']\n    return this._schema\n  }\n\n  $meta(fields?: AnyObject) {\n    this._$meta = fields\n    return this\n  }\n\n  async build(withExternalMeta = false) {\n    let hashableFields = this.hashableFields()\n    if (this._$meta) {\n      const $hash = await PayloadHasher.hashAsync(hashableFields)\n      hashableFields = { ...hashableFields, $hash, $meta: this._$meta }\n    }\n    return withExternalMeta ? { ...hashableFields, ...this.externalMeta } : hashableFields\n  }\n\n  fields(fields?: Partial<T>) {\n    if (fields) {\n      this._fields = { ...this._fields, ...removeEmptyFields(fields) }\n    }\n    return this\n  }\n\n  hashableFields() {\n    return {\n      ...removeEmptyFields(deepOmitUnderscoreFields(this._fields)),\n      schema: assertEx(this.schema, 'Payload: Missing Schema'),\n    } as T\n  }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,0BAA0BC,eAAeC,yBAAyB;AAQpE,IAAMC,iBAAN,MAAMA;EATb,OASaA;;;EACHC;EACAC,UAAU;EACVC,UAAsB,CAAC;EACvBC;EACAC,aAAaC,KAAKC,IAAG;EAE7BC,YAAY,EAAEC,OAAM,GAA2B;AAC7C,SAAKL,UAAUK;EACjB;EAEA,IAAIC,eAAe;AACjB,UAAMC,QAAQC,cAAcC,UAAU,KAAKC,cAAc;AACzD,WAAO;MAAEZ,SAAS,KAAKA;MAASS;MAAON,YAAY,KAAKA;IAAW;EACrE;EAEA,IAAII,SAAS;AACX,SAAKL,UAAU,KAAKA,WAAW,KAAKD,QAAQ,QAAA;AAC5C,WAAO,KAAKC;EACd;EAEAW,MAAMC,QAAoB;AACxB,SAAKf,SAASe;AACd,WAAO;EACT;EAEA,MAAMC,MAAMC,mBAAmB,OAAO;AACpC,QAAIJ,iBAAiB,KAAKA,eAAc;AACxC,QAAI,KAAKb,QAAQ;AACf,YAAMkB,QAAQ,MAAMP,cAAcC,UAAUC,cAAAA;AAC5CA,uBAAiB;QAAE,GAAGA;QAAgBK;QAAOJ,OAAO,KAAKd;MAAO;IAClE;AACA,WAAOiB,mBAAmB;MAAE,GAAGJ;MAAgB,GAAG,KAAKJ;IAAa,IAAII;EAC1E;EAEAE,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKb,UAAU;QAAE,GAAG,KAAKA;QAAS,GAAGiB,kBAAkBJ,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;EAEAF,iBAAiB;AACf,WAAO;MACL,GAAGM,kBAAkBC,yBAAyB,KAAKlB,OAAO,CAAA;MAC1DM,QAAQa,SAAS,KAAKb,QAAQ,yBAAA;IAChC;EACF;AACF;","names":["assertEx","deepOmitUnderscoreFields","PayloadHasher","removeEmptyFields","PayloadBuilder","_$meta","_client","_fields","_schema","_timestamp","Date","now","constructor","schema","externalMeta","_hash","PayloadHasher","hashAsync","hashableFields","$meta","fields","build","withExternalMeta","$hash","removeEmptyFields","deepOmitUnderscoreFields","assertEx"]}
+{"version":3,"sources":["../../src/Builder.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { 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> {\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    const builder = new PayloadBuilder<T>({ schema: payload.schema })\n    builder.fields(payload)\n    return await builder.build()\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<T extends Payload>(payloads: T[]): Promise<Hash[]> {\n    return await Promise.all(\n      payloads.map(async (payload) => {\n        const built = await PayloadBuilder.build(payload)\n        return built.$hash\n      }),\n    )\n  }\n\n  static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async filterInclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n    const hashes = Array.isArray(hash) ? hash : [hash]\n    return (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map((pair) => pair[0])\n  }\n\n  static async find<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n    return (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n  }\n\n  /**\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 PayloadHasher.hashAsync(built)]\n      }),\n    )\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(fields?: JsonObject) {\n    this._$meta = fields\n    return this\n  }\n\n  async build(): Promise<WithMeta<T>> {\n    const dataHashableFields = this.dataHashableFields()\n    const $hash = await PayloadHasher.hashAsync(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,iBAAN,MAAMA,gBAAAA;EAZb,OAYaA;;;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;AAChD,UAAMC,UAAU,IAAIV,gBAAkB;MAAEK,QAAQI,QAAQJ;IAAO,CAAA;AAC/DK,YAAQJ,OAAOG,OAAAA;AACf,WAAO,MAAMC,QAAQF,MAAK;EAC5B;EAEA,aAAaG,cAAiCC,UAA+C;AAC3F,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAON,YAAAA;AAClB,YAAMO,QAAQ,MAAMhB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACO;QAAOA,MAAMC;;IACvB,CAAA,CAAA;EAEJ;EAEA,aAAaC,WAA8BN,UAAgC;AACzE,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAI,OAAON,YAAAA;AAClB,YAAMO,QAAQ,MAAMhB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAOO,MAAMC;IACf,CAAA,CAAA;EAEJ;EAEA,aAAaE,cAAiCP,WAAgB,CAAA,GAAIQ,MAAmC;AACnG,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,MAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACN,OAAOO,SAASD,OAAAA,CAAAA,GAAWZ,IAAI,CAACc,SAASA,KAAK,CAAA,CAAE;EACpH;EAEA,aAAaC,cAAiClB,WAAgB,CAAA,GAAIQ,MAAmC;AACnG,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,MAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaN,OAAOO,SAASD,OAAAA,CAAAA,GAAWZ,IAAI,CAACc,SAASA,KAAK,CAAA,CAAE;EACnH;EAEA,aAAaE,KAAwBnB,WAAgB,CAAA,GAAIQ,MAAoC;AAC3F,YAAQ,MAAM,KAAKI,UAAUZ,QAAAA,GAAWmB,KAAK,CAAC,CAACL,GAAGC,OAAAA,MAAaA,YAAYP,IAAAA,IAAQ,CAAA;EACrF;;;;;;EAOA,aAAaI,UAA6BZ,UAA+C;AACvF,WAAO,MAAMC,QAAQC,IACnBF,SAASG,IAAkC,OAAON,YAAAA;AAChD,YAAMO,QAAQ,MAAMhB,gBAAeQ,MAAMC,OAAAA;AACzC,aAAO;QAACO;QAAO,MAAMgB,cAAcC,UAAUjB,KAAAA;;IAC/C,CAAA,CAAA;EAEJ;EAEA,aAAakB,cAAiCC,MAAqC;AACjF,UAAMC,SAA0B,CAAC;AACjC,eAAWP,QAAQ,MAAM,KAAKlB,cAAcwB,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,KAAKL,UAAUW,IAAAA,GAAO;AAC7CC,aAAOP,KAAK,CAAA,CAAE,IAAIA,KAAK,CAAA;IACzB;AACA,WAAOO;EACT;EAEAE,MAAMhC,QAAqB;AACzB,SAAKL,SAASK;AACd,WAAO;EACT;EAEA,MAAME,QAA8B;AAClC,UAAM+B,qBAAqB,KAAKA,mBAAkB;AAClD,UAAMtB,QAAQ,MAAMe,cAAcC,UAAUM,kBAAAA;AAC5C,UAAMC,iBAAkC;MAAE,GAAGD;MAAoBtB;IAAM;AAGvE,QAAI,KAAKhB,UAAUwC,OAAOC,KAAK,KAAKzC,MAAM,EAAE0C,SAAS,GAAG;AACtDH,qBAAe,OAAA,IAAW,KAAKvC;IACjC;AACA,WAAOuC;EACT;EAEAD,qBAAqB;AACnB,WAAO;MACL,GAAGK,kBAAkBC,uBAAuBA,uBAAuB,KAAK3C,SAAS,GAAA,GAAM,GAAA,CAAA;MACvFG,QAAQyC,SAAS,KAAKzC,QAAQ,yBAAA;IAChC;EACF;EAEAC,OAAOA,QAAqB;AAC1B,QAAIA,QAAQ;AACV,WAAKJ,UAAU;QAAE,GAAG,KAAKA;QAAS,GAAG0C,kBAAkBtC,MAAAA;MAAQ;IACjE;AACA,WAAO;EACT;AACF;","names":["assertEx","deepOmitPrefixedFields","PayloadHasher","removeEmptyFields","PayloadBuilder","_$meta","_fields","_schema","constructor","schema","fields","meta","build","payload","builder","dataHashPairs","payloads","Promise","all","map","built","$hash","dataHashes","filterExclude","hash","hashes","Array","isArray","hashPairs","filter","_","objHash","includes","pair","filterInclude","find","PayloadHasher","hashAsync","toDataHashMap","objs","result","toHashMap","$meta","dataHashableFields","hashableFields","Object","keys","length","removeEmptyFields","deepOmitPrefixedFields","assertEx"]}

package/dist/node/Builder.d.cts

@@ -1,24 +1,39 @@
-import { AnyObject } from '@xyo-network/object';
-import { Payload } from '@xyo-network/payload-model';
-export interface PayloadBuilderOptions {
+import { Hash } from '@xylabs/hex';
+import { JsonObject } from '@xylabs/object';
+import { Payload, WithMeta } from '@xyo-network/payload-model';
+export interface PayloadBuilderOptions<T> {
+    fields?: Partial<T>;
+    meta?: JsonObject;
     schema: string;
 }
-export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
+export declare class PayloadBuilder<T extends Payload = Payload> {
     private _$meta?;
-    private _client;
     private _fields;
     private _schema;
-    private _timestamp;
-    constructor({ schema }: PayloadBuilderOptions);
-    get externalMeta(): {
-        _client: string;
-        _hash: Promise<string>;
-        _timestamp: number;
-    };
+    constructor({ schema, fields, meta }: PayloadBuilderOptions<T>);
     get schema(): string;
-    $meta(fields?: AnyObject): this;
-    build(withExternalMeta?: boolean): Promise<T>;
+    static build<T extends Payload>(payload: T): Promise<WithMeta<T>>;
+    static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
+    static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static filterInclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
+    static find<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
+    /**
+     * Creates an array of payload/hash tuples based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns An array of payload/hash tuples
+     */
+    static hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
+    static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    /**
+     * Creates an object map of payload hashes to payloads based on the payloads passed in
+     * @param objs Any array of payloads
+     * @returns A map of hashes to payloads
+     */
+    static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
+    $meta(fields?: JsonObject): this;
+    build(): Promise<WithMeta<T>>;
+    dataHashableFields(): T;
     fields(fields?: Partial<T>): this;
-    hashableFields(): T;
 }
 //# sourceMappingURL=Builder.d.ts.map