@xyo-network/payload 2.42.17 → 2.42.19

package/dist/cjs/SchemaNameValidator.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Validates a XYO schema structure and existence
+ */
+export declare class XyoSchemaNameValidator {
+    schema?: string;
+    private _parts?;
+    private _rootDomain?;
+    constructor(schema?: string);
+    /**
+     * Checks whether the schema is all lowercase
+     *
+     * @returns boolean
+     */
+    get isLowercase(): boolean;
+    /**
+     * Levels in the schema
+     *
+     * @returns number
+     */
+    get levels(): number | undefined;
+    /**
+     * The schema converted into a string array split on '.'
+     *
+     * @returns string[]
+     */
+    get parts(): string[] | undefined;
+    /**
+     * 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(): string | undefined;
+    /**
+     * Run all static validations
+     * @returns Error[]
+     */
+    all(): Error[];
+    /**
+     * Run all the validations
+     * @param checkExistence - boolean
+     * @returns Error[]
+     */
+    allDynamic(): Promise<Error[]>;
+    /**
+     * Determines how many levels of the schema's reverse domain
+     * pass DNS resolution
+     *
+     * @returns number (0 if none exist)
+     */
+    domainExistenceDepth(): Promise<number>;
+    /**
+     * Checks if the root domain validates via DNS resolution
+     *
+     * @returns boolean
+     */
+    rootDomainExists(): Promise<boolean>;
+    /**
+     *
+     * Get a domain for the schema at a certain level
+     *
+     * @param level - Zero based level to check
+     * @returns string
+     */
+    private domainLevel;
+}
+//# sourceMappingURL=SchemaNameValidator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaNameValidator.d.ts","sourceRoot":"","sources":["../../src/SchemaNameValidator.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,qBAAa,sBAAsB;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,MAAM,CAAC,CAAU;IACzB,OAAO,CAAC,WAAW,CAAC,CAAQ;gBAChB,MAAM,CAAC,EAAE,MAAM;IAI3B;;;;OAIG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAED;;;;OAIG;IACH,IAAI,KAAK,yBAGR;IAED;;;;;;OAMG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAGnC;IAED;;;OAGG;IAEI,GAAG;IAQV;;;;OAIG;IAEU,UAAU;IAOvB;;;;;OAKG;IACU,oBAAoB;IAYjC;;;;OAIG;IACU,gBAAgB;IAI7B;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CAMpB"}

package/dist/cjs/SchemaNameValidator.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XyoSchemaNameValidator = void 0;
+const tslib_1 = require("tslib");
+const dns_1 = require("@xyo-network/dns");
+/**
+ * Validates a XYO schema structure and existence
+ */
+class XyoSchemaNameValidator {
+    constructor(schema) {
+        this.schema = schema;
+    }
+    /**
+     * 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());
+    }
+    /**
+     * Levels in the schema
+     *
+     * @returns number
+     */
+    get levels() {
+        var _a;
+        return (_a = this.parts) === null || _a === void 0 ? void 0 : _a.length;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * Run all the validations
+     * @param checkExistence - 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;
+        });
+    }
+    /**
+     * Determines how many levels of the schema's reverse domain
+     * pass DNS resolution
+     *
+     * @returns number (0 if none exist)
+     */
+    domainExistenceDepth() {
+        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, dns_1.domainExists)(this.domainLevel(level)))) {
+                    break;
+                }
+                level += 1;
+            }
+            return level;
+        });
+    }
+    /**
+     * 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, dns_1.domainExists)(this.rootDomain);
+        });
+    }
+    /**
+     *
+     * 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('.');
+    }
+}
+exports.XyoSchemaNameValidator = XyoSchemaNameValidator;
+//# 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,0CAA+C;AAE/C;;GAEG;AACH,MAAa,sBAAsB;IAIjC,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;;QACb,OAAO,IAAI,CAAC,MAAM,MAAK,MAAA,IAAI,CAAC,MAAM,0CAAE,WAAW,EAAE,CAAA,CAAA;IACnD,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;;QACR,OAAO,MAAA,IAAI,CAAC,KAAK,0CAAE,MAAM,CAAA;IAC3B,CAAC;IAED;;;;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;;;;;;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;;;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;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;;;;;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,kBAAY,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;IACU,gBAAgB;;YAC3B,OAAO,MAAM,IAAA,kBAAY,EAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC5C,CAAC;KAAA;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;CACF;AAlHD,wDAkHC"}

package/dist/cjs/index.d.ts

@@ -1,3 +1,4 @@
+export * from './SchemaNameValidator';
 export * from '@xyo-network/huri';
 export * from '@xyo-network/payload-builder';
 export * from '@xyo-network/payload-model';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,8BAA8B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,8BAA8B,CAAA"}

package/dist/cjs/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./SchemaNameValidator"), exports);
 tslib_1.__exportStar(require("@xyo-network/huri"), exports);
 tslib_1.__exportStar(require("@xyo-network/payload-builder"), exports);
 tslib_1.__exportStar(require("@xyo-network/payload-model"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC;AACjC,uEAA4C;AAC5C,qEAA0C;AAC1C,yEAA8C;AAC9C,uEAA4C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,gEAAqC;AACrC,4DAAiC;AACjC,uEAA4C;AAC5C,qEAA0C;AAC1C,yEAA8C;AAC9C,uEAA4C"}