@itwin/ecschema-metadata 4.8.0-dev.4 → 4.8.0-dev.40

package/lib/esm/SchemaKey.js

@@ -0,0 +1,214 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { SchemaMatchType } from "./ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "./Exception";
+import { ECName } from "./ECName";
+/**
+ * @beta
+ */
+export class ECVersion {
+    /**
+     * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
+     * @param read Can support up to 999.
+     * @param write Can support up to 999.
+     * @param minor Can support up to 9999999.
+     *
+     */
+    constructor(read, write, minor) {
+        this._read = 0;
+        this._write = 0;
+        this._minor = 0;
+        if (undefined !== read)
+            this._read = read;
+        if (undefined !== write)
+            this._write = write;
+        if (undefined !== minor)
+            this._minor = minor;
+        if (this._read > 999 || this._read < 0 || this._write > 999 || this._write < 0 || this._minor > 9999999 || this._minor < 0)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion);
+    }
+    get read() { return this._read; }
+    get write() { return this._write; }
+    get minor() { return this._minor; }
+    /**
+     * Creates a string, in the format 'RR.ww.mm', representing this ECVersion.
+     * @note The default is to pad with zeroes.
+     * @param padZeroes If true, the returned string will strictly follow `RR.ww.mm` and add leading zeroes if necessary.
+     */
+    toString(padZeroes = true) {
+        if (!padZeroes)
+            return `${this.read}.${this.write}.${this.minor}`;
+        const padWithZeroes = (num) => {
+            return (num < 10 ? "0" : "") + num;
+        };
+        return `${padWithZeroes(this.read)}.${padWithZeroes(this.write)}.${padWithZeroes(this.minor)}`;
+    }
+    /**
+     * Given a valid version string the
+     * @param versionString A valid version string of the format, 'RR.ww.mm'.
+     */
+    static fromString(versionString) {
+        const [read, write, minor] = versionString.split(".");
+        if (!read)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!write)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The write version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
+        return new ECVersion(+read, +write, +minor);
+    }
+    /**
+     * Compares two schema versions.
+     * @param rhs The schema to compare.
+     * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.
+     */
+    compare(rhv) {
+        if (this.read !== rhv.read)
+            return this.read - rhv.read;
+        if (this.write !== rhv.write)
+            return this.write - rhv.write;
+        return this.minor - rhv.minor;
+    }
+}
+/**
+ * The SchemaKey contains a Schemas name and version.
+ * @beta
+ */
+export class SchemaKey {
+    constructor(name, readOrVersion, writeVersion, minorVersion) {
+        this._name = new ECName(name);
+        if (readOrVersion !== undefined && typeof (readOrVersion) !== "number")
+            this._version = readOrVersion;
+        else
+            this._version = new ECVersion(readOrVersion, writeVersion, minorVersion);
+    }
+    get version() { return this._version; }
+    get name() { return this._name.name; }
+    get readVersion() { return this.version.read; }
+    get writeVersion() { return this.version.write; }
+    get minorVersion() { return this.version.minor; }
+    /**
+     * Creates a string, in the format 'RR.ww.mm', representing this SchemaKey.
+     * @note The default is to pad the full name with zeroes.
+     * @param padZeroes If true, the returned string will strictly follow `Name.RR.ww.mm` and add leading zeroes if necessary.
+     */
+    toString(padZeroes = true) { return `${this.name}.${this.version.toString(padZeroes)}`; }
+    static parseString(fullName) {
+        const keyPieces = fullName.split(".");
+        if (keyPieces.length !== 4)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECName);
+        const schemaName = keyPieces[0];
+        const readVer = Number(keyPieces[1]);
+        const writeVer = Number(keyPieces[2]);
+        const minorVer = Number(keyPieces[3]);
+        return new SchemaKey(schemaName, new ECVersion(readVer, writeVer, minorVer));
+    }
+    /**
+     * Compares two schema names, case-insensitive.
+     * @return True if they match; otherwise, false.
+     */
+    compareByName(rhs) {
+        if (undefined === rhs)
+            return false;
+        if (typeof (rhs) === "string")
+            return rhs.toLowerCase() === this.name.toLowerCase();
+        return rhs.name.toLowerCase() === this.name.toLowerCase();
+    }
+    /**
+     * Compares two schema versions.
+     * @param rhs The schema to compare.
+     * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.
+     */
+    compareByVersion(rhs) {
+        return this.version.compare(rhs.version);
+    }
+    /**
+     *
+     * @param rhs The SchemaKey to compare with
+     * @param matchType The match type to use for comparison.
+     */
+    matches(rhs, matchType = SchemaMatchType.Identical) {
+        switch (matchType) {
+            case SchemaMatchType.Identical:
+                // TODO: if (this.checksum && rhs.checksum)
+                // TODO:   return this.checksum === rhs.checksum;
+                return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&
+                    this.writeVersion === rhs.writeVersion && this.minorVersion === rhs.minorVersion;
+            case SchemaMatchType.Exact:
+                return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&
+                    this.writeVersion === rhs.writeVersion && this.minorVersion === rhs.minorVersion;
+            case SchemaMatchType.LatestReadCompatible:
+                if (!this.compareByName(rhs.name))
+                    return false;
+                if (rhs.readVersion !== this.readVersion)
+                    return false;
+                if (this.writeVersion === rhs.writeVersion)
+                    return this.minorVersion >= rhs.minorVersion;
+                return this.writeVersion > rhs.writeVersion;
+            case SchemaMatchType.LatestWriteCompatible:
+                return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&
+                    this.writeVersion === rhs.writeVersion && this.minorVersion >= rhs.minorVersion;
+            case SchemaMatchType.Latest:
+                return this.compareByName(rhs.name);
+            default:
+                return false;
+        }
+    }
+    /**
+     * Deserializes a SchemaKeyProps JSON object into a SchemaKey object.
+     * @param props SchemaKeyProps
+     * @returns A SchemaKey object.
+     */
+    static fromJSON(props) {
+        return new SchemaKey(props.name, props.read, props.write, props.minor);
+    }
+    /**
+     * Save this SchemaKey's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        return {
+            name: this.name,
+            read: this.readVersion,
+            write: this.writeVersion,
+            minor: this.minorVersion,
+        };
+    }
+}
+/**
+ * The SchemaItemKey contains a SchemaItem's name and SchemaKey.
+ * @beta
+ */
+export class SchemaItemKey {
+    constructor(name, schema) {
+        this._name = new ECName(name);
+        this._schemaKey = schema;
+    }
+    get schemaKey() { return this._schemaKey; }
+    get name() { return this._name.name; }
+    get schemaName() { return this.schemaKey.name; }
+    /** Returns the name in the format, {schemaName}.{name}. */
+    get fullName() { return `${this.schemaName}.${this.name}`; }
+    /**
+     * Checks whether this SchemaItemKey matches the one provided.
+     * @param rhs The SchemaItemKey to compare to this.
+     */
+    // TODO: Need to add a match type
+    matches(rhs) {
+        if (rhs.name !== this.name)
+            return false;
+        if (!rhs.schemaKey.matches(this.schemaKey, SchemaMatchType.Latest))
+            return false;
+        return true;
+    }
+    matchesFullName(name) {
+        const schemaVersion = this.schemaKey.version.toString().replace(/\./g, "\\.");
+        const fullNameRegex = new RegExp(`^${this.schemaName}(\\.${schemaVersion})?[.:]${this.name}$`, "i");
+        return fullNameRegex.test(name);
+    }
+}
+//# sourceMappingURL=SchemaKey.js.map

