@xyo-network/payload-model 3.5.1 → 3.6.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.
- package/dist/browser/Payload.d.ts +1 -8
- package/dist/browser/Payload.d.ts.map +1 -1
- package/dist/browser/Schema.d.ts +2 -2
- package/dist/browser/index.d.ts +0 -2
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.mjs +1 -29
- package/dist/browser/index.mjs.map +1 -1
- package/dist/browser/isPayload.d.ts +4 -4
- package/dist/browser/isPayload.d.ts.map +1 -1
- package/dist/browser/isPayloadOfSchemaType.d.ts +0 -2
- package/dist/browser/isPayloadOfSchemaType.d.ts.map +1 -1
- package/dist/neutral/Payload.d.ts +1 -8
- package/dist/neutral/Payload.d.ts.map +1 -1
- package/dist/neutral/Schema.d.ts +2 -2
- package/dist/neutral/index.d.ts +0 -2
- package/dist/neutral/index.d.ts.map +1 -1
- package/dist/neutral/index.mjs +1 -29
- package/dist/neutral/index.mjs.map +1 -1
- package/dist/neutral/isPayload.d.ts +4 -4
- package/dist/neutral/isPayload.d.ts.map +1 -1
- package/dist/neutral/isPayloadOfSchemaType.d.ts +0 -2
- package/dist/neutral/isPayloadOfSchemaType.d.ts.map +1 -1
- package/dist/node/Payload.d.ts +1 -8
- package/dist/node/Payload.d.ts.map +1 -1
- package/dist/node/Schema.d.ts +2 -2
- package/dist/node/index.d.ts +0 -2
- package/dist/node/index.d.ts.map +1 -1
- package/dist/node/index.mjs +1 -29
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/isPayload.d.ts +4 -4
- package/dist/node/isPayload.d.ts.map +1 -1
- package/dist/node/isPayloadOfSchemaType.d.ts +0 -2
- package/dist/node/isPayloadOfSchemaType.d.ts.map +1 -1
- package/package.json +7 -6
- package/src/Payload.ts +1 -9
- package/src/index.ts +0 -2
- package/src/isPayloadOfSchemaType.ts +0 -16
- package/dist/browser/Meta.d.ts +0 -8
- package/dist/browser/Meta.d.ts.map +0 -1
- package/dist/browser/isPayloadWithHash.d.ts +0 -15
- package/dist/browser/isPayloadWithHash.d.ts.map +0 -1
- package/dist/neutral/Meta.d.ts +0 -8
- package/dist/neutral/Meta.d.ts.map +0 -1
- package/dist/neutral/isPayloadWithHash.d.ts +0 -15
- package/dist/neutral/isPayloadWithHash.d.ts.map +0 -1
- package/dist/node/Meta.d.ts +0 -8
- package/dist/node/Meta.d.ts.map +0 -1
- package/dist/node/isPayloadWithHash.d.ts +0 -15
- package/dist/node/isPayloadWithHash.d.ts.map +0 -1
- package/src/Meta.ts +0 -20
- package/src/isPayloadWithHash.ts +0 -21
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
import type { Hash } from '@xylabs/hex';
|
|
2
|
-
import type { EmptyObject
|
|
2
|
+
import type { EmptyObject } from '@xylabs/object';
|
|
3
3
|
import type { Schema, WithSchema } from './Schema.ts';
|
|
4
|
-
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
|
|
6
|
-
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
|
-
$hash: Hash;
|
|
8
|
-
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
|
|
10
|
-
}
|
|
11
4
|
/** Additional fields for a payload */
|
|
12
5
|
export interface PayloadFields extends EmptyObject {
|
|
13
6
|
schema: Schema;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAEpI,6BAA6B;AAC7B,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
|
package/dist/browser/Schema.d.ts
CHANGED
|
@@ -5,8 +5,8 @@ export declare const PayloadSchema: "network.xyo.payload";
|
|
|
5
5
|
export type PayloadSchema = typeof PayloadSchema;
|
|
6
6
|
export declare const isSchema: (value: unknown) => value is Schema;
|
|
7
7
|
export declare const asSchema: {
|
|
8
|
-
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
9
|
-
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
8
|
+
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
9
|
+
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
10
10
|
};
|
|
11
11
|
/** Schema fields for a Payload */
|
|
12
12
|
export interface SchemaFields extends EmptyObject {
|
package/dist/browser/index.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
export * from './Error.ts';
|
|
2
2
|
export * from './isPayload.ts';
|
|
3
3
|
export * from './isPayloadOfSchemaType.ts';
|
|
4
|
-
export * from './isPayloadWithHash.ts';
|
|
5
|
-
export * from './Meta.ts';
|
|
6
4
|
export * from './Payload.ts';
|
|
7
5
|
export * from './PayloadFindFilter.ts';
|
|
8
6
|
export * from './PayloadSet/index.ts';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}
|
package/dist/browser/index.mjs
CHANGED
|
@@ -19,9 +19,6 @@ var asPayload = (schema) => AsObjectFactory.create((value) => isPayload(schema)(
|
|
|
19
19
|
var isPayloadOfSchemaType = (schema) => {
|
|
20
20
|
return (x) => isAnyPayload(x) && x?.schema === schema;
|
|
21
21
|
};
|
|
22
|
-
var isPayloadOfSchemaTypeWithMeta = (schema) => {
|
|
23
|
-
return (x) => isPayloadOfSchemaType(schema)(x) && x.$hash !== void 0;
|
|
24
|
-
};
|
|
25
22
|
var isPayloadOfSchemaTypeWithSources = (schema) => {
|
|
26
23
|
return (x) => isPayloadOfSchemaType(schema)(x) && x.sources !== void 0 && Array.isArray(x.sources);
|
|
27
24
|
};
|
|
@@ -33,27 +30,6 @@ var notPayloadOfSchemaType = (schema) => {
|
|
|
33
30
|
var ModuleErrorSchema = "network.xyo.error.module";
|
|
34
31
|
var isModuleError = isPayloadOfSchemaType(ModuleErrorSchema);
|
|
35
32
|
|
|
36
|
-
// src/isPayloadWithHash.ts
|
|
37
|
-
var isWithHash = (value) => {
|
|
38
|
-
return typeof value?.$hash === "string";
|
|
39
|
-
};
|
|
40
|
-
var isPayloadWithHash = (value) => {
|
|
41
|
-
return isAnyPayload(value) && isWithHash(value);
|
|
42
|
-
};
|
|
43
|
-
|
|
44
|
-
// src/Meta.ts
|
|
45
|
-
var unMeta = (payload) => {
|
|
46
|
-
if (payload) {
|
|
47
|
-
const {
|
|
48
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
49
|
-
$meta,
|
|
50
|
-
$hash,
|
|
51
|
-
...result
|
|
52
|
-
} = payload;
|
|
53
|
-
return result;
|
|
54
|
-
}
|
|
55
|
-
};
|
|
56
|
-
|
|
57
33
|
// src/PayloadSet/PayloadSetSchema.ts
|
|
58
34
|
var PayloadSetSchema = "network.xyo.payload.set";
|
|
59
35
|
|
|
@@ -75,12 +51,8 @@ export {
|
|
|
75
51
|
isModuleError,
|
|
76
52
|
isPayload,
|
|
77
53
|
isPayloadOfSchemaType,
|
|
78
|
-
isPayloadOfSchemaTypeWithMeta,
|
|
79
54
|
isPayloadOfSchemaTypeWithSources,
|
|
80
|
-
isPayloadWithHash,
|
|
81
55
|
isSchema,
|
|
82
|
-
|
|
83
|
-
notPayloadOfSchemaType,
|
|
84
|
-
unMeta
|
|
56
|
+
notPayloadOfSchemaType
|
|
85
57
|
};
|
|
86
58
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/
|
|
1
|
+
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n if (isObject(value)) {\n return typeof value.schema === 'string'\n }\n return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n = <T extends Payload>(schema: string[]) =>\n (value: unknown): value is T => {\n if (isAnyPayload(value)) {\n return schema.includes(value.schema)\n }\n return false\n }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithSources<T> =>\n isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n details?: JsonValue\n message?: string\n name?: string\n query?: Hash\n schema: ModuleErrorSchema\n sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n /** Schema of the object */\n schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;ACnB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACPO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACjB1E,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;","names":[]}
|
|
@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
|
|
|
3
3
|
export declare const asAnyPayload: {
|
|
4
4
|
<TType extends {
|
|
5
5
|
schema: string;
|
|
6
|
-
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
6
|
+
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
7
7
|
<TType extends {
|
|
8
8
|
schema: string;
|
|
9
|
-
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
9
|
+
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
|
|
10
10
|
schema: string;
|
|
11
11
|
} & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
12
12
|
};
|
|
13
13
|
export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
|
|
14
14
|
export declare const asPayload: <T extends Payload>(schema: string[]) => {
|
|
15
|
-
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
16
|
-
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
15
|
+
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
16
|
+
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
17
17
|
};
|
|
18
18
|
//# sourceMappingURL=isPayload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;4DAHpB,
|
|
1
|
+
{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;4DAHpB,sDAGD,iCAAiC,gBAAoB;;;4DAIrD,sDAAe;;+DAGb,gBACK;CARqD,CAAA;AAEhE,eAAO,MAAM,SAAS,GACjB,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE,aAC5B,OAAO,KAAG,KAAK,IAAI,CAK1B,CAAA;AAEL,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE;oCAdxD,sDAGD,iCAAiC,gBAAoB;oCAIrD,sDAAe,4FAGb,gBACK;CAGuI,CAAA"}
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import type { WithMeta } from './Meta.ts';
|
|
2
1
|
import type { Payload, WithSources } from './Payload.ts';
|
|
3
2
|
export declare const isPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
|
|
4
|
-
export declare const isPayloadOfSchemaTypeWithMeta: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithMeta<T>;
|
|
5
3
|
export declare const isPayloadOfSchemaTypeWithSources: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithSources<T>;
|
|
6
4
|
export declare const notPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
|
|
7
5
|
//# sourceMappingURL=isPayloadOfSchemaType.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAExD,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACzD,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA;AAED,eAAO,MAAM,gCAAgC,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACpE,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAEhD,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UAC1D,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA"}
|
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
import type { Hash } from '@xylabs/hex';
|
|
2
|
-
import type { EmptyObject
|
|
2
|
+
import type { EmptyObject } from '@xylabs/object';
|
|
3
3
|
import type { Schema, WithSchema } from './Schema.ts';
|
|
4
|
-
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
|
|
6
|
-
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
|
-
$hash: Hash;
|
|
8
|
-
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
|
|
10
|
-
}
|
|
11
4
|
/** Additional fields for a payload */
|
|
12
5
|
export interface PayloadFields extends EmptyObject {
|
|
13
6
|
schema: Schema;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAEpI,6BAA6B;AAC7B,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
|
package/dist/neutral/Schema.d.ts
CHANGED
|
@@ -5,8 +5,8 @@ export declare const PayloadSchema: "network.xyo.payload";
|
|
|
5
5
|
export type PayloadSchema = typeof PayloadSchema;
|
|
6
6
|
export declare const isSchema: (value: unknown) => value is Schema;
|
|
7
7
|
export declare const asSchema: {
|
|
8
|
-
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
9
|
-
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
8
|
+
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
9
|
+
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
10
10
|
};
|
|
11
11
|
/** Schema fields for a Payload */
|
|
12
12
|
export interface SchemaFields extends EmptyObject {
|
package/dist/neutral/index.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
export * from './Error.ts';
|
|
2
2
|
export * from './isPayload.ts';
|
|
3
3
|
export * from './isPayloadOfSchemaType.ts';
|
|
4
|
-
export * from './isPayloadWithHash.ts';
|
|
5
|
-
export * from './Meta.ts';
|
|
6
4
|
export * from './Payload.ts';
|
|
7
5
|
export * from './PayloadFindFilter.ts';
|
|
8
6
|
export * from './PayloadSet/index.ts';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}
|
package/dist/neutral/index.mjs
CHANGED
|
@@ -19,9 +19,6 @@ var asPayload = (schema) => AsObjectFactory.create((value) => isPayload(schema)(
|
|
|
19
19
|
var isPayloadOfSchemaType = (schema) => {
|
|
20
20
|
return (x) => isAnyPayload(x) && x?.schema === schema;
|
|
21
21
|
};
|
|
22
|
-
var isPayloadOfSchemaTypeWithMeta = (schema) => {
|
|
23
|
-
return (x) => isPayloadOfSchemaType(schema)(x) && x.$hash !== void 0;
|
|
24
|
-
};
|
|
25
22
|
var isPayloadOfSchemaTypeWithSources = (schema) => {
|
|
26
23
|
return (x) => isPayloadOfSchemaType(schema)(x) && x.sources !== void 0 && Array.isArray(x.sources);
|
|
27
24
|
};
|
|
@@ -33,27 +30,6 @@ var notPayloadOfSchemaType = (schema) => {
|
|
|
33
30
|
var ModuleErrorSchema = "network.xyo.error.module";
|
|
34
31
|
var isModuleError = isPayloadOfSchemaType(ModuleErrorSchema);
|
|
35
32
|
|
|
36
|
-
// src/isPayloadWithHash.ts
|
|
37
|
-
var isWithHash = (value) => {
|
|
38
|
-
return typeof value?.$hash === "string";
|
|
39
|
-
};
|
|
40
|
-
var isPayloadWithHash = (value) => {
|
|
41
|
-
return isAnyPayload(value) && isWithHash(value);
|
|
42
|
-
};
|
|
43
|
-
|
|
44
|
-
// src/Meta.ts
|
|
45
|
-
var unMeta = (payload) => {
|
|
46
|
-
if (payload) {
|
|
47
|
-
const {
|
|
48
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
49
|
-
$meta,
|
|
50
|
-
$hash,
|
|
51
|
-
...result
|
|
52
|
-
} = payload;
|
|
53
|
-
return result;
|
|
54
|
-
}
|
|
55
|
-
};
|
|
56
|
-
|
|
57
33
|
// src/PayloadSet/PayloadSetSchema.ts
|
|
58
34
|
var PayloadSetSchema = "network.xyo.payload.set";
|
|
59
35
|
|
|
@@ -75,12 +51,8 @@ export {
|
|
|
75
51
|
isModuleError,
|
|
76
52
|
isPayload,
|
|
77
53
|
isPayloadOfSchemaType,
|
|
78
|
-
isPayloadOfSchemaTypeWithMeta,
|
|
79
54
|
isPayloadOfSchemaTypeWithSources,
|
|
80
|
-
isPayloadWithHash,
|
|
81
55
|
isSchema,
|
|
82
|
-
|
|
83
|
-
notPayloadOfSchemaType,
|
|
84
|
-
unMeta
|
|
56
|
+
notPayloadOfSchemaType
|
|
85
57
|
};
|
|
86
58
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/
|
|
1
|
+
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n if (isObject(value)) {\n return typeof value.schema === 'string'\n }\n return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n = <T extends Payload>(schema: string[]) =>\n (value: unknown): value is T => {\n if (isAnyPayload(value)) {\n return schema.includes(value.schema)\n }\n return false\n }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithSources<T> =>\n isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n details?: JsonValue\n message?: string\n name?: string\n query?: Hash\n schema: ModuleErrorSchema\n sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n /** Schema of the object */\n schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;ACnB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACPO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACjB1E,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;","names":[]}
|
|
@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
|
|
|
3
3
|
export declare const asAnyPayload: {
|
|
4
4
|
<TType extends {
|
|
5
5
|
schema: string;
|
|
6
|
-
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
6
|
+
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
7
7
|
<TType extends {
|
|
8
8
|
schema: string;
|
|
9
|
-
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
9
|
+
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
|
|
10
10
|
schema: string;
|
|
11
11
|
} & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
12
12
|
};
|
|
13
13
|
export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
|
|
14
14
|
export declare const asPayload: <T extends Payload>(schema: string[]) => {
|
|
15
|
-
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
16
|
-
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
15
|
+
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
16
|
+
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
17
17
|
};
|
|
18
18
|
//# sourceMappingURL=isPayload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;4DAHpB,
|
|
1
|
+
{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;4DAHpB,sDAGD,iCAAiC,gBAAoB;;;4DAIrD,sDAAe;;+DAGb,gBACK;CARqD,CAAA;AAEhE,eAAO,MAAM,SAAS,GACjB,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE,aAC5B,OAAO,KAAG,KAAK,IAAI,CAK1B,CAAA;AAEL,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE;oCAdxD,sDAGD,iCAAiC,gBAAoB;oCAIrD,sDAAe,4FAGb,gBACK;CAGuI,CAAA"}
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import type { WithMeta } from './Meta.ts';
|
|
2
1
|
import type { Payload, WithSources } from './Payload.ts';
|
|
3
2
|
export declare const isPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
|
|
4
|
-
export declare const isPayloadOfSchemaTypeWithMeta: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithMeta<T>;
|
|
5
3
|
export declare const isPayloadOfSchemaTypeWithSources: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithSources<T>;
|
|
6
4
|
export declare const notPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
|
|
7
5
|
//# sourceMappingURL=isPayloadOfSchemaType.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAExD,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACzD,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA;AAED,eAAO,MAAM,gCAAgC,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACpE,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAEhD,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UAC1D,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA"}
|
package/dist/node/Payload.d.ts
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
import type { Hash } from '@xylabs/hex';
|
|
2
|
-
import type { EmptyObject
|
|
2
|
+
import type { EmptyObject } from '@xylabs/object';
|
|
3
3
|
import type { Schema, WithSchema } from './Schema.ts';
|
|
4
|
-
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
|
|
6
|
-
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
|
-
$hash: Hash;
|
|
8
|
-
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta;
|
|
10
|
-
}
|
|
11
4
|
/** Additional fields for a payload */
|
|
12
5
|
export interface PayloadFields extends EmptyObject {
|
|
13
6
|
schema: Schema;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAA;AAEpI,6BAA6B;AAC7B,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAClG,CAAC,SAAS,UAAU,GAClB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAC3B,WAAW,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GACT,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAExF,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEzB,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAA;CAAE,CAAA;AACzE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7I,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA"}
|
package/dist/node/Schema.d.ts
CHANGED
|
@@ -5,8 +5,8 @@ export declare const PayloadSchema: "network.xyo.payload";
|
|
|
5
5
|
export type PayloadSchema = typeof PayloadSchema;
|
|
6
6
|
export declare const isSchema: (value: unknown) => value is Schema;
|
|
7
7
|
export declare const asSchema: {
|
|
8
|
-
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
9
|
-
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
8
|
+
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
9
|
+
<TType extends string>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<string>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
10
10
|
};
|
|
11
11
|
/** Schema fields for a Payload */
|
|
12
12
|
export interface SchemaFields extends EmptyObject {
|
package/dist/node/index.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
export * from './Error.ts';
|
|
2
2
|
export * from './isPayload.ts';
|
|
3
3
|
export * from './isPayloadOfSchemaType.ts';
|
|
4
|
-
export * from './isPayloadWithHash.ts';
|
|
5
|
-
export * from './Meta.ts';
|
|
6
4
|
export * from './Payload.ts';
|
|
7
5
|
export * from './PayloadFindFilter.ts';
|
|
8
6
|
export * from './PayloadSet/index.ts';
|
package/dist/node/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA;AAC1C,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}
|
package/dist/node/index.mjs
CHANGED
|
@@ -19,9 +19,6 @@ var asPayload = (schema) => AsObjectFactory.create((value) => isPayload(schema)(
|
|
|
19
19
|
var isPayloadOfSchemaType = (schema) => {
|
|
20
20
|
return (x) => isAnyPayload(x) && x?.schema === schema;
|
|
21
21
|
};
|
|
22
|
-
var isPayloadOfSchemaTypeWithMeta = (schema) => {
|
|
23
|
-
return (x) => isPayloadOfSchemaType(schema)(x) && x.$hash !== void 0;
|
|
24
|
-
};
|
|
25
22
|
var isPayloadOfSchemaTypeWithSources = (schema) => {
|
|
26
23
|
return (x) => isPayloadOfSchemaType(schema)(x) && x.sources !== void 0 && Array.isArray(x.sources);
|
|
27
24
|
};
|
|
@@ -33,27 +30,6 @@ var notPayloadOfSchemaType = (schema) => {
|
|
|
33
30
|
var ModuleErrorSchema = "network.xyo.error.module";
|
|
34
31
|
var isModuleError = isPayloadOfSchemaType(ModuleErrorSchema);
|
|
35
32
|
|
|
36
|
-
// src/isPayloadWithHash.ts
|
|
37
|
-
var isWithHash = (value) => {
|
|
38
|
-
return typeof value?.$hash === "string";
|
|
39
|
-
};
|
|
40
|
-
var isPayloadWithHash = (value) => {
|
|
41
|
-
return isAnyPayload(value) && isWithHash(value);
|
|
42
|
-
};
|
|
43
|
-
|
|
44
|
-
// src/Meta.ts
|
|
45
|
-
var unMeta = (payload) => {
|
|
46
|
-
if (payload) {
|
|
47
|
-
const {
|
|
48
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
49
|
-
$meta,
|
|
50
|
-
$hash,
|
|
51
|
-
...result
|
|
52
|
-
} = payload;
|
|
53
|
-
return result;
|
|
54
|
-
}
|
|
55
|
-
};
|
|
56
|
-
|
|
57
33
|
// src/PayloadSet/PayloadSetSchema.ts
|
|
58
34
|
var PayloadSetSchema = "network.xyo.payload.set";
|
|
59
35
|
|
|
@@ -75,12 +51,8 @@ export {
|
|
|
75
51
|
isModuleError,
|
|
76
52
|
isPayload,
|
|
77
53
|
isPayloadOfSchemaType,
|
|
78
|
-
isPayloadOfSchemaTypeWithMeta,
|
|
79
54
|
isPayloadOfSchemaTypeWithSources,
|
|
80
|
-
isPayloadWithHash,
|
|
81
55
|
isSchema,
|
|
82
|
-
|
|
83
|
-
notPayloadOfSchemaType,
|
|
84
|
-
unMeta
|
|
56
|
+
notPayloadOfSchemaType
|
|
85
57
|
};
|
|
86
58
|
//# sourceMappingURL=index.mjs.map
|
package/dist/node/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/
|
|
1
|
+
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["import { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport type { Payload } from './Payload.ts'\n\nexport const isAnyPayload = (value: unknown): value is Payload => {\n if (isObject(value)) {\n return typeof value.schema === 'string'\n }\n return false\n}\n\nexport const asAnyPayload = AsObjectFactory.create(isAnyPayload)\n\nexport const isPayload\n = <T extends Payload>(schema: string[]) =>\n (value: unknown): value is T => {\n if (isAnyPayload(value)) {\n return schema.includes(value.schema)\n }\n return false\n }\n\nexport const asPayload = <T extends Payload>(schema: string[]) => AsObjectFactory.create((value: unknown): value is T => isPayload(schema)(value))\n","import { isAnyPayload } from './isPayload.ts'\nimport type { Payload, WithSources } from './Payload.ts'\n\nexport const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema\n}\n\nexport const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithSources<T> =>\n isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)\n}\n\nexport const notPayloadOfSchemaType = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is T => !isAnyPayload(x) || x?.schema !== schema\n}\n\n// test types -- keep for future validation, but comment out\n\n/*\ntype TestSchema = 'network.xyo.test'\nconst TestSchema: TestSchema = 'network.xyo.test'\n\ntype Test = Payload<{ field: string }, TestSchema>\n\nconst testPayload: Test = { field: 'test', schema: TestSchema }\n\nconst testPayloads: Payload[] = [testPayload]\n\nconst isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))\n\nconst isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))\n*/\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonValue } from '@xylabs/object'\n\nimport { isPayloadOfSchemaType } from './isPayloadOfSchemaType.ts'\nimport type { Payload } from './Payload.ts'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n details?: JsonValue\n message?: string\n name?: string\n query?: Hash\n schema: ModuleErrorSchema\n sources?: Hash[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import type { EmptyObject } from '@xylabs/object'\nimport { AsTypeFactory } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload' as const\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n return typeof value === 'string'\n}\n\nexport const asSchema = AsTypeFactory.create<Schema>(isSchema)\n\n/** Schema fields for a Payload */\nexport interface SchemaFields extends EmptyObject {\n /** Schema of the object */\n schema: Schema\n}\n\n/** Add the Schema Fields to an object */\nexport type WithSchema<T extends EmptyObject | void = void> = T extends EmptyObject ? SchemaFields & T : SchemaFields\n"],"mappings":";AAAA,SAAS,iBAAiB,gBAAgB;AAInC,IAAM,eAAe,CAAC,UAAqC;AAChE,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,OAAO,MAAM,WAAW;AAAA,EACjC;AACA,SAAO;AACT;AAEO,IAAM,eAAe,gBAAgB,OAAO,YAAY;AAExD,IAAM,YACT,CAAoB,WACpB,CAAC,UAA+B;AAC9B,MAAI,aAAa,KAAK,GAAG;AACvB,WAAO,OAAO,SAAS,MAAM,MAAM;AAAA,EACrC;AACA,SAAO;AACT;AAEG,IAAM,YAAY,CAAoB,WAAqB,gBAAgB,OAAO,CAAC,UAA+B,UAAU,MAAM,EAAE,KAAK,CAAC;;;ACnB1I,IAAM,wBAAwB,CAAoB,WAAmB;AAC1E,SAAO,CAAC,MAA+B,aAAa,CAAC,KAAK,GAAG,WAAW;AAC1E;AAEO,IAAM,mCAAmC,CAAoB,WAAmB;AACrF,SAAO,CAAC,MACN,sBAAsC,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,UAAa,MAAM,QAAQ,EAAE,OAAO;AAC1G;AAEO,IAAM,yBAAyB,CAAoB,WAAmB;AAC3E,SAAO,CAAC,MAA+B,CAAC,aAAa,CAAC,KAAK,GAAG,WAAW;AAC3E;;;ACPO,IAAM,oBAAuC;AAW7C,IAAM,gBAAgB,sBAAmC,iBAAiB;;;ACjB1E,IAAM,mBAAqC;;;ACAlD,SAAS,qBAAqB;AAKvB,IAAM,gBAAgB;AAGtB,IAAM,WAAW,CAAC,UAAoC;AAC3D,SAAO,OAAO,UAAU;AAC1B;AAEO,IAAM,WAAW,cAAc,OAAe,QAAQ;","names":[]}
|
package/dist/node/isPayload.d.ts
CHANGED
|
@@ -3,16 +3,16 @@ export declare const isAnyPayload: (value: unknown) => value is Payload;
|
|
|
3
3
|
export declare const asAnyPayload: {
|
|
4
4
|
<TType extends {
|
|
5
5
|
schema: string;
|
|
6
|
-
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
6
|
+
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
7
7
|
<TType extends {
|
|
8
8
|
schema: string;
|
|
9
|
-
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
9
|
+
} & import("./Payload.ts").PayloadFields>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<{
|
|
10
10
|
schema: string;
|
|
11
11
|
} & import("./Payload.ts").PayloadFields>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
12
12
|
};
|
|
13
13
|
export declare const isPayload: <T extends Payload>(schema: string[]) => (value: unknown) => value is T;
|
|
14
14
|
export declare const asPayload: <T extends Payload>(schema: string[]) => {
|
|
15
|
-
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
16
|
-
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.
|
|
15
|
+
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, config?: import("@xylabs/object").TypeCheckConfig): TType | undefined;
|
|
16
|
+
<TType extends T>(value: import(".store/@xylabs-promise-npm-4.4.12-5822811789/package").AnyNonPromise, assert: import("@xylabs/object").StringOrAlertFunction<T>, config?: import("@xylabs/object").TypeCheckConfig): TType;
|
|
17
17
|
};
|
|
18
18
|
//# sourceMappingURL=isPayload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;4DAHpB,
|
|
1
|
+
{"version":3,"file":"isPayload.d.ts","sourceRoot":"","sources":["../../src/isPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C,eAAO,MAAM,YAAY,UAAW,OAAO,KAAG,KAAK,IAAI,OAKtD,CAAA;AAED,eAAO,MAAM,YAAY;;;4DAHpB,sDAGD,iCAAiC,gBAAoB;;;4DAIrD,sDAAe;;+DAGb,gBACK;CARqD,CAAA;AAEhE,eAAO,MAAM,SAAS,GACjB,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE,aAC5B,OAAO,KAAG,KAAK,IAAI,CAK1B,CAAA;AAEL,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,EAAE;oCAdxD,sDAGD,iCAAiC,gBAAoB;oCAIrD,sDAAe,4FAGb,gBACK;CAGuI,CAAA"}
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import type { WithMeta } from './Meta.ts';
|
|
2
1
|
import type { Payload, WithSources } from './Payload.ts';
|
|
3
2
|
export declare const isPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
|
|
4
|
-
export declare const isPayloadOfSchemaTypeWithMeta: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithMeta<T>;
|
|
5
3
|
export declare const isPayloadOfSchemaTypeWithSources: <T extends Payload>(schema: string) => (x?: unknown | null) => x is WithSources<T>;
|
|
6
4
|
export declare const notPayloadOfSchemaType: <T extends Payload>(schema: string) => (x?: unknown | null) => x is T;
|
|
7
5
|
//# sourceMappingURL=isPayloadOfSchemaType.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"isPayloadOfSchemaType.d.ts","sourceRoot":"","sources":["../../src/isPayloadOfSchemaType.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAExD,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACzD,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA;AAED,eAAO,MAAM,gCAAgC,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UACpE,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAEhD,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,OAAO,UAAU,MAAM,UAC1D,OAAO,GAAG,IAAI,KAAG,CAAC,IAAI,CACnC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/payload-model",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.6.0-rc.1",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -37,17 +37,18 @@
|
|
|
37
37
|
"module": "dist/neutral/index.mjs",
|
|
38
38
|
"types": "dist/neutral/index.d.ts",
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@xylabs/hex": "^4.4.
|
|
41
|
-
"@xylabs/object": "^4.4.
|
|
40
|
+
"@xylabs/hex": "^4.4.12",
|
|
41
|
+
"@xylabs/object": "^4.4.12"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@xylabs/ts-scripts-yarn3": "^4.2.4",
|
|
45
45
|
"@xylabs/tsconfig": "^4.2.4",
|
|
46
|
-
"@xylabs/vitest-extended": "^4.4.
|
|
46
|
+
"@xylabs/vitest-extended": "^4.4.12",
|
|
47
47
|
"typescript": "^5.7.2",
|
|
48
|
-
"vitest": "^2.1.
|
|
48
|
+
"vitest": "^2.1.8"
|
|
49
49
|
},
|
|
50
50
|
"publishConfig": {
|
|
51
51
|
"access": "public"
|
|
52
|
-
}
|
|
52
|
+
},
|
|
53
|
+
"stableVersion": "3.5.2"
|
|
53
54
|
}
|
package/src/Payload.ts
CHANGED
|
@@ -1,16 +1,8 @@
|
|
|
1
1
|
import type { Hash } from '@xylabs/hex'
|
|
2
|
-
import type { EmptyObject
|
|
2
|
+
import type { EmptyObject } from '@xylabs/object'
|
|
3
3
|
|
|
4
4
|
import type { Schema, WithSchema } from './Schema.ts'
|
|
5
5
|
|
|
6
|
-
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
7
|
-
export interface PayloadMetaFields<TAdditionalMeta extends EmptyObject | void = void> extends EmptyObject {
|
|
8
|
-
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
9
|
-
$hash: Hash
|
|
10
|
-
/** Meta data that should be included in the main hash of the payload */
|
|
11
|
-
$meta?: TAdditionalMeta extends void ? JsonObject : TAdditionalMeta
|
|
12
|
-
}
|
|
13
|
-
|
|
14
6
|
/** Additional fields for a payload */
|
|
15
7
|
export interface PayloadFields extends EmptyObject {
|
|
16
8
|
schema: Schema
|
package/src/index.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
export * from './Error.ts'
|
|
2
2
|
export * from './isPayload.ts'
|
|
3
3
|
export * from './isPayloadOfSchemaType.ts'
|
|
4
|
-
export * from './isPayloadWithHash.ts'
|
|
5
|
-
export * from './Meta.ts'
|
|
6
4
|
export * from './Payload.ts'
|
|
7
5
|
export * from './PayloadFindFilter.ts'
|
|
8
6
|
export * from './PayloadSet/index.ts'
|
|
@@ -1,15 +1,10 @@
|
|
|
1
1
|
import { isAnyPayload } from './isPayload.ts'
|
|
2
|
-
import type { WithMeta } from './Meta.ts'
|
|
3
2
|
import type { Payload, WithSources } from './Payload.ts'
|
|
4
3
|
|
|
5
4
|
export const isPayloadOfSchemaType = <T extends Payload>(schema: string) => {
|
|
6
5
|
return (x?: unknown | null): x is T => isAnyPayload(x) && x?.schema === schema
|
|
7
6
|
}
|
|
8
7
|
|
|
9
|
-
export const isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {
|
|
10
|
-
return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined
|
|
11
|
-
}
|
|
12
|
-
|
|
13
8
|
export const isPayloadOfSchemaTypeWithSources = <T extends Payload>(schema: string) => {
|
|
14
9
|
return (x?: unknown | null): x is WithSources<T> =>
|
|
15
10
|
isPayloadOfSchemaType<WithSources<T>>(schema)(x) && x.sources !== undefined && Array.isArray(x.sources)
|
|
@@ -28,21 +23,10 @@ const TestSchema: TestSchema = 'network.xyo.test'
|
|
|
28
23
|
type Test = Payload<{ field: string }, TestSchema>
|
|
29
24
|
|
|
30
25
|
const testPayload: Test = { field: 'test', schema: TestSchema }
|
|
31
|
-
const testWithMeta: WithMeta<Test> = { $hash: '1234abcd', $meta: { timestamp: Date.now() }, field: 'test', schema: TestSchema }
|
|
32
26
|
|
|
33
27
|
const testPayloads: Payload[] = [testPayload]
|
|
34
|
-
const testMetaPayloads: WithMeta<Payload>[] = [testWithMeta]
|
|
35
|
-
|
|
36
|
-
const testType: Test = testWithMeta
|
|
37
28
|
|
|
38
29
|
const isTest: Test[] = testPayloads.filter(isPayloadOfSchemaType(TestSchema))
|
|
39
|
-
const isTestFromMeta: Payload[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))
|
|
40
|
-
const isTestFromMetaWithMeta: PayloadWithMeta[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))
|
|
41
30
|
|
|
42
31
|
const isTestFromMetaTyped = testMetaPayloads.filter(isPayloadOfSchemaType<Test>(TestSchema))
|
|
43
|
-
|
|
44
|
-
const isTestFromMetaTypedWithMeta: WithMeta<Test>[] = testMetaPayloads.filter(isPayloadOfSchemaType(TestSchema))
|
|
45
|
-
|
|
46
|
-
const isTestWithMeta: WithMeta<Test>[] = testPayloads.filter(isPayloadOfSchemaTypeWithMeta(TestSchema))
|
|
47
|
-
const isTestWithMetaFromMeta: WithMeta<Test>[] = testMetaPayloads.filter(isPayloadOfSchemaTypeWithMeta(TestSchema))
|
|
48
32
|
*/
|
package/dist/browser/Meta.d.ts
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { EmptyObject, JsonObject } from '@xylabs/object';
|
|
2
|
-
import type { Payload, PayloadMetaFields } from './Payload.ts';
|
|
3
|
-
import type { Schema, WithSchema } from './Schema.ts';
|
|
4
|
-
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T;
|
|
5
|
-
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
6
|
-
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
7
|
-
export declare const unMeta: <T extends WithMeta<Payload>>(payload?: T) => T | undefined;
|
|
8
|
-
//# sourceMappingURL=Meta.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../src/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAChH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACrH,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AAE/B,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAEvI,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,KAAG,CAAC,GAAG,SAQrE,CAAA"}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { WithMeta } from './Meta.ts';
|
|
2
|
-
import type { Payload } from './Payload.ts';
|
|
3
|
-
/**
|
|
4
|
-
* Return true if the value is a payload with the required meta fields
|
|
5
|
-
* @param value The value to check
|
|
6
|
-
* @returns True if the value is a payload with the required meta fields
|
|
7
|
-
*/
|
|
8
|
-
export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
|
|
9
|
-
/**
|
|
10
|
-
* Return true if the value is a payload with the required meta fields
|
|
11
|
-
* @param value The value to check
|
|
12
|
-
* @returns True if the value is a payload with the required meta fields
|
|
13
|
-
*/
|
|
14
|
-
export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
|
|
15
|
-
//# sourceMappingURL=isPayloadWithHash.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
|
package/dist/neutral/Meta.d.ts
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { EmptyObject, JsonObject } from '@xylabs/object';
|
|
2
|
-
import type { Payload, PayloadMetaFields } from './Payload.ts';
|
|
3
|
-
import type { Schema, WithSchema } from './Schema.ts';
|
|
4
|
-
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T;
|
|
5
|
-
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
6
|
-
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
7
|
-
export declare const unMeta: <T extends WithMeta<Payload>>(payload?: T) => T | undefined;
|
|
8
|
-
//# sourceMappingURL=Meta.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../src/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAChH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACrH,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AAE/B,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAEvI,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,KAAG,CAAC,GAAG,SAQrE,CAAA"}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { WithMeta } from './Meta.ts';
|
|
2
|
-
import type { Payload } from './Payload.ts';
|
|
3
|
-
/**
|
|
4
|
-
* Return true if the value is a payload with the required meta fields
|
|
5
|
-
* @param value The value to check
|
|
6
|
-
* @returns True if the value is a payload with the required meta fields
|
|
7
|
-
*/
|
|
8
|
-
export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
|
|
9
|
-
/**
|
|
10
|
-
* Return true if the value is a payload with the required meta fields
|
|
11
|
-
* @param value The value to check
|
|
12
|
-
* @returns True if the value is a payload with the required meta fields
|
|
13
|
-
*/
|
|
14
|
-
export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
|
|
15
|
-
//# sourceMappingURL=isPayloadWithHash.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
|
package/dist/node/Meta.d.ts
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { EmptyObject, JsonObject } from '@xylabs/object';
|
|
2
|
-
import type { Payload, PayloadMetaFields } from './Payload.ts';
|
|
3
|
-
import type { Schema, WithSchema } from './Schema.ts';
|
|
4
|
-
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T;
|
|
5
|
-
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
6
|
-
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
7
|
-
export declare const unMeta: <T extends WithMeta<Payload>>(payload?: T) => T | undefined;
|
|
8
|
-
//# sourceMappingURL=Meta.d.ts.map
|
package/dist/node/Meta.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../src/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAE7D,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAChH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACrH,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AAE/B,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,UAAU,GAAG,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAEvI,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,KAAG,CAAC,GAAG,SAQrE,CAAA"}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { WithMeta } from './Meta.ts';
|
|
2
|
-
import type { Payload } from './Payload.ts';
|
|
3
|
-
/**
|
|
4
|
-
* Return true if the value is a payload with the required meta fields
|
|
5
|
-
* @param value The value to check
|
|
6
|
-
* @returns True if the value is a payload with the required meta fields
|
|
7
|
-
*/
|
|
8
|
-
export declare const isWithHash: <T extends Payload>(value: T) => value is WithMeta<T>;
|
|
9
|
-
/**
|
|
10
|
-
* Return true if the value is a payload with the required meta fields
|
|
11
|
-
* @param value The value to check
|
|
12
|
-
* @returns True if the value is a payload with the required meta fields
|
|
13
|
-
*/
|
|
14
|
-
export declare const isPayloadWithHash: <T extends Payload>(value: unknown) => value is WithMeta<T>;
|
|
15
|
-
//# sourceMappingURL=isPayloadWithHash.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"isPayloadWithHash.d.ts","sourceRoot":"","sources":["../../src/isPayloadWithHash.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE3C;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,SAAS,CAAC,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAE3E,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,OAAO,SAAS,OAAO,KAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAExF,CAAA"}
|
package/src/Meta.ts
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import type { EmptyObject, JsonObject } from '@xylabs/object'
|
|
2
|
-
|
|
3
|
-
import type { Payload, PayloadMetaFields } from './Payload.ts'
|
|
4
|
-
import type { Schema, WithSchema } from './Schema.ts'
|
|
5
|
-
|
|
6
|
-
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = PayloadMetaFields<M> & T
|
|
7
|
-
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &
|
|
8
|
-
Omit<WithMeta<T, M>, '$hash'>
|
|
9
|
-
|
|
10
|
-
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>
|
|
11
|
-
|
|
12
|
-
export const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {
|
|
13
|
-
if (payload) {
|
|
14
|
-
const {
|
|
15
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
16
|
-
$meta, $hash, ...result
|
|
17
|
-
} = payload
|
|
18
|
-
return result as T
|
|
19
|
-
}
|
|
20
|
-
}
|
package/src/isPayloadWithHash.ts
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { isAnyPayload } from './isPayload.ts'
|
|
2
|
-
import type { WithMeta } from './Meta.ts'
|
|
3
|
-
import type { Payload } from './Payload.ts'
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* Return true if the value is a payload with the required meta fields
|
|
7
|
-
* @param value The value to check
|
|
8
|
-
* @returns True if the value is a payload with the required meta fields
|
|
9
|
-
*/
|
|
10
|
-
export const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {
|
|
11
|
-
return typeof (value as WithMeta<T>)?.$hash === 'string'
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Return true if the value is a payload with the required meta fields
|
|
16
|
-
* @param value The value to check
|
|
17
|
-
* @returns True if the value is a payload with the required meta fields
|
|
18
|
-
*/
|
|
19
|
-
export const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {
|
|
20
|
-
return isAnyPayload(value) && isWithHash(value)
|
|
21
|
-
}
|