@xyo-network/payload-model 2.90.3 → 2.90.4
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.cts +5 -5
- package/dist/browser/Payload.d.cts.map +1 -1
- package/dist/browser/Payload.d.mts +5 -5
- package/dist/browser/Payload.d.mts.map +1 -1
- package/dist/browser/Payload.d.ts +5 -5
- package/dist/browser/Payload.d.ts.map +1 -1
- package/dist/browser/index.cjs.map +1 -1
- package/dist/browser/index.js.map +1 -1
- package/dist/node/Payload.d.cts +5 -5
- package/dist/node/Payload.d.cts.map +1 -1
- package/dist/node/Payload.d.mts +5 -5
- package/dist/node/Payload.d.mts.map +1 -1
- package/dist/node/Payload.d.ts +5 -5
- package/dist/node/Payload.d.ts.map +1 -1
- package/dist/node/index.cjs.map +1 -1
- package/dist/node/index.js.map +1 -1
- package/package.json +1 -1
- package/src/Payload.ts +5 -4
|
@@ -2,11 +2,11 @@ import { Hash } from '@xylabs/hex';
|
|
|
2
2
|
import { EmptyObject, JsonObject } from '@xylabs/object';
|
|
3
3
|
import { Schema, WithSchema } from './Schema';
|
|
4
4
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
5
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
6
6
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
7
|
$hash: Hash;
|
|
8
8
|
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: JsonObject;
|
|
9
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta;
|
|
10
10
|
}
|
|
11
11
|
/** Additional fields for a payload */
|
|
12
12
|
export type PayloadFields = EmptyObject;
|
|
@@ -24,10 +24,10 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
24
24
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
|
|
25
25
|
schema: string;
|
|
26
26
|
};
|
|
27
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
28
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> & Omit<WithMeta<T>, '$hash'>;
|
|
27
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>;
|
|
28
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
29
29
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
30
30
|
export declare const unMeta: <T extends WithMeta<{
|
|
31
31
|
schema: string;
|
|
32
|
-
} & object>>(payload?: T | undefined) => T | undefined;
|
|
32
|
+
} & object, void>>(payload?: T | undefined) => T | undefined;
|
|
33
33
|
//# sourceMappingURL=Payload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACtG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,eAAe,CAAA;CACjF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AAEvC,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,IAAI,CAAC,SAAS,UAAU,GACxH,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9D,WAAW,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9C,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAErD,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEvB,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,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,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;;4DAMlB,CAAA"}
|
|
@@ -2,11 +2,11 @@ import { Hash } from '@xylabs/hex';
|
|
|
2
2
|
import { EmptyObject, JsonObject } from '@xylabs/object';
|
|
3
3
|
import { Schema, WithSchema } from './Schema';
|
|
4
4
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
5
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
6
6
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
7
|
$hash: Hash;
|
|
8
8
|
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: JsonObject;
|
|
9
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta;
|
|
10
10
|
}
|
|
11
11
|
/** Additional fields for a payload */
|
|
12
12
|
export type PayloadFields = EmptyObject;
|
|
@@ -24,10 +24,10 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
24
24
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
|
|
25
25
|
schema: string;
|
|
26
26
|
};
|
|
27
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
28
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> & Omit<WithMeta<T>, '$hash'>;
|
|
27
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>;
|
|
28
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
29
29
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
30
30
|
export declare const unMeta: <T extends WithMeta<{
|
|
31
31
|
schema: string;
|
|
32
|
-
} & object>>(payload?: T | undefined) => T | undefined;
|
|
32
|
+
} & object, void>>(payload?: T | undefined) => T | undefined;
|
|
33
33
|
//# sourceMappingURL=Payload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACtG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,eAAe,CAAA;CACjF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AAEvC,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,IAAI,CAAC,SAAS,UAAU,GACxH,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9D,WAAW,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9C,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAErD,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEvB,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,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,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;;4DAMlB,CAAA"}
|
|
@@ -2,11 +2,11 @@ import { Hash } from '@xylabs/hex';
|
|
|
2
2
|
import { EmptyObject, JsonObject } from '@xylabs/object';
|
|
3
3
|
import { Schema, WithSchema } from './Schema';
|
|
4
4
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
5
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
6
6
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
7
|
$hash: Hash;
|
|
8
8
|
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: JsonObject;
|
|
9
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta;
|
|
10
10
|
}
|
|
11
11
|
/** Additional fields for a payload */
|
|
12
12
|
export type PayloadFields = EmptyObject;
|
|
@@ -24,10 +24,10 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
24
24
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
|
|
25
25
|
schema: string;
|
|
26
26
|
};
|
|
27
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
28
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> & Omit<WithMeta<T>, '$hash'>;
|
|
27
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>;
|
|
28
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
29
29
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
30
30
|
export declare const unMeta: <T extends WithMeta<{
|
|
31
31
|
schema: string;
|
|
32
|
-
} & object>>(payload?: T | undefined) => T | undefined;
|
|
32
|
+
} & object, void>>(payload?: T | undefined) => T | undefined;
|
|
33
33
|
//# sourceMappingURL=Payload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACtG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,eAAe,CAAA;CACjF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AAEvC,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,IAAI,CAAC,SAAS,UAAU,GACxH,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9D,WAAW,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9C,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAErD,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEvB,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,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,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;;4DAMlB,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts","../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["export * from './Error'\nexport * from './isPayload'\nexport * from './isPayloadOfSchemaType'\nexport * from './isPayloadWithHash'\nexport * from './Payload'\nexport * from './PayloadFindFilter'\nexport * from './PayloadSet'\nexport * from './Query'\nexport * from './Schema'\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: JsonObject\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts","../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["export * from './Error'\nexport * from './isPayload'\nexport * from './isPayloadOfSchemaType'\nexport * from './isPayloadWithHash'\nexport * from './Payload'\nexport * from './PayloadFindFilter'\nexport * from './PayloadSet'\nexport * from './Query'\nexport * from './Schema'\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>\nexport type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &\n Omit<WithMeta<T, M>, '$hash'>\n\nexport type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>\n\nexport const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {\n if (payload) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, $hash, ...result } = payload\n return result as T\n }\n}\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import { AsTypeFactory, EmptyObject } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload'\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n if (typeof value === 'string') {\n return true\n }\n return false\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;;;;;;;;;;;;;;;;;;;;;;ACCA,oBAA0C;AAInC,IAAMA,eAAe,wBAACC,UAAAA;AAC3B,UAAIC,wBAASD,KAAAA,GAAQ;AACnB,WAAO,OAAOA,MAAME,WAAW;EACjC;AACA,SAAO;AACT,GAL4B;AAOrB,IAAMC,eAAeC,8BAAgBC,OAAON,YAAAA;AAE5C,IAAMO,YACX,wBAAoBJ,WACpB,CAACF,UAAAA;AACC,MAAID,aAAaC,KAAAA,GAAQ;AACvB,WAAOE,OAAOK,SAASP,MAAME,MAAM;EACrC;AACA,SAAO;AACT,GANA;AAQK,IAAMM,YAAY,wBAAoBN,WAAqBE,8BAAgBC,OAAO,CAACL,UAA+BM,UAAUJ,MAAAA,EAAQF,KAAAA,CAAAA,GAAlH;;;ACpBlB,IAAMS,wBAAwB,wBAAoBC,WAAAA;AACvD,SAAO,CAACC,MAA+BC,aAAaD,CAAAA,KAAMA,GAAGD,WAAWA;AAC1E,GAFqC;AAI9B,IAAMG,gCAAgC,wBAAoBH,WAAAA;AAC/D,SAAO,CAACC,MAAyCF,sBAAmCC,MAAAA,EAAQC,CAAAA,KAAMA,EAAEG,UAAUC,UAAaJ,EAAEK,UAAUD;AACzI,GAF6C;AAItC,IAAME,yBAAyB,wBAAoBP,WAAAA;AACxD,SAAO,CAACC,MAA+B,CAACC,aAAaD,CAAAA,KAAMA,GAAGD,WAAWA;AAC3E,GAFsC;;;ACP/B,IAAMQ,oBAAuC;AAU7C,IAAMC,gBAAgBC,sBAAmCF,iBAAAA;;;ACNzD,IAAMG,aAAa,wBAAoBC,UAAAA;AAC5C,SAAO,OAAQA,OAAuBC,UAAU;AAClD,GAF0B;AASnB,IAAMC,oBAAoB,wBAAoBF,UAAAA;AACnD,SAAOG,aAAaH,KAAAA,KAAUD,WAAWC,KAAAA;AAC3C,GAFiC;;;AC2B1B,IAAMI,SAAS,wBAA8BC,YAAAA;AAClD,MAAIA,SAAS;AAEX,UAAM,EAAEC,OAAOC,OAAO,GAAGC,OAAAA,IAAWH;AACpC,WAAOG;EACT;AACF,GANsB;;;AC3Cf,IAAMC,mBAAqC;;;ACDlD,IAAAC,iBAA2C;AAKpC,IAAMC,gBAAgB;AAGtB,IAAMC,WAAW,wBAACC,UAAAA;AACvB,MAAI,OAAOA,UAAU,UAAU;AAC7B,WAAO;EACT;AACA,SAAO;AACT,GALwB;AAOjB,IAAMC,WAAWC,6BAAcC,OAAeJ,QAAAA;","names":["isAnyPayload","value","isObject","schema","asAnyPayload","AsObjectFactory","create","isPayload","includes","asPayload","isPayloadOfSchemaType","schema","x","isAnyPayload","isPayloadOfSchemaTypeWithMeta","$hash","undefined","$meta","notPayloadOfSchemaType","ModuleErrorSchema","isModuleError","isPayloadOfSchemaType","isWithHash","value","$hash","isPayloadWithHash","isAnyPayload","unMeta","payload","$meta","$hash","result","PayloadSetSchema","import_object","PayloadSchema","isSchema","value","asSchema","AsTypeFactory","create"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: JsonObject\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
1
|
+
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>\nexport type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &\n Omit<WithMeta<T, M>, '$hash'>\n\nexport type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>\n\nexport const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {\n if (payload) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, $hash, ...result } = payload\n return result as T\n }\n}\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import { AsTypeFactory, EmptyObject } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload'\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n if (typeof value === 'string') {\n return true\n }\n return false\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":";;;;AACA,SAASA,iBAAiBC,gBAAgB;AAInC,IAAMC,eAAe,wBAACC,UAAAA;AAC3B,MAAIC,SAASD,KAAAA,GAAQ;AACnB,WAAO,OAAOA,MAAME,WAAW;EACjC;AACA,SAAO;AACT,GAL4B;AAOrB,IAAMC,eAAeC,gBAAgBC,OAAON,YAAAA;AAE5C,IAAMO,YACX,wBAAoBJ,WACpB,CAACF,UAAAA;AACC,MAAID,aAAaC,KAAAA,GAAQ;AACvB,WAAOE,OAAOK,SAASP,MAAME,MAAM;EACrC;AACA,SAAO;AACT,GANA;AAQK,IAAMM,YAAY,wBAAoBN,WAAqBE,gBAAgBC,OAAO,CAACL,UAA+BM,UAAUJ,MAAAA,EAAQF,KAAAA,CAAAA,GAAlH;;;ACpBlB,IAAMS,wBAAwB,wBAAoBC,WAAAA;AACvD,SAAO,CAACC,MAA+BC,aAAaD,CAAAA,KAAMA,GAAGD,WAAWA;AAC1E,GAFqC;AAI9B,IAAMG,gCAAgC,wBAAoBH,WAAAA;AAC/D,SAAO,CAACC,MAAyCF,sBAAmCC,MAAAA,EAAQC,CAAAA,KAAMA,EAAEG,UAAUC,UAAaJ,EAAEK,UAAUD;AACzI,GAF6C;AAItC,IAAME,yBAAyB,wBAAoBP,WAAAA;AACxD,SAAO,CAACC,MAA+B,CAACC,aAAaD,CAAAA,KAAMA,GAAGD,WAAWA;AAC3E,GAFsC;;;ACP/B,IAAMQ,oBAAuC;AAU7C,IAAMC,gBAAgBC,sBAAmCF,iBAAAA;;;ACNzD,IAAMG,aAAa,wBAAoBC,UAAAA;AAC5C,SAAO,OAAQA,OAAuBC,UAAU;AAClD,GAF0B;AASnB,IAAMC,oBAAoB,wBAAoBF,UAAAA;AACnD,SAAOG,aAAaH,KAAAA,KAAUD,WAAWC,KAAAA;AAC3C,GAFiC;;;AC2B1B,IAAMI,SAAS,wBAA8BC,YAAAA;AAClD,MAAIA,SAAS;AAEX,UAAM,EAAEC,OAAOC,OAAO,GAAGC,OAAAA,IAAWH;AACpC,WAAOG;EACT;AACF,GANsB;;;AC3Cf,IAAMC,mBAAqC;;;ACDlD,SAASC,qBAAkC;AAKpC,IAAMC,gBAAgB;AAGtB,IAAMC,WAAW,wBAACC,UAAAA;AACvB,MAAI,OAAOA,UAAU,UAAU;AAC7B,WAAO;EACT;AACA,SAAO;AACT,GALwB;AAOjB,IAAMC,WAAWC,cAAcC,OAAeJ,QAAAA;","names":["AsObjectFactory","isObject","isAnyPayload","value","isObject","schema","asAnyPayload","AsObjectFactory","create","isPayload","includes","asPayload","isPayloadOfSchemaType","schema","x","isAnyPayload","isPayloadOfSchemaTypeWithMeta","$hash","undefined","$meta","notPayloadOfSchemaType","ModuleErrorSchema","isModuleError","isPayloadOfSchemaType","isWithHash","value","$hash","isPayloadWithHash","isAnyPayload","unMeta","payload","$meta","$hash","result","PayloadSetSchema","AsTypeFactory","PayloadSchema","isSchema","value","asSchema","AsTypeFactory","create"]}
|
package/dist/node/Payload.d.cts
CHANGED
|
@@ -2,11 +2,11 @@ import { Hash } from '@xylabs/hex';
|
|
|
2
2
|
import { EmptyObject, JsonObject } from '@xylabs/object';
|
|
3
3
|
import { Schema, WithSchema } from './Schema';
|
|
4
4
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
5
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
6
6
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
7
|
$hash: Hash;
|
|
8
8
|
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: JsonObject;
|
|
9
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta;
|
|
10
10
|
}
|
|
11
11
|
/** Additional fields for a payload */
|
|
12
12
|
export type PayloadFields = EmptyObject;
|
|
@@ -24,10 +24,10 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
24
24
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
|
|
25
25
|
schema: string;
|
|
26
26
|
};
|
|
27
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
28
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> & Omit<WithMeta<T>, '$hash'>;
|
|
27
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>;
|
|
28
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
29
29
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
30
30
|
export declare const unMeta: <T extends WithMeta<{
|
|
31
31
|
schema: string;
|
|
32
|
-
} & object>>(payload?: T | undefined) => T | undefined;
|
|
32
|
+
} & object, void>>(payload?: T | undefined) => T | undefined;
|
|
33
33
|
//# sourceMappingURL=Payload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACtG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,eAAe,CAAA;CACjF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AAEvC,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,IAAI,CAAC,SAAS,UAAU,GACxH,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9D,WAAW,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9C,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAErD,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEvB,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,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,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;;4DAMlB,CAAA"}
|
package/dist/node/Payload.d.mts
CHANGED
|
@@ -2,11 +2,11 @@ import { Hash } from '@xylabs/hex';
|
|
|
2
2
|
import { EmptyObject, JsonObject } from '@xylabs/object';
|
|
3
3
|
import { Schema, WithSchema } from './Schema';
|
|
4
4
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
5
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
6
6
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
7
|
$hash: Hash;
|
|
8
8
|
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: JsonObject;
|
|
9
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta;
|
|
10
10
|
}
|
|
11
11
|
/** Additional fields for a payload */
|
|
12
12
|
export type PayloadFields = EmptyObject;
|
|
@@ -24,10 +24,10 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
24
24
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
|
|
25
25
|
schema: string;
|
|
26
26
|
};
|
|
27
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
28
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> & Omit<WithMeta<T>, '$hash'>;
|
|
27
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>;
|
|
28
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
29
29
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
30
30
|
export declare const unMeta: <T extends WithMeta<{
|
|
31
31
|
schema: string;
|
|
32
|
-
} & object>>(payload?: T | undefined) => T | undefined;
|
|
32
|
+
} & object, void>>(payload?: T | undefined) => T | undefined;
|
|
33
33
|
//# sourceMappingURL=Payload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACtG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,eAAe,CAAA;CACjF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AAEvC,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,IAAI,CAAC,SAAS,UAAU,GACxH,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9D,WAAW,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9C,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAErD,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEvB,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,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,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;;4DAMlB,CAAA"}
|
package/dist/node/Payload.d.ts
CHANGED
|
@@ -2,11 +2,11 @@ import { Hash } from '@xylabs/hex';
|
|
|
2
2
|
import { EmptyObject, JsonObject } from '@xylabs/object';
|
|
3
3
|
import { Schema, WithSchema } from './Schema';
|
|
4
4
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
5
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
5
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
6
6
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
7
7
|
$hash: Hash;
|
|
8
8
|
/** Meta data that should be included in the main hash of the payload */
|
|
9
|
-
$meta?: JsonObject;
|
|
9
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta;
|
|
10
10
|
}
|
|
11
11
|
/** Additional fields for a payload */
|
|
12
12
|
export type PayloadFields = EmptyObject;
|
|
@@ -24,10 +24,10 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
24
24
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & {
|
|
25
25
|
schema: string;
|
|
26
26
|
};
|
|
27
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
28
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> & Omit<WithMeta<T>, '$hash'>;
|
|
27
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>;
|
|
28
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> & Omit<WithMeta<T, M>, '$hash'>;
|
|
29
29
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>;
|
|
30
30
|
export declare const unMeta: <T extends WithMeta<{
|
|
31
31
|
schema: string;
|
|
32
|
-
} & object>>(payload?: T | undefined) => T | undefined;
|
|
32
|
+
} & object, void>>(payload?: T | undefined) => T | undefined;
|
|
33
33
|
//# sourceMappingURL=Payload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE7C,sFAAsF;AACtF,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,CAAE,SAAQ,WAAW;IACtG,8EAA8E;IAC9E,KAAK,EAAE,IAAI,CAAA;IACX,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,SAAS,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,eAAe,CAAA;CACjF;AAED,sCAAsC;AACtC,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AAEvC,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,IAAI,CAAC,SAAS,UAAU,GACxH,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9D,WAAW,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,MAAM,GAEd,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,GAE9C,WAAW,CAAC,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAAC,GAErD,AADA,8CAA8C,CAC9C;IACE,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,MAAM,CAAA;CACtC,GAAG,aAAa,CAAA;AAEvB,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,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,CAAC,SAAS,UAAU,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC,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;;4DAMlB,CAAA"}
|
package/dist/node/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts","../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["export * from './Error'\nexport * from './isPayload'\nexport * from './isPayloadOfSchemaType'\nexport * from './isPayloadWithHash'\nexport * from './Payload'\nexport * from './PayloadFindFilter'\nexport * from './PayloadSet'\nexport * from './Query'\nexport * from './Schema'\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: JsonObject\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts","../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["export * from './Error'\nexport * from './isPayload'\nexport * from './isPayloadOfSchemaType'\nexport * from './isPayloadWithHash'\nexport * from './Payload'\nexport * from './PayloadFindFilter'\nexport * from './PayloadSet'\nexport * from './Query'\nexport * from './Schema'\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>\nexport type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &\n Omit<WithMeta<T, M>, '$hash'>\n\nexport type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>\n\nexport const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {\n if (payload) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, $hash, ...result } = payload\n return result as T\n }\n}\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import { AsTypeFactory, EmptyObject } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload'\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n if (typeof value === 'string') {\n return true\n }\n return false\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;;;;;;;;;;;;;;;;;;;;;;ACCA,oBAA0C;AAInC,IAAMA,eAAe,wBAACC,UAAAA;AAC3B,UAAIC,wBAASD,KAAAA,GAAQ;AACnB,WAAO,OAAOA,MAAME,WAAW;EACjC;AACA,SAAO;AACT,GAL4B;AAOrB,IAAMC,eAAeC,8BAAgBC,OAAON,YAAAA;AAE5C,IAAMO,YACX,wBAAoBJ,WACpB,CAACF,UAAAA;AACC,MAAID,aAAaC,KAAAA,GAAQ;AACvB,WAAOE,OAAOK,SAASP,MAAME,MAAM;EACrC;AACA,SAAO;AACT,GANA;AAQK,IAAMM,YAAY,wBAAoBN,WAAqBE,8BAAgBC,OAAO,CAACL,UAA+BM,UAAUJ,MAAAA,EAAQF,KAAAA,CAAAA,GAAlH;;;ACpBlB,IAAMS,wBAAwB,wBAAoBC,WAAAA;AACvD,SAAO,CAACC,MAA+BC,aAAaD,CAAAA,MAAMA,uBAAGD,YAAWA;AAC1E,GAFqC;AAI9B,IAAMG,gCAAgC,wBAAoBH,WAAAA;AAC/D,SAAO,CAACC,MAAyCF,sBAAmCC,MAAAA,EAAQC,CAAAA,KAAMA,EAAEG,UAAUC,UAAaJ,EAAEK,UAAUD;AACzI,GAF6C;AAItC,IAAME,yBAAyB,wBAAoBP,WAAAA;AACxD,SAAO,CAACC,MAA+B,CAACC,aAAaD,CAAAA,MAAMA,uBAAGD,YAAWA;AAC3E,GAFsC;;;ACP/B,IAAMQ,oBAAuC;AAU7C,IAAMC,gBAAgBC,sBAAmCF,iBAAAA;;;ACNzD,IAAMG,aAAa,wBAAoBC,UAAAA;AAC5C,SAAO,QAAQA,+BAAuBC,WAAU;AAClD,GAF0B;AASnB,IAAMC,oBAAoB,wBAAoBF,UAAAA;AACnD,SAAOG,aAAaH,KAAAA,KAAUD,WAAWC,KAAAA;AAC3C,GAFiC;;;AC2B1B,IAAMI,SAAS,wBAA8BC,YAAAA;AAClD,MAAIA,SAAS;AAEX,UAAM,EAAEC,OAAOC,OAAO,GAAGC,OAAAA,IAAWH;AACpC,WAAOG;EACT;AACF,GANsB;;;AC3Cf,IAAMC,mBAAqC;;;ACDlD,IAAAC,iBAA2C;AAKpC,IAAMC,gBAAgB;AAGtB,IAAMC,WAAW,wBAACC,UAAAA;AACvB,MAAI,OAAOA,UAAU,UAAU;AAC7B,WAAO;EACT;AACA,SAAO;AACT,GALwB;AAOjB,IAAMC,WAAWC,6BAAcC,OAAeJ,QAAAA;","names":["isAnyPayload","value","isObject","schema","asAnyPayload","AsObjectFactory","create","isPayload","includes","asPayload","isPayloadOfSchemaType","schema","x","isAnyPayload","isPayloadOfSchemaTypeWithMeta","$hash","undefined","$meta","notPayloadOfSchemaType","ModuleErrorSchema","isModuleError","isPayloadOfSchemaType","isWithHash","value","$hash","isPayloadWithHash","isAnyPayload","unMeta","payload","$meta","$hash","result","PayloadSetSchema","import_object","PayloadSchema","isSchema","value","asSchema","AsTypeFactory","create"]}
|
package/dist/node/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: JsonObject\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
1
|
+
{"version":3,"sources":["../../src/isPayload.ts","../../src/isPayloadOfSchemaType.ts","../../src/Error.ts","../../src/isPayloadWithHash.ts","../../src/Payload.ts","../../src/PayloadSet/PayloadSetSchema.ts","../../src/Schema.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { AsObjectFactory, isObject } from '@xylabs/object'\n\nimport { Payload } from './Payload'\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'\nimport { Payload, WithMeta } from './Payload'\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 isPayloadOfSchemaTypeWithMeta = <T extends Payload>(schema: string) => {\n return (x?: unknown | null): x is WithMeta<T> => isPayloadOfSchemaType<WithMeta<T>>(schema)(x) && x.$hash !== undefined && x.$meta !== undefined\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","import { isPayloadOfSchemaType } from './isPayloadOfSchemaType'\nimport { Payload } from './Payload'\n\nexport type ModuleErrorSchema = 'network.xyo.error.module'\nexport const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'\n\nexport type ModuleError = Payload<{\n message?: string\n name?: string\n query?: string\n schema: ModuleErrorSchema\n sources?: string[]\n}>\n\nexport const isModuleError = isPayloadOfSchemaType<ModuleError>(ModuleErrorSchema)\n","import { isAnyPayload } from './isPayload'\nimport { Payload, WithMeta } from './Payload'\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isWithHash = <T extends Payload>(value: T): value is WithMeta<T> => {\n return typeof (value as WithMeta<T>)?.$hash === 'string'\n}\n\n/**\n * Return true if the value is a payload with the required meta fields\n * @param value The value to check\n * @returns True if the value is a payload with the required meta fields\n */\nexport const isPayloadWithHash = <T extends Payload>(value: unknown): value is WithMeta<T> => {\n return isAnyPayload(value) && isWithHash(value)\n}\n","import { Hash } from '@xylabs/hex'\nimport { EmptyObject, JsonObject } from '@xylabs/object'\n\nimport { Schema, WithSchema } from './Schema'\n\n/** Meta fields for a payload - Either both $hash and $meta should exist or neither */\nexport interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {\n /** Hash of the body of the payload excluding the items in the $meta object */\n $hash: Hash\n /** Meta data that should be included in the main hash of the payload */\n $meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta\n}\n\n/** Additional fields for a payload */\nexport type PayloadFields = EmptyObject\n\nexport type WithPayload<T extends EmptyObject | void = void> = WithSchema<T extends EmptyObject ? PayloadFields & T : PayloadFields>\n\n/** Base Type for Payloads */\nexport type Payload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = T extends WithSchema\n ? S extends Schema\n ? /* T (w/Schema) & S provided */\n WithPayload<Omit<T, 'schema'> & { schema: S } & PayloadFields>\n : /* Only T (w/Schema) provided */\n WithPayload<T>\n : T extends object\n ? S extends Schema\n ? /* T (w/o Schema) & S provided */\n WithPayload<T & { schema: S } & PayloadFields>\n : /* Only T (w/o Schema) provided */\n WithPayload<T & { schema: Schema } & PayloadFields>\n : /* Either just S or neither S or T provided */\n {\n schema: S extends Schema ? S : Schema\n } & PayloadFields\n\nexport type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }\n\nexport type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>\nexport type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &\n Omit<WithMeta<T, M>, '$hash'>\n\nexport type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>\n\nexport const unMeta = <T extends WithMeta<Payload>>(payload?: T): T | undefined => {\n if (payload) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { $meta, $hash, ...result } = payload\n return result as T\n }\n}\n","export type PayloadSetSchema = 'network.xyo.payload.set'\nexport const PayloadSetSchema: PayloadSetSchema = 'network.xyo.payload.set'\n","import { AsTypeFactory, EmptyObject } from '@xylabs/object'\n\n/** Schema type in Javascript is a string */\nexport type Schema = string\n\nexport const PayloadSchema = 'network.xyo.payload'\nexport type PayloadSchema = typeof PayloadSchema\n\nexport const isSchema = (value: unknown): value is Schema => {\n if (typeof value === 'string') {\n return true\n }\n return false\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":";;;;AACA,SAASA,iBAAiBC,gBAAgB;AAInC,IAAMC,eAAe,wBAACC,UAAAA;AAC3B,MAAIC,SAASD,KAAAA,GAAQ;AACnB,WAAO,OAAOA,MAAME,WAAW;EACjC;AACA,SAAO;AACT,GAL4B;AAOrB,IAAMC,eAAeC,gBAAgBC,OAAON,YAAAA;AAE5C,IAAMO,YACX,wBAAoBJ,WACpB,CAACF,UAAAA;AACC,MAAID,aAAaC,KAAAA,GAAQ;AACvB,WAAOE,OAAOK,SAASP,MAAME,MAAM;EACrC;AACA,SAAO;AACT,GANA;AAQK,IAAMM,YAAY,wBAAoBN,WAAqBE,gBAAgBC,OAAO,CAACL,UAA+BM,UAAUJ,MAAAA,EAAQF,KAAAA,CAAAA,GAAlH;;;ACpBlB,IAAMS,wBAAwB,wBAAoBC,WAAAA;AACvD,SAAO,CAACC,MAA+BC,aAAaD,CAAAA,MAAMA,uBAAGD,YAAWA;AAC1E,GAFqC;AAI9B,IAAMG,gCAAgC,wBAAoBH,WAAAA;AAC/D,SAAO,CAACC,MAAyCF,sBAAmCC,MAAAA,EAAQC,CAAAA,KAAMA,EAAEG,UAAUC,UAAaJ,EAAEK,UAAUD;AACzI,GAF6C;AAItC,IAAME,yBAAyB,wBAAoBP,WAAAA;AACxD,SAAO,CAACC,MAA+B,CAACC,aAAaD,CAAAA,MAAMA,uBAAGD,YAAWA;AAC3E,GAFsC;;;ACP/B,IAAMQ,oBAAuC;AAU7C,IAAMC,gBAAgBC,sBAAmCF,iBAAAA;;;ACNzD,IAAMG,aAAa,wBAAoBC,UAAAA;AAC5C,SAAO,QAAQA,+BAAuBC,WAAU;AAClD,GAF0B;AASnB,IAAMC,oBAAoB,wBAAoBF,UAAAA;AACnD,SAAOG,aAAaH,KAAAA,KAAUD,WAAWC,KAAAA;AAC3C,GAFiC;;;AC2B1B,IAAMI,SAAS,wBAA8BC,YAAAA;AAClD,MAAIA,SAAS;AAEX,UAAM,EAAEC,OAAOC,OAAO,GAAGC,OAAAA,IAAWH;AACpC,WAAOG;EACT;AACF,GANsB;;;AC3Cf,IAAMC,mBAAqC;;;ACDlD,SAASC,qBAAkC;AAKpC,IAAMC,gBAAgB;AAGtB,IAAMC,WAAW,wBAACC,UAAAA;AACvB,MAAI,OAAOA,UAAU,UAAU;AAC7B,WAAO;EACT;AACA,SAAO;AACT,GALwB;AAOjB,IAAMC,WAAWC,cAAcC,OAAeJ,QAAAA;","names":["AsObjectFactory","isObject","isAnyPayload","value","isObject","schema","asAnyPayload","AsObjectFactory","create","isPayload","includes","asPayload","isPayloadOfSchemaType","schema","x","isAnyPayload","isPayloadOfSchemaTypeWithMeta","$hash","undefined","$meta","notPayloadOfSchemaType","ModuleErrorSchema","isModuleError","isPayloadOfSchemaType","isWithHash","value","$hash","isPayloadWithHash","isAnyPayload","unMeta","payload","$meta","$hash","result","PayloadSetSchema","AsTypeFactory","PayloadSchema","isSchema","value","asSchema","AsTypeFactory","create"]}
|
package/package.json
CHANGED
package/src/Payload.ts
CHANGED
|
@@ -4,11 +4,11 @@ import { EmptyObject, JsonObject } from '@xylabs/object'
|
|
|
4
4
|
import { Schema, WithSchema } from './Schema'
|
|
5
5
|
|
|
6
6
|
/** Meta fields for a payload - Either both $hash and $meta should exist or neither */
|
|
7
|
-
export interface PayloadMetaFields extends EmptyObject {
|
|
7
|
+
export interface PayloadMetaFields<TAdditionalMeta extends JsonObject | void = void> extends EmptyObject {
|
|
8
8
|
/** Hash of the body of the payload excluding the items in the $meta object */
|
|
9
9
|
$hash: Hash
|
|
10
10
|
/** Meta data that should be included in the main hash of the payload */
|
|
11
|
-
$meta?: JsonObject
|
|
11
|
+
$meta?: TAdditionalMeta extends void ? JsonObject : JsonObject & TAdditionalMeta
|
|
12
12
|
}
|
|
13
13
|
|
|
14
14
|
/** Additional fields for a payload */
|
|
@@ -36,8 +36,9 @@ export type Payload<T extends void | EmptyObject | WithSchema = void, S extends
|
|
|
36
36
|
|
|
37
37
|
export type OverridablePayload<T extends Payload> = Omit<T, 'schema'> & { schema: string }
|
|
38
38
|
|
|
39
|
-
export type WithMeta<T extends Payload = Payload> = T & PayloadMetaFields
|
|
40
|
-
export type WithOptionalMeta<T extends Payload = Payload> = Partial<WithMeta<T>> &
|
|
39
|
+
export type WithMeta<T extends Payload = Payload, M extends JsonObject | void = void> = T & PayloadMetaFields<M>
|
|
40
|
+
export type WithOptionalMeta<T extends Payload = Payload, M extends JsonObject | void = void> = Partial<WithMeta<T, M>> &
|
|
41
|
+
Omit<WithMeta<T, M>, '$hash'>
|
|
41
42
|
|
|
42
43
|
export type PayloadWithMeta<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = WithMeta<Payload<T, S>>
|
|
43
44
|
|