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

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.
Files changed (22) hide show
  1. package/dist/browser/Builder.d.cts +30 -15
  2. package/dist/browser/Builder.d.cts.map +1 -1
  3. package/dist/browser/Builder.d.mts +30 -15
  4. package/dist/browser/Builder.d.mts.map +1 -1
  5. package/dist/browser/Builder.d.ts +30 -15
  6. package/dist/browser/Builder.d.ts.map +1 -1
  7. package/dist/browser/index.cjs +90 -31
  8. package/dist/browser/index.cjs.map +1 -1
  9. package/dist/browser/index.js +91 -32
  10. package/dist/browser/index.js.map +1 -1
  11. package/dist/node/Builder.d.cts +30 -15
  12. package/dist/node/Builder.d.cts.map +1 -1
  13. package/dist/node/Builder.d.mts +30 -15
  14. package/dist/node/Builder.d.mts.map +1 -1
  15. package/dist/node/Builder.d.ts +30 -15
  16. package/dist/node/Builder.d.ts.map +1 -1
  17. package/dist/node/index.cjs +92 -30
  18. package/dist/node/index.cjs.map +1 -1
  19. package/dist/node/index.js +93 -31
  20. package/dist/node/index.js.map +1 -1
  21. package/package.json +8 -6
  22. package/src/Builder.ts +102 -28