package/lib/esm/SchemaKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaKey.js","sourceRoot":"","sources":["../../src/SchemaKey.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,SAAS;IAKpB;;;;;;OAMG;IACH,YAAY,IAAa,EAAE,KAAc,EAAE,KAAc;QAXjD,UAAK,GAAW,CAAC,CAAC;QAClB,WAAM,GAAW,CAAC,CAAC;QACnB,WAAM,GAAW,CAAC,CAAC;QAUzB,IAAI,SAAS,KAAK,IAAI;YACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,IAAI,SAAS,KAAK,KAAK;YACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACtB,IAAI,SAAS,KAAK,KAAK;YACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEtB,IAAI,IAAI,CAAC,KAAK,GAAG,GAAG,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YACxH,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IAED,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1C;;;;OAIG;IACI,QAAQ,CAAC,YAAqB,IAAI;QACvC,IAAI,CAAC,SAAS;YACZ,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAEpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;YACpC,OAAO,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;QACrC,CAAC,CAAC;QAEF,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACjG,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,aAAqB;QAC5C,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAElI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,OAAO,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAc;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI;YACxB,OAAO,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QAE9B,IAAI,IAAI,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK;YAC1B,OAAO,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QAEhC,OAAO,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IAQpB,YAAY,IAAY,EAAE,aAAkC,EAAE,YAAqB,EAAE,YAAqB;QACxG,IAAI,CAAC,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,KAAK,QAAQ;YACpE,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC;;YAE9B,IAAI,CAAC,QAAQ,GAAG,IAAI,SAAS,CAAC,aAAa,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;IAC7E,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAExD;;;;OAIG;IACI,QAAQ,CAAC,YAAqB,IAAI,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;IAElG,MAAM,CAAC,WAAW,CAAC,QAAgB;QACxC,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAE1D,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,GAAmC;QACtD,IAAI,SAAS,KAAK,GAAG;YACnB,OAAO,KAAK,CAAC;QAEf,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ;YAC3B,OAAO,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAEvD,OAAO,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,GAAc;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAwB,EAAE,YAA6B,eAAe,CAAC,SAAS;QAC7F,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,eAAe,CAAC,SAAS;gBAC5B,2CAA2C;gBAC3C,iDAAiD;gBACjD,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW;oBACzE,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,CAAC;YACrF,KAAK,eAAe,CAAC,KAAK;gBACxB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW;oBACzE,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,CAAC;YACrF,KAAK,eAAe,CAAC,oBAAoB;gBACvC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC;oBAC/B,OAAO,KAAK,CAAC;gBAEf,IAAI,GAAG,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW;oBACtC,OAAO,KAAK,CAAC;gBAEf,IAAI,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY;oBACxC,OAAO,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC;gBAE/C,OAAO,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;YAC9C,KAAK,eAAe,CAAC,qBAAqB;gBACxC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW;oBACzE,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC;YACpF,KAAK,eAAe,CAAC,MAAM;gBACzB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACtC;gBACE,OAAO,KAAK,CAAC;QACjB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACI,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,KAAK,EAAE,IAAI,CAAC,YAAY;YACxB,KAAK,EAAE,IAAI,CAAC,YAAY;SACzB,CAAC;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,aAAa;IAIxB,YAAY,IAAY,EAAE,MAAiB;QACzC,IAAI,CAAC,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,CAAC;IAED,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAClD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAE7C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvD,2DAA2D;IAC3D,IAAW,QAAQ,KAAK,OAAO,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAEnE;;;OAGG;IACH,iCAAiC;IAC1B,OAAO,CAAC,GAAkB;QAC/B,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;YACxB,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC;YAChE,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,eAAe,CAAC,IAAY;QACjC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9E,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,OAAO,aAAa,SAAS,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC;QACpG,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { SchemaKeyProps } from \"./Deserialization/JsonProps\";\r\nimport { SchemaMatchType } from \"./ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\nimport { ECName } from \"./ECName\";\r\n\r\n/**\r\n * @beta\r\n */\r\nexport class ECVersion {\r\n  private _read: number = 0;\r\n  private _write: number = 0;\r\n  private _minor: number = 0;\r\n\r\n  /**\r\n   * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.\r\n   * @param read Can support up to 999.\r\n   * @param write Can support up to 999.\r\n   * @param minor Can support up to 9999999.\r\n   *\r\n   */\r\n  constructor(read?: number, write?: number, minor?: number) {\r\n    if (undefined !== read)\r\n      this._read = read;\r\n    if (undefined !== write)\r\n      this._write = write;\r\n    if (undefined !== minor)\r\n      this._minor = minor;\r\n\r\n    if (this._read > 999 || this._read < 0 || this._write > 999 || this._write < 0 || this._minor > 9999999 || this._minor < 0)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion);\r\n  }\r\n\r\n  public get read() { return this._read; }\r\n  public get write() { return this._write; }\r\n  public get minor() { return this._minor; }\r\n\r\n  /**\r\n   * Creates a string, in the format 'RR.ww.mm', representing this ECVersion.\r\n   * @note The default is to pad with zeroes.\r\n   * @param padZeroes If true, the returned string will strictly follow `RR.ww.mm` and add leading zeroes if necessary.\r\n   */\r\n  public toString(padZeroes: boolean = true): string {\r\n    if (!padZeroes)\r\n      return `${this.read}.${this.write}.${this.minor}`;\r\n\r\n    const padWithZeroes = (num: number) => {\r\n      return (num < 10 ? \"0\" : \"\") + num;\r\n    };\r\n\r\n    return `${padWithZeroes(this.read)}.${padWithZeroes(this.write)}.${padWithZeroes(this.minor)}`;\r\n  }\r\n\r\n  /**\r\n   * Given a valid version string the\r\n   * @param versionString A valid version string of the format, 'RR.ww.mm'.\r\n   */\r\n  public static fromString(versionString: string): ECVersion {\r\n    const [read, write, minor] = versionString.split(\".\");\r\n    if (!read)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\r\n\r\n    if (!write)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The write version is missing from version string, ${versionString}`);\r\n\r\n    if (!minor)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\r\n\r\n    return new ECVersion(+read, +write, +minor);\r\n  }\r\n\r\n  /**\r\n   * Compares two schema versions.\r\n   * @param rhs The schema to compare.\r\n   * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.\r\n   */\r\n  public compare(rhv: ECVersion): number {\r\n    if (this.read !== rhv.read)\r\n      return this.read - rhv.read;\r\n\r\n    if (this.write !== rhv.write)\r\n      return this.write - rhv.write;\r\n\r\n    return this.minor - rhv.minor;\r\n  }\r\n}\r\n\r\n/**\r\n * The SchemaKey contains a Schemas name and version.\r\n * @beta\r\n */\r\nexport class SchemaKey {\r\n  private _name: ECName;\r\n  protected _version: ECVersion;\r\n  // public checksum: number;\r\n  // TODO: need to add a checksum\r\n\r\n  constructor(name: string, version: ECVersion);\r\n  constructor(name: string, readVersion?: number, writeVersion?: number, minorVersion?: number);\r\n  constructor(name: string, readOrVersion?: number | ECVersion, writeVersion?: number, minorVersion?: number) {\r\n    this._name = new ECName(name);\r\n    if (readOrVersion !== undefined && typeof (readOrVersion) !== \"number\")\r\n      this._version = readOrVersion;\r\n    else\r\n      this._version = new ECVersion(readOrVersion, writeVersion, minorVersion);\r\n  }\r\n\r\n  public get version() { return this._version; }\r\n  public get name() { return this._name.name; }\r\n  public get readVersion() { return this.version.read; }\r\n  public get writeVersion() { return this.version.write; }\r\n  public get minorVersion() { return this.version.minor; }\r\n\r\n  /**\r\n   * Creates a string, in the format 'RR.ww.mm', representing this SchemaKey.\r\n   * @note The default is to pad the full name with zeroes.\r\n   * @param padZeroes If true, the returned string will strictly follow `Name.RR.ww.mm` and add leading zeroes if necessary.\r\n   */\r\n  public toString(padZeroes: boolean = true) { return `${this.name}.${this.version.toString(padZeroes)}`; }\r\n\r\n  public static parseString(fullName: string) {\r\n    const keyPieces = fullName.split(\".\");\r\n    if (keyPieces.length !== 4)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName);\r\n\r\n    const schemaName = keyPieces[0];\r\n    const readVer = Number(keyPieces[1]);\r\n    const writeVer = Number(keyPieces[2]);\r\n    const minorVer = Number(keyPieces[3]);\r\n    return new SchemaKey(schemaName, new ECVersion(readVer, writeVer, minorVer));\r\n  }\r\n\r\n  /**\r\n   * Compares two schema names, case-insensitive.\r\n   * @return True if they match; otherwise, false.\r\n   */\r\n  public compareByName(rhs: SchemaKey | string | undefined): boolean {\r\n    if (undefined === rhs)\r\n      return false;\r\n\r\n    if (typeof (rhs) === \"string\")\r\n      return rhs.toLowerCase() === this.name.toLowerCase();\r\n\r\n    return rhs.name.toLowerCase() === this.name.toLowerCase();\r\n  }\r\n\r\n  /**\r\n   * Compares two schema versions.\r\n   * @param rhs The schema to compare.\r\n   * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.\r\n   */\r\n  public compareByVersion(rhs: SchemaKey): number {\r\n    return this.version.compare(rhs.version);\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param rhs The SchemaKey to compare with\r\n   * @param matchType The match type to use for comparison.\r\n   */\r\n  public matches(rhs: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Identical): boolean {\r\n    switch (matchType) {\r\n      case SchemaMatchType.Identical:\r\n        // TODO: if (this.checksum && rhs.checksum)\r\n        // TODO:   return this.checksum === rhs.checksum;\r\n        return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&\r\n          this.writeVersion === rhs.writeVersion && this.minorVersion === rhs.minorVersion;\r\n      case SchemaMatchType.Exact:\r\n        return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&\r\n          this.writeVersion === rhs.writeVersion && this.minorVersion === rhs.minorVersion;\r\n      case SchemaMatchType.LatestReadCompatible:\r\n        if (!this.compareByName(rhs.name))\r\n          return false;\r\n\r\n        if (rhs.readVersion !== this.readVersion)\r\n          return false;\r\n\r\n        if (this.writeVersion === rhs.writeVersion)\r\n          return this.minorVersion >= rhs.minorVersion;\r\n\r\n        return this.writeVersion > rhs.writeVersion;\r\n      case SchemaMatchType.LatestWriteCompatible:\r\n        return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&\r\n          this.writeVersion === rhs.writeVersion && this.minorVersion >= rhs.minorVersion;\r\n      case SchemaMatchType.Latest:\r\n        return this.compareByName(rhs.name);\r\n      default:\r\n        return false;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Deserializes a SchemaKeyProps JSON object into a SchemaKey object.\r\n   * @param props SchemaKeyProps\r\n   * @returns A SchemaKey object.\r\n   */\r\n  public static fromJSON(props: SchemaKeyProps): SchemaKey {\r\n    return new SchemaKey(props.name, props.read, props.write, props.minor);\r\n  }\r\n\r\n  /**\r\n   * Save this SchemaKey's properties to an object for serializing to JSON.\r\n   */\r\n  public toJSON(): SchemaKeyProps {\r\n    return {\r\n      name: this.name,\r\n      read: this.readVersion,\r\n      write: this.writeVersion,\r\n      minor: this.minorVersion,\r\n    };\r\n  }\r\n}\r\n\r\n/**\r\n * The SchemaItemKey contains a SchemaItem's name and SchemaKey.\r\n * @beta\r\n */\r\nexport class SchemaItemKey {\r\n  private _name: ECName;\r\n  protected _schemaKey: SchemaKey;\r\n\r\n  constructor(name: string, schema: SchemaKey) {\r\n    this._name = new ECName(name);\r\n    this._schemaKey = schema;\r\n  }\r\n\r\n  public get schemaKey() { return this._schemaKey; }\r\n  public get name() { return this._name.name; }\r\n\r\n  public get schemaName() { return this.schemaKey.name; }\r\n\r\n  /** Returns the name in the format, {schemaName}.{name}. */\r\n  public get fullName() { return `${this.schemaName}.${this.name}`; }\r\n\r\n  /**\r\n   * Checks whether this SchemaItemKey matches the one provided.\r\n   * @param rhs The SchemaItemKey to compare to this.\r\n   */\r\n  // TODO: Need to add a match type\r\n  public matches(rhs: SchemaItemKey): boolean {\r\n    if (rhs.name !== this.name)\r\n      return false;\r\n\r\n    if (!rhs.schemaKey.matches(this.schemaKey, SchemaMatchType.Latest))\r\n      return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  public matchesFullName(name: string): boolean {\r\n    const schemaVersion = this.schemaKey.version.toString().replace(/\\./g, \"\\\\.\");\r\n    const fullNameRegex = new RegExp(`^${this.schemaName}(\\\\.${schemaVersion})?[.:]${this.name}$`, \"i\");\r\n    return fullNameRegex.test(name);\r\n  }\r\n}\r\n"]}

