@xyo-network/payload-builder 4.1.1 → 4.1.3

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 (4) hide show
  1. package/dist/browser/index.d.ts +4 -72
  2. package/dist/neutral/index.d.ts +4 -72
  3. package/dist/node/index.d.ts +4 -72
  4. package/package.json +12 -12
package/dist/browser/index.d.ts CHANGED
@@ -1,72 +1,4 @@
1
- import * as _xylabs_object from '@xylabs/object';
2
- import { AnyObject, Compare, EmptyObject } from '@xylabs/object';
3
- import { Hash } from '@xylabs/hex';
4
- import { Promisable } from '@xylabs/promise';
5
- import { Schema, WithOptionalSchema, WithoutSchema, Payload, WithoutStorageMeta, WithoutClientMeta, WithOnlyClientMeta, WithStorageMeta, Sequence, WithoutMeta, WithoutPrivateStorageMeta } from '@xyo-network/payload-model';
6
- import { Logger } from '@xylabs/logger';
7
-
8
- interface PayloadBuilderOptions {
9
- readonly logger?: Logger;
10
- readonly schema: Schema;
11
- }
12
-
13
- declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
14
- declare class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {
15
- readonly options: PayloadBuilderOptions;
16
- protected _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>;
17
- protected _meta?: WithOnlyClientMeta<T>;
18
- protected _schema: Schema;
19
- constructor(options: PayloadBuilderOptions);
20
- static addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>;
21
- static addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>;
22
- static compareStorageMeta(a: WithStorageMeta<Payload>, b: WithStorageMeta<Payload>, comparer?: Compare<Sequence>): number;
23
- static dataHash<T extends Payload>(payload: T): Promise<Hash>;
24
- static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
25
- static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
26
- static dataHashes(payloads: undefined): Promise<undefined>;
27
- static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
28
- static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
29
- static filterExcludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
30
- static filterIncludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
31
- static filterIncludeByEitherHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
32
- static findByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
33
- static hash<T extends Payload>(payload: T): Promise<Hash>;
34
- /**
35
- * Creates an array of payload/hash tuples based on the payloads passed in
36
- * @param objs Any array of payloads
37
- * @returns An array of payload/hash tuples
38
- */
39
- static hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
40
- static hashableFields<T extends Payload>(payload: T): WithoutStorageMeta<T>;
41
- static hashes(payloads: undefined): Promise<undefined>;
42
- static hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
43
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
44
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
45
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
46
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
47
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
48
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
49
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
50
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
51
- static pickClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithOnlyClientMeta<T>;
52
- static pickClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithOnlyClientMeta<T>[];
53
- static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction?: -1 | 1, comparer?: Compare<Sequence>): WithStorageMeta<T>[];
54
- static toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>>;
55
- static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
56
- /**
57
- * Creates an object map of payload hashes to payloads based on the payloads passed in
58
- * @param objs Any array of payloads
59
- * @returns A map of hashes to payloads
60
- */
61
- static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
62
- private static addHashMeta;
63
- private static addSequencedStorageMeta;
64
- build(): R;
65
- dataHashableFields(): Promise<_xylabs_object.DeepOmitStartsWith<_xylabs_object.DeepOmitStartsWith<T, "_">, "$">>;
66
- fields(fields: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>): this;
67
- meta(meta: WithOnlyClientMeta<T>): this;
68
- schema(value: Schema): void;
69
- }
70
-
71
- export { PayloadBuilder, omitSchema };
72
- export type { PayloadBuilderOptions };
1
+ export * from './Builder.ts';
2
+ export * from './Builder.ts';
3
+ export * from './Options.ts';
4
+ //# sourceMappingURL=index.d.ts.map
package/dist/neutral/index.d.ts CHANGED
@@ -1,72 +1,4 @@
1
- import * as _xylabs_object from '@xylabs/object';
2
- import { AnyObject, Compare, EmptyObject } from '@xylabs/object';
3
- import { Hash } from '@xylabs/hex';
4
- import { Promisable } from '@xylabs/promise';
5
- import { Schema, WithOptionalSchema, WithoutSchema, Payload, WithoutStorageMeta, WithoutClientMeta, WithOnlyClientMeta, WithStorageMeta, Sequence, WithoutMeta, WithoutPrivateStorageMeta } from '@xyo-network/payload-model';
6
- import { Logger } from '@xylabs/logger';
7
-
8
- interface PayloadBuilderOptions {
9
- readonly logger?: Logger;
10
- readonly schema: Schema;
11
- }
12
-
13
- declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
14
- declare class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {
15
- readonly options: PayloadBuilderOptions;
16
- protected _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>;
17
- protected _meta?: WithOnlyClientMeta<T>;
18
- protected _schema: Schema;
19
- constructor(options: PayloadBuilderOptions);
20
- static addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>;
21
- static addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>;
22
- static compareStorageMeta(a: WithStorageMeta<Payload>, b: WithStorageMeta<Payload>, comparer?: Compare<Sequence>): number;
23
- static dataHash<T extends Payload>(payload: T): Promise<Hash>;
24
- static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
25
- static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
26
- static dataHashes(payloads: undefined): Promise<undefined>;
27
- static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
28
- static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
29
- static filterExcludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
30
- static filterIncludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
31
- static filterIncludeByEitherHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
32
- static findByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
33
- static hash<T extends Payload>(payload: T): Promise<Hash>;
34
- /**
35
- * Creates an array of payload/hash tuples based on the payloads passed in
36
- * @param objs Any array of payloads
37
- * @returns An array of payload/hash tuples
38
- */
39
- static hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
40
- static hashableFields<T extends Payload>(payload: T): WithoutStorageMeta<T>;
41
- static hashes(payloads: undefined): Promise<undefined>;
42
- static hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
43
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
44
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
45
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
46
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
47
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
48
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
49
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
50
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
51
- static pickClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithOnlyClientMeta<T>;
52
- static pickClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithOnlyClientMeta<T>[];
53
- static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction?: -1 | 1, comparer?: Compare<Sequence>): WithStorageMeta<T>[];
54
- static toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>>;
55
- static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
56
- /**
57
- * Creates an object map of payload hashes to payloads based on the payloads passed in
58
- * @param objs Any array of payloads
59
- * @returns A map of hashes to payloads
60
- */
61
- static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
62
- private static addHashMeta;
63
- private static addSequencedStorageMeta;
64
- build(): R;
65
- dataHashableFields(): Promise<_xylabs_object.DeepOmitStartsWith<_xylabs_object.DeepOmitStartsWith<T, "_">, "$">>;
66
- fields(fields: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>): this;
67
- meta(meta: WithOnlyClientMeta<T>): this;
68
- schema(value: Schema): void;
69
- }
70
-
71
- export { PayloadBuilder, omitSchema };
72
- export type { PayloadBuilderOptions };
1
+ export * from './Builder.ts';
2
+ export * from './Builder.ts';
3
+ export * from './Options.ts';
4
+ //# sourceMappingURL=index.d.ts.map
package/dist/node/index.d.ts CHANGED
@@ -1,72 +1,4 @@
1
- import * as _xylabs_object from '@xylabs/object';
2
- import { AnyObject, Compare, EmptyObject } from '@xylabs/object';
3
- import { Hash } from '@xylabs/hex';
4
- import { Promisable } from '@xylabs/promise';
5
- import { Schema, WithOptionalSchema, WithoutSchema, Payload, WithoutStorageMeta, WithoutClientMeta, WithOnlyClientMeta, WithStorageMeta, Sequence, WithoutMeta, WithoutPrivateStorageMeta } from '@xyo-network/payload-model';
6
- import { Logger } from '@xylabs/logger';
7
-
8
- interface PayloadBuilderOptions {
9
- readonly logger?: Logger;
10
- readonly schema: Schema;
11
- }
12
-
13
- declare const omitSchema: <T extends WithOptionalSchema>(payload: T) => WithoutSchema<T>;
14
- declare class PayloadBuilder<T extends Payload = Payload<AnyObject>, R = T> {
15
- readonly options: PayloadBuilderOptions;
16
- protected _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>;
17
- protected _meta?: WithOnlyClientMeta<T>;
18
- protected _schema: Schema;
19
- constructor(options: PayloadBuilderOptions);
20
- static addStorageMeta<T extends Payload>(payload: T, index?: number): Promise<WithStorageMeta<T>>;
21
- static addStorageMeta<T extends Payload>(payloads: T[]): Promise<WithStorageMeta<T>[]>;
22
- static compareStorageMeta(a: WithStorageMeta<Payload>, b: WithStorageMeta<Payload>, comparer?: Compare<Sequence>): number;
23
- static dataHash<T extends Payload>(payload: T): Promise<Hash>;
24
- static dataHashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
25
- static dataHashableFields<T extends Payload>(schema: Schema, payload: WithoutSchema<T>): Promisable<WithoutMeta<T>>;
26
- static dataHashes(payloads: undefined): Promise<undefined>;
27
- static dataHashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
28
- static filterExclude<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
29
- static filterExcludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
30
- static filterIncludeByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
31
- static filterIncludeByEitherHash<T extends Payload>(payloads: T[] | undefined, hash: Hash[] | Hash): Promise<T[]>;
32
- static findByDataHash<T extends Payload>(payloads: T[] | undefined, hash: Hash): Promise<T | undefined>;
33
- static hash<T extends Payload>(payload: T): Promise<Hash>;
34
- /**
35
- * Creates an array of payload/hash tuples based on the payloads passed in
36
- * @param objs Any array of payloads
37
- * @returns An array of payload/hash tuples
38
- */
39
- static hashPairs<T extends Payload>(payloads: T[]): Promise<[T, Hash][]>;
40
- static hashableFields<T extends Payload>(payload: T): WithoutStorageMeta<T>;
41
- static hashes(payloads: undefined): Promise<undefined>;
42
- static hashes<T extends Payload>(payloads: T[]): Promise<Hash[]>;
43
- static omitClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutClientMeta<T>;
44
- static omitClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutClientMeta<T>[];
45
- static omitMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutMeta<T>;
46
- static omitMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutMeta<T>[];
47
- static omitPrivateStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutPrivateStorageMeta<T>;
48
- static omitPrivateStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutPrivateStorageMeta<T>[];
49
- static omitStorageMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithoutStorageMeta<T>;
50
- static omitStorageMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithoutStorageMeta<T>[];
51
- static pickClientMeta<T extends EmptyObject>(payload: T, maxDepth?: number): WithOnlyClientMeta<T>;
52
- static pickClientMeta<T extends EmptyObject>(payloads: T[], maxDepth?: number): WithOnlyClientMeta<T>[];
53
- static sortByStorageMeta<T extends Payload>(payloads: WithStorageMeta<T>[], direction?: -1 | 1, comparer?: Compare<Sequence>): WithStorageMeta<T>[];
54
- static toAllHashMap<T extends Payload>(payloads: T[]): Promise<Record<Hash, T>>;
55
- static toDataHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
56
- /**
57
- * Creates an object map of payload hashes to payloads based on the payloads passed in
58
- * @param objs Any array of payloads
59
- * @returns A map of hashes to payloads
60
- */
61
- static toHashMap<T extends Payload>(objs: T[]): Promise<Record<Hash, T>>;
62
- private static addHashMeta;
63
- private static addSequencedStorageMeta;
64
- build(): R;
65
- dataHashableFields(): Promise<_xylabs_object.DeepOmitStartsWith<_xylabs_object.DeepOmitStartsWith<T, "_">, "$">>;
66
- fields(fields: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>): this;
67
- meta(meta: WithOnlyClientMeta<T>): this;
68
- schema(value: Schema): void;
69
- }
70
-
71
- export { PayloadBuilder, omitSchema };
72
- export type { PayloadBuilderOptions };
1
+ export * from './Builder.ts';
2
+ export * from './Builder.ts';
3
+ export * from './Options.ts';
4
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/payload-builder",
3
- "version": "4.1.1",
3
+ "version": "4.1.3",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,19 +29,19 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/assert": "^4.13.15",
33
- "@xylabs/exists": "^4.13.15",
34
- "@xylabs/hex": "^4.13.15",
35
- "@xylabs/logger": "^4.13.15",
36
- "@xylabs/object": "^4.13.15",
37
- "@xylabs/promise": "^4.13.15",
38
- "@xyo-network/hash": "^4.1.1",
39
- "@xyo-network/payload-model": "^4.1.1"
32
+ "@xylabs/assert": "^4.13.16",
33
+ "@xylabs/exists": "^4.13.16",
34
+ "@xylabs/hex": "^4.13.16",
35
+ "@xylabs/logger": "^4.13.16",
36
+ "@xylabs/object": "^4.13.16",
37
+ "@xylabs/promise": "^4.13.16",
38
+ "@xyo-network/hash": "^4.1.3",
39
+ "@xyo-network/payload-model": "^4.1.3"
40
40
  },
41
41
  "devDependencies": {
42
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
43
- "@xylabs/tsconfig": "^7.0.0-rc.23",
44
- "@xylabs/vitest-extended": "^4.13.15",
42
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
43
+ "@xylabs/tsconfig": "^7.0.0-rc.27",
44
+ "@xylabs/vitest-extended": "^4.13.16",
45
45
  "typescript": "^5.8.3",
46
46
  "vitest": "^3.2.4"
47
47
  },