@xyo-network/payload 2.21.11

package/dist/cjs/SchemaNameValidator.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoSchemaValidator = exports.SchemaValidator = exports.XyoSchemaNameValidator = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@xyo-network/core");
+/**
+ * Validates a XYO schema structure and existence
+ */
+class XyoSchemaNameValidator {
+    constructor(schema) {
+        this.schema = schema;
+    }
+    /**
+     * The schema converted into a string array split on '.'
+     *
+     * @returns string[]
+     */
+    get parts() {
+        var _a, _b;
+        this._parts = (_a = this._parts) !== null && _a !== void 0 ? _a : (_b = this.schema) === null || _b === void 0 ? void 0 : _b.split('.');
+        return this._parts;
+    }
+    /**
+     * Levels in the schema
+     *
+     * @returns number
+     */
+    get levels() {
+        var _a;
+        return (_a = this.parts) === null || _a === void 0 ? void 0 : _a.length;
+    }
+    /**
+     * Checks whether the schema is all lowercase
+     *
+     * @returns boolean
+     */
+    get isLowercase() {
+        var _a;
+        return this.schema === ((_a = this.schema) === null || _a === void 0 ? void 0 : _a.toLowerCase());
+    }
+    /**
+     *
+     * Get a domain for the schema at a certain level
+     *
+     * @param level - Zero based level to check
+     * @returns string
+     */
+    domainLevel(level) {
+        var _a;
+        return (_a = this.parts) === null || _a === void 0 ? void 0 : _a.slice(0, level + 1).reverse().join('.');
+    }
+    /**
+     * The rootDomain is the first two levels of the schema, in reverse order
+     * This can be used to determine who 'owns' that schema, based on domain
+     * registration
+     *
+     * @returns string
+     */
+    get rootDomain() {
+        var _a;
+        this._rootDomain = (_a = this._rootDomain) !== null && _a !== void 0 ? _a : this.domainLevel(1);
+        return this._rootDomain;
+    }
+    /**
+     * Checks if the root domain validates via DNS resolution
+     *
+     * @returns boolean
+     */
+    rootDomainExists() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return yield (0, core_1.domainExists)(this.rootDomain);
+        });
+    }
+    /**
+     * Determines how many levels of the schema's reverse domain
+     * pass DNS resolution
+     *
+     * @returns number (0 if none exist)
+     */
+    domainExistanceDepth() {
+        var _a;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const levels = (_a = this.levels) !== null && _a !== void 0 ? _a : 0;
+            let level = 0;
+            while (level < levels) {
+                if (!(yield (0, core_1.domainExists)(this.domainLevel(level)))) {
+                    break;
+                }
+                level += 1;
+            }
+            return level;
+        });
+    }
+    /**
+     * Run all the validations
+     * @param checkExistance - boolean
+     * @returns Error[]
+     */
+    allDynamic() {
+        var _a, _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            if (((_b = (_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0)
+                errors.push(Error('schema missing'));
+            else if (!(yield this.rootDomainExists()))
+                errors.push(Error(`schema root domain must exist [${this.rootDomain}]`));
+            return errors;
+        });
+    }
+    /**
+     * Run all static validations
+     * @returns Error[]
+     */
+    all() {
+        var _a, _b, _c;
+        const errors = [];
+        if (((_b = (_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0)
+            errors.push(Error('schema missing'));
+        else if (((_c = this.levels) !== null && _c !== void 0 ? _c : 0) < 3)
+            errors.push(Error(`schema levels < 3 [${this.levels}, ${this.schema}]`));
+        else if (!this.isLowercase)
+            errors.push(Error(`schema not lowercase [${this.schema}]`));
+        return errors;
+    }
+}
+exports.XyoSchemaNameValidator = XyoSchemaNameValidator;
+/** @deprectated use XyoSchemaNameValidator instead */
+class SchemaValidator extends XyoSchemaNameValidator {
+}
+exports.SchemaValidator = SchemaValidator;
+/** @deprectated use XyoSchemaNameValidator instead */
+class XyoSchemaValidator extends XyoSchemaNameValidator {
+}
+exports.XyoSchemaValidator = XyoSchemaValidator;
+//# sourceMappingURL=SchemaNameValidator.js.map

package/dist/cjs/SchemaNameValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaNameValidator.js","sourceRoot":"","sources":["../../src/SchemaNameValidator.ts"],"names":[],"mappings":";;;;AAAA,4CAAgD;AAEhD;;GAEG;AACH,MAAa,sBAAsB;IAEjC,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAID;;;;OAIG;IACH,IAAI,KAAK;;QACP,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,mCAAI,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,GAAG,CAAC,CAAA;QACpD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;;QACR,OAAO,MAAA,IAAI,CAAC,KAAK,0CAAE,MAAM,CAAA;IAC3B,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;;QACb,OAAO,IAAI,CAAC,MAAM,MAAK,MAAA,IAAI,CAAC,MAAM,0CAAE,WAAW,EAAE,CAAA,CAAA;IACnD,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CAAC,KAAa;;QAC/B,OAAO,MAAA,IAAI,CAAC,KAAK,0CACb,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,EACnB,OAAO,GACP,IAAI,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;IAID;;;;;;OAMG;IACH,IAAI,UAAU;;QACZ,IAAI,CAAC,WAAW,GAAG,MAAA,IAAI,CAAC,WAAW,mCAAI,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QAC1D,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACU,gBAAgB;;YAC3B,OAAO,MAAM,IAAA,mBAAY,EAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC5C,CAAC;KAAA;IAED;;;;;OAKG;IACU,oBAAoB;;;YAC/B,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,mCAAI,CAAC,CAAA;YAC/B,IAAI,KAAK,GAAG,CAAC,CAAA;YACb,OAAO,KAAK,GAAG,MAAM,EAAE;gBACrB,IAAI,CAAC,CAAC,MAAM,IAAA,mBAAY,EAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;oBAClD,MAAK;iBACN;gBACD,KAAK,IAAI,CAAC,CAAA;aACX;YACD,OAAO,KAAK,CAAA;;KACb;IAED;;;;OAIG;IAEU,UAAU;;;YACrB,MAAM,MAAM,GAAY,EAAE,CAAA;YAC1B,IAAI,CAAC,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,MAAM,mCAAI,CAAC,CAAC,KAAK,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;iBACrE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;YACnH,OAAO,MAAM,CAAA;;KACd;IAED;;;OAGG;IAEI,GAAG;;QACR,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,IAAI,CAAC,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,MAAM,mCAAI,CAAC,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;aACrE,IAAI,CAAC,MAAA,IAAI,CAAC,MAAM,mCAAI,CAAC,CAAC,GAAG,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;aACpG,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,yBAAyB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACvF,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AApHD,wDAoHC;AAED,sDAAsD;AACtD,MAAa,eAAgB,SAAQ,sBAAsB;CAAG;AAA9D,0CAA8D;AAE9D,sDAAsD;AACtD,MAAa,kBAAmB,SAAQ,sBAAsB;CAAG;AAAjE,gDAAiE"}

package/dist/cjs/Test/index.d.ts

@@ -0,0 +1 @@
+export * from './testPayload';

package/dist/cjs/Test/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./testPayload"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/Test/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Test/index.ts"],"names":[],"mappings":";;;AAAA,wDAA6B"}

package/dist/cjs/Test/testPayload.d.ts

@@ -0,0 +1,5 @@
+import { WithAdditional } from '@xyo-network/core';
+import { XyoPayloadWithMeta } from '../models';
+declare const testSchema = "network.xyo.test";
+declare const testPayload: WithAdditional<XyoPayloadWithMeta>;
+export { testPayload, testSchema };

package/dist/cjs/Test/testPayload.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testSchema = exports.testPayload = void 0;
+const testSchema = 'network.xyo.test';
+exports.testSchema = testSchema;
+const testPayload = {
+    _archive: 'test',
+    _hash: '20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c',
+    _timestamp: 1609459255555,
+    numberField: 1,
+    objectField: {
+        numberField: 1,
+        stringField: 'stringValue',
+    },
+    schema: testSchema,
+    stringField: 'stringValue',
+};
+exports.testPayload = testPayload;
+//# sourceMappingURL=testPayload.js.map

package/dist/cjs/Test/testPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testPayload.js","sourceRoot":"","sources":["../../../src/Test/testPayload.ts"],"names":[],"mappings":";;;AAIA,MAAM,UAAU,GAAG,kBAAkB,CAAA;AAcf,gCAAU;AAbhC,MAAM,WAAW,GAAuC;IACtD,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,kEAAkE;IACzE,UAAU,EAAE,aAAa;IACzB,WAAW,EAAE,CAAC;IACd,WAAW,EAAE;QACX,WAAW,EAAE,CAAC;QACd,WAAW,EAAE,aAAa;KAC3B;IACD,MAAM,EAAE,UAAU;IAClB,WAAW,EAAE,aAAa;CAC3B,CAAA;AAEQ,kCAAW"}

package/dist/cjs/Validator/BodyValidator.d.ts

@@ -0,0 +1,9 @@
+import { XyoValidator } from '@xyo-network/core';
+import { XyoPayload } from '../models';
+import { XyoSchemaNameValidator } from '../SchemaNameValidator';
+export declare class XyoPayloadBodyValidator<T extends XyoPayload = XyoPayload> extends XyoValidator<T> {
+    private _schemaValidator?;
+    get schemaValidator(): XyoSchemaNameValidator;
+    schemaName(): Error[];
+    validate(): Error[];
+}

package/dist/cjs/Validator/BodyValidator.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoPayloadBodyValidator = void 0;
+const core_1 = require("@xyo-network/core");
+const SchemaNameValidator_1 = require("../SchemaNameValidator");
+class XyoPayloadBodyValidator extends core_1.XyoValidator {
+    get schemaValidator() {
+        var _a, _b;
+        this._schemaValidator = (_a = this._schemaValidator) !== null && _a !== void 0 ? _a : new SchemaNameValidator_1.XyoSchemaNameValidator((_b = this.obj.schema) !== null && _b !== void 0 ? _b : '');
+        return this._schemaValidator;
+    }
+    schemaName() {
+        const errors = [];
+        if (this.obj.schema === undefined) {
+            errors.push(Error('schema missing'));
+        }
+        else {
+            errors.push(...this.schemaValidator.all());
+        }
+        return errors;
+    }
+    validate() {
+        const errors = [];
+        errors.push(...this.schemaName());
+        return errors;
+    }
+}
+exports.XyoPayloadBodyValidator = XyoPayloadBodyValidator;
+//# sourceMappingURL=BodyValidator.js.map

package/dist/cjs/Validator/BodyValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BodyValidator.js","sourceRoot":"","sources":["../../../src/Validator/BodyValidator.ts"],"names":[],"mappings":";;;AAAA,4CAAgD;AAGhD,gEAA+D;AAE/D,MAAa,uBAA2D,SAAQ,mBAAe;IAE7F,IAAI,eAAe;;QACjB,IAAI,CAAC,gBAAgB,GAAG,MAAA,IAAI,CAAC,gBAAgB,mCAAI,IAAI,4CAAsB,CAAC,MAAA,IAAI,CAAC,GAAG,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAA;QAClG,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAEM,UAAU;QACf,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE;YACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;SACrC;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC,CAAA;SAC3C;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACjC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAtBD,0DAsBC"}

package/dist/cjs/Validator/MetaValidator.d.ts

@@ -0,0 +1,8 @@
+import { XyoValidator } from '@xyo-network/core';
+import { XyoPayloadMeta } from '../models';
+declare class XyoPayloadMetaValidator<T extends XyoPayloadMeta = XyoPayloadMeta> extends XyoValidator<T> {
+    hash(): Error[];
+    timestamp(): Error[];
+    validate(): Error[];
+}
+export { XyoPayloadMetaValidator };

package/dist/cjs/Validator/MetaValidator.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoPayloadMetaValidator = void 0;
+const core_1 = require("@xyo-network/core");
+const MIN_ALLOWED_TIMESTAMP = 1609459200000;
+const MAX_ALLOWED_TIMESTAMP = 4102444800000;
+class XyoPayloadMetaValidator extends core_1.XyoValidator {
+    hash() {
+        const errors = [];
+        const wrapper = new core_1.XyoHasher(this.obj);
+        const bodyHash = wrapper.hash;
+        if (bodyHash !== this.obj._hash)
+            errors.push(new Error(`Body hash mismatch: [calculated: ${bodyHash}] [found: ${this.obj._hash}]`));
+        return errors;
+    }
+    timestamp() {
+        const errors = [];
+        const { _timestamp } = this.obj;
+        if (_timestamp === undefined)
+            errors.push(new Error('Missing _timestamp'));
+        else if (_timestamp < MIN_ALLOWED_TIMESTAMP)
+            errors.push(new Error('_timestamp is before year 2021'));
+        else if (_timestamp > MAX_ALLOWED_TIMESTAMP)
+            errors.push(new Error('_timestamp is after year 2100'));
+        return errors;
+    }
+    validate() {
+        const errors = [];
+        errors.push(...this.hash(), ...this.timestamp());
+        return errors;
+    }
+}
+exports.XyoPayloadMetaValidator = XyoPayloadMetaValidator;
+//# sourceMappingURL=MetaValidator.js.map

package/dist/cjs/Validator/MetaValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetaValidator.js","sourceRoot":"","sources":["../../../src/Validator/MetaValidator.ts"],"names":[],"mappings":";;;AAAA,4CAA2D;AAI3D,MAAM,qBAAqB,GAAG,aAAa,CAAA;AAC3C,MAAM,qBAAqB,GAAG,aAAa,CAAA;AAE3C,MAAM,uBAAmE,SAAQ,mBAAe;IACvF,IAAI;QACT,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,OAAO,GAAG,IAAI,gBAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAA;QAC7B,IAAI,QAAQ,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,oCAAoC,QAAQ,aAAa,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;QACnI,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,SAAS;QACd,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,GAAG,CAAA;QAC/B,IAAI,UAAU,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAA;aACrE,IAAI,UAAU,GAAG,qBAAqB;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC,CAAA;aAChG,IAAI,UAAU,GAAG,qBAAqB;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAA;QACpG,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QAChD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAEQ,0DAAuB"}

package/dist/cjs/Validator/Validator.d.ts

@@ -0,0 +1,10 @@
+import { XyoValidator } from '@xyo-network/core';
+import { XyoPayloadWithMeta } from '../models';
+import { XyoPayloadBodyValidator } from './BodyValidator';
+import { XyoPayloadMetaValidator } from './MetaValidator';
+export declare class XyoPayloadValidator<T extends XyoPayloadWithMeta = XyoPayloadWithMeta> extends XyoValidator<T> {
+    body: XyoPayloadBodyValidator;
+    meta: XyoPayloadMetaValidator;
+    constructor(payload: T);
+    validate(): Error[];
+}

package/dist/cjs/Validator/Validator.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoPayloadValidator = void 0;
+const core_1 = require("@xyo-network/core");
+const BodyValidator_1 = require("./BodyValidator");
+const MetaValidator_1 = require("./MetaValidator");
+class XyoPayloadValidator extends core_1.XyoValidator {
+    constructor(payload) {
+        super(payload);
+        this.body = new BodyValidator_1.XyoPayloadBodyValidator(payload);
+        this.meta = new MetaValidator_1.XyoPayloadMetaValidator(payload);
+    }
+    validate() {
+        const errors = [];
+        errors.push(...this.body.validate());
+        return errors;
+    }
+}
+exports.XyoPayloadValidator = XyoPayloadValidator;
+//# sourceMappingURL=Validator.js.map

package/dist/cjs/Validator/Validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../../src/Validator/Validator.ts"],"names":[],"mappings":";;;AAAA,4CAAgD;AAGhD,mDAAyD;AACzD,mDAAyD;AAEzD,MAAa,mBAAuE,SAAQ,mBAAe;IAGzG,YAAY,OAAU;QACpB,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,uCAAuB,CAAC,OAAO,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,uCAAuB,CAAC,OAAO,CAAC,CAAA;IAClD,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QACpC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAdD,kDAcC"}

package/dist/cjs/Validator/index.d.ts

@@ -0,0 +1,3 @@
+export * from './BodyValidator';
+export * from './MetaValidator';
+export * from './Validator';

package/dist/cjs/Validator/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./BodyValidator"), exports);
+tslib_1.__exportStar(require("./MetaValidator"), exports);
+tslib_1.__exportStar(require("./Validator"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/Validator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Validator/index.ts"],"names":[],"mappings":";;;AAAA,0DAA+B;AAC/B,0DAA+B;AAC/B,sDAA2B"}

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

@@ -0,0 +1,8 @@
+import { XyoValidator } from '@xyo-network/core';
+import { XyoPayloadWithMeta } from '../models';
+import { XyoPayloadValidator } from '../Validator';
+import { XyoPayloadWrapper } from './Wrapper';
+export declare class XyoPayloadWrapperValidator<T extends XyoPayloadWrapper<XyoPayloadWithMeta> = XyoPayloadWrapper<XyoPayloadWithMeta>> extends XyoValidator<T> {
+    get payload(): XyoPayloadValidator<XyoPayloadWithMeta<unknown>>;
+    validate(): Error[];
+}

package/dist/cjs/Wrapper/Validator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoPayloadWrapperValidator = void 0;
+const core_1 = require("@xyo-network/core");
+const Validator_1 = require("../Validator");
+class XyoPayloadWrapperValidator extends core_1.XyoValidator {
+    get payload() {
+        return new Validator_1.XyoPayloadValidator(this.obj.body);
+    }
+    validate() {
+        const errors = [];
+        errors.push(...this.payload.validate());
+        return errors;
+    }
+}
+exports.XyoPayloadWrapperValidator = XyoPayloadWrapperValidator;
+//# sourceMappingURL=Validator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../../src/Wrapper/Validator.ts"],"names":[],"mappings":";;;AAAA,4CAAgD;AAGhD,4CAAkD;AAGlD,MAAa,0BAAoH,SAAQ,mBAAe;IACtJ,IAAW,OAAO;QAChB,OAAO,IAAI,+BAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC/C,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;QACvC,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAVD,gEAUC"}

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

@@ -0,0 +1,9 @@
+import { XyoDataLike, XyoHasher } from '@xyo-network/core';
+import { Huri } from '../Huri';
+import { XyoPayload } from '../models';
+export declare class XyoPayloadWrapper<T extends XyoPayload> extends XyoHasher<T> {
+    get payload(): T;
+    get body(): T;
+    get meta(): T;
+    static load(address: XyoDataLike | Huri): Promise<XyoPayloadWrapper<XyoPayload<object>> | undefined>;
+}

package/dist/cjs/Wrapper/Wrapper.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoPayloadWrapper = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@xyo-network/core");
+const Huri_1 = require("../Huri");
+class XyoPayloadWrapper extends core_1.XyoHasher {
+    get payload() {
+        return this.obj;
+    }
+    get body() {
+        return (0, core_1.deepOmitUnderscoreFields)(this.obj);
+    }
+    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();
+            if (payload) {
+                return new XyoPayloadWrapper(payload);
+            }
+        });
+    }
+}
+exports.XyoPayloadWrapper = XyoPayloadWrapper;
+//# sourceMappingURL=Wrapper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":";;;;AAAA,4CAA8G;AAE9G,kCAA8B;AAG9B,MAAa,iBAAwC,SAAQ,gBAAY;IACvE,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,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,iBAAiB,CAAC,OAAO,CAAC,CAAA;aACtC;QACH,CAAC;KAAA;CACF;AAnBD,8CAmBC"}

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