package/lib/esm/SchemaLoader.d.ts

@@ -0,0 +1,32 @@
+import { SchemaContext } from "./Context";
+import { Schema } from "./Metadata/Schema";
+import { SchemaPropsGetter } from "./SchemaJsonLocater";
+/**
+ * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
+ * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
+ * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
+ * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
+ *
+ * ** Example **
+ * ```ts
+ * [[include:IModelSchemas.loadFromDb]]
+ * ```
+ * @beta
+ */
+export declare class SchemaLoader {
+    private _context;
+    constructor(getSchema: SchemaPropsGetter);
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
+     */
+    getSchema<T extends Schema>(schemaName: string): T;
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema<T extends Schema>(schemaName: string): T | undefined;
+    /** Gets the SchemaContext used by the loader. */
+    get context(): SchemaContext;
+}
+//# sourceMappingURL=SchemaLoader.d.ts.map

package/lib/esm/SchemaLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaLoader.d.ts","sourceRoot":"","sources":["../../src/SchemaLoader.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAG1C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAqB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG3E;;;;;;;;;;;GAWG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAgB;gBAEb,SAAS,EAAE,iBAAiB;IAM/C;;;OAGG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC;IAQzD;;;OAGG;IACI,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAOxE,iDAAiD;IACjD,IAAW,OAAO,IAAI,aAAa,CAElC;CACF"}

