@xyo-network/payload 2.42.16 → 2.42.18

package/dist/esm/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/esm/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/esm/SchemaNameValidator.js

@@ -0,0 +1,114 @@
+import { domainExists } from '@xyo-network/dns';
+/**
+ * Validates a XYO schema structure and existence
+ */
+export class XyoSchemaNameValidator {
+    schema;
+    _parts;
+    _rootDomain;
+    constructor(schema) {
+        this.schema = schema;
+    }
+    /**
+     * Checks whether the schema is all lowercase
+     *
+     * @returns boolean
+     */
+    get isLowercase() {
+        return this.schema === this.schema?.toLowerCase();
+    }
+    /**
+     * Levels in the schema
+     *
+     * @returns number
+     */
+    get levels() {
+        return this.parts?.length;
+    }
+    /**
+     * The schema converted into a string array split on '.'
+     *
+     * @returns string[]
+     */
+    get parts() {
+        this._parts = this._parts ?? this.schema?.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() {
+        this._rootDomain = this._rootDomain ?? this.domainLevel(1);
+        return this._rootDomain;
+    }
+    /**
+     * Run all static validations
+     * @returns Error[]
+     */
+    all() {
+        const errors = [];
+        if ((this.schema?.length ?? 0) === 0)
+            errors.push(Error('schema missing'));
+        else if ((this.levels ?? 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[]
+     */
+    async allDynamic() {
+        const errors = [];
+        if ((this.schema?.length ?? 0) === 0)
+            errors.push(Error('schema missing'));
+        else if (!(await 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)
+     */
+    async domainExistenceDepth() {
+        const levels = this.levels ?? 0;
+        let level = 0;
+        while (level < levels) {
+            if (!(await domainExists(this.domainLevel(level)))) {
+                break;
+            }
+            level += 1;
+        }
+        return level;
+    }
+    /**
+     * Checks if the root domain validates via DNS resolution
+     *
+     * @returns boolean
+     */
+    async rootDomainExists() {
+        return await domainExists(this.rootDomain);
+    }
+    /**
+     *
+     * Get a domain for the schema at a certain level
+     *
+     * @param level - Zero based level to check
+     * @returns string
+     */
+    domainLevel(level) {
+        return this.parts
+            ?.slice(0, level + 1)
+            .reverse()
+            .join('.');
+    }
+}
+//# sourceMappingURL=SchemaNameValidator.js.map

package/dist/esm/SchemaNameValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaNameValidator.js","sourceRoot":"","sources":["../../src/SchemaNameValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAC1B,MAAM,CAAS;IACd,MAAM,CAAW;IACjB,WAAW,CAAS;IAC5B,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,CAAA;IACnD,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,EAAE,MAAM,CAAA;IAC3B,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;QACpD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;;;;OAMG;IACH,IAAI,UAAU;QACZ,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,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,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;aACrE,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,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;IAEI,KAAK,CAAC,UAAU;QACrB,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;aACrE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;QACnH,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA;QAC/B,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,OAAO,KAAK,GAAG,MAAM,EAAE;YACrB,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBAClD,MAAK;aACN;YACD,KAAK,IAAI,CAAC,CAAA;SACX;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC3B,OAAO,MAAM,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CAAC,KAAa;QAC/B,OAAO,IAAI,CAAC,KAAK;YACf,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC;aACpB,OAAO,EAAE;aACT,IAAI,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;CACF"}

package/dist/esm/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/esm/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/esm/index.js

@@ -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/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","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.js","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/package.json

@@ -10,14 +10,15 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/huri": "^2.42.15",
-    "@xyo-network/payload-builder": "^2.42.15",
-    "@xyo-network/payload-model": "^2.42.15",
-    "@xyo-network/payload-validator": "^2.42.15",
-    "@xyo-network/payload-wrapper": "^2.42.15"
+    "@xyo-network/dns": "^2.42.17",
+    "@xyo-network/huri": "^2.42.17",
+    "@xyo-network/payload-builder": "^2.42.17",
+    "@xyo-network/payload-model": "^2.42.17",
+    "@xyo-network/payload-validator": "^2.42.17",
+    "@xyo-network/payload-wrapper": "^2.42.17"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.10.25",
+    "@xylabs/ts-scripts-yarn3": "^2.11.16",
     "axios": "~1.2.1",
     "pako": "^2.1.0"
   },
@@ -58,5 +59,5 @@
   },
   "sideEffects": false,
   "types": "dist/esm/index.d.ts",
-  "version": "2.42.16"
+  "version": "2.42.18"
 }

package/src/SchemaNameValidator.ts

@@ -0,0 +1,120 @@
+import { domainExists } from '@xyo-network/dns'
+
+/**
+ * Validates a XYO schema structure and existence
+ */
+export class XyoSchemaNameValidator {
+  public schema?: string
+  private _parts?: string[]
+  private _rootDomain?: string
+  constructor(schema?: string) {
+    this.schema = schema
+  }
+
+  /**
+   * Checks whether the schema is all lowercase
+   *
+   * @returns boolean
+   */
+  get isLowercase(): boolean {
+    return this.schema === this.schema?.toLowerCase()
+  }
+
+  /**
+   * Levels in the schema
+   *
+   * @returns number
+   */
+  get levels(): number | undefined {
+    return this.parts?.length
+  }
+
+  /**
+   * The schema converted into a string array split on '.'
+   *
+   * @returns string[]
+   */
+  get parts() {
+    this._parts = this._parts ?? this.schema?.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(): string | undefined {
+    this._rootDomain = this._rootDomain ?? this.domainLevel(1)
+    return this._rootDomain
+  }
+
+  /**
+   * Run all static validations
+   * @returns Error[]
+   */
+
+  public all() {
+    const errors: Error[] = []
+    if ((this.schema?.length ?? 0) === 0) errors.push(Error('schema missing'))
+    else if ((this.levels ?? 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[]
+   */
+
+  public async allDynamic() {
+    const errors: Error[] = []
+    if ((this.schema?.length ?? 0) === 0) errors.push(Error('schema missing'))
+    else if (!(await 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)
+   */
+  public async domainExistenceDepth() {
+    const levels = this.levels ?? 0
+    let level = 0
+    while (level < levels) {
+      if (!(await domainExists(this.domainLevel(level)))) {
+        break
+      }
+      level += 1
+    }
+    return level
+  }
+
+  /**
+   * Checks if the root domain validates via DNS resolution
+   *
+   * @returns boolean
+   */
+  public async rootDomainExists() {
+    return await domainExists(this.rootDomain)
+  }
+
+  /**
+   *
+   * Get a domain for the schema at a certain level
+   *
+   * @param level - Zero based level to check
+   * @returns string
+   */
+  private domainLevel(level: number): string | undefined {
+    return this.parts
+      ?.slice(0, level + 1)
+      .reverse()
+      .join('.')
+  }
+}

package/src/index.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'