@xyo-network/payload 2.34.0 → 2.36.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/cjs/Wrapper/Wrapper.d.ts +3 -2
- package/dist/cjs/Wrapper/Wrapper.d.ts.map +1 -1
- package/dist/cjs/Wrapper/Wrapper.js +19 -4
- package/dist/cjs/Wrapper/Wrapper.js.map +1 -1
- package/dist/docs.json +800 -425
- package/dist/esm/Wrapper/Wrapper.d.ts +3 -2
- package/dist/esm/Wrapper/Wrapper.d.ts.map +1 -1
- package/dist/esm/Wrapper/Wrapper.js +17 -5
- package/dist/esm/Wrapper/Wrapper.js.map +1 -1
- package/package.json +4 -3
- package/src/Wrapper/Wrapper.ts +20 -6
|
@@ -2,15 +2,16 @@ import { Hasher, XyoDataLike } from '@xyo-network/core';
|
|
|
2
2
|
import { Huri } from '../Huri';
|
|
3
3
|
import { XyoPayload } from '../models';
|
|
4
4
|
export declare class PayloadWrapper<T extends XyoPayload = XyoPayload> extends Hasher<T> {
|
|
5
|
+
private isPayloadWrapper;
|
|
5
6
|
get payload(): T;
|
|
7
|
+
get schemaName(): string;
|
|
6
8
|
get body(): T;
|
|
7
9
|
get valid(): boolean;
|
|
8
10
|
get errors(): Error[];
|
|
9
|
-
/** @deprecated - meta fields not supported by client anymore */
|
|
10
|
-
get meta(): T;
|
|
11
11
|
static load(address: XyoDataLike | Huri): Promise<PayloadWrapper<import("../models").SchemaFields & import("../models").PayloadFields & {
|
|
12
12
|
schema: string;
|
|
13
13
|
}> | undefined>;
|
|
14
|
+
static parse<T extends XyoPayload = XyoPayload>(obj: unknown): PayloadWrapper<T>;
|
|
14
15
|
}
|
|
15
16
|
/** @deprecated use PayloadWrapper instead */
|
|
16
17
|
export declare class XyoPayloadWrapper<T extends XyoPayload = XyoPayload> extends PayloadWrapper<T> {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Wrapper.d.ts","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Wrapper.d.ts","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAEjF,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAGtC,qBAAa,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,MAAM,CAAC,CAAC,CAAC;IAC9E,OAAO,CAAC,gBAAgB,CAAO;IAE/B,IAAW,OAAO,MAEjB;IAGD,IAAW,UAAU,WAEpB;IAED,IAAW,IAAI,MAEd;IAED,IAAI,KAAK,YAER;IAED,IAAI,MAAM,YAET;WAEmB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;;;WAOtC,KAAK,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EAAE,GAAG,EAAE,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC;CAUxF;AAED,6CAA6C;AAC7C,qBAAa,iBAAiB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,cAAc,CAAC,CAAC,CAAC;CAAG"}
|
|
@@ -2,13 +2,22 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.XyoPayloadWrapper = exports.PayloadWrapper = void 0;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
+
const sdk_js_1 = require("@xylabs/sdk-js");
|
|
5
6
|
const core_1 = require("@xyo-network/core");
|
|
6
7
|
const Huri_1 = require("../Huri");
|
|
7
8
|
const Validator_1 = require("../Validator");
|
|
8
9
|
class PayloadWrapper extends core_1.Hasher {
|
|
10
|
+
constructor() {
|
|
11
|
+
super(...arguments);
|
|
12
|
+
this.isPayloadWrapper = true;
|
|
13
|
+
}
|
|
9
14
|
get payload() {
|
|
10
15
|
return this.obj;
|
|
11
16
|
}
|
|
17
|
+
//intentionally not naming this 'schema' so that the wrapper is not confused for a XyoPayload
|
|
18
|
+
get schemaName() {
|
|
19
|
+
return this.obj.schema;
|
|
20
|
+
}
|
|
12
21
|
get body() {
|
|
13
22
|
return (0, core_1.deepOmitUnderscoreFields)(this.obj);
|
|
14
23
|
}
|
|
@@ -18,10 +27,6 @@ class PayloadWrapper extends core_1.Hasher {
|
|
|
18
27
|
get errors() {
|
|
19
28
|
return new Validator_1.PayloadValidator(this.payload).validate();
|
|
20
29
|
}
|
|
21
|
-
/** @deprecated - meta fields not supported by client anymore */
|
|
22
|
-
get meta() {
|
|
23
|
-
return (0, core_1.deepPickUnderscoreFields)(this.obj);
|
|
24
|
-
}
|
|
25
30
|
static load(address) {
|
|
26
31
|
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
27
32
|
const payload = yield new Huri_1.Huri(address).fetch();
|
|
@@ -30,6 +35,16 @@ class PayloadWrapper extends core_1.Hasher {
|
|
|
30
35
|
}
|
|
31
36
|
});
|
|
32
37
|
}
|
|
38
|
+
static parse(obj) {
|
|
39
|
+
(0, sdk_js_1.assertEx)(!Array.isArray(obj), 'Array can not be converted to PayloadWrapper');
|
|
40
|
+
switch (typeof obj) {
|
|
41
|
+
case 'object': {
|
|
42
|
+
const castWrapper = obj;
|
|
43
|
+
return (castWrapper === null || castWrapper === void 0 ? void 0 : castWrapper.isPayloadWrapper) ? castWrapper : new PayloadWrapper(obj);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
throw Error(`Unable to parse [${typeof obj}]`);
|
|
47
|
+
}
|
|
33
48
|
}
|
|
34
49
|
exports.PayloadWrapper = PayloadWrapper;
|
|
35
50
|
/** @deprecated use PayloadWrapper instead */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":";;;;AAAA,
|
|
1
|
+
{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":";;;;AAAA,2CAAyC;AACzC,4CAAiF;AAEjF,kCAA8B;AAE9B,4CAA+C;AAE/C,MAAa,cAAkD,SAAQ,aAAS;IAAhF;;QACU,qBAAgB,GAAG,IAAI,CAAA;IAwCjC,CAAC;IAtCC,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,GAAG,CAAA;IACjB,CAAC;IAED,6FAA6F;IAC7F,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAA;IACxB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAA,+BAAwB,EAAI,IAAI,CAAC,GAAG,CAAC,CAAA;IAC9C,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,4BAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;IACtD,CAAC;IAEM,MAAM,CAAO,IAAI,CAAC,OAA2B;;YAClD,MAAM,OAAO,GAAG,MAAM,IAAI,WAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAA;YAC/C,IAAI,OAAO,EAAE;gBACX,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,CAAA;aACnC;QACH,CAAC;KAAA;IAEM,MAAM,CAAC,KAAK,CAAoC,GAAY;QACjE,IAAA,iBAAQ,EAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,8CAA8C,CAAC,CAAA;QAC7E,QAAQ,OAAO,GAAG,EAAE;YAClB,KAAK,QAAQ,CAAC,CAAC;gBACb,MAAM,WAAW,GAAG,GAAwB,CAAA;gBAC5C,OAAO,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,EAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,GAAQ,CAAC,CAAA;aAClF;SACF;QACD,MAAM,KAAK,CAAC,oBAAoB,OAAO,GAAG,GAAG,CAAC,CAAA;IAChD,CAAC;CACF;AAzCD,wCAyCC;AAED,6CAA6C;AAC7C,MAAa,iBAAqD,SAAQ,cAAiB;CAAG;AAA9F,8CAA8F"}
|