package/lib/esm/SchemaLoader.js

@@ -0,0 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { SchemaContext } from "./Context";
+import { SchemaMatchType } from "./ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "./Exception";
+import { SchemaJsonLocater } from "./SchemaJsonLocater";
+import { ECVersion, SchemaKey } from "./SchemaKey";
+/**
+ * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
+ * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
+ * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
+ * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
+ *
+ * ** Example **
+ * ```ts
+ * [[include:IModelSchemas.loadFromDb]]
+ * ```
+ * @beta
+ */
+export class SchemaLoader {
+    constructor(getSchema) {
+        this._context = new SchemaContext();
+        const locater = new SchemaJsonLocater(getSchema);
+        this._context.addLocater(locater);
+    }
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
+     */
+    getSchema(schemaName) {
+        const schema = this.tryGetSchema(schemaName);
+        if (!schema)
+            throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);
+        return schema;
+    }
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema(schemaName) {
+        // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.
+        const key = new SchemaKey(schemaName, new ECVersion(1, 0, 0));
+        const schema = this._context.getSchemaSync(key, SchemaMatchType.Latest);
+        return schema;
+    }
+    /** Gets the SchemaContext used by the loader. */
+    get context() {
+        return this._context;
+    }
+}
+//# sourceMappingURL=SchemaLoader.js.map

