@xyo-network/payload 2.35.0 → 2.36.0-rc.2

package/dist/cjs/Huri/Huri.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Huri = void 0;
 const tslib_1 = require("tslib");
-const sdk_js_1 = require("@xylabs/sdk-js");
+const assert_1 = require("@xylabs/assert");
 const account_1 = require("@xyo-network/account");
 const axios_1 = tslib_1.__importDefault(require("axios"));
 class Huri {
@@ -13,7 +13,7 @@ class Huri {
         this.originalHref = huriString;
         const protocol = Huri.parseProtocol(huriString);
         this.protocol = protocol !== null && protocol !== void 0 ? protocol : 'https';
-        const path = (0, sdk_js_1.assertEx)(Huri.parsePath(huriString), 'Missing path');
+        const path = (0, assert_1.assertEx)(Huri.parsePath(huriString), 'Missing path');
         this.hash = this.parsePath(path, protocol !== undefined);
         //if archivistUri sent, overwrite protocol and archivist
         if (archivistUri) {
@@ -27,27 +27,27 @@ class Huri {
         var _a;
         const pathParts = path.split('/');
         //if the protocol was found, then there is not allowed to be a leading /
-        (0, sdk_js_1.assertEx)(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol separator');
+        (0, assert_1.assertEx)(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol separator');
         //remove leading '/' if needed
         pathParts[0].length === 0 ? pathParts.shift() : null;
         //hash is assumed to be the last part
-        const hash = (0, sdk_js_1.assertEx)(pathParts.pop(), 'No hash specified');
+        const hash = (0, assert_1.assertEx)(pathParts.pop(), 'No hash specified');
         //archivist is assumed to be the first part
         this.archivist = (_a = pathParts.shift()) !== null && _a !== void 0 ? _a : 'api.archivist.xyo.network';
         //the archive is whatever is left
         this.archive = pathParts.pop();
         //after we pull off all the path parts, there should be nothing left
-        (0, sdk_js_1.assertEx)(pathParts.length === 0, 'Too many path parts');
+        (0, assert_1.assertEx)(pathParts.length === 0, 'Too many path parts');
         return hash;
     }
     validateParse() {
         var _a, _b;
         //the archivist should not be zero length
-        (0, sdk_js_1.assertEx)(((_a = this.archivist) === null || _a === void 0 ? void 0 : _a.length) !== 0, 'Invalid archivist length');
+        (0, assert_1.assertEx)(((_a = this.archivist) === null || _a === void 0 ? void 0 : _a.length) !== 0, 'Invalid archivist length');
         //the archivist should not be zero length (can be undefined)
-        (0, sdk_js_1.assertEx)(((_b = this.archive) === null || _b === void 0 ? void 0 : _b.length) !== 0, 'Invalid archive length');
+        (0, assert_1.assertEx)(((_b = this.archive) === null || _b === void 0 ? void 0 : _b.length) !== 0, 'Invalid archive length');
         //the archive should not be set if the archivist is not set
-        (0, sdk_js_1.assertEx)(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required');
+        (0, assert_1.assertEx)(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required');
     }
     /*
     The full href or the hash
@@ -81,18 +81,18 @@ class Huri {
     }
     static parseProtocol(huri) {
         const protocolSplit = huri.split('//');
-        (0, sdk_js_1.assertEx)(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`);
+        (0, assert_1.assertEx)(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`);
         const rawProtocol = protocolSplit.length === 2 ? protocolSplit.shift() : undefined;
         if (rawProtocol) {
             const protocolParts = rawProtocol === null || rawProtocol === void 0 ? void 0 : rawProtocol.split(':');
-            (0, sdk_js_1.assertEx)(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`);
-            (0, sdk_js_1.assertEx)(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`);
+            (0, assert_1.assertEx)(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`);
+            (0, assert_1.assertEx)(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`);
             return protocolParts.shift();
         }
     }
     static parsePath(huri) {
         const protocolSplit = huri.split('//');
-        (0, sdk_js_1.assertEx)(protocolSplit.length <= 2, `Invalid format [${huri}]`);
+        (0, assert_1.assertEx)(protocolSplit.length <= 2, `Invalid format [${huri}]`);
         if (protocolSplit.length === 1) {
             return huri;
         }

package/dist/cjs/Wrapper/Wrapper.d.ts

@@ -2,15 +2,16 @@ import { Hasher, XyoDataLike } from '@xyo-network/core';
 import { Huri } from '../Huri';
 import { XyoPayload } from '../models';
 export declare class PayloadWrapper<T extends XyoPayload = XyoPayload> extends Hasher<T> {
+    private isPayloadWrapper;
     get payload(): T;
+    get schemaName(): string;
     get body(): T;
     get valid(): boolean;
     get errors(): Error[];
-    /** @deprecated - meta fields not supported by client anymore */
-    get meta(): T;
     static load(address: XyoDataLike | Huri): Promise<PayloadWrapper<import("../models").SchemaFields & import("../models").PayloadFields & {
         schema: string;
     }> | undefined>;
+    static parse<T extends XyoPayload = XyoPayload>(obj: unknown): PayloadWrapper<T>;
 }
 /** @deprecated use PayloadWrapper instead */
 export declare class XyoPayloadWrapper<T extends XyoPayload = XyoPayload> extends PayloadWrapper<T> {

package/dist/cjs/Wrapper/Wrapper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Wrapper.d.ts","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsD,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE3G,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,IAAW,OAAO,MAEjB;IAED,IAAW,IAAI,MAEd;IAED,IAAI,KAAK,YAER;IAED,IAAI,MAAM,YAET;IAED,gEAAgE;IAChE,IAAW,IAAI,MAEd;WAEmB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;;;CAMrD;AAED,6CAA6C;AAC7C,qBAAa,iBAAiB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,cAAc,CAAC,CAAC,CAAC;CAAG"}
+{"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"}

package/dist/cjs/Wrapper/Wrapper.js

@@ -2,13 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XyoPayloadWrapper = exports.PayloadWrapper = void 0;
 const tslib_1 = require("tslib");
+const assert_1 = require("@xylabs/assert");
 const core_1 = require("@xyo-network/core");
 const Huri_1 = require("../Huri");
 const Validator_1 = require("../Validator");
 class PayloadWrapper extends core_1.Hasher {
+    constructor() {
+        super(...arguments);
+        this.isPayloadWrapper = true;
+    }
     get payload() {
         return this.obj;
     }
+    //intentionally not naming this 'schema' so that the wrapper is not confused for a XyoPayload
+    get schemaName() {
+        return this.obj.schema;
+    }
     get body() {
         return (0, core_1.deepOmitUnderscoreFields)(this.obj);
     }
@@ -18,10 +27,6 @@ class PayloadWrapper extends core_1.Hasher {
     get errors() {
         return new Validator_1.PayloadValidator(this.payload).validate();
     }
-    /** @deprecated - meta fields not supported by client anymore */
-    get meta() {
-        return (0, core_1.deepPickUnderscoreFields)(this.obj);
-    }
     static load(address) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const payload = yield new Huri_1.Huri(address).fetch();
@@ -30,6 +35,16 @@ class PayloadWrapper extends core_1.Hasher {
             }
         });
     }
+    static parse(obj) {
+        (0, assert_1.assertEx)(!Array.isArray(obj), 'Array can not be converted to PayloadWrapper');
+        switch (typeof obj) {
+            case 'object': {
+                const castWrapper = obj;
+                return (castWrapper === null || castWrapper === void 0 ? void 0 : castWrapper.isPayloadWrapper) ? castWrapper : new PayloadWrapper(obj);
+            }
+        }
+        throw Error(`Unable to parse [${typeof obj}]`);
+    }
 }
 exports.PayloadWrapper = PayloadWrapper;
 /** @deprecated use PayloadWrapper instead */

package/dist/cjs/Wrapper/Wrapper.js.map

@@ -1 +1 @@
-{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":";;;;AAAA,4CAA2G;AAE3G,kCAA8B;AAE9B,4CAA+C;AAE/C,MAAa,cAAkD,SAAQ,aAAS;IAC9E,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,GAAG,CAAA;IACjB,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;IAED,gEAAgE;IAChE,IAAW,IAAI;QACb,OAAO,IAAA,+BAAwB,EAAI,IAAI,CAAC,GAAG,CAAC,CAAA;IAC9C,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;CACF;AA5BD,wCA4BC;AAED,6CAA6C;AAC7C,MAAa,iBAAqD,SAAQ,cAAiB;CAAG;AAA9F,8CAA8F"}
+{"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"}