@@ -0,0 +1,2 @@
+export * from './Validator';
+export * from './Wrapper';

package/dist/cjs/Wrapper/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Validator"), exports);
+tslib_1.__exportStar(require("./Wrapper"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Wrapper/index.ts"],"names":[],"mappings":";;;AAAA,sDAA2B;AAC3B,oDAAyB"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,9 @@
+export * from './Builder';
+export * from './Huri';
+export * from './isXyoPayloadOfSchemaType';
+export * from './models';
+export * from './Query';
+export * from './Schema';
+export * from './SchemaNameValidator';
+export * from './Validator';
+export * from './Wrapper';

package/dist/cjs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Builder"), exports);
+tslib_1.__exportStar(require("./Huri"), exports);
+tslib_1.__exportStar(require("./isXyoPayloadOfSchemaType"), exports);
+tslib_1.__exportStar(require("./models"), exports);
+tslib_1.__exportStar(require("./Query"), exports);
+tslib_1.__exportStar(require("./Schema"), exports);
+tslib_1.__exportStar(require("./SchemaNameValidator"), exports);
+tslib_1.__exportStar(require("./Validator"), exports);
+tslib_1.__exportStar(require("./Wrapper"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,iDAAsB;AACtB,qEAA0C;AAC1C,mDAAwB;AACxB,kDAAuB;AACvB,mDAAwB;AACxB,gEAAqC;AACrC,sDAA2B;AAC3B,oDAAyB"}

package/dist/cjs/isXyoPayloadOfSchemaType.d.ts

@@ -0,0 +1,4 @@
+import { XyoPayload } from './models';
+import { XyoSchemaPayload } from './Schema';
+export declare const isXyoPayloadOfSchemaType: <T extends XyoPayload<object>>(schema: string) => (x: XyoPayload) => x is T;
+export declare const isXyoSchemaPayload: (x: XyoPayload) => x is XyoSchemaPayload;

package/dist/cjs/isXyoPayloadOfSchemaType.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isXyoSchemaPayload = exports.isXyoPayloadOfSchemaType = void 0;
+const isXyoPayloadOfSchemaType = (schema) => {
+    return (x) => x.schema === schema;
+};
+exports.isXyoPayloadOfSchemaType = isXyoPayloadOfSchemaType;
+exports.isXyoSchemaPayload = (0, exports.isXyoPayloadOfSchemaType)('network.xyo.schema');
+//# sourceMappingURL=isXyoPayloadOfSchemaType.js.map

package/dist/cjs/isXyoPayloadOfSchemaType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isXyoPayloadOfSchemaType.js","sourceRoot":"","sources":["../../src/isXyoPayloadOfSchemaType.ts"],"names":[],"mappings":";;;AAGO,MAAM,wBAAwB,GAAG,CAAuB,MAAc,EAAE,EAAE;IAC/E,OAAO,CAAC,CAAa,EAAU,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAA;AACvD,CAAC,CAAA;AAFY,QAAA,wBAAwB,4BAEpC;AAEY,QAAA,kBAAkB,GAAG,IAAA,gCAAwB,EAAmB,oBAAoB,CAAC,CAAA"}

package/dist/cjs/models/Base.d.ts

@@ -0,0 +1,6 @@
+export interface XyoPayloadBase {
+    schema: string;
+    previousHash?: string;
+    sources?: string[];
+    timestamp?: number;
+}

package/dist/cjs/models/Base.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Base.js.map

package/dist/cjs/models/Base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.js","sourceRoot":"","sources":["../../../src/models/Base.ts"],"names":[],"mappings":""}

package/dist/cjs/models/Meta.d.ts

@@ -0,0 +1,24 @@
+import { XyoPayloadBase } from './Base';
+import { XyoPayload } from './XyoPayload';
+export interface XyoPayloadMetaBase {
+    _hash: string;
+    _observeDuration?: number;
+    _archive: string;
+    _client?: string;
+    _reportedHash?: string;
+    _timestamp: number;
+    _sources?: XyoPayload[];
+    _user_agent?: string;
+    _schemaValid?: boolean;
+}
+export interface XyoQueryPayloadMetaBase extends XyoPayloadMetaBase {
+    _queryId: string;
+}
+export declare type XyoPayloadMeta<T = unknown> = T & XyoPayloadMetaBase;
+export declare type XyoPartialPayloadMeta<T = unknown> = T & Partial<XyoPayloadMetaBase>;
+export declare type XyoPayloadWithMeta<T = unknown> = T & XyoPayloadMetaBase & XyoPayloadBase;
+export declare type XyoPayloadWithPartialMeta<T = unknown> = T & Partial<XyoPayloadMetaBase> & XyoPayloadBase;
+export declare type XyoQueryPayloadMeta<T = unknown> = T & XyoQueryPayloadMetaBase;
+export declare type XyoQueryPartialPayloadMeta<T = unknown> = T & Partial<XyoQueryPayloadMetaBase>;
+export declare type XyoQueryPayloadWithMeta<T = unknown> = T & XyoQueryPayloadMetaBase & XyoPayloadBase;
+export declare type XyoQueryPayloadWithPartialMeta<T = unknown> = T & Partial<XyoQueryPayloadMetaBase> & XyoPayloadBase;

package/dist/cjs/models/Meta.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Meta.js.map

package/dist/cjs/models/Meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Meta.js","sourceRoot":"","sources":["../../../src/models/Meta.ts"],"names":[],"mappings":""}

package/dist/cjs/models/XyoPayload.d.ts

@@ -0,0 +1,2 @@
+import { XyoPayloadBase } from './Base';
+export declare type XyoPayload<T extends object = object> = T & XyoPayloadBase;

package/dist/cjs/models/XyoPayload.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=XyoPayload.js.map

package/dist/cjs/models/XyoPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoPayload.js","sourceRoot":"","sources":["../../../src/models/XyoPayload.ts"],"names":[],"mappings":""}

package/dist/cjs/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Base';
+export * from './Meta';
+export * from './XyoPayload';

package/dist/cjs/models/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Base"), exports);
+tslib_1.__exportStar(require("./Meta"), exports);
+tslib_1.__exportStar(require("./XyoPayload"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,iDAAsB;AACtB,iDAAsB;AACtB,uDAA4B"}

package/dist/docs.json

@@ -0,0 +1,7 @@
+{
+	"id": 0,
+	"name": "@xyo-network/payload",
+	"kind": 1,
+	"flags": {},
+	"originalName": ""
+}

package/dist/esm/Builder/Builder.d.ts

@@ -0,0 +1,15 @@
+import { StringKeyObject } from '@xyo-network/core';
+import { XyoPayload } from '../models';
+export interface XyoPayloadBuilderOptions {
+    schema: string;
+}
+export declare class XyoPayloadBuilder<T extends XyoPayload = XyoPayload<StringKeyObject>> {
+    private _fields;
+    private _previousHash?;
+    private _schema;
+    constructor({ schema }: XyoPayloadBuilderOptions);
+    fields(fields?: Partial<T>): this;
+    previousHash(hash?: string): this;
+    hashableFields(): T;
+    build(): T;
+}

package/dist/esm/Builder/Builder.js

@@ -0,0 +1,30 @@
+import { deepOmitUnderscoreFields, removeEmptyFields, XyoHasher } from '@xyo-network/core';
+export class XyoPayloadBuilder {
+    constructor({ schema }) {
+        this._fields = {};
+        this._schema = schema;
+    }
+    fields(fields) {
+        if (fields) {
+            this._fields = { ...this._fields, ...removeEmptyFields(fields) };
+        }
+        return this;
+    }
+    previousHash(hash) {
+        this._previousHash = hash;
+        return this;
+    }
+    hashableFields() {
+        return {
+            ...removeEmptyFields(deepOmitUnderscoreFields({ ...this._fields, previousHash: this._previousHash })),
+            schema: this._schema,
+        };
+    }
+    build() {
+        const hashableFields = this.hashableFields();
+        const _hash = new XyoHasher(hashableFields).hash;
+        const _timestamp = Date.now();
+        return { ...hashableFields, _client: 'js', _hash, _timestamp, schema: this._schema };
+    }
+}
+//# sourceMappingURL=Builder.js.map

package/dist/esm/Builder/Builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../src/Builder/Builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAmB,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAQ3G,MAAM,OAAO,iBAAiB;IAK5B,YAAY,EAAE,MAAM,EAA4B;QAJxC,YAAO,GAAe,EAAE,CAAA;QAK9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAEM,MAAM,CAAC,MAAmB;QAC/B,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAA;SACjE;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAEM,YAAY,CAAC,IAAa;QAC/B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IAEM,cAAc;QACnB,OAAO;YACL,GAAG,iBAAiB,CAAC,wBAAwB,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;YACrG,MAAM,EAAE,IAAI,CAAC,OAAO;SAChB,CAAA;IACR,CAAC;IAEM,KAAK;QACV,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;QAC5C,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC,CAAC,IAAI,CAAA;QAChD,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC7B,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,CAAA;IACtF,CAAC;CACF"}

package/dist/esm/Builder/index.d.ts

@@ -0,0 +1 @@
+export * from './Builder';

package/dist/esm/Builder/index.js

@@ -0,0 +1,2 @@
+export * from './Builder';
+//# sourceMappingURL=index.js.map

package/dist/esm/Builder/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Builder/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}