package/lib/esm/SchemaLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaLoader.js","sourceRoot":"","sources":["../../src/SchemaLoader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAqB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,YAAY;IAGvB,YAAmB,SAA4B;QAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAmB,UAAkB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC;QAEjG,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAmB,UAAkB;QACtD,gGAAgG;QAChG,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QACxE,OAAO,MAAW,CAAC;IACrB,CAAC;IAED,iDAAiD;IACjD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { SchemaContext } from \"./Context\";\r\nimport { SchemaMatchType } from \"./ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\nimport { Schema } from \"./Metadata/Schema\";\r\nimport { SchemaJsonLocater, SchemaPropsGetter } from \"./SchemaJsonLocater\";\r\nimport { ECVersion, SchemaKey } from \"./SchemaKey\";\r\n\r\n/**\r\n * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.\r\n * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.\r\n * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]\r\n * is a possibility, thereby avoiding unnecessary schema retrievals from the function.\r\n *\r\n * ** Example **\r\n * ```ts\r\n * [[include:IModelSchemas.loadFromDb]]\r\n * ```\r\n * @beta\r\n */\r\nexport class SchemaLoader {\r\n  private _context: SchemaContext;\r\n\r\n  public constructor(getSchema: SchemaPropsGetter) {\r\n    this._context = new SchemaContext();\r\n    const locater = new SchemaJsonLocater(getSchema);\r\n    this._context.addLocater(locater);\r\n  }\r\n\r\n  /** Get a schema by name\r\n   * @param schemaName a string with the name of the schema to load.\r\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.\r\n   */\r\n  public getSchema<T extends Schema>(schemaName: string): T {\r\n    const schema = this.tryGetSchema(schemaName);\r\n    if (!schema)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);\r\n\r\n    return schema as T;\r\n  }\r\n\r\n  /** Attempts to get a schema by name\r\n   * @param schemaName a string with the name of the schema to load.\r\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.\r\n   */\r\n  public tryGetSchema<T extends Schema>(schemaName: string): T | undefined {\r\n    // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.\r\n    const key = new SchemaKey(schemaName, new ECVersion(1, 0, 0));\r\n    const schema = this._context.getSchemaSync(key, SchemaMatchType.Latest);\r\n    return schema as T;\r\n  }\r\n\r\n  /** Gets the SchemaContext used by the loader. */\r\n  public get context(): SchemaContext {\r\n    return this._context;\r\n  }\r\n}\r\n"]}