package/dist/node/Builder.d.cts.map CHANGED
@@ -1 +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"}
1
+ {"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/node/Builder.d.mts CHANGED
@@ -1,24 +1,39 @@
1
- import { AnyObject } from '@xyo-network/object';
2
- import { Payload } from '@xyo-network/payload-model';
3
- export interface PayloadBuilderOptions {
1
+ import { Hash } from '@xylabs/hex';
2
+ import { JsonObject } from '@xylabs/object';
3
+ import { Payload, WithMeta } from '@xyo-network/payload-model';
4
+ export interface PayloadBuilderOptions<T> {
5
+ fields?: Partial<T>;
6
+ meta?: JsonObject;
4
7
  schema: string;
5
8
  }
6
- export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
9
+ export declare class PayloadBuilder<T extends Payload = Payload> {
7
10
  private _$meta?;
8
- private _client;
9
11
  private _fields;
10
12
  private _schema;
11
- private _timestamp;
12
- constructor({ schema }: PayloadBuilderOptions);
13
- get externalMeta(): {
14
- _client: string;
15
- _hash: Promise<string>;
16
- _timestamp: number;
17
- };
13
+ constructor({ schema, fields, meta }: PayloadBuilderOptions<T>);
18
14
  get schema(): string;
19
- $meta(fields?: AnyObject): this;
20
- build(withExternalMeta?: boolean): Promise<T>;
15
+ static build<T extends Payload>(payload: T): Promise<WithMeta<T>>;
16
+ static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
17
+ static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
18
+ static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
19
+ static filterInclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
20
+ static find<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
21
+ /**
22
+ * Creates an array of payload/hash tuples based on the payloads passed in
23
+ * @param objs Any array of payloads
24
+ * @returns An array of payload/hash tuples
25
+ */
26
+ static hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
27
+ static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
28
+ /**
29
+ * Creates an object map of payload hashes to payloads based on the payloads passed in
30
+ * @param objs Any array of payloads
31
+ * @returns A map of hashes to payloads
32
+ */
33
+ static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
34
+ $meta(fields?: JsonObject): this;
35
+ build(): Promise<WithMeta<T>>;
36
+ dataHashableFields(): T;
21
37
  fields(fields?: Partial<T>): this;
22
- hashableFields(): T;
23
38
  }
24
39
  //# sourceMappingURL=Builder.d.ts.map
package/dist/node/Builder.d.mts.map CHANGED
@@ -1 +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"}
1
+ {"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/node/Builder.d.ts CHANGED
@@ -1,24 +1,39 @@
1
- import { AnyObject } from '@xyo-network/object';
2
- import { Payload } from '@xyo-network/payload-model';
3
- export interface PayloadBuilderOptions {
1
+ import { Hash } from '@xylabs/hex';
2
+ import { JsonObject } from '@xylabs/object';
3
+ import { Payload, WithMeta } from '@xyo-network/payload-model';
4
+ export interface PayloadBuilderOptions<T> {
5
+ fields?: Partial<T>;
6
+ meta?: JsonObject;
4
7
  schema: string;
5
8
  }
6
- export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>> {
9
+ export declare class PayloadBuilder<T extends Payload = Payload> {
7
10
  private _$meta?;
8
- private _client;
9
11
  private _fields;
10
12
  private _schema;
11
- private _timestamp;
12
- constructor({ schema }: PayloadBuilderOptions);
13
- get externalMeta(): {
14
- _client: string;
15
- _hash: Promise<string>;
16
- _timestamp: number;
17
- };
13
+ constructor({ schema, fields, meta }: PayloadBuilderOptions<T>);
18
14
  get schema(): string;
19
- $meta(fields?: AnyObject): this;
20
- build(withExternalMeta?: boolean): Promise<T>;
15
+ static build<T extends Payload>(payload: T): Promise<WithMeta<T>>;
16
+ static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
17
+ static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
18
+ static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
19
+ static filterInclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
20
+ static find<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
21
+ /**
22
+ * Creates an array of payload/hash tuples based on the payloads passed in
23
+ * @param objs Any array of payloads
24
+ * @returns An array of payload/hash tuples
25
+ */
26
+ static hashPairs<T extends Payload>(payloads: T[]): Promise<[WithMeta<T>, Hash][]>;
27
+ static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
28
+ /**
29
+ * Creates an object map of payload hashes to payloads based on the payloads passed in
30
+ * @param objs Any array of payloads
31
+ * @returns A map of hashes to payloads
32
+ */
33
+ static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
34
+ $meta(fields?: JsonObject): this;
35
+ build(): Promise<WithMeta<T>>;
36
+ dataHashableFields(): T;
21
37
  fields(fields?: Partial<T>): this;
22
- hashableFields(): T;
23
38
  }
24
39
  //# sourceMappingURL=Builder.d.ts.map
package/dist/node/Builder.d.ts.map CHANGED
@@ -1 +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"}
1
+ {"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/node/index.cjs CHANGED
@@ -30,43 +30,111 @@ var import_assert = require("@xylabs/assert");
30
30
  var import_hash = require("@xyo-network/hash");
31
31
  var _PayloadBuilder = class _PayloadBuilder {
32
32
  _$meta;
33
- _client = "js";
34
33
  _fields = {};
35
34
  _schema;
36
- _timestamp = Date.now();
37
- constructor({ schema }) {
35
+ constructor({ schema, fields, meta }) {
38
36
  this._schema = schema;
39
- }
40
- get externalMeta() {
41
- const _hash = import_hash.PayloadHasher.hashAsync(this.hashableFields);
42
- return {
43
- _client: this._client,
44
- _hash,
45
- _timestamp: this._timestamp
46
- };
37
+ this._fields = fields ?? {};
38
+ this._$meta = meta;
47
39
  }
48
40
  get schema() {
49
41
  this._schema = this._schema ?? this._fields["schema"];
50
42
  return this._schema;
51
43
  }
44
+ static async build(payload) {
45
+ const builder = new _PayloadBuilder({
46
+ schema: payload.schema
47
+ });
48
+ builder.fields(payload);
49
+ return await builder.build();
50
+ }
51
+ static async dataHashPairs(payloads) {
52
+ return await Promise.all(payloads.map(async (payload) => {
53
+ const built = await _PayloadBuilder.build(payload);
54
+ return [
55
+ built,
56
+ built.$hash
57
+ ];
58
+ }));
59
+ }
60
+ static async dataHashes(payloads) {
61
+ return await Promise.all(payloads.map(async (payload) => {
62
+ const built = await _PayloadBuilder.build(payload);
63
+ return built.$hash;
64
+ }));
65
+ }
66
+ static async filterExclude(payloads = [], hash) {
67
+ var _a;
68
+ const hashes = Array.isArray(hash) ? hash : [
69
+ hash
70
+ ];
71
+ return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
72
+ }
73
+ static async filterInclude(payloads = [], hash) {
74
+ var _a;
75
+ const hashes = Array.isArray(hash) ? hash : [
76
+ hash
77
+ ];
78
+ return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
79
+ }
80
+ static async find(payloads = [], hash) {
81
+ var _a;
82
+ return (_a = (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)) == null ? void 0 : _a[0];
83
+ }
84
+ /**
85
+ * Creates an array of payload/hash tuples based on the payloads passed in
86
+ * @param objs Any array of payloads
87
+ * @returns An array of payload/hash tuples
88
+ */
89
+ static async hashPairs(payloads) {
90
+ return await Promise.all(payloads.map(async (payload) => {
91
+ const built = await _PayloadBuilder.build(payload);
92
+ return [
93
+ built,
94
+ await import_hash.PayloadHasher.hashAsync(built)
95
+ ];
96
+ }));
97
+ }
98
+ static async toDataHashMap(objs) {
99
+ const result = {};
100
+ for (const pair of await this.dataHashPairs(objs)) {
101
+ result[pair[1]] = pair[0];
102
+ }
103
+ return result;
104
+ }
105
+ /**
106
+ * Creates an object map of payload hashes to payloads based on the payloads passed in
107
+ * @param objs Any array of payloads
108
+ * @returns A map of hashes to payloads
109
+ */
110
+ static async toHashMap(objs) {
111
+ const result = {};
112
+ for (const pair of await this.hashPairs(objs)) {
113
+ result[pair[1]] = pair[0];
114
+ }
115
+ return result;
116
+ }
52
117
  $meta(fields) {
53
118
  this._$meta = fields;
54
119
  return this;
55
120
  }
56
- async build(withExternalMeta = false) {
57
- let hashableFields = this.hashableFields();
58
- if (this._$meta) {
59
- const $hash = await import_hash.PayloadHasher.hashAsync(hashableFields);
60
- hashableFields = {
61
- ...hashableFields,
62
- $hash,
63
- $meta: this._$meta
64
- };
121
+ async build() {
122
+ const dataHashableFields = this.dataHashableFields();
123
+ const $hash = await import_hash.PayloadHasher.hashAsync(dataHashableFields);
124
+ const hashableFields = {
125
+ ...dataHashableFields,
126
+ $hash
127
+ };
128
+ if (this._$meta && Object.keys(this._$meta).length > 0) {
129
+ hashableFields["$meta"] = this._$meta;
65
130
  }
66
- return withExternalMeta ? {
67
- ...hashableFields,
68
- ...this.externalMeta
69
- } : hashableFields;
131
+ return hashableFields;
132
+ }
133
+ dataHashableFields() {
134
+ return {
135
+ ...(0, import_hash.removeEmptyFields)((0, import_hash.deepOmitPrefixedFields)((0, import_hash.deepOmitPrefixedFields)(this._fields, "$"), "_")),
136
+ schema: (0, import_assert.assertEx)(this.schema, "Payload: Missing Schema")
137
+ };
70
138
  }
71
139
  fields(fields) {
72
140
  if (fields) {
@@ -77,12 +145,6 @@ var _PayloadBuilder = class _PayloadBuilder {
77
145
  }
78
146
  return this;
79
147
  }
80
- hashableFields() {
81
- return {
82
- ...(0, import_hash.removeEmptyFields)((0, import_hash.deepOmitUnderscoreFields)(this._fields)),
83
- schema: (0, import_assert.assertEx)(this.schema, "Payload: Missing Schema")
84
- };
85
- }
86
148
  };
87
149
  __name(_PayloadBuilder, "PayloadBuilder");
88
150
  var PayloadBuilder = _PayloadBuilder;
package/dist/node/index.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/index.ts","../../src/Builder.ts"],"sourcesContent":["export * from './Builder'\n","import { assertEx } from '@xylabs/assert'\nimport { 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,kBAAN,MAAMA,gBAAAA;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;AAhDaT;AAAN,IAAMA,iBAAN;","names":["PayloadBuilder","_$meta","_client","_fields","_schema","_timestamp","Date","now","constructor","schema","externalMeta","_hash","PayloadHasher","hashAsync","hashableFields","$meta","fields","build","withExternalMeta","$hash","removeEmptyFields","deepOmitUnderscoreFields","assertEx"]}
1
+ {"version":3,"sources":["../../src/index.ts","../../src/Builder.ts"],"sourcesContent":["export * from './Builder'\n","import { assertEx } from '@xylabs/assert'\nimport { Hash } from '@xylabs/hex'\nimport { 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,kBAAN,MAAMA,gBAAAA;EACHC;EACAC,UAAsB,CAAC;EACvBC;EAERC,YAAY,EAAEC,QAAQC,QAAQC,KAAI,GAA8B;AAC9D,SAAKJ,UAAUE;AACf,SAAKH,UAAUI,UAAU,CAAC;AAC1B,SAAKL,SAASM;EAChB;EAEA,IAAIF,SAAS;AACX,SAAKF,UAAU,KAAKA,WAAW,KAAKD,QAAQ,QAAA;AAC5C,WAAO,KAAKC;EACd;EAEA,aAAaK,MAAyBC,SAAY;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;AApDvG;AAqDI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACN,OAAOO,SAASD,OAAAA,CAAAA,MAA1E,mBAAqFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EAClH;EAEA,aAAaC,cAAiClB,WAAgB,CAAA,GAAIQ,MAAmC;AAzDvG;AA0DI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaN,OAAOO,SAASD,OAAAA,CAAAA,MAAzE,mBAAoFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EACjH;EAEA,aAAaE,KAAwBnB,WAAgB,CAAA,GAAIQ,MAAoC;AA9D/F;AA+DI,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWmB,KAAK,CAAC,CAACL,GAAGC,OAAAA,MAAaA,YAAYP,IAAAA,MAAnE,mBAA2E;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;AAvHaN;AAAN,IAAMA,iBAAN;","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/node/index.js CHANGED
@@ -3,46 +3,114 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
3
3
 
4
4
  // src/Builder.ts
5
5
  import { assertEx } from "@xylabs/assert";
6
- import { deepOmitUnderscoreFields, PayloadHasher, removeEmptyFields } from "@xyo-network/hash";
6
+ import { deepOmitPrefixedFields, PayloadHasher, removeEmptyFields } from "@xyo-network/hash";
7
7
  var _PayloadBuilder = class _PayloadBuilder {
8
8
  _$meta;
9
- _client = "js";
10
9
  _fields = {};
11
10
  _schema;
12
- _timestamp = Date.now();
13
- constructor({ schema }) {
11
+ constructor({ schema, fields, meta }) {
14
12
  this._schema = schema;
15
- }
16
- get externalMeta() {
17
- const _hash = PayloadHasher.hashAsync(this.hashableFields);
18
- return {
19
- _client: this._client,
20
- _hash,
21
- _timestamp: this._timestamp
22
- };
13
+ this._fields = fields ?? {};
14
+ this._$meta = meta;
23
15
  }
24
16
  get schema() {
25
17
  this._schema = this._schema ?? this._fields["schema"];
26
18
  return this._schema;
27
19
  }
20
+ static async build(payload) {
21
+ const builder = new _PayloadBuilder({
22
+ schema: payload.schema
23
+ });
24
+ builder.fields(payload);
25
+ return await builder.build();
26
+ }
27
+ static async dataHashPairs(payloads) {
28
+ return await Promise.all(payloads.map(async (payload) => {
29
+ const built = await _PayloadBuilder.build(payload);
30
+ return [
31
+ built,
32
+ built.$hash
33
+ ];
34
+ }));
35
+ }
36
+ static async dataHashes(payloads) {
37
+ return await Promise.all(payloads.map(async (payload) => {
38
+ const built = await _PayloadBuilder.build(payload);
39
+ return built.$hash;
40
+ }));
41
+ }
42
+ static async filterExclude(payloads = [], hash) {
43
+ var _a;
44
+ const hashes = Array.isArray(hash) ? hash : [
45
+ hash
46
+ ];
47
+ return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
48
+ }
49
+ static async filterInclude(payloads = [], hash) {
50
+ var _a;
51
+ const hashes = Array.isArray(hash) ? hash : [
52
+ hash
53
+ ];
54
+ return (_a = (await this.hashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))) == null ? void 0 : _a.map((pair) => pair[0]);
55
+ }
56
+ static async find(payloads = [], hash) {
57
+ var _a;
58
+ return (_a = (await this.hashPairs(payloads)).find(([_, objHash]) => objHash === hash)) == null ? void 0 : _a[0];
59
+ }
60
+ /**
61
+ * Creates an array of payload/hash tuples based on the payloads passed in
62
+ * @param objs Any array of payloads
63
+ * @returns An array of payload/hash tuples
64
+ */
65
+ static async hashPairs(payloads) {
66
+ return await Promise.all(payloads.map(async (payload) => {
67
+ const built = await _PayloadBuilder.build(payload);
68
+ return [
69
+ built,
70
+ await PayloadHasher.hashAsync(built)
71
+ ];
72
+ }));
73
+ }
74
+ static async toDataHashMap(objs) {
75
+ const result = {};
76
+ for (const pair of await this.dataHashPairs(objs)) {
77
+ result[pair[1]] = pair[0];
78
+ }
79
+ return result;
80
+ }
81
+ /**
82
+ * Creates an object map of payload hashes to payloads based on the payloads passed in
83
+ * @param objs Any array of payloads
84
+ * @returns A map of hashes to payloads
85
+ */
86
+ static async toHashMap(objs) {
87
+ const result = {};
88
+ for (const pair of await this.hashPairs(objs)) {
89
+ result[pair[1]] = pair[0];
90
+ }
91
+ return result;
92
+ }
28
93
  $meta(fields) {
29
94
  this._$meta = fields;
30
95
  return this;
31
96
  }
32
- async build(withExternalMeta = false) {
33
- let hashableFields = this.hashableFields();
34
- if (this._$meta) {
35
- const $hash = await PayloadHasher.hashAsync(hashableFields);
36
- hashableFields = {
37
- ...hashableFields,
38
- $hash,
39
- $meta: this._$meta
40
- };
97
+ async build() {
98
+ const dataHashableFields = this.dataHashableFields();
99
+ const $hash = await PayloadHasher.hashAsync(dataHashableFields);
100
+ const hashableFields = {
101
+ ...dataHashableFields,
102
+ $hash
103
+ };
104
+ if (this._$meta && Object.keys(this._$meta).length > 0) {
105
+ hashableFields["$meta"] = this._$meta;
41
106
  }
42
- return withExternalMeta ? {
43
- ...hashableFields,
44
- ...this.externalMeta
45
- } : hashableFields;
107
+ return hashableFields;
108
+ }
109
+ dataHashableFields() {
110
+ return {
111
+ ...removeEmptyFields(deepOmitPrefixedFields(deepOmitPrefixedFields(this._fields, "$"), "_")),
112
+ schema: assertEx(this.schema, "Payload: Missing Schema")
113
+ };
46
114
  }
47
115
  fields(fields) {
48
116
  if (fields) {
@@ -53,12 +121,6 @@ var _PayloadBuilder = class _PayloadBuilder {
53
121
  }
54
122
  return this;
55
123
  }
56
- hashableFields() {
57
- return {
58
- ...removeEmptyFields(deepOmitUnderscoreFields(this._fields)),
59
- schema: assertEx(this.schema, "Payload: Missing Schema")
60
- };
61
- }
62
124
  };
63
125
  __name(_PayloadBuilder, "PayloadBuilder");
64
126
  var PayloadBuilder = _PayloadBuilder;
package/dist/node/index.js.map CHANGED
@@ -1 +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,kBAAN,MAAMA,gBAAAA;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;AAhDaT;AAAN,IAAMA,iBAAN;","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"]}
1
+ {"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,kBAAN,MAAMA,gBAAAA;EACHC;EACAC,UAAsB,CAAC;EACvBC;EAERC,YAAY,EAAEC,QAAQC,QAAQC,KAAI,GAA8B;AAC9D,SAAKJ,UAAUE;AACf,SAAKH,UAAUI,UAAU,CAAC;AAC1B,SAAKL,SAASM;EAChB;EAEA,IAAIF,SAAS;AACX,SAAKF,UAAU,KAAKA,WAAW,KAAKD,QAAQ,QAAA;AAC5C,WAAO,KAAKC;EACd;EAEA,aAAaK,MAAyBC,SAAY;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;AApDvG;AAqDI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAa,CAACN,OAAOO,SAASD,OAAAA,CAAAA,MAA1E,mBAAqFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EAClH;EAEA,aAAaC,cAAiClB,WAAgB,CAAA,GAAIQ,MAAmC;AAzDvG;AA0DI,UAAMC,SAASC,MAAMC,QAAQH,IAAAA,IAAQA,OAAO;MAACA;;AAC7C,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWa,OAAO,CAAC,CAACC,GAAGC,OAAAA,MAAaN,OAAOO,SAASD,OAAAA,CAAAA,MAAzE,mBAAoFZ,IAAI,CAACc,SAASA,KAAK,CAAA;EACjH;EAEA,aAAaE,KAAwBnB,WAAgB,CAAA,GAAIQ,MAAoC;AA9D/F;AA+DI,YAAQ,YAAM,KAAKI,UAAUZ,QAAAA,GAAWmB,KAAK,CAAC,CAACL,GAAGC,OAAAA,MAAaA,YAAYP,IAAAA,MAAnE,mBAA2E;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;AAvHaN;AAAN,IAAMA,iBAAN;","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/package.json CHANGED
@@ -10,10 +10,11 @@
10
10
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
11
  },
12
12
  "dependencies": {
13
- "@xylabs/assert": "^2.13.25",
14
- "@xyo-network/hash": "~2.88.2",
15
- "@xyo-network/object": "~2.88.2",
16
- "@xyo-network/payload-model": "~2.88.2"
13
+ "@xylabs/assert": "^2.13.29",
14
+ "@xylabs/hex": "^2.13.29",
15
+ "@xylabs/object": "^2.88.5",
16
+ "@xyo-network/hash": "~2.89.0-rc.1",
17
+ "@xyo-network/payload-model": "~2.89.0-rc.1"
17
18
  },
18
19
  "devDependencies": {
19
20
  "@xylabs/ts-scripts-yarn3": "^3.2.42",
@@ -59,6 +60,7 @@
59
60
  },
60
61
  "sideEffects": false,
61
62
  "types": "dist/node/index.d.ts",
62
- "version": "2.88.2",
63
- "type": "module"
63
+ "version": "2.89.0-rc.1",
64
+ "type": "module",
65
+ "stableVersion": "2.88.3"
64
66
  }