@xyo-network/payload-builder 3.5.2 → 3.6.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/Builder.d.ts +19 -25
- package/dist/browser/Builder.d.ts.map +1 -1
- package/dist/browser/BuilderBase.d.ts +15 -13
- package/dist/browser/BuilderBase.d.ts.map +1 -1
- package/dist/browser/Options.d.ts +1 -1
- package/dist/browser/Options.d.ts.map +1 -1
- package/dist/browser/index.mjs +87 -140
- package/dist/browser/index.mjs.map +1 -1
- package/dist/neutral/Builder.d.ts +19 -25
- package/dist/neutral/Builder.d.ts.map +1 -1
- package/dist/neutral/BuilderBase.d.ts +15 -13
- package/dist/neutral/BuilderBase.d.ts.map +1 -1
- package/dist/neutral/Options.d.ts +1 -1
- package/dist/neutral/Options.d.ts.map +1 -1
- package/dist/neutral/index.mjs +87 -140
- package/dist/neutral/index.mjs.map +1 -1
- package/dist/node/Builder.d.ts +19 -25
- package/dist/node/Builder.d.ts.map +1 -1
- package/dist/node/BuilderBase.d.ts +15 -13
- package/dist/node/BuilderBase.d.ts.map +1 -1
- package/dist/node/Options.d.ts +1 -1
- package/dist/node/Options.d.ts.map +1 -1
- package/dist/node/index.mjs +87 -140
- package/dist/node/index.mjs.map +1 -1
- package/package.json +12 -11
- package/src/Builder.ts +92 -140
- package/src/BuilderBase.ts +41 -50
- package/src/Options.ts +1 -1
package/dist/node/Builder.d.ts
CHANGED
|
@@ -1,46 +1,40 @@
|
|
|
1
|
-
import type { Hash } from '@xylabs/hex';
|
|
2
|
-
import type { AnyObject
|
|
3
|
-
import type
|
|
4
|
-
import type { WithoutMeta, WithoutSchema } from './BuilderBase.ts';
|
|
1
|
+
import type { Hash, Hex } from '@xylabs/hex';
|
|
2
|
+
import type { AnyObject } from '@xylabs/object';
|
|
3
|
+
import { type Payload, type WithStorageMeta } from '@xyo-network/payload-model';
|
|
5
4
|
import { PayloadBuilderBase } from './BuilderBase.ts';
|
|
6
5
|
import type { PayloadBuilderOptions } from './Options.ts';
|
|
7
|
-
export interface BuildOptions {
|
|
8
|
-
stamp?: boolean;
|
|
9
|
-
validate?: boolean;
|
|
10
|
-
}
|
|
11
6
|
export declare class PayloadBuilder<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> extends PayloadBuilderBase<T, O> {
|
|
12
|
-
static
|
|
13
|
-
static
|
|
14
|
-
static
|
|
15
|
-
static
|
|
16
|
-
static
|
|
17
|
-
static
|
|
7
|
+
static addSequencedStorageMeta<T extends Payload = Payload>(payload: T, hash?: Hash, dataHash?: Hash): Promise<WithStorageMeta<T>>;
|
|
8
|
+
static addStorageMeta<T extends Payload>(payload: T): Promise<WithStorageMeta<T>>;
|
|
9
|
+
static addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>;
|
|
10
|
+
static buildSequence(epoch: number, nonce: Hex): Hex;
|
|
11
|
+
static dataHash<T extends Payload>(payload: T): Promise<Hash>;
|
|
12
|
+
static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
|
|
13
|
+
static dataHashes(payloads: undefined): Promise<undefined>;
|
|
14
|
+
static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
|
|
18
15
|
static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
|
|
19
16
|
static filterExcludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
|
|
20
17
|
static filterIncludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
|
|
21
18
|
static findByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
|
|
22
|
-
static hash<T extends Payload>(payload: T
|
|
19
|
+
static hash<T extends Payload>(payload: T): Promise<Hash>;
|
|
23
20
|
/**
|
|
24
21
|
* Creates an array of payload/hash tuples based on the payloads passed in
|
|
25
22
|
* @param objs Any array of payloads
|
|
26
23
|
* @returns An array of payload/hash tuples
|
|
27
24
|
*/
|
|
28
|
-
static hashPairs<T extends Payload>(payloads: T[]
|
|
29
|
-
static hashableFields<T extends Payload
|
|
25
|
+
static hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
|
|
26
|
+
static hashableFields<T extends Payload>(payload: T): T;
|
|
30
27
|
static hashes(payloads: undefined): Promise<undefined>;
|
|
31
28
|
static hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
|
|
32
|
-
static
|
|
33
|
-
static
|
|
29
|
+
static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction?: -1 | 1): WithStorageMeta<T>[];
|
|
30
|
+
static toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>>;
|
|
31
|
+
static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
|
|
34
32
|
/**
|
|
35
33
|
* Creates an object map of payload hashes to payloads based on the payloads passed in
|
|
36
34
|
* @param objs Any array of payloads
|
|
37
35
|
* @returns A map of hashes to payloads
|
|
38
36
|
*/
|
|
39
|
-
static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash,
|
|
40
|
-
|
|
41
|
-
static withoutMeta<T extends PayloadWithMeta>(payload: T): Omit<T, '$meta'>;
|
|
42
|
-
static withoutMeta<T extends PayloadWithMeta>(payloads: T[]): Omit<T, '$meta'>[];
|
|
43
|
-
build(options?: BuildOptions): Promise<WithMeta<T>>;
|
|
44
|
-
hashableFields(): Promise<WithMeta<T>>;
|
|
37
|
+
static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
|
|
38
|
+
build(): T;
|
|
45
39
|
}
|
|
46
40
|
//# sourceMappingURL=Builder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/Builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,IAAI,EACJ,GAAG,EACJ,MAAM,aAAa,CAAA;AAIpB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,EACL,KAAK,OAAO,EAAwB,KAAK,eAAe,EACzD,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,qBAAa,cAAc,CACzB,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,EACtC,CAAC,SAAS,qBAAqB,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAC7D,SAAQ,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;WACnB,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;WAY3H,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;WAC1E,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;IAe5F,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG;WAavC,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;WAItD,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;WASrE,UAAU,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;WACnD,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;WAW7D,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAIvF,uBAAuB,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKjG,uBAAuB,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;WAKjG,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAK,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;WAIzF,IAAI,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;;OAIG;WACU,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;IAQ9E,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,OAAO,EACrC,OAAO,EAAE,CAAC,GACT,CAAC;WAIS,MAAM,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;WAC/C,MAAM,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAKtE,MAAM,CAAC,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,GAAE,CAAC,CAAC,GAAG,CAAK;WASpF,YAAY,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;WAUxE,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,IAAI,CAAC;CAMX"}
|
|
@@ -1,24 +1,26 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { AnyObject, JsonObject } from '@xylabs/object';
|
|
1
|
+
import type { AnyObject } from '@xylabs/object';
|
|
3
2
|
import type { Promisable } from '@xylabs/promise';
|
|
4
|
-
import type { Payload, Schema
|
|
3
|
+
import type { Payload, Schema } from '@xyo-network/payload-model';
|
|
5
4
|
import type { PayloadBuilderOptions } from './Options.ts';
|
|
6
5
|
export type WithOptionalSchema<T extends Payload> = Omit<T, 'schema'> & Partial<T>;
|
|
7
6
|
export type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>;
|
|
8
|
-
export
|
|
9
|
-
export declare const removeMetaAndSchema: <T extends Payload>(payload: WithOptionalSchema<WithOptionalMeta<T>>) => WithoutSchema<WithoutMeta<T>>;
|
|
7
|
+
export declare const removeMetaAndSchema: <T extends Payload>(payload: Partial<WithOptionalSchema<T>>) => WithoutSchema<T>;
|
|
10
8
|
export declare class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {
|
|
11
9
|
readonly options: O;
|
|
12
|
-
protected
|
|
13
|
-
protected _fields?: WithoutSchema<WithoutMeta<T>>;
|
|
10
|
+
protected _fields?: Partial<WithoutSchema<T>>;
|
|
14
11
|
protected _schema: Schema;
|
|
15
12
|
constructor(options: O);
|
|
16
|
-
static dataHashableFields<T extends Payload
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
13
|
+
static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<Payload>;
|
|
14
|
+
static omitClientMeta<T extends Payload>(payload: T, maxDepth?: number): T;
|
|
15
|
+
static omitClientMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[];
|
|
16
|
+
static omitMeta<T extends Payload>(payload: T, maxDepth?: number): T;
|
|
17
|
+
static omitMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[];
|
|
18
|
+
static omitStorageMeta<T extends Payload>(payload: T, maxDepth?: number): T;
|
|
19
|
+
static omitStorageMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[];
|
|
20
|
+
dataHashableFields(): Promise<{
|
|
21
|
+
schema: string;
|
|
22
|
+
} & import("@xyo-network/payload-model").PayloadFields>;
|
|
23
|
+
fields(fields: WithOptionalSchema<T>): this;
|
|
21
24
|
schema(value: Schema): void;
|
|
22
|
-
protected metaFields(dataHash: Hash, stamp?: boolean): Promise<JsonObject>;
|
|
23
25
|
}
|
|
24
26
|
//# sourceMappingURL=BuilderBase.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BuilderBase.d.ts","sourceRoot":"","sources":["../../src/BuilderBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"BuilderBase.d.ts","sourceRoot":"","sources":["../../src/BuilderBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAI/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAGjE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAElF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,kBAAkB,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;AAEpF,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,OAAO,WAAW,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAG,aAAa,CAAC,CAAC,CAI/G,CAAA;AAOD,qBAAa,kBAAkB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,qBAAqB,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAIvH,QAAQ,CAAC,OAAO,EAAE,CAAC;IAH/B,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7C,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEJ,OAAO,EAAE,CAAC;IAM/B,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS,OAAO,EACzC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAExB,UAAU,CAAC,OAAO,CAAC;IAStB,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC;IAC1E,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE;IAO/E,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC;IACpE,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE;IAOzE,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC;IAC3E,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE;IAO1E,kBAAkB;;;IAQxB,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAYpC,MAAM,CAAC,KAAK,EAAE,MAAM;CAGrB"}
|
package/dist/node/Options.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import type { Logger } from '@xylabs/logger';
|
|
|
2
2
|
import type { JsonObject } from '@xylabs/object';
|
|
3
3
|
import type { Schema } from '@xyo-network/payload-model';
|
|
4
4
|
export interface PayloadBuilderOptions<T> {
|
|
5
|
-
readonly fields?:
|
|
5
|
+
readonly fields?: Partial<T>;
|
|
6
6
|
readonly logger?: Logger;
|
|
7
7
|
readonly meta?: JsonObject;
|
|
8
8
|
readonly schema: Schema;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Options.d.ts","sourceRoot":"","sources":["../../src/Options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"Options.d.ts","sourceRoot":"","sources":["../../src/Options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAA;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB"}
|
package/dist/node/index.mjs
CHANGED
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
// src/Builder.ts
|
|
2
2
|
import { assertEx as assertEx2 } from "@xylabs/assert";
|
|
3
|
-
import {
|
|
4
|
-
|
|
3
|
+
import {
|
|
4
|
+
isHash,
|
|
5
|
+
isHex,
|
|
6
|
+
toHex
|
|
7
|
+
} from "@xylabs/hex";
|
|
8
|
+
import { ObjectHasher } from "@xyo-network/hash";
|
|
9
|
+
import {
|
|
10
|
+
StorageMetaConstants
|
|
11
|
+
} from "@xyo-network/payload-model";
|
|
5
12
|
|
|
6
13
|
// src/BuilderBase.ts
|
|
7
14
|
import { assertEx } from "@xylabs/assert";
|
|
@@ -12,143 +19,119 @@ import {
|
|
|
12
19
|
} from "@xylabs/object";
|
|
13
20
|
import { removeEmptyFields } from "@xyo-network/hash";
|
|
14
21
|
var removeMetaAndSchema = (payload) => {
|
|
15
|
-
const { ...result } = payload;
|
|
16
|
-
delete result.$hash;
|
|
17
|
-
delete result.$meta;
|
|
22
|
+
const { ...result } = PayloadBuilder.omitMeta(payload);
|
|
18
23
|
delete result.schema;
|
|
19
24
|
return result;
|
|
20
25
|
};
|
|
21
|
-
var
|
|
26
|
+
var omitByPrefixPredicate = (prefix) => (_, key) => {
|
|
22
27
|
assertEx(typeof key === "string", () => `Invalid key type [${key}, ${typeof key}]`);
|
|
23
28
|
return key.startsWith(prefix);
|
|
24
29
|
};
|
|
25
30
|
var PayloadBuilderBase = class _PayloadBuilderBase {
|
|
26
31
|
constructor(options) {
|
|
27
32
|
this.options = options;
|
|
28
|
-
const {
|
|
29
|
-
schema,
|
|
30
|
-
fields,
|
|
31
|
-
meta
|
|
32
|
-
} = options;
|
|
33
|
+
const { schema, fields } = options;
|
|
33
34
|
this._schema = schema;
|
|
34
|
-
this._fields = removeEmptyFields(fields ?? {});
|
|
35
|
-
this._$meta = meta;
|
|
35
|
+
this._fields = removeMetaAndSchema(removeEmptyFields(structuredClone(fields ?? {})));
|
|
36
36
|
}
|
|
37
|
-
_$meta;
|
|
38
37
|
_fields;
|
|
39
38
|
_schema;
|
|
40
|
-
static dataHashableFields(schema,
|
|
41
|
-
const cleanFields =
|
|
39
|
+
static dataHashableFields(schema, payload) {
|
|
40
|
+
const cleanFields = removeEmptyFields({ ...payload, schema });
|
|
42
41
|
assertEx(
|
|
43
42
|
cleanFields === void 0 || isJsonObject(cleanFields),
|
|
44
43
|
() => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`
|
|
45
44
|
);
|
|
46
|
-
return
|
|
45
|
+
return this.omitMeta(cleanFields);
|
|
47
46
|
}
|
|
48
|
-
static
|
|
49
|
-
|
|
50
|
-
if (!meta.timestamp && stamp) {
|
|
51
|
-
meta.timestamp = meta.timestamp ?? Date.now();
|
|
52
|
-
}
|
|
53
|
-
return meta;
|
|
47
|
+
static omitClientMeta(payloads, maxDepth = 100) {
|
|
48
|
+
return Array.isArray(payloads) ? payloads.map((payload) => this.omitClientMeta(payload, maxDepth)) : omitBy(payloads, omitByPrefixPredicate("$"), maxDepth);
|
|
54
49
|
}
|
|
55
|
-
|
|
56
|
-
this.
|
|
57
|
-
|
|
50
|
+
static omitMeta(payloads, maxDepth = 100) {
|
|
51
|
+
return Array.isArray(payloads) ? this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth) : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth);
|
|
52
|
+
}
|
|
53
|
+
static omitStorageMeta(payloads, maxDepth = 100) {
|
|
54
|
+
return Array.isArray(payloads) ? payloads.map((payload) => this.omitStorageMeta(payload, maxDepth)) : omitBy(payloads, omitByPrefixPredicate("_"), maxDepth);
|
|
58
55
|
}
|
|
59
56
|
async dataHashableFields() {
|
|
60
57
|
return await _PayloadBuilderBase.dataHashableFields(
|
|
61
58
|
assertEx(this._schema, () => "Payload: Missing Schema"),
|
|
59
|
+
// TDOD: Add verification that required fields are present
|
|
62
60
|
this._fields
|
|
63
61
|
);
|
|
64
62
|
}
|
|
65
|
-
// we do not require sending in $hash since it will be generated anyway
|
|
66
63
|
fields(fields) {
|
|
67
64
|
if (fields) {
|
|
68
|
-
const
|
|
69
|
-
|
|
70
|
-
$meta,
|
|
71
|
-
$hash,
|
|
72
|
-
schema,
|
|
73
|
-
...fieldsOnly
|
|
74
|
-
} = fields;
|
|
75
|
-
if ($meta) {
|
|
76
|
-
this.$meta($meta);
|
|
77
|
-
}
|
|
65
|
+
const fieldsClone = structuredClone(fields);
|
|
66
|
+
const { schema } = fieldsClone;
|
|
78
67
|
if (schema) {
|
|
79
68
|
this.schema(schema);
|
|
80
69
|
}
|
|
81
|
-
this._fields = removeMetaAndSchema(
|
|
70
|
+
this._fields = removeEmptyFields(removeMetaAndSchema(fieldsClone));
|
|
82
71
|
}
|
|
83
72
|
return this;
|
|
84
73
|
}
|
|
85
74
|
schema(value) {
|
|
86
75
|
this._schema = value;
|
|
87
76
|
}
|
|
88
|
-
async metaFields(dataHash, stamp = true) {
|
|
89
|
-
return await _PayloadBuilderBase.metaFields(dataHash, this._$meta, stamp);
|
|
90
|
-
}
|
|
91
77
|
};
|
|
92
78
|
|
|
93
79
|
// src/Builder.ts
|
|
94
|
-
var omitByPredicate2 = (prefix) => (_, key) => {
|
|
95
|
-
assertEx2(typeof key === "string", () => `Invalid key type [${String(key)}, ${typeof key}]`);
|
|
96
|
-
return key.startsWith(prefix);
|
|
97
|
-
};
|
|
98
80
|
var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
|
|
99
|
-
static async
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
const hashableFields = {
|
|
121
|
-
...dataHashableFields,
|
|
122
|
-
$hash,
|
|
123
|
-
schema
|
|
124
|
-
};
|
|
125
|
-
if (Object.keys($meta).length > 0) {
|
|
126
|
-
hashableFields.$meta = $meta;
|
|
127
|
-
}
|
|
128
|
-
return hashableFields;
|
|
129
|
-
}
|
|
81
|
+
static async addSequencedStorageMeta(payload, hash, dataHash) {
|
|
82
|
+
assertEx2(hash === void 0 || isHash(hash), () => "Invalid hash");
|
|
83
|
+
assertEx2(dataHash === void 0 || isHash(dataHash), () => "Invalid dataHash");
|
|
84
|
+
const _hash = hash ?? await _PayloadBuilder.hash(payload);
|
|
85
|
+
return {
|
|
86
|
+
...payload,
|
|
87
|
+
_sequence: this.buildSequence(Date.now(), _hash.slice(-(StorageMetaConstants.nonceBytes * 2))),
|
|
88
|
+
_dataHash: dataHash ?? await _PayloadBuilder.dataHash(payload),
|
|
89
|
+
_hash
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
static async addStorageMeta(payloads) {
|
|
93
|
+
return Array.isArray(payloads) ? await (async () => {
|
|
94
|
+
const pairs = await _PayloadBuilder.hashPairs(payloads);
|
|
95
|
+
return await Promise.all(pairs.map(async ([payload, hash]) => await this.addSequencedStorageMeta(
|
|
96
|
+
payload,
|
|
97
|
+
hash
|
|
98
|
+
)));
|
|
99
|
+
})() : this.addSequencedStorageMeta(
|
|
100
|
+
payloads
|
|
101
|
+
);
|
|
130
102
|
}
|
|
131
|
-
static
|
|
132
|
-
|
|
103
|
+
static buildSequence(epoch, nonce) {
|
|
104
|
+
assertEx2(
|
|
105
|
+
epoch <= StorageMetaConstants.maxEpoch,
|
|
106
|
+
() => `epoch must be less than or equal to ${StorageMetaConstants.maxEpoch} [${epoch}]`
|
|
107
|
+
);
|
|
108
|
+
assertEx2(isHex(nonce), () => "nonce must be a Hex type");
|
|
109
|
+
assertEx2(
|
|
110
|
+
nonce.length === StorageMetaConstants.nonceBytes * 2,
|
|
111
|
+
() => `nonce must be ${StorageMetaConstants.nonceBytes} bytes [${nonce.length}] <- Hex String Length`
|
|
112
|
+
);
|
|
113
|
+
return `${toHex(epoch, { byteSize: 4 })}${nonce}`;
|
|
114
|
+
}
|
|
115
|
+
static async dataHash(payload) {
|
|
116
|
+
return await ObjectHasher.hash(this.omitMeta(payload));
|
|
133
117
|
}
|
|
134
|
-
static async dataHashPairs(payloads
|
|
118
|
+
static async dataHashPairs(payloads) {
|
|
135
119
|
return await Promise.all(
|
|
136
120
|
payloads.map(async (payload) => {
|
|
137
|
-
const
|
|
138
|
-
return [
|
|
121
|
+
const dataHash = await this.dataHash(payload);
|
|
122
|
+
return [payload, dataHash];
|
|
139
123
|
})
|
|
140
124
|
);
|
|
141
125
|
}
|
|
142
|
-
static async dataHashes(payloads
|
|
126
|
+
static async dataHashes(payloads) {
|
|
143
127
|
return payloads ? await Promise.all(
|
|
144
128
|
payloads.map(async (payload) => {
|
|
145
|
-
|
|
146
|
-
return built.$hash;
|
|
129
|
+
return await _PayloadBuilder.dataHash(payload);
|
|
147
130
|
})
|
|
148
131
|
) : void 0;
|
|
149
132
|
}
|
|
150
133
|
static async filterExclude(payloads = [], hash) {
|
|
151
|
-
return await
|
|
134
|
+
return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash);
|
|
152
135
|
}
|
|
153
136
|
static async filterExcludeByDataHash(payloads = [], hash) {
|
|
154
137
|
const hashes = Array.isArray(hash) ? hash : [hash];
|
|
@@ -161,53 +144,36 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
|
|
|
161
144
|
static async findByDataHash(payloads = [], hash) {
|
|
162
145
|
return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0];
|
|
163
146
|
}
|
|
164
|
-
static async hash(payload
|
|
165
|
-
return await
|
|
147
|
+
static async hash(payload) {
|
|
148
|
+
return await ObjectHasher.hash(this.omitStorageMeta(payload));
|
|
166
149
|
}
|
|
167
150
|
/**
|
|
168
151
|
* Creates an array of payload/hash tuples based on the payloads passed in
|
|
169
152
|
* @param objs Any array of payloads
|
|
170
153
|
* @returns An array of payload/hash tuples
|
|
171
154
|
*/
|
|
172
|
-
static async hashPairs(payloads
|
|
155
|
+
static async hashPairs(payloads) {
|
|
173
156
|
return await Promise.all(
|
|
174
157
|
payloads.map(async (payload) => {
|
|
175
|
-
|
|
176
|
-
return [built, await _PayloadBuilder.hash(built)];
|
|
158
|
+
return [payload, await _PayloadBuilder.hash(payload)];
|
|
177
159
|
})
|
|
178
160
|
);
|
|
179
161
|
}
|
|
180
|
-
static
|
|
181
|
-
|
|
182
|
-
assertEx2($meta === void 0 || isJsonObject2($meta), () => "$meta must be JsonObject");
|
|
183
|
-
const result = omitBy2(
|
|
184
|
-
{
|
|
185
|
-
...dataFields,
|
|
186
|
-
$hash: $hash ?? await _PayloadBuilder.dataHash(dataFields),
|
|
187
|
-
schema
|
|
188
|
-
},
|
|
189
|
-
omitByPredicate2("_")
|
|
190
|
-
);
|
|
191
|
-
const clonedMeta = { ...$meta };
|
|
192
|
-
if (timestamp) {
|
|
193
|
-
clonedMeta.timestamp = timestamp;
|
|
194
|
-
}
|
|
195
|
-
if (clonedMeta.timestamp === void 0 && stamp) {
|
|
196
|
-
clonedMeta.timestamp = Date.now();
|
|
197
|
-
}
|
|
198
|
-
if (Object.keys(clonedMeta).length > 0) {
|
|
199
|
-
result.$meta = clonedMeta;
|
|
200
|
-
}
|
|
201
|
-
return result;
|
|
162
|
+
static hashableFields(payload) {
|
|
163
|
+
return this.omitStorageMeta(payload);
|
|
202
164
|
}
|
|
203
165
|
static async hashes(payloads) {
|
|
204
|
-
return await
|
|
166
|
+
return await ObjectHasher.hashes(payloads);
|
|
205
167
|
}
|
|
206
|
-
static
|
|
168
|
+
static sortByStorageMeta(payloads, direction = 1) {
|
|
169
|
+
return payloads.sort((a, b) => a._sequence < b._sequence ? -direction : a._sequence > b._sequence ? direction : 0);
|
|
170
|
+
}
|
|
171
|
+
static async toAllHashMap(payloads) {
|
|
207
172
|
const result = {};
|
|
208
|
-
for (const pair of await this.hashPairs(
|
|
173
|
+
for (const pair of await this.hashPairs(payloads)) {
|
|
174
|
+
const dataHash = await this.dataHash(pair[0]);
|
|
209
175
|
result[pair[1]] = pair[0];
|
|
210
|
-
result[
|
|
176
|
+
result[dataHash] = pair[0];
|
|
211
177
|
}
|
|
212
178
|
return result;
|
|
213
179
|
}
|
|
@@ -230,30 +196,11 @@ var PayloadBuilder = class _PayloadBuilder extends PayloadBuilderBase {
|
|
|
230
196
|
}
|
|
231
197
|
return result;
|
|
232
198
|
}
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
const { $meta, ...result } = payloads;
|
|
239
|
-
return result;
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
}
|
|
243
|
-
async build(options) {
|
|
244
|
-
const dataHashableFields = await this.dataHashableFields();
|
|
245
|
-
return await _PayloadBuilder.build({
|
|
246
|
-
...dataHashableFields,
|
|
247
|
-
$meta: this._$meta,
|
|
248
|
-
schema: this._schema
|
|
249
|
-
}, options);
|
|
250
|
-
}
|
|
251
|
-
async hashableFields() {
|
|
252
|
-
return await _PayloadBuilder.hashableFields(
|
|
253
|
-
assertEx2(this._schema, () => "Payload: Missing Schema"),
|
|
254
|
-
this._fields,
|
|
255
|
-
this._$meta
|
|
256
|
-
);
|
|
199
|
+
build() {
|
|
200
|
+
return {
|
|
201
|
+
schema: this._schema,
|
|
202
|
+
...this._fields
|
|
203
|
+
};
|
|
257
204
|
}
|
|
258
205
|
};
|
|
259
206
|
export {
|
package/dist/node/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type {\n AnyObject, JsonArray, JsonObject,\n} from '@xylabs/object'\nimport { isJsonObject, omitBy } from '@xylabs/object'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport type {\n Payload, PayloadWithMeta, WithMeta,\n} from '@xyo-network/payload-model'\n\nimport type { WithoutMeta, WithoutSchema } from './BuilderBase.ts'\nimport { PayloadBuilderBase, removeMetaAndSchema } from './BuilderBase.ts'\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport interface BuildOptions {\n stamp?: boolean\n validate?: boolean\n}\n\nconst omitByPredicate = <T extends object>(prefix: string) => (_: T[keyof T], key: keyof T) => {\n assertEx(typeof key === 'string', () => `Invalid key type [${String(key)}, ${typeof key}]`)\n return (key as string).startsWith(prefix)\n}\n\nexport class PayloadBuilder<\n T extends Payload = Payload<AnyObject>,\n O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>,\n> extends PayloadBuilderBase<T, O> {\n static async build<T extends Payload = Payload<AnyObject>>(payload: T, options?: BuildOptions): Promise<WithMeta<T>>\n static async build<T extends Payload = Payload<AnyObject>>(payload: T[], options?: BuildOptions): Promise<WithMeta<T>[]>\n static async build<T extends Payload = Payload<AnyObject>>(payload: T | T[], options: BuildOptions = {}) {\n if (Array.isArray(payload)) {\n return await Promise.all(payload.map(payload => this.build(payload, options)))\n } else {\n const { stamp = false, validate = true } = options\n const {\n schema, $hash: incomingDataHash, $meta: incomingMeta = {},\n } = payload as WithMeta<T>\n\n // check for legacy signatures\n const { _signatures } = payload as { _signatures?: JsonArray }\n if (_signatures && !incomingMeta.signatures) {\n incomingMeta.signatures = _signatures\n }\n\n const fields = removeMetaAndSchema(payload)\n const dataHashableFields = await PayloadBuilder.dataHashableFields(schema, fields)\n const $hash = validate || incomingDataHash === undefined ? await PayloadHasher.hash(dataHashableFields) : incomingDataHash\n const $meta: JsonObject = { ...incomingMeta }\n if ($meta.timestamp === undefined && stamp) {\n $meta.timestamp = Date.now()\n }\n const hashableFields: WithMeta<Payload> = {\n ...dataHashableFields, $hash, schema,\n }\n\n if (Object.keys($meta).length > 0) {\n hashableFields.$meta = $meta\n }\n\n return hashableFields as WithMeta<T>\n }\n }\n\n static async dataHash<T extends Payload>(payload: T, options?: BuildOptions): Promise<Hash> {\n return (await this.build(payload, options)).$hash\n }\n\n static async dataHashPairs<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<[WithMeta<T>, Hash][]> {\n return await Promise.all(\n payloads.map(async (payload) => {\n const built = await PayloadBuilder.build(payload, options)\n return [built, built.$hash]\n }),\n )\n }\n\n static async dataHashes(payloads: undefined, options?: BuildOptions): Promise<undefined>\n static async dataHashes<T extends Payload>(payloads: T[], options?: BuildOptions): Promise<Hash[]>\n static async dataHashes<T extends Payload>(payloads?: T[], options?: BuildOptions): Promise<Hash[] | undefined> {\n return payloads\n ? await Promise.all(\n payloads.map(async (payload) => {\n const built = await PayloadBuilder.build(payload, options)\n return built.$hash\n }),\n )\n : undefined\n }\n\n static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n return await PayloadHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)\n }\n\n static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n }\n\n static async hash<T extends Payload>(payload: T, options?: BuildOptions): Promise<Hash> {\n return await PayloadHasher.hash(await PayloadBuilder.build(payload, options))\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[], options?: BuildOptions): 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, options)\n return [built, await PayloadBuilder.hash(built)]\n }),\n )\n }\n\n static async hashableFields<T extends Payload = Payload<AnyObject>>(\n schema: string,\n fields?: WithoutSchema<WithoutMeta<T>>,\n $meta?: JsonObject,\n $hash?: Hash,\n timestamp?: number,\n stamp = false,\n ): Promise<WithMeta<T>> {\n const dataFields = await this.dataHashableFields<T>(schema, fields)\n assertEx($meta === undefined || isJsonObject($meta), () => '$meta must be JsonObject')\n const result: WithMeta<T> = omitBy(\n {\n ...dataFields,\n $hash: $hash ?? (await PayloadBuilder.dataHash(dataFields)),\n schema,\n } as WithMeta<T>,\n omitByPredicate('_'),\n ) as WithMeta<T>\n\n const clonedMeta = { ...$meta }\n\n if (timestamp) {\n clonedMeta.timestamp = timestamp\n }\n\n if (clonedMeta.timestamp === undefined && stamp) {\n clonedMeta.timestamp = Date.now()\n }\n\n if (Object.keys(clonedMeta).length > 0) {\n result.$meta = clonedMeta\n }\n\n return result\n }\n\n static async hashes(payloads: undefined): Promise<undefined>\n static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return await PayloadHasher.hashes(payloads)\n }\n\n static async toAllHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {\n const result: Record<Hash, WithMeta<T>> = {}\n for (const pair of await this.hashPairs(objs)) {\n result[pair[1]] = pair[0]\n result[pair[0].$hash] = pair[0]\n }\n return result\n }\n\n static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, WithMeta<T>>> {\n const result: Record<Hash, WithMeta<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, WithMeta<T>>> {\n const result: Record<Hash, WithMeta<T>> = {}\n for (const pair of await this.hashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n static withoutMeta(payload: undefined): undefined\n static withoutMeta<T extends PayloadWithMeta>(payload: T): Omit<T, '$meta'>\n static withoutMeta<T extends PayloadWithMeta>(payloads: T[]): Omit<T, '$meta'>[]\n static withoutMeta<T extends PayloadWithMeta>(payloads: T | T[]) {\n if (Array.isArray(payloads)) {\n return payloads.map(payload => this.withoutMeta(payload))\n } else {\n if (payloads) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, ...result } = payloads\n return result as Omit<T, '$meta'>\n }\n }\n }\n\n async build(options?: BuildOptions): Promise<WithMeta<T>> {\n const dataHashableFields = await this.dataHashableFields()\n return await PayloadBuilder.build<T>({\n ...dataHashableFields, $meta: this._$meta, schema: this._schema,\n } as Payload as T, options)\n }\n\n async hashableFields() {\n return await PayloadBuilder.hashableFields(\n assertEx(this._schema, () => 'Payload: Missing Schema'),\n this._fields,\n this._$meta,\n )\n }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { Hash } from '@xylabs/hex'\nimport type { AnyObject, JsonObject } from '@xylabs/object'\nimport {\n isJsonObject, omitBy, toJson,\n} from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { removeEmptyFields } from '@xyo-network/hash'\nimport type {\n Payload, Schema, WithMeta, WithOptionalMeta,\n} from '@xyo-network/payload-model'\n\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport type WithOptionalSchema<T extends Payload> = Omit<T, 'schema'> & Partial<T>\n\nexport type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>\n\nexport type WithoutMeta<T extends WithOptionalMeta<Payload>> = Omit<T, '$hash' | '$meta'>\n\nexport const removeMetaAndSchema = <T extends Payload>(payload: WithOptionalSchema<WithOptionalMeta<T>>): WithoutSchema<WithoutMeta<T>> => {\n const { ...result } = payload\n delete result.$hash\n delete result.$meta\n delete result.schema\n return result as Omit<T, 'schema'>\n}\n\nconst omitByPredicate = (prefix: string) => (_: unknown, key: string) => {\n assertEx(typeof key === 'string', () => `Invalid key type [${key}, ${typeof key}]`)\n return key.startsWith(prefix)\n}\n\nexport class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n protected _$meta?: JsonObject\n protected _fields?: WithoutSchema<WithoutMeta<T>>\n protected _schema: Schema\n\n constructor(readonly options: O) {\n const {\n schema, fields, meta,\n } = options\n this._schema = schema\n this._fields = removeEmptyFields(fields ?? {}) as WithoutSchema<WithoutMeta<T>>\n this._$meta = meta\n }\n\n static dataHashableFields<T extends Payload = Payload<AnyObject>>(\n schema: string,\n fields?: WithoutSchema<WithoutMeta<T>>,\n ): Promisable<Omit<T, '$hash' | '$meta'>> {\n const cleanFields = fields ? removeEmptyFields(fields) : undefined\n assertEx(\n cleanFields === undefined || isJsonObject(cleanFields),\n () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n )\n return omitBy(omitBy({ schema, ...cleanFields }, omitByPredicate('$')), omitByPredicate('_')) as unknown as T\n }\n\n protected static metaFields(dataHash: Hash, otherMeta?: JsonObject, stamp = true): Promisable<JsonObject> {\n const meta: JsonObject = { ...otherMeta }\n\n if (!meta.timestamp && stamp) {\n meta.timestamp = meta.timestamp ?? Date.now()\n }\n\n return meta\n }\n\n $meta(meta?: JsonObject) {\n this._$meta = meta ?? (this._fields as WithMeta<T>).$meta\n return this\n }\n\n async dataHashableFields() {\n return await PayloadBuilderBase.dataHashableFields(\n assertEx(this._schema, () => 'Payload: Missing Schema'),\n this._fields,\n )\n }\n\n // we do not require sending in $hash since it will be generated anyway\n fields(fields: WithOptionalSchema<WithOptionalMeta<T>>) {\n if (fields) {\n const {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n $meta, $hash, schema, ...fieldsOnly\n } = fields\n if ($meta) {\n this.$meta($meta)\n }\n if (schema) {\n this.schema(schema)\n }\n this._fields = removeMetaAndSchema<T>(fields)\n }\n return this\n }\n\n schema(value: Schema) {\n this._schema = value\n }\n\n protected async metaFields(dataHash: Hash, stamp = true): Promise<JsonObject> {\n return await PayloadBuilderBase.metaFields(dataHash, this._$meta, stamp)\n }\n}\n"],"mappings":";AAAA,SAAS,YAAAA,iBAAgB;AAKzB,SAAS,gBAAAC,eAAc,UAAAC,eAAc;AACrC,SAAS,qBAAqB;;;ACN9B,SAAS,gBAAgB;AAGzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAQ;AAAA,OACjB;AAEP,SAAS,yBAAyB;AAa3B,IAAM,sBAAsB,CAAoB,YAAoF;AACzI,QAAM,EAAE,GAAG,OAAO,IAAI;AACtB,SAAO,OAAO;AACd,SAAO,OAAO;AACd,SAAO,OAAO;AACd,SAAO;AACT;AAEA,IAAM,kBAAkB,CAAC,WAAmB,CAAC,GAAY,QAAgB;AACvE,WAAS,OAAO,QAAQ,UAAU,MAAM,qBAAqB,GAAG,KAAK,OAAO,GAAG,GAAG;AAClF,SAAO,IAAI,WAAW,MAAM;AAC9B;AAEO,IAAM,qBAAN,MAAM,oBAA0H;AAAA,EAKrI,YAAqB,SAAY;AAAZ;AACnB,UAAM;AAAA,MACJ;AAAA,MAAQ;AAAA,MAAQ;AAAA,IAClB,IAAI;AACJ,SAAK,UAAU;AACf,SAAK,UAAU,kBAAkB,UAAU,CAAC,CAAC;AAC7C,SAAK,SAAS;AAAA,EAChB;AAAA,EAXU;AAAA,EACA;AAAA,EACA;AAAA,EAWV,OAAO,mBACL,QACA,QACwC;AACxC,UAAM,cAAc,SAAS,kBAAkB,MAAM,IAAI;AACzD;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,OAAO,OAAO,EAAE,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,CAAC,GAAG,gBAAgB,GAAG,CAAC;AAAA,EAC9F;AAAA,EAEA,OAAiB,WAAW,UAAgB,WAAwB,QAAQ,MAA8B;AACxG,UAAM,OAAmB,EAAE,GAAG,UAAU;AAExC,QAAI,CAAC,KAAK,aAAa,OAAO;AAC5B,WAAK,YAAY,KAAK,aAAa,KAAK,IAAI;AAAA,IAC9C;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,MAAmB;AACvB,SAAK,SAAS,QAAS,KAAK,QAAwB;AACpD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,oBAAmB;AAAA,MAC9B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA,MACtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA;AAAA,EAGA,OAAO,QAAiD;AACtD,QAAI,QAAQ;AACV,YAAM;AAAA;AAAA,QAEJ;AAAA,QAAO;AAAA,QAAO;AAAA,QAAQ,GAAG;AAAA,MAC3B,IAAI;AACJ,UAAI,OAAO;AACT,aAAK,MAAM,KAAK;AAAA,MAClB;AACA,UAAI,QAAQ;AACV,aAAK,OAAO,MAAM;AAAA,MACpB;AACA,WAAK,UAAU,oBAAuB,MAAM;AAAA,IAC9C;AACA,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,MAAgB,WAAW,UAAgB,QAAQ,MAA2B;AAC5E,WAAO,MAAM,oBAAmB,WAAW,UAAU,KAAK,QAAQ,KAAK;AAAA,EACzE;AACF;;;ADtFA,IAAMC,mBAAkB,CAAmB,WAAmB,CAAC,GAAe,QAAiB;AAC7F,EAAAC,UAAS,OAAO,QAAQ,UAAU,MAAM,qBAAqB,OAAO,GAAG,CAAC,KAAK,OAAO,GAAG,GAAG;AAC1F,SAAQ,IAAe,WAAW,MAAM;AAC1C;AAEO,IAAM,iBAAN,MAAM,wBAGH,mBAAyB;AAAA,EAGjC,aAAa,MAA8C,SAAkB,UAAwB,CAAC,GAAG;AACvG,QAAI,MAAM,QAAQ,OAAO,GAAG;AAC1B,aAAO,MAAM,QAAQ,IAAI,QAAQ,IAAI,CAAAC,aAAW,KAAK,MAAMA,UAAS,OAAO,CAAC,CAAC;AAAA,IAC/E,OAAO;AACL,YAAM,EAAE,QAAQ,OAAO,WAAW,KAAK,IAAI;AAC3C,YAAM;AAAA,QACJ;AAAA,QAAQ,OAAO;AAAA,QAAkB,OAAO,eAAe,CAAC;AAAA,MAC1D,IAAI;AAGJ,YAAM,EAAE,YAAY,IAAI;AACxB,UAAI,eAAe,CAAC,aAAa,YAAY;AAC3C,qBAAa,aAAa;AAAA,MAC5B;AAEA,YAAM,SAAS,oBAAoB,OAAO;AAC1C,YAAM,qBAAqB,MAAM,gBAAe,mBAAmB,QAAQ,MAAM;AACjF,YAAM,QAAQ,YAAY,qBAAqB,SAAY,MAAM,cAAc,KAAK,kBAAkB,IAAI;AAC1G,YAAM,QAAoB,EAAE,GAAG,aAAa;AAC5C,UAAI,MAAM,cAAc,UAAa,OAAO;AAC1C,cAAM,YAAY,KAAK,IAAI;AAAA,MAC7B;AACA,YAAM,iBAAoC;AAAA,QACxC,GAAG;AAAA,QAAoB;AAAA,QAAO;AAAA,MAChC;AAEA,UAAI,OAAO,KAAK,KAAK,EAAE,SAAS,GAAG;AACjC,uBAAe,QAAQ;AAAA,MACzB;AAEA,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEA,aAAa,SAA4B,SAAY,SAAuC;AAC1F,YAAQ,MAAM,KAAK,MAAM,SAAS,OAAO,GAAG;AAAA,EAC9C;AAAA,EAEA,aAAa,cAAiC,UAAe,SAAwD;AACnH,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,QAAQ,MAAM,gBAAe,MAAM,SAAS,OAAO;AACzD,eAAO,CAAC,OAAO,MAAM,KAAK;AAAA,MAC5B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAIA,aAAa,WAA8B,UAAgB,SAAqD;AAC9G,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,QAAQ,MAAM,gBAAe,MAAM,SAAS,OAAO;AACzD,eAAO,MAAM;AAAA,MACf,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,cAAc,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACzG;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACtH;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACrH;AAAA,EAEA,aAAa,eAAkC,WAAgB,CAAC,GAAG,MAAoC;AACrG,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,OAAO,MAAM,YAAY,IAAI,IAAI,CAAC;AAAA,EAC1F;AAAA,EAEA,aAAa,KAAwB,SAAY,SAAuC;AACtF,WAAO,MAAM,cAAc,KAAK,MAAM,gBAAe,MAAM,SAAS,OAAO,CAAC;AAAA,EAC9E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAe,SAAwD;AAC/G,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAkC,OAAO,YAAY;AAC5D,cAAM,QAAQ,MAAM,gBAAe,MAAM,SAAS,OAAO;AACzD,eAAO,CAAC,OAAO,MAAM,gBAAe,KAAK,KAAK,CAAC;AAAA,MACjD,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,aAAa,eACX,QACA,QACA,OACA,OACA,WACA,QAAQ,OACc;AACtB,UAAM,aAAa,MAAM,KAAK,mBAAsB,QAAQ,MAAM;AAClE,IAAAD,UAAS,UAAU,UAAaE,cAAa,KAAK,GAAG,MAAM,0BAA0B;AACrF,UAAM,SAAsBC;AAAA,MAC1B;AAAA,QACE,GAAG;AAAA,QACH,OAAO,SAAU,MAAM,gBAAe,SAAS,UAAU;AAAA,QACzD;AAAA,MACF;AAAA,MACAJ,iBAAgB,GAAG;AAAA,IACrB;AAEA,UAAM,aAAa,EAAE,GAAG,MAAM;AAE9B,QAAI,WAAW;AACb,iBAAW,YAAY;AAAA,IACzB;AAEA,QAAI,WAAW,cAAc,UAAa,OAAO;AAC/C,iBAAW,YAAY,KAAK,IAAI;AAAA,IAClC;AAEA,QAAI,OAAO,KAAK,UAAU,EAAE,SAAS,GAAG;AACtC,aAAO,QAAQ;AAAA,IACjB;AAEA,WAAO;AAAA,EACT;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,cAAc,OAAO,QAAQ;AAAA,EAC5C;AAAA,EAEA,aAAa,aAAgC,MAA+C;AAC1F,UAAM,SAAoC,CAAC;AAC3C,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,KAAK,CAAC,EAAE,KAAK,IAAI,KAAK,CAAC;AAAA,IAChC;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAA+C;AAC3F,UAAM,SAAoC,CAAC;AAC3C,eAAW,QAAQ,MAAM,KAAK,cAAc,IAAI,GAAG;AACjD,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,MAA+C;AACvF,UAAM,SAAoC,CAAC;AAC3C,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAKA,OAAO,YAAuC,UAAmB;AAC/D,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,SAAS,IAAI,aAAW,KAAK,YAAY,OAAO,CAAC;AAAA,IAC1D,OAAO;AACL,UAAI,UAAU;AAEZ,cAAM,EAAE,OAAO,GAAG,OAAO,IAAI;AAC7B,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAM,SAA8C;AACxD,UAAM,qBAAqB,MAAM,KAAK,mBAAmB;AACzD,WAAO,MAAM,gBAAe,MAAS;AAAA,MACnC,GAAG;AAAA,MAAoB,OAAO,KAAK;AAAA,MAAQ,QAAQ,KAAK;AAAA,IAC1D,GAAmB,OAAO;AAAA,EAC5B;AAAA,EAEA,MAAM,iBAAiB;AACrB,WAAO,MAAM,gBAAe;AAAA,MAC1BC,UAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA,MACtD,KAAK;AAAA,MACL,KAAK;AAAA,IACP;AAAA,EACF;AACF;","names":["assertEx","isJsonObject","omitBy","omitByPredicate","assertEx","payload","isJsonObject","omitBy"]}
|
|
1
|
+
{"version":3,"sources":["../../src/Builder.ts","../../src/BuilderBase.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport type {\n Hash,\n Hex,\n} from '@xylabs/hex'\nimport {\n isHash, isHex, toHex,\n} from '@xylabs/hex'\nimport type { AnyObject } from '@xylabs/object'\nimport { ObjectHasher } from '@xyo-network/hash'\nimport {\n type Payload, StorageMetaConstants, type WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nimport { PayloadBuilderBase } from './BuilderBase.ts'\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport class PayloadBuilder<\n T extends Payload = Payload<AnyObject>,\n O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>,\n> extends PayloadBuilderBase<T, O> {\n static async addSequencedStorageMeta<T extends Payload = Payload>(payload: T, hash?: Hash, dataHash?: Hash): Promise<WithStorageMeta<T>> {\n assertEx(hash === undefined || isHash(hash), () => 'Invalid hash')\n assertEx(dataHash === undefined || isHash(dataHash), () => 'Invalid dataHash')\n const _hash = hash ?? await PayloadBuilder.hash(payload)\n return {\n ...payload,\n _sequence: this.buildSequence(Date.now(), _hash.slice(-(StorageMetaConstants.nonceBytes * 2)) as Hex),\n _dataHash: dataHash ?? await PayloadBuilder.dataHash(payload),\n _hash,\n }\n }\n\n static async addStorageMeta<T extends Payload>(payload: T): Promise<WithStorageMeta<T>>\n static async addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>\n static async addStorageMeta<T extends Payload>(payloads: T | T[]): Promise<WithStorageMeta<T>[] | WithStorageMeta<T>> {\n return Array.isArray(payloads)\n ? await (async () => {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n return await Promise.all(pairs.map(async ([payload, hash]) => await this.addSequencedStorageMeta(\n payload,\n hash,\n )))\n })()\n : this.addSequencedStorageMeta(\n payloads,\n )\n }\n\n static buildSequence(epoch: number, nonce: Hex): Hex {\n assertEx(\n epoch <= StorageMetaConstants.maxEpoch,\n () => `epoch must be less than or equal to ${StorageMetaConstants.maxEpoch} [${epoch}]`,\n )\n assertEx(isHex(nonce), () => 'nonce must be a Hex type')\n assertEx(\n nonce.length === StorageMetaConstants.nonceBytes * 2,\n () => `nonce must be ${StorageMetaConstants.nonceBytes} bytes [${nonce.length}] <- Hex String Length`,\n )\n return `${toHex(epoch, { byteSize: 4 })}${nonce}` as Hex\n }\n\n static async dataHash<T extends Payload>(payload: T): Promise<Hash> {\n return await ObjectHasher.hash(this.omitMeta(payload))\n }\n\n static async dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n return await Promise.all(\n payloads.map(async (payload) => {\n const dataHash = await this.dataHash(payload)\n return [payload, dataHash]\n }),\n )\n }\n\n static async dataHashes(payloads: undefined): Promise<undefined>\n static async dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async dataHashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return payloads\n ? await Promise.all(\n payloads.map(async (payload) => {\n return await PayloadBuilder.dataHash(payload)\n }),\n )\n : undefined\n }\n\n static async filterExclude<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n return await ObjectHasher.filterExcludeByHash(await this.filterExcludeByDataHash(payloads, hash), hash)\n }\n\n static async filterExcludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => !hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async filterIncludeByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash[] | Hash): Promise<T[]> {\n const hashes = Array.isArray(hash) ? hash : [hash]\n return (await this.dataHashPairs(payloads)).filter(([_, objHash]) => hashes.includes(objHash))?.map(pair => pair[0])\n }\n\n static async findByDataHash<T extends Payload>(payloads: T[] = [], hash: Hash): Promise<T | undefined> {\n return (await this.dataHashPairs(payloads)).find(([_, objHash]) => objHash === hash)?.[0]\n }\n\n static async hash<T extends Payload>(payload: T): Promise<Hash> {\n return await ObjectHasher.hash(this.omitStorageMeta(payload))\n }\n\n /**\n * Creates an array of payload/hash tuples based on the payloads passed in\n * @param objs Any array of payloads\n * @returns An array of payload/hash tuples\n */\n static async hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]> {\n return await Promise.all(\n payloads.map<Promise<[T, Hash]>>(async (payload) => {\n return [payload, await PayloadBuilder.hash(payload)]\n }),\n )\n }\n\n static hashableFields<T extends Payload>(\n payload: T,\n ): T {\n return this.omitStorageMeta(payload)\n }\n\n static async hashes(payloads: undefined): Promise<undefined>\n static async hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>\n static async hashes<T extends Payload>(payloads?: T[]): Promise<Hash[] | undefined> {\n return await ObjectHasher.hashes(payloads)\n }\n\n static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction: -1 | 1 = 1) {\n return payloads.sort((a, b) =>\n a._sequence < b._sequence\n ? -direction\n : a._sequence > b._sequence\n ? direction\n : 0)\n }\n\n static async toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.hashPairs(payloads)) {\n const dataHash = await this.dataHash(pair[0])\n result[pair[1]] = pair[0]\n result[dataHash] = pair[0]\n }\n return result\n }\n\n static async toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.dataHashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n /**\n * Creates an object map of payload hashes to payloads based on the payloads passed in\n * @param objs Any array of payloads\n * @returns A map of hashes to payloads\n */\n static async toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>> {\n const result: Record<Hash, T> = {}\n for (const pair of await this.hashPairs(objs)) {\n result[pair[1]] = pair[0]\n }\n return result\n }\n\n build(): T {\n return {\n schema: this._schema,\n ...this._fields,\n } as T\n }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { AnyObject } from '@xylabs/object'\nimport {\n isJsonObject, omitBy, toJson,\n} from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport { removeEmptyFields } from '@xyo-network/hash'\nimport type { Payload, Schema } from '@xyo-network/payload-model'\n\nimport { PayloadBuilder } from './Builder.ts'\nimport type { PayloadBuilderOptions } from './Options.ts'\n\nexport type WithOptionalSchema<T extends Payload> = Omit<T, 'schema'> & Partial<T>\n\nexport type WithoutSchema<T extends WithOptionalSchema<Payload>> = Omit<T, 'schema'>\n\nexport const removeMetaAndSchema = <T extends Payload>(payload: Partial<WithOptionalSchema<T>>): WithoutSchema<T> => {\n const { ...result } = PayloadBuilder.omitMeta(payload as T) as WithOptionalSchema<T>\n delete result.schema\n return result as Omit<T, 'schema'>\n}\n\nconst omitByPrefixPredicate = (prefix: string) => (_: unknown, key: string) => {\n assertEx(typeof key === 'string', () => `Invalid key type [${key}, ${typeof key}]`)\n return key.startsWith(prefix)\n}\n\nexport class PayloadBuilderBase<T extends Payload = Payload<AnyObject>, O extends PayloadBuilderOptions<T> = PayloadBuilderOptions<T>> {\n protected _fields?: Partial<WithoutSchema<T>>\n protected _schema: Schema\n\n constructor(readonly options: O) {\n const { schema, fields } = options\n this._schema = schema\n this._fields = removeMetaAndSchema(removeEmptyFields(structuredClone(fields ?? {})))\n }\n\n static dataHashableFields<T extends Payload>(\n schema: Schema,\n payload: WithoutSchema<T>,\n\n ): Promisable<Payload> {\n const cleanFields = removeEmptyFields({ ...payload, schema })\n assertEx(\n cleanFields === undefined || isJsonObject(cleanFields),\n () => `Fields must be JsonObject: ${JSON.stringify(toJson(cleanFields), null, 2)}`,\n )\n return this.omitMeta(cleanFields) as T\n }\n\n static omitClientMeta<T extends Payload>(payload: T, maxDepth?: number): T\n static omitClientMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]\n static omitClientMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitClientMeta(payload, maxDepth)) as T[]\n : omitBy(payloads, omitByPrefixPredicate('$'), maxDepth) as T\n }\n\n static omitMeta<T extends Payload>(payload: T, maxDepth?: number): T\n static omitMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]\n static omitMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {\n return Array.isArray(payloads)\n ? this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth)\n : this.omitStorageMeta(this.omitClientMeta(payloads, maxDepth), maxDepth)\n }\n\n static omitStorageMeta<T extends Payload>(payload: T, maxDepth?: number): T\n static omitStorageMeta<T extends Payload>(payloads: T[], maxDepth?: number): T[]\n static omitStorageMeta<T extends Payload>(payloads: T | T[], maxDepth = 100): T | T[] {\n return Array.isArray(payloads)\n ? payloads.map(payload => this.omitStorageMeta(payload, maxDepth)) as T[]\n : omitBy(payloads, omitByPrefixPredicate('_'), maxDepth) as T\n }\n\n async dataHashableFields() {\n return await PayloadBuilderBase.dataHashableFields(\n assertEx(this._schema, () => 'Payload: Missing Schema'),\n // TDOD: Add verification that required fields are present\n this._fields as T,\n )\n }\n\n fields(fields: WithOptionalSchema<T>) {\n if (fields) {\n const fieldsClone = structuredClone(fields)\n const { schema } = fieldsClone\n if (schema) {\n this.schema(schema)\n }\n this._fields = removeEmptyFields(removeMetaAndSchema<T>(fieldsClone))\n }\n return this\n }\n\n schema(value: Schema) {\n this._schema = value\n }\n}\n"],"mappings":";AAAA,SAAS,YAAAA,iBAAgB;AAKzB;AAAA,EACE;AAAA,EAAQ;AAAA,EAAO;AAAA,OACV;AAEP,SAAS,oBAAoB;AAC7B;AAAA,EACgB;AAAA,OACT;;;ACZP,SAAS,gBAAgB;AAEzB;AAAA,EACE;AAAA,EAAc;AAAA,EAAQ;AAAA,OACjB;AAEP,SAAS,yBAAyB;AAU3B,IAAM,sBAAsB,CAAoB,YAA8D;AACnH,QAAM,EAAE,GAAG,OAAO,IAAI,eAAe,SAAS,OAAY;AAC1D,SAAO,OAAO;AACd,SAAO;AACT;AAEA,IAAM,wBAAwB,CAAC,WAAmB,CAAC,GAAY,QAAgB;AAC7E,WAAS,OAAO,QAAQ,UAAU,MAAM,qBAAqB,GAAG,KAAK,OAAO,GAAG,GAAG;AAClF,SAAO,IAAI,WAAW,MAAM;AAC9B;AAEO,IAAM,qBAAN,MAAM,oBAA0H;AAAA,EAIrI,YAAqB,SAAY;AAAZ;AACnB,UAAM,EAAE,QAAQ,OAAO,IAAI;AAC3B,SAAK,UAAU;AACf,SAAK,UAAU,oBAAoB,kBAAkB,gBAAgB,UAAU,CAAC,CAAC,CAAC,CAAC;AAAA,EACrF;AAAA,EAPU;AAAA,EACA;AAAA,EAQV,OAAO,mBACL,QACA,SAEqB;AACrB,UAAM,cAAc,kBAAkB,EAAE,GAAG,SAAS,OAAO,CAAC;AAC5D;AAAA,MACE,gBAAgB,UAAa,aAAa,WAAW;AAAA,MACrD,MAAM,8BAA8B,KAAK,UAAU,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC;AAAA,IAClF;AACA,WAAO,KAAK,SAAS,WAAW;AAAA,EAClC;AAAA,EAIA,OAAO,eAAkC,UAAmB,WAAW,KAAc;AACnF,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,eAAe,SAAS,QAAQ,CAAC,IAC9D,OAAO,UAAU,sBAAsB,GAAG,GAAG,QAAQ;AAAA,EAC3D;AAAA,EAIA,OAAO,SAA4B,UAAmB,WAAW,KAAc;AAC7E,WAAO,MAAM,QAAQ,QAAQ,IACzB,KAAK,gBAAgB,KAAK,eAAe,UAAU,QAAQ,GAAG,QAAQ,IACtE,KAAK,gBAAgB,KAAK,eAAe,UAAU,QAAQ,GAAG,QAAQ;AAAA,EAC5E;AAAA,EAIA,OAAO,gBAAmC,UAAmB,WAAW,KAAc;AACpF,WAAO,MAAM,QAAQ,QAAQ,IACzB,SAAS,IAAI,aAAW,KAAK,gBAAgB,SAAS,QAAQ,CAAC,IAC/D,OAAO,UAAU,sBAAsB,GAAG,GAAG,QAAQ;AAAA,EAC3D;AAAA,EAEA,MAAM,qBAAqB;AACzB,WAAO,MAAM,oBAAmB;AAAA,MAC9B,SAAS,KAAK,SAAS,MAAM,yBAAyB;AAAA;AAAA,MAEtD,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,OAAO,QAA+B;AACpC,QAAI,QAAQ;AACV,YAAM,cAAc,gBAAgB,MAAM;AAC1C,YAAM,EAAE,OAAO,IAAI;AACnB,UAAI,QAAQ;AACV,aAAK,OAAO,MAAM;AAAA,MACpB;AACA,WAAK,UAAU,kBAAkB,oBAAuB,WAAW,CAAC;AAAA,IACtE;AACA,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,OAAe;AACpB,SAAK,UAAU;AAAA,EACjB;AACF;;;ADhFO,IAAM,iBAAN,MAAM,wBAGH,mBAAyB;AAAA,EACjC,aAAa,wBAAqD,SAAY,MAAa,UAA8C;AACvI,IAAAC,UAAS,SAAS,UAAa,OAAO,IAAI,GAAG,MAAM,cAAc;AACjE,IAAAA,UAAS,aAAa,UAAa,OAAO,QAAQ,GAAG,MAAM,kBAAkB;AAC7E,UAAM,QAAQ,QAAQ,MAAM,gBAAe,KAAK,OAAO;AACvD,WAAO;AAAA,MACL,GAAG;AAAA,MACH,WAAW,KAAK,cAAc,KAAK,IAAI,GAAG,MAAM,MAAM,EAAE,qBAAqB,aAAa,EAAE,CAAQ;AAAA,MACpG,WAAW,YAAY,MAAM,gBAAe,SAAS,OAAO;AAAA,MAC5D;AAAA,IACF;AAAA,EACF;AAAA,EAIA,aAAa,eAAkC,UAAuE;AACpH,WAAO,MAAM,QAAQ,QAAQ,IACzB,OAAO,YAAY;AACnB,YAAM,QAAQ,MAAM,gBAAe,UAAU,QAAQ;AACrD,aAAO,MAAM,QAAQ,IAAI,MAAM,IAAI,OAAO,CAAC,SAAS,IAAI,MAAM,MAAM,KAAK;AAAA,QACvE;AAAA,QACA;AAAA,MACF,CAAC,CAAC;AAAA,IACJ,GAAG,IACD,KAAK;AAAA,MACH;AAAA,IACF;AAAA,EACN;AAAA,EAEA,OAAO,cAAc,OAAe,OAAiB;AACnD,IAAAA;AAAA,MACE,SAAS,qBAAqB;AAAA,MAC9B,MAAM,uCAAuC,qBAAqB,QAAQ,KAAK,KAAK;AAAA,IACtF;AACA,IAAAA,UAAS,MAAM,KAAK,GAAG,MAAM,0BAA0B;AACvD,IAAAA;AAAA,MACE,MAAM,WAAW,qBAAqB,aAAa;AAAA,MACnD,MAAM,iBAAiB,qBAAqB,UAAU,WAAW,MAAM,MAAM;AAAA,IAC/E;AACA,WAAO,GAAG,MAAM,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,KAAK;AAAA,EACjD;AAAA,EAEA,aAAa,SAA4B,SAA2B;AAClE,WAAO,MAAM,aAAa,KAAK,KAAK,SAAS,OAAO,CAAC;AAAA,EACvD;AAAA,EAEA,aAAa,cAAiC,UAAqC;AACjF,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAI,OAAO,YAAY;AAC9B,cAAM,WAAW,MAAM,KAAK,SAAS,OAAO;AAC5C,eAAO,CAAC,SAAS,QAAQ;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAIA,aAAa,WAA8B,UAA6C;AACtF,WAAO,WACH,MAAM,QAAQ;AAAA,MACd,SAAS,IAAI,OAAO,YAAY;AAC9B,eAAO,MAAM,gBAAe,SAAS,OAAO;AAAA,MAC9C,CAAC;AAAA,IACH,IACE;AAAA,EACN;AAAA,EAEA,aAAa,cAAiC,WAAgB,CAAC,GAAG,MAAmC;AACnG,WAAO,MAAM,aAAa,oBAAoB,MAAM,KAAK,wBAAwB,UAAU,IAAI,GAAG,IAAI;AAAA,EACxG;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACtH;AAAA,EAEA,aAAa,wBAA2C,WAAgB,CAAC,GAAG,MAAmC;AAC7G,UAAM,SAAS,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACjD,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,MAAM,OAAO,SAAS,OAAO,CAAC,GAAG,IAAI,UAAQ,KAAK,CAAC,CAAC;AAAA,EACrH;AAAA,EAEA,aAAa,eAAkC,WAAgB,CAAC,GAAG,MAAoC;AACrG,YAAQ,MAAM,KAAK,cAAc,QAAQ,GAAG,KAAK,CAAC,CAAC,GAAG,OAAO,MAAM,YAAY,IAAI,IAAI,CAAC;AAAA,EAC1F;AAAA,EAEA,aAAa,KAAwB,SAA2B;AAC9D,WAAO,MAAM,aAAa,KAAK,KAAK,gBAAgB,OAAO,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,UAAqC;AAC7E,WAAO,MAAM,QAAQ;AAAA,MACnB,SAAS,IAAwB,OAAO,YAAY;AAClD,eAAO,CAAC,SAAS,MAAM,gBAAe,KAAK,OAAO,CAAC;AAAA,MACrD,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,OAAO,eACL,SACG;AACH,WAAO,KAAK,gBAAgB,OAAO;AAAA,EACrC;AAAA,EAIA,aAAa,OAA0B,UAA6C;AAClF,WAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,EAC3C;AAAA,EAEA,OAAO,kBAAqC,UAAgC,YAAoB,GAAG;AACjG,WAAO,SAAS,KAAK,CAAC,GAAG,MACvB,EAAE,YAAY,EAAE,YACZ,CAAC,YACD,EAAE,YAAY,EAAE,YACd,YACA,CAAC;AAAA,EACX;AAAA,EAEA,aAAa,aAAgC,UAAyC;AACpF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,QAAQ,GAAG;AACjD,YAAM,WAAW,MAAM,KAAK,SAAS,KAAK,CAAC,CAAC;AAC5C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AACxB,aAAO,QAAQ,IAAI,KAAK,CAAC;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,cAAiC,MAAqC;AACjF,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,cAAc,IAAI,GAAG;AACjD,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,UAA6B,MAAqC;AAC7E,UAAM,SAA0B,CAAC;AACjC,eAAW,QAAQ,MAAM,KAAK,UAAU,IAAI,GAAG;AAC7C,aAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAAW;AACT,WAAO;AAAA,MACL,QAAQ,KAAK;AAAA,MACb,GAAG,KAAK;AAAA,IACV;AAAA,EACF;AACF;","names":["assertEx","assertEx"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/payload-builder",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.6.0-rc.2",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -29,22 +29,23 @@
|
|
|
29
29
|
"module": "dist/neutral/index.mjs",
|
|
30
30
|
"types": "dist/neutral/index.d.ts",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@xylabs/assert": "^4.4.
|
|
33
|
-
"@xylabs/hex": "^4.4.
|
|
34
|
-
"@xylabs/logger": "^4.4.
|
|
35
|
-
"@xylabs/object": "^4.4.
|
|
36
|
-
"@xylabs/promise": "^4.4.
|
|
37
|
-
"@xyo-network/hash": "^3.
|
|
38
|
-
"@xyo-network/payload-model": "^3.
|
|
32
|
+
"@xylabs/assert": "^4.4.12",
|
|
33
|
+
"@xylabs/hex": "^4.4.12",
|
|
34
|
+
"@xylabs/logger": "^4.4.12",
|
|
35
|
+
"@xylabs/object": "^4.4.12",
|
|
36
|
+
"@xylabs/promise": "^4.4.12",
|
|
37
|
+
"@xyo-network/hash": "^3.6.0-rc.2",
|
|
38
|
+
"@xyo-network/payload-model": "^3.6.0-rc.2"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@xylabs/ts-scripts-yarn3": "^4.2.4",
|
|
42
42
|
"@xylabs/tsconfig": "^4.2.4",
|
|
43
|
-
"@xylabs/vitest-extended": "^4.4.
|
|
43
|
+
"@xylabs/vitest-extended": "^4.4.12",
|
|
44
44
|
"typescript": "^5.7.2",
|
|
45
|
-
"vitest": "^2.1.
|
|
45
|
+
"vitest": "^2.1.8"
|
|
46
46
|
},
|
|
47
47
|
"publishConfig": {
|
|
48
48
|
"access": "public"
|
|
49
|
-
}
|
|
49
|
+
},
|
|
50
|
+
"stableVersion": "3.5.2"
|
|
50
51
|
}
|