package/lib/esm/SchemaPartVisitorDelegate.d.ts

@@ -0,0 +1,275 @@
+import { AnyClass, AnyECType } from "./Interfaces";
+import { StructClass } from "./Metadata/Class";
+import { Constant } from "./Metadata/Constant";
+import { CustomAttributeContainerProps } from "./Metadata/CustomAttribute";
+import { CustomAttributeClass } from "./Metadata/CustomAttributeClass";
+import { EntityClass } from "./Metadata/EntityClass";
+import { Enumeration } from "./Metadata/Enumeration";
+import { Format } from "./Metadata/Format";
+import { InvertedUnit } from "./Metadata/InvertedUnit";
+import { KindOfQuantity } from "./Metadata/KindOfQuantity";
+import { Mixin } from "./Metadata/Mixin";
+import { Phenomenon } from "./Metadata/Phenomenon";
+import { AnyProperty } from "./Metadata/Property";
+import { PropertyCategory } from "./Metadata/PropertyCategory";
+import { RelationshipClass, RelationshipConstraint } from "./Metadata/RelationshipClass";
+import { Schema } from "./Metadata/Schema";
+import { SchemaItem } from "./Metadata/SchemaItem";
+import { Unit } from "./Metadata/Unit";
+import { UnitSystem } from "./Metadata/UnitSystem";
+/**
+ * Interface to allow schema traversal/deserialization workflows to visit
+ * each part, item, class, etc. that exists in a given schema.
+ * @beta
+ */
+export interface ISchemaPartVisitor {
+    /**
+     * Called for a partially loaded schema. During deserialization, this would
+     * be after a schema and all its references are deserialized, but _before_
+     * any of its items or custom attributes have been deserialized.
+     * @param schema A partially-loaded Schema.
+     */
+    visitEmptySchema?: (schema: Schema) => Promise<void>;
+    /**
+     * Called for a partially loaded schema. During deserialization, this would
+     * be after a schema and all its references are deserialized, but _before_
+     * any of its items or custom attributes have been deserialized.
+     * @param schema A partially-loaded Schema.
+     */
+    visitEmptySchemaSync?: (schema: Schema) => void;
+    /**
+     * Called for a fully loaded schema.
+     * @param schema A fully-loaded Schema.
+     */
+    visitFullSchema?: (schema: Schema) => Promise<void>;
+    /**
+     * Called for a fully loaded schema.
+     * @param schema A fully-loaded Schema.
+     */
+    visitFullSchemaSync?: (schema: Schema) => void;
+    /**
+     * Called for each [[SchemaItem]] instance.
+     * @param schemaItem a SchemaItem object.
+     */
+    visitSchemaItem?: (schemaItem: SchemaItem) => Promise<void>;
+    /**
+     * Called for each [[SchemaItem]] instance.
+     * @param schemaItem a SchemaItem object.
+     */
+    visitSchemaItemSync?: (schemaItem: SchemaItem) => void;
+    /**
+     * Called for each [[AnyClass]] instance.
+     * @param ecClass an ECClass object.
+     */
+    visitClass?: (ecClass: AnyClass) => Promise<void>;
+    /**
+     * Called for each [[AnyClass]] instance.
+     * @param ecClass an ECClass object.
+     */
+    visitClassSync?: (ecClass: AnyClass) => void;
+    /**
+     * Called for each [[AnyProperty]] instance of an ECClass.
+     * @param property an AnyProperty object.
+     */
+    visitProperty?: (property: AnyProperty) => Promise<void>;
+    /**
+     * Called for each [[AnyProperty]] instance of an ECClass.
+     * @param property an AnyProperty object.
+     */
+    visitPropertySync?: (property: AnyProperty) => void;
+    /**
+     * Called for each [[EntityClass]] instance.
+     * @param entityClass an EntityClass object.
+     */
+    visitEntityClass?: (entityClass: EntityClass) => Promise<void>;
+    /**
+     * Called for each [[EntityClass]] instance.
+     * @param entityClass an EntityClass object.
+     */
+    visitEntityClassSync?: (entityClass: EntityClass) => void;
+    /**
+     * Called for each [[StructClass]] instance.
+     * @param structClass a StructClass object.
+     */
+    visitStructClass?: (structClass: StructClass) => Promise<void>;
+    /**
+     * Called for each [[StructClass]] instance.
+     * @param structClass a StructClass object.
+     */
+    visitStructClassSync?: (structClass: StructClass) => void;
+    /**
+     * Called for each [[Mixin]] instance.
+     * @param mixin a Mixin object.
+     */
+    visitMixin?: (mixin: Mixin) => Promise<void>;
+    /**
+     * Called for each [[Mixin]] instance.
+     * @param mixin a Mixin object.
+     */
+    visitMixinSync?: (mixin: Mixin) => void;
+    /**
+     * Called for each [[RelationshipClass]] instance.
+     * @param relationshipClass a RelationshipClass object.
+     */
+    visitRelationshipClass?: (relationshipClass: RelationshipClass) => Promise<void>;
+    /**
+     * Called for each [[RelationshipClass]] instance.
+     * @param relationshipClass a RelationshipClass object.
+     */
+    visitRelationshipClassSync?: (relationshipClass: RelationshipClass) => void;
+    /**
+     * Called for each [[RelationshipConstraint]] of each RelationshipClass.
+     * @param relationshipConstraint a RelationshipConstraint object.
+     */
+    visitRelationshipConstraint?: (relationshipConstraint: RelationshipConstraint) => Promise<void>;
+    /**
+     * Called for each [[RelationshipConstraint]] of each RelationshipClass.
+     * @param relationshipConstraint a RelationshipConstraint object.
+     */
+    visitRelationshipConstraintSync?: (relationshipConstraint: RelationshipConstraint) => void;
+    /**
+     * Called for each [[CustomAttributeClass]] instance.
+     * @param customAttributeClass a CustomAttributeClass object.
+     */
+    visitCustomAttributeClass?: (customAttributeClass: CustomAttributeClass) => Promise<void>;
+    /**
+     * Called for each [[CustomAttributeClass]] instance.
+     * @param customAttributeClass a CustomAttributeClass object.
+     */
+    visitCustomAttributeClassSync?: (customAttributeClass: CustomAttributeClass) => void;
+    /**
+     * Called for each CustomAttribute container in the schema.
+     * @param customAttributeContainer a CustomAttributeContainerProps object.
+     */
+    visitCustomAttributeContainer?: (customAttributeContainer: CustomAttributeContainerProps) => Promise<void>;
+    /**
+     * Called for each CustomAttribute container in the schema.
+     * @param customAttributeContainer a CustomAttributeContainerProps object.
+     */
+    visitCustomAttributeContainerSync?: (customAttributeContainer: CustomAttributeContainerProps) => void;
+    /**
+     * Called for each [[Enumeration]] instance.
+     * @param enumeration an Enumeration object.
+     */
+    visitEnumeration?: (enumeration: Enumeration) => Promise<void>;
+    /**
+     * Called for each [[Enumeration]] instance.
+     * @param enumeration an Enumeration object.
+     */
+    visitEnumerationSync?: (enumeration: Enumeration) => void;
+    /**
+     * Called for each [[KindOfQuantity]] instance.
+     * @param koq a KindOfQuantity object.
+     */
+    visitKindOfQuantity?: (koq: KindOfQuantity) => Promise<void>;
+    /**
+     * Called for each [[KindOfQuantity]] instance.
+     * @param koq a KindOfQuantity object.
+     */
+    visitKindOfQuantitySync?: (koq: KindOfQuantity) => void;
+    /**
+     * Called for each [[PropertyCategory]] instance.
+     * @param category a PropertyCategory object.
+     */
+    visitPropertyCategory?: (category: PropertyCategory) => Promise<void>;
+    /**
+     * Called for each [[PropertyCategory]] instance.
+     * @param category a PropertyCategory object.
+     */
+    visitPropertyCategorySync?: (category: PropertyCategory) => void;
+    /**
+     * Called for each [[Format]] instance.
+     * @param format a Format object.
+     */
+    visitFormat?: (format: Format) => Promise<void>;
+    /**
+     * Called for each [[Format]] instance.
+     * @param format a Format object.
+     */
+    visitFormatSync?: (format: Format) => void;
+    /**
+     * Called for each [[Unit]] instance.
+     * @param unit a Unit object.
+     */
+    visitUnit?: (unit: Unit) => Promise<void>;
+    /**
+     * Called for each [[Unit]] instance.
+     * @param unit a Unit object.
+     */
+    visitUnitSync?: (unit: Unit) => void;
+    /**
+     * Called for each [[InvertedUnit]] instance.
+     * @param invertedUnit an InvertedUnit object.
+     */
+    visitInvertedUnit?: (invertedUnit: InvertedUnit) => Promise<void>;
+    /**
+     * Called for each [[InvertedUnit]] instance.
+     * @param invertedUnit an InvertedUnit object.
+     */
+    visitInvertedUnitSync?: (invertedUnit: InvertedUnit) => void;
+    /**
+     * Called for each [[UnitSystem]] instance.
+     * @param unitSystem a UnitSystem object.
+     */
+    visitUnitSystem?: (unitSystem: UnitSystem) => Promise<void>;
+    /**
+     * Called for each [[UnitSystem]] instance.
+     * @param unitSystem a UnitSystem object.
+     */
+    visitUnitSystemSync?: (unitSystem: UnitSystem) => void;
+    /**
+     * Called for each [[Phenomenon]] instance.
+     * @param phenomena a Phenomenon object.
+     */
+    visitPhenomenon?: (phenomena: Phenomenon) => Promise<void>;
+    /**
+     * Called for each [[Phenomenon]] instance.
+     * @param phenomena a Phenomenon object.
+     */
+    visitPhenomenonSync?: (phenomena: Phenomenon) => void;
+    /**
+     * Called for each [[Constant]] instance.
+     * @param constant a Constant object.
+     */
+    visitConstant?: (constant: Constant) => Promise<void>;
+    /**
+     * Called for each [[Constant]] instance.
+     * @param constant a Constant object.
+     */
+    visitConstantSync?: (constant: Constant) => void;
+}
+/**
+ * A helper class to call methods on the provided [[ISchemaPartVisitor]].
+ * @beta
+ */
+export declare class SchemaPartVisitorDelegate {
+    private _visitor;
+    constructor(visitor: ISchemaPartVisitor);
+    /**
+     * Calls (async) visitEmptySchema or visitFullSchema on the configured [[ISchemaPartVisitor]].
+     * @param schema The schema to pass to the visitor.
+     * @param fullSchema Indicates if the schema is partially or fully-loaded.
+     */
+    visitSchema(schema: Schema, fullSchema?: boolean): Promise<void>;
+    /**
+     * Calls (synchronously) visitEmptySchema or visitFullSchema on the configured [[ISchemaPartVisitor]].
+     * @param schema The schema to pass to the visitor.
+     * @param fullSchema Indicates if the schema is partially or fully-loaded.
+     */
+    visitSchemaSync(schema: Schema, fullSchema?: boolean): void;
+    /**
+     * Calls (async) the appropriate visit methods on the configured [[ISchemaPartVisitor]]
+     * based on the type of the part specified.
+     * @param schemaPart The schema part to pass to the visitor methods.
+     */
+    visitSchemaPart(schemaPart: AnyECType): Promise<void>;
+    /**
+     * Calls (synchronously) the appropriate visit methods on the configured [[ISchemaPartVisitor]]
+     * based on the type of the part specified.
+     * @param schemaPart The schema part to pass to the visitor methods.
+     */
+    visitSchemaPartSync(schemaPart: AnyECType): void;
+    private visitSchemaItem;
+    private visitSchemaItemSync;
+}
+//# sourceMappingURL=SchemaPartVisitorDelegate.d.ts.map

package/lib/esm/SchemaPartVisitorDelegate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaPartVisitorDelegate.d.ts","sourceRoot":"","sources":["../../src/SchemaPartVisitorDelegate.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAW,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAY,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACzF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACS,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhD;;;OAGG;IACS,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAE/C;;;OAGG;IACS,eAAe,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAEvD;;;OAGG;IACS,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;IAE7C;;;OAGG;IACS,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,WAAW,KAAK,IAAI,CAAC;IAEpD;;;OAGG;IACS,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,IAAI,CAAC;IAE1D;;;OAGG;IACS,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,IAAI,CAAC;IAE1D;;;OAGG;IACS,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAExC;;;OAGG;IACS,sBAAsB,CAAC,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7F;;;OAGG;IACH,0BAA0B,CAAC,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAE5E;;;OAGG;IACS,2BAA2B,CAAC,EAAE,CAAC,sBAAsB,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5G;;;OAGG;IACH,+BAA+B,CAAC,EAAE,CAAC,sBAAsB,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAE3F;;;OAGG;IACS,yBAAyB,CAAC,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtG;;;OAGG;IACH,6BAA6B,CAAC,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAErF;;;OAGG;IACS,6BAA6B,CAAC,EAAE,CAAC,wBAAwB,EAAE,6BAA6B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvH;;;OAGG;IACH,iCAAiC,CAAC,EAAE,CAAC,wBAAwB,EAAE,6BAA6B,KAAK,IAAI,CAAC;IAEtG;;;OAGG;IACS,gBAAgB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,IAAI,CAAC;IAE1D;;;OAGG;IACS,mBAAmB,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;;OAGG;IACH,uBAAuB,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,IAAI,CAAC;IAExD;;;OAGG;IACS,qBAAqB,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;;OAGG;IACH,yBAAyB,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAEjE;;;OAGG;IACS,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5D;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAE3C;;;OAGG;IACS,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAErC;;;OAGG;IACS,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAC;IAE7D;;;OAGG;IACS,eAAe,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAEvD;;;OAGG;IACS,eAAe,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvE;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,KAAK,IAAI,CAAC;IAEtD;;;OAGG;IACS,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;CAClD;AAMD;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,QAAQ,CAAqB;gBAEzB,OAAO,EAAE,kBAAkB;IAIvC;;;;OAIG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnF;;;;OAIG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,OAAc,GAAG,IAAI;IAQxE;;;;OAIG;IACU,eAAe,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAclE;;;;OAIG;IACI,mBAAmB,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI;YAazC,eAAe;IAmE7B,OAAO,CAAC,mBAAmB;CAkE5B"}