@itwin/ecschema-metadata 5.0.0-dev.98 → 5.1.0-dev.0

package/lib/esm/SchemaFormatsProvider.js

@@ -0,0 +1,142 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { SchemaContext } from "./Context";
+import { SchemaItemKey, SchemaKey } from "./SchemaKey";
+import { SchemaItem } from "./Metadata/SchemaItem";
+import { Format } from "./Metadata/Format";
+import { BeEvent } from "@itwin/core-bentley";
+import { KindOfQuantity } from "./Metadata/KindOfQuantity";
+import { getFormatProps } from "./Metadata/OverrideFormat";
+/**
+ * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
+ * @beta
+ */
+export class SchemaFormatsProvider {
+    _context;
+    _unitSystem;
+    _formatsRetrieved = new Set();
+    onFormatsChanged = new BeEvent();
+    /**
+     *
+     * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext
+     * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be
+     * created and the locater will be added.
+     * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.
+     */
+    constructor(contextOrLocater, unitSystem) {
+        if (contextOrLocater instanceof SchemaContext) {
+            this._context = contextOrLocater;
+        }
+        else {
+            this._context = new SchemaContext();
+            this._context.addLocater(contextOrLocater);
+        }
+        this._unitSystem = unitSystem;
+    }
+    get context() { return this._context; }
+    get unitSystem() { return this._unitSystem; }
+    set unitSystem(unitSystem) {
+        this._unitSystem = unitSystem;
+        this.clear();
+    }
+    clear() {
+        const formatsChanged = Array.from(this._formatsRetrieved);
+        this._formatsRetrieved.clear();
+        this.onFormatsChanged.raiseEvent({ formatsChanged });
+    }
+    async getKindOfQuantityFormatFromSchema(itemKey) {
+        const kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);
+        if (!kindOfQuantity) {
+            return undefined;
+        }
+        // Find the first presentation format that matches the provided unit system.
+        const unitSystemGroupNames = getUnitSystemGroupNames(this._unitSystem);
+        const presentationFormats = kindOfQuantity.presentationFormats;
+        for (const system of unitSystemGroupNames) {
+            for (const lazyFormat of presentationFormats) {
+                const format = await lazyFormat;
+                const unit = await (format.units && format.units[0][0]);
+                if (!unit) {
+                    continue;
+                }
+                const currentUnitSystem = unit.unitSystem;
+                if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system) {
+                    this._formatsRetrieved.add(itemKey.fullName);
+                    return getFormatProps(format);
+                }
+            }
+        }
+        // If no matching presentation format was found, use persistence unit format if it matches unit system.
+        const persistenceUnit = await kindOfQuantity.persistenceUnit;
+        const persistenceUnitSystem = await persistenceUnit?.unitSystem;
+        if (persistenceUnitSystem && unitSystemGroupNames.includes(persistenceUnitSystem.name.toUpperCase())) {
+            this._formatsRetrieved.add(itemKey.fullName);
+            return getPersistenceUnitFormatProps(persistenceUnit);
+        }
+        const defaultFormat = kindOfQuantity.defaultPresentationFormat;
+        if (!defaultFormat) {
+            return undefined;
+        }
+        this._formatsRetrieved.add(itemKey.fullName);
+        return getFormatProps(await defaultFormat);
+    }
+    /**
+     * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.
+     * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.
+     * Else, the default presentation format will be retrieved.
+     * @param name The full name of the Format or KindOfQuantity.
+     * @returns
+     */
+    async getFormat(name) {
+        const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);
+        const schemaKey = new SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            return undefined;
+        }
+        const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);
+        if (schema.name === "Formats") {
+            const format = await this._context.getSchemaItem(itemKey, Format);
+            if (!format) {
+                return undefined;
+            }
+            return format.toJSON(true);
+        }
+        return this.getKindOfQuantityFormatFromSchema(itemKey);
+    }
+}
+function getUnitSystemGroupNames(unitSystem) {
+    switch (unitSystem) {
+        case "imperial":
+            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "metric":
+            return ["SI", "METRIC", "INTERNATIONAL", "FINANCE"];
+        case "usCustomary":
+            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "usSurvey":
+            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+    }
+    return [];
+}
+function getPersistenceUnitFormatProps(persistenceUnit) {
+    // Same as Format "DefaultRealU" in Formats ecschema
+    return {
+        formatTraits: ["keepSingleZero", "keepDecimalPoint", "showUnitLabel"],
+        precision: 6,
+        type: "Decimal",
+        composite: {
+            units: [
+                {
+                    name: persistenceUnit.fullName,
+                    label: persistenceUnit.label,
+                },
+            ],
+        },
+    };
+}
+//# sourceMappingURL=SchemaFormatsProvider.js.map

package/lib/esm/SchemaFormatsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaFormatsProvider.js","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAK3D;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACxB,QAAQ,CAAgB;IACxB,WAAW,CAAgB;IAC3B,iBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAC5C,gBAAgB,GAAG,IAAI,OAAO,EAAsC,CAAC;IAC5E;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAE,UAAyB;QACrE,IAAI,gBAAgB,YAAY,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpD,IAAW,UAAU,CAAC,UAAyB;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,OAAsB;QACpE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAElF,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,4EAA4E;QAC5E,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvE,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;QAC/D,KAAK,MAAM,MAAM,IAAI,oBAAoB,EAAE,CAAC;YAC1C,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,SAAS;gBACX,CAAC;gBACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,CAAC;gBAC1C,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;oBACzE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC7C,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAED,uGAAuG;QACvG,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC;QAC7D,MAAM,qBAAqB,GAAG,MAAM,eAAe,EAAE,UAAU,CAAC;QAChE,IAAI,qBAAqB,IAAI,oBAAoB,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACrG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7C,OAAO,6BAA6B,CAAC,eAAgB,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,cAAc,CAAC,MAAM,aAAa,CAAC,CAAC;IAC7C,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAClE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,SAAS,uBAAuB,CAAC,UAA0B;IACzD,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAC9D,KAAK,QAAQ;YACX,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtD,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAClD,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC","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 { ISchemaLocater, SchemaContext } from \"./Context\";\r\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\r\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\r\nimport { Format } from \"./Metadata/Format\";\r\nimport { SchemaItemFormatProps } from \"./Deserialization/JsonProps\";\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\r\nimport { getFormatProps } from \"./Metadata/OverrideFormat\";\r\nimport { FormatProps, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport { Unit } from \"./Metadata/Unit\";\r\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\r\n\r\n/**\r\n * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.\r\n * @beta\r\n */\r\nexport class SchemaFormatsProvider implements FormatsProvider {\r\n  private _context: SchemaContext;\r\n  private _unitSystem: UnitSystemKey;\r\n  private _formatsRetrieved: Set<string> = new Set();\r\n  public onFormatsChanged = new BeEvent<(args: FormatsChangedArgs) => void>();\r\n  /**\r\n   *\r\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\r\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\r\n   * created and the locater will be added.\r\n   * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.\r\n   */\r\n  constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey) {\r\n    if (contextOrLocater instanceof SchemaContext) {\r\n      this._context = contextOrLocater;\r\n    } else {\r\n      this._context = new SchemaContext();\r\n      this._context.addLocater(contextOrLocater);\r\n    }\r\n    this._unitSystem = unitSystem;\r\n  }\r\n\r\n  public get context() { return this._context; }\r\n  public get unitSystem() { return this._unitSystem; }\r\n\r\n  public set unitSystem(unitSystem: UnitSystemKey) {\r\n    this._unitSystem = unitSystem;\r\n    this.clear();\r\n  }\r\n\r\n  private clear(): void {\r\n    const formatsChanged = Array.from(this._formatsRetrieved);\r\n    this._formatsRetrieved.clear();\r\n    this.onFormatsChanged.raiseEvent({ formatsChanged });\r\n  }\r\n\r\n  private async getKindOfQuantityFormatFromSchema(itemKey: SchemaItemKey): Promise<SchemaItemFormatProps | undefined> {\r\n    const kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);\r\n\r\n    if (!kindOfQuantity) {\r\n      return undefined;\r\n    }\r\n\r\n    // Find the first presentation format that matches the provided unit system.\r\n    const unitSystemGroupNames = getUnitSystemGroupNames(this._unitSystem);\r\n    const presentationFormats = kindOfQuantity.presentationFormats;\r\n    for (const system of unitSystemGroupNames) {\r\n      for (const lazyFormat of presentationFormats) {\r\n        const format = await lazyFormat;\r\n        const unit = await (format.units && format.units[0][0]);\r\n        if (!unit) {\r\n          continue;\r\n        }\r\n        const currentUnitSystem = unit.unitSystem;\r\n        if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system) {\r\n          this._formatsRetrieved.add(itemKey.fullName);\r\n          return getFormatProps(format);\r\n        }\r\n      }\r\n    }\r\n\r\n    // If no matching presentation format was found, use persistence unit format if it matches unit system.\r\n    const persistenceUnit = await kindOfQuantity.persistenceUnit;\r\n    const persistenceUnitSystem = await persistenceUnit?.unitSystem;\r\n    if (persistenceUnitSystem && unitSystemGroupNames.includes(persistenceUnitSystem.name.toUpperCase())) {\r\n      this._formatsRetrieved.add(itemKey.fullName);\r\n      return getPersistenceUnitFormatProps(persistenceUnit!);\r\n    }\r\n\r\n    const defaultFormat = kindOfQuantity.defaultPresentationFormat;\r\n    if (!defaultFormat) {\r\n      return undefined;\r\n    }\r\n    this._formatsRetrieved.add(itemKey.fullName);\r\n    return getFormatProps(await defaultFormat);\r\n  }\r\n\r\n\r\n  /**\r\n   * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.\r\n   * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.\r\n   * Else, the default presentation format will be retrieved.\r\n   * @param name The full name of the Format or KindOfQuantity.\r\n   * @returns\r\n   */\r\n  public async getFormat(name: string): Promise<SchemaItemFormatProps | undefined> {\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n    if (!schema) {\r\n      return undefined;\r\n    }\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n\r\n    if (schema.name === \"Formats\") {\r\n      const format = await this._context.getSchemaItem(itemKey, Format);\r\n      if (!format) {\r\n        return undefined;\r\n      }\r\n      return format.toJSON(true);\r\n    }\r\n    return this.getKindOfQuantityFormatFromSchema(itemKey);\r\n  }\r\n}\r\n\r\nfunction getUnitSystemGroupNames(unitSystem?: UnitSystemKey) {\r\n  switch (unitSystem) {\r\n    case \"imperial\":\r\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\r\n    case \"metric\":\r\n      return [\"SI\", \"METRIC\", \"INTERNATIONAL\", \"FINANCE\"];\r\n    case \"usCustomary\":\r\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\r\n    case \"usSurvey\":\r\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\r\n  }\r\n  return [];\r\n}\r\n\r\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\r\n  // Same as Format \"DefaultRealU\" in Formats ecschema\r\n  return {\r\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\r\n    precision: 6,\r\n    type: \"Decimal\",\r\n    composite: {\r\n      units: [\r\n        {\r\n          name: persistenceUnit.fullName,\r\n          label: persistenceUnit.label,\r\n        },\r\n      ],\r\n    },\r\n  };\r\n}"]}

package/lib/esm/SchemaJsonLocater.d.ts

@@ -7,13 +7,13 @@ import { SchemaKey } from "./SchemaKey";
 /**
  * Gets the full schema Json for the input schema name or undefined if not found
  * @throws [Error] if the schema is found but json cannot be returned
- * @beta
+ * @public @preview
  */
 export type SchemaPropsGetter = (schemaName: string) => SchemaProps | undefined;
 /**
- * A  ISchemaLocater implementation for locating and retrieving EC Schema objects using a function
+ * An ISchemaLocater implementation for locating and retrieving EC Schema objects using a function
  * that returns the Schema Json for a given schema name
- * @beta
+ * @public @preview
  */
 export declare class SchemaJsonLocater implements ISchemaLocater {
     private _getSchema;
@@ -22,7 +22,7 @@ export declare class SchemaJsonLocater implements ISchemaLocater {
      * @param schemaKey The [SchemaKey] that identifies the schema.
      * @param matchType The [SchemaMatchType] to used for comparing schema versions.
      * @param context The [SchemaContext] used to facilitate schema location.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     * @throws [ECSchemaError]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */
     getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
     /**
@@ -33,7 +33,7 @@ export declare class SchemaJsonLocater implements ISchemaLocater {
     getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
     /** Get a schema by [SchemaKey] synchronously.
      * @param schemaKey The [SchemaKey] that identifies the schema.
-     * * @param matchType The [SchemaMatchType] to used for comparing schema versions.
+     * @param matchType The [SchemaMatchType] to used for comparing schema versions.
      * @param context The [SchemaContext] used to facilitate schema location.
      * @throws [Error]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */

package/lib/esm/SchemaJsonLocater.js

@@ -5,9 +5,9 @@
 import { SchemaContext } from "./Context";
 import { Schema } from "./Metadata/Schema";
 /**
- * A  ISchemaLocater implementation for locating and retrieving EC Schema objects using a function
+ * An ISchemaLocater implementation for locating and retrieving EC Schema objects using a function
  * that returns the Schema Json for a given schema name
- * @beta
+ * @public @preview
  */
 export class SchemaJsonLocater {
     _getSchema;
@@ -18,7 +18,7 @@ export class SchemaJsonLocater {
      * @param schemaKey The [SchemaKey] that identifies the schema.
      * @param matchType The [SchemaMatchType] to used for comparing schema versions.
      * @param context The [SchemaContext] used to facilitate schema location.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     * @throws [ECSchemaError]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */
     async getSchema(schemaKey, matchType, context) {
         await this.getSchemaInfo(schemaKey, matchType, context);
@@ -40,7 +40,7 @@ export class SchemaJsonLocater {
     }
     /** Get a schema by [SchemaKey] synchronously.
      * @param schemaKey The [SchemaKey] that identifies the schema.
-     * * @param matchType The [SchemaMatchType] to used for comparing schema versions.
+     * @param matchType The [SchemaMatchType] to used for comparing schema versions.
      * @param context The [SchemaContext] used to facilitate schema location.
      * @throws [Error]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */

package/lib/esm/SchemaJsonLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaJsonLocater.js","sourceRoot":"","sources":["../../src/SchemaJsonLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAkB,aAAa,EAAE,MAAM,WAAW,CAAC;AAI1D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAU3C;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IACD;IAA3B,YAA2B,UAA6B;QAA7B,eAAU,GAAV,UAAU,CAAmB;IAAI,CAAC;IAE7D;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW;YACd,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC3E,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC;YAChF,OAAO,UAAU,CAAC;QAEpB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,SAAoB,EAAE,UAA2B,EAAE,OAAsB;QAC5F,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW;YACd,OAAO,SAAS,CAAC;QAEnB,OAAO,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,IAAI,IAAI,aAAa,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { ISchemaLocater, SchemaContext } from \"./Context\";\nimport { SchemaProps } from \"./Deserialization/JsonProps\";\nimport { SchemaMatchType } from \"./ECObjects\";\nimport { SchemaInfo } from \"./Interfaces\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { SchemaKey } from \"./SchemaKey\";\n\n/**\n * Gets the full schema Json for the input schema name or undefined if not found\n * @throws [Error] if the schema is found but json cannot be returned\n * @beta\n */\nexport type SchemaPropsGetter = (schemaName: string) => SchemaProps | undefined;\n\n/**\n * A  ISchemaLocater implementation for locating and retrieving EC Schema objects using a function\n * that returns the Schema Json for a given schema name\n * @beta\n */\nexport class SchemaJsonLocater implements ISchemaLocater {\n  public constructor(private _getSchema: SchemaPropsGetter) { }\n\n  /** Get a schema by [SchemaKey]\n   * @param schemaKey The [SchemaKey] that identifies the schema.\n   * @param matchType The [SchemaMatchType] to used for comparing schema versions.\n   * @param context The [SchemaContext] used to facilitate schema location.\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.\n   */\n  public async getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n    return context.getCachedSchema(schemaKey, matchType);\n  }\n\n  /**\n   * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\n   * @param matchType The match type to use when locating the schema\n   */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const schemaProps = this._getSchema(schemaKey.name);\n    if (!schemaProps)\n      return undefined;\n\n    const schemaInfo = await Schema.startLoadingFromJson(schemaProps, context);\n    if (schemaInfo !== undefined && schemaInfo.schemaKey.matches(schemaKey, matchType))\n      return schemaInfo;\n\n    return undefined;\n  }\n\n  /** Get a schema by [SchemaKey] synchronously.\n   * @param schemaKey The [SchemaKey] that identifies the schema.\n   * * @param matchType The [SchemaMatchType] to used for comparing schema versions.\n   * @param context The [SchemaContext] used to facilitate schema location.\n   * @throws [Error]($ecschema-metadata) if the schema exists, but cannot be loaded.\n   */\n  public getSchemaSync(schemaKey: SchemaKey, _matchType: SchemaMatchType, context: SchemaContext): Schema | undefined {\n    const schemaProps = this._getSchema(schemaKey.name);\n    if (!schemaProps)\n      return undefined;\n\n    return Schema.fromJsonSync(schemaProps, context || new SchemaContext());\n  }\n}\n"]}
+{"version":3,"file":"SchemaJsonLocater.js","sourceRoot":"","sources":["../../src/SchemaJsonLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAkB,aAAa,EAAE,MAAM,WAAW,CAAC;AAI1D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAU3C;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IACD;IAA3B,YAA2B,UAA6B;QAA7B,eAAU,GAAV,UAAU,CAAmB;IAAI,CAAC;IAE7D;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW;YACd,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC3E,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC;YAChF,OAAO,UAAU,CAAC;QAEpB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,SAAoB,EAAE,UAA2B,EAAE,OAAsB;QAC5F,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW;YACd,OAAO,SAAS,CAAC;QAEnB,OAAO,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,IAAI,IAAI,aAAa,EAAE,CAAC,CAAC;IAC1E,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 { ISchemaLocater, SchemaContext } from \"./Context\";\r\nimport { SchemaProps } from \"./Deserialization/JsonProps\";\r\nimport { SchemaMatchType } from \"./ECObjects\";\r\nimport { SchemaInfo } from \"./Interfaces\";\r\nimport { Schema } from \"./Metadata/Schema\";\r\nimport { SchemaKey } from \"./SchemaKey\";\r\n\r\n/**\r\n * Gets the full schema Json for the input schema name or undefined if not found\r\n * @throws [Error] if the schema is found but json cannot be returned\r\n * @public @preview\r\n */\r\nexport type SchemaPropsGetter = (schemaName: string) => SchemaProps | undefined;\r\n\r\n/**\r\n * An ISchemaLocater implementation for locating and retrieving EC Schema objects using a function\r\n * that returns the Schema Json for a given schema name\r\n * @public @preview\r\n */\r\nexport class SchemaJsonLocater implements ISchemaLocater {\r\n  public constructor(private _getSchema: SchemaPropsGetter) { }\r\n\r\n  /** Get a schema by [SchemaKey]\r\n   * @param schemaKey The [SchemaKey] that identifies the schema.\r\n   * @param matchType The [SchemaMatchType] to used for comparing schema versions.\r\n   * @param context The [SchemaContext] used to facilitate schema location.\r\n   * @throws [ECSchemaError]($ecschema-metadata) if the schema exists, but cannot be loaded.\r\n   */\r\n  public async getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\r\n    await this.getSchemaInfo(schemaKey, matchType, context);\r\n    return context.getCachedSchema(schemaKey, matchType);\r\n  }\r\n\r\n  /**\r\n   * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\r\n    const schemaProps = this._getSchema(schemaKey.name);\r\n    if (!schemaProps)\r\n      return undefined;\r\n\r\n    const schemaInfo = await Schema.startLoadingFromJson(schemaProps, context);\r\n    if (schemaInfo !== undefined && schemaInfo.schemaKey.matches(schemaKey, matchType))\r\n      return schemaInfo;\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Get a schema by [SchemaKey] synchronously.\r\n   * @param schemaKey The [SchemaKey] that identifies the schema.\r\n   * @param matchType The [SchemaMatchType] to used for comparing schema versions.\r\n   * @param context The [SchemaContext] used to facilitate schema location.\r\n   * @throws [Error]($ecschema-metadata) if the schema exists, but cannot be loaded.\r\n   */\r\n  public getSchemaSync(schemaKey: SchemaKey, _matchType: SchemaMatchType, context: SchemaContext): Schema | undefined {\r\n    const schemaProps = this._getSchema(schemaKey.name);\r\n    if (!schemaProps)\r\n      return undefined;\r\n\r\n    return Schema.fromJsonSync(schemaProps, context || new SchemaContext());\r\n  }\r\n}\r\n"]}

package/lib/esm/SchemaKey.d.ts

@@ -4,7 +4,7 @@
 import { SchemaKeyProps } from "./Deserialization/JsonProps";
 import { SchemaMatchType } from "./ECObjects";
 /**
- * @beta
+ * @public @preview
  */
 export declare class ECVersion {
     private _read;
@@ -17,7 +17,7 @@ export declare class ECVersion {
      */
     static readonly NO_VERSION: ECVersion;
     /**
-     * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
+     * The constructor will throw an ECSchemaError 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.
@@ -47,11 +47,11 @@ export declare class ECVersion {
 }
 /**
  * The SchemaKey contains a Schemas name and version.
- * @beta
+ * @public @preview
  */
 export declare class SchemaKey {
     private _name;
-    protected _version: ECVersion;
+    private _version;
     constructor(name: string, version: ECVersion);
     constructor(name: string, readVersion?: number, writeVersion?: number, minorVersion?: number);
     get version(): ECVersion;
@@ -96,11 +96,11 @@ export declare class SchemaKey {
 }
 /**
  * The SchemaItemKey contains a SchemaItem's name and SchemaKey.
- * @beta
+ * @public @preview
  */
 export declare class SchemaItemKey {
     private _name;
-    protected _schemaKey: SchemaKey;
+    private _schemaKey;
     constructor(name: string, schema: SchemaKey);
     get schemaKey(): SchemaKey;
     get name(): string;

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaKey.d.ts","sourceRoot":"","sources":["../../src/SchemaKey.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI9C;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,MAAM,CAAa;IAE3B;;;;OAIG;IACH,gBAAuB,UAAU,YAA0B;IAE3D;;;;;;OAMG;gBACS,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAYzD,IAAW,IAAI,WAAyB;IACxC,IAAW,KAAK,WAA0B;IAC1C,IAAW,KAAK,WAA0B;IAE1C;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc,GAAG,MAAM;IAWlD;;;OAGG;WACW,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS;IAc1D;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;CASvC;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC;gBAIlB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS;gBAChC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAS5F,IAAW,OAAO,cAA4B;IAC9C,IAAW,IAAI,WAA8B;IAC7C,IAAW,WAAW,WAAgC;IACtD,IAAW,YAAY,WAAiC;IACxD,IAAW,YAAY,WAAiC;IAExD;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc;WAE3B,WAAW,CAAC,QAAQ,EAAE,MAAM;IAY1C;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO;IAUlE;;;;OAIG;IACI,gBAAgB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;IAI/C;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,GAAE,eAAuC,GAAG,OAAO;IA2B3F;;;;OAIG;WACW,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIxD;;OAEG;IACI,MAAM,IAAI,cAAc;CAQhC;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC;gBAEpB,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;IAK3C,IAAW,SAAS,cAA8B;IAClD,IAAW,IAAI,WAA8B;IAE7C,IAAW,UAAU,WAAkC;IAEvD,2DAA2D;IAC3D,IAAW,QAAQ,WAAgD;IAEnE;;;OAGG;IAEI,OAAO,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAUpC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAK9C"}
+{"version":3,"file":"SchemaKey.d.ts","sourceRoot":"","sources":["../../src/SchemaKey.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI9C;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,MAAM,CAAa;IAE3B;;;;OAIG;IACH,gBAAuB,UAAU,YAA0B;IAE3D;;;;;;OAMG;gBACS,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAYzD,IAAW,IAAI,WAAyB;IACxC,IAAW,KAAK,WAA0B;IAC1C,IAAW,KAAK,WAA0B;IAE1C;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc,GAAG,MAAM;IAWlD;;;OAGG;WACW,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS;IAc1D;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;CASvC;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAY;gBAIhB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS;gBAChC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAS5F,IAAW,OAAO,cAA4B;IAC9C,IAAW,IAAI,WAA8B;IAC7C,IAAW,WAAW,WAAgC;IACtD,IAAW,YAAY,WAAiC;IACxD,IAAW,YAAY,WAAiC;IAExD;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc;WAE3B,WAAW,CAAC,QAAQ,EAAE,MAAM;IAY1C;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO;IAUlE;;;;OAIG;IACI,gBAAgB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;IAI/C;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,GAAE,eAAuC,GAAG,OAAO;IA2B3F;;;;OAIG;WACW,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIxD;;OAEG;IACI,MAAM,IAAI,cAAc;CAQhC;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,UAAU,CAAY;gBAElB,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;IAK3C,IAAW,SAAS,cAA8B;IAClD,IAAW,IAAI,WAA8B;IAE7C,IAAW,UAAU,WAAkC;IAEvD,2DAA2D;IAC3D,IAAW,QAAQ,WAAgD;IAEnE;;;OAGG;IAEI,OAAO,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAUpC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAK9C"}

package/lib/esm/SchemaKey.js

@@ -6,10 +6,10 @@
  * @module Metadata
  */
 import { SchemaMatchType } from "./ECObjects";
-import { ECObjectsError, ECObjectsStatus } from "./Exception";
+import { ECSchemaError, ECSchemaStatus } from "./Exception";
 import { ECName } from "./ECName";
 /**
- * @beta
+ * @public @preview
  */
 export class ECVersion {
     _read = 0;
@@ -22,7 +22,7 @@ export class ECVersion {
      */
     static NO_VERSION = new ECVersion(0, 0, 0);
     /**
-     * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
+     * The constructor will throw an ECSchemaError 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.
@@ -36,7 +36,7 @@ export class ECVersion {
         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);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECVersion);
     }
     get read() { return this._read; }
     get write() { return this._write; }
@@ -61,11 +61,11 @@ export class ECVersion {
     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}`);
+            throw new ECSchemaError(ECSchemaStatus.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}`);
+            throw new ECSchemaError(ECSchemaStatus.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}`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
         return new ECVersion(+read, +write, +minor);
     }
     /**
@@ -83,7 +83,7 @@ export class ECVersion {
 }
 /**
  * The SchemaKey contains a Schemas name and version.
- * @beta
+ * @public @preview
  */
 export class SchemaKey {
     _name;
@@ -109,7 +109,7 @@ export class SchemaKey {
     static parseString(fullName) {
         const keyPieces = fullName.split(".");
         if (keyPieces.length !== 4)
-            throw new ECObjectsError(ECObjectsStatus.InvalidECName);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECName);
         const schemaName = keyPieces[0];
         const readVer = Number(keyPieces[1]);
         const writeVer = Number(keyPieces[2]);
@@ -185,7 +185,7 @@ export class SchemaKey {
 }
 /**
  * The SchemaItemKey contains a SchemaItem's name and SchemaKey.
- * @beta
+ * @public @preview
  */
 export class SchemaItemKey {
     _name;

package/lib/esm/SchemaKey.js.map

@@ -1 +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;IACZ,KAAK,GAAW,CAAC,CAAC;IAClB,MAAM,GAAW,CAAC,CAAC;IACnB,MAAM,GAAW,CAAC,CAAC;IAE3B;;;;OAIG;IACI,MAAM,CAAU,UAAU,GAAG,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,YAAY,IAAa,EAAE,KAAc,EAAE,KAAc;QACvD,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;;AAGH;;;GAGG;AACH,MAAM,OAAO,SAAS;IACZ,KAAK,CAAS;IACZ,QAAQ,CAAY;IAM9B,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,GAAc,EAAE,YAA6B,eAAe,CAAC,KAAK;QAC/E,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,eAAe,CAAC,SAAS,CAAC;YAC/B,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;IAChB,KAAK,CAAS;IACZ,UAAU,CAAY;IAEhC,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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { SchemaKeyProps } from \"./Deserialization/JsonProps\";\nimport { SchemaMatchType } from \"./ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\nimport { ECName } from \"./ECName\";\n\n/**\n * @beta\n */\nexport class ECVersion {\n  private _read: number = 0;\n  private _write: number = 0;\n  private _minor: number = 0;\n\n  /**\n   * Using a version with all zero is invalid\n   * for a schema, but it can be used to indicate\n   * \"no version has been specified\" when locating things\n   */\n  public static readonly NO_VERSION = new ECVersion(0, 0, 0);\n\n  /**\n   * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.\n   * @param read Can support up to 999.\n   * @param write Can support up to 999.\n   * @param minor Can support up to 9999999.\n   *\n   */\n  constructor(read?: number, write?: number, minor?: number) {\n    if (undefined !== read)\n      this._read = read;\n    if (undefined !== write)\n      this._write = write;\n    if (undefined !== minor)\n      this._minor = minor;\n\n    if (this._read > 999 || this._read < 0 || this._write > 999 || this._write < 0 || this._minor > 9999999 || this._minor < 0)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion);\n  }\n\n  public get read() { return this._read; }\n  public get write() { return this._write; }\n  public get minor() { return this._minor; }\n\n  /**\n   * Creates a string, in the format 'RR.ww.mm', representing this ECVersion.\n   * @note The default is to pad with zeroes.\n   * @param padZeroes If true, the returned string will strictly follow `RR.ww.mm` and add leading zeroes if necessary.\n   */\n  public toString(padZeroes: boolean = true): string {\n    if (!padZeroes)\n      return `${this.read}.${this.write}.${this.minor}`;\n\n    const padWithZeroes = (num: number) => {\n      return (num < 10 ? \"0\" : \"\") + num;\n    };\n\n    return `${padWithZeroes(this.read)}.${padWithZeroes(this.write)}.${padWithZeroes(this.minor)}`;\n  }\n\n  /**\n   * Given a valid version string the\n   * @param versionString A valid version string of the format, 'RR.ww.mm'.\n   */\n  public static fromString(versionString: string): ECVersion {\n    const [read, write, minor] = versionString.split(\".\");\n    if (!read)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\n\n    if (!write)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The write version is missing from version string, ${versionString}`);\n\n    if (!minor)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\n\n    return new ECVersion(+read, +write, +minor);\n  }\n\n  /**\n   * Compares two schema versions.\n   * @param rhs The schema to compare.\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.\n   */\n  public compare(rhv: ECVersion): number {\n    if (this.read !== rhv.read)\n      return this.read - rhv.read;\n\n    if (this.write !== rhv.write)\n      return this.write - rhv.write;\n\n    return this.minor - rhv.minor;\n  }\n}\n\n/**\n * The SchemaKey contains a Schemas name and version.\n * @beta\n */\nexport class SchemaKey {\n  private _name: ECName;\n  protected _version: ECVersion;\n  // public checksum: number;\n  // TODO: need to add a checksum\n\n  constructor(name: string, version: ECVersion);\n  constructor(name: string, readVersion?: number, writeVersion?: number, minorVersion?: number);\n  constructor(name: string, readOrVersion?: number | ECVersion, writeVersion?: number, minorVersion?: number) {\n    this._name = new ECName(name);\n    if (readOrVersion !== undefined && typeof (readOrVersion) !== \"number\")\n      this._version = readOrVersion;\n    else\n      this._version = new ECVersion(readOrVersion, writeVersion, minorVersion);\n  }\n\n  public get version() { return this._version; }\n  public get name() { return this._name.name; }\n  public get readVersion() { return this.version.read; }\n  public get writeVersion() { return this.version.write; }\n  public get minorVersion() { return this.version.minor; }\n\n  /**\n   * Creates a string, in the format 'RR.ww.mm', representing this SchemaKey.\n   * @note The default is to pad the full name with zeroes.\n   * @param padZeroes If true, the returned string will strictly follow `Name.RR.ww.mm` and add leading zeroes if necessary.\n   */\n  public toString(padZeroes: boolean = true) { return `${this.name}.${this.version.toString(padZeroes)}`; }\n\n  public static parseString(fullName: string) {\n    const keyPieces = fullName.split(\".\");\n    if (keyPieces.length !== 4)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName);\n\n    const schemaName = keyPieces[0];\n    const readVer = Number(keyPieces[1]);\n    const writeVer = Number(keyPieces[2]);\n    const minorVer = Number(keyPieces[3]);\n    return new SchemaKey(schemaName, new ECVersion(readVer, writeVer, minorVer));\n  }\n\n  /**\n   * Compares two schema names, case-insensitive.\n   * @return True if they match; otherwise, false.\n   */\n  public compareByName(rhs: SchemaKey | string | undefined): boolean {\n    if (undefined === rhs)\n      return false;\n\n    if (typeof (rhs) === \"string\")\n      return rhs.toLowerCase() === this.name.toLowerCase();\n\n    return rhs.name.toLowerCase() === this.name.toLowerCase();\n  }\n\n  /**\n   * Compares two schema versions.\n   * @param rhs The schema to compare.\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.\n   */\n  public compareByVersion(rhs: SchemaKey): number {\n    return this.version.compare(rhs.version);\n  }\n\n  /**\n   *\n   * @param rhs The SchemaKey to compare with\n   * @param matchType The match type to use for comparison.\n   */\n  public matches(rhs: SchemaKey, matchType: SchemaMatchType = SchemaMatchType.Exact): boolean {\n    switch (matchType) {\n      case SchemaMatchType.Identical:\n      case SchemaMatchType.Exact:\n        return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&\n          this.writeVersion === rhs.writeVersion && this.minorVersion === rhs.minorVersion;\n      case SchemaMatchType.LatestReadCompatible:\n        if (!this.compareByName(rhs.name))\n          return false;\n\n        if (rhs.readVersion !== this.readVersion)\n          return false;\n\n        if (this.writeVersion === rhs.writeVersion)\n          return this.minorVersion >= rhs.minorVersion;\n\n        return this.writeVersion > rhs.writeVersion;\n      case SchemaMatchType.LatestWriteCompatible:\n        return this.compareByName(rhs.name) && this.readVersion === rhs.readVersion &&\n          this.writeVersion === rhs.writeVersion && this.minorVersion >= rhs.minorVersion;\n      case SchemaMatchType.Latest:\n        return this.compareByName(rhs.name);\n      default:\n        return false;\n    }\n  }\n\n  /**\n   * Deserializes a SchemaKeyProps JSON object into a SchemaKey object.\n   * @param props SchemaKeyProps\n   * @returns A SchemaKey object.\n   */\n  public static fromJSON(props: SchemaKeyProps): SchemaKey {\n    return new SchemaKey(props.name, props.read, props.write, props.minor);\n  }\n\n  /**\n   * Save this SchemaKey's properties to an object for serializing to JSON.\n   */\n  public toJSON(): SchemaKeyProps {\n    return {\n      name: this.name,\n      read: this.readVersion,\n      write: this.writeVersion,\n      minor: this.minorVersion,\n    };\n  }\n}\n\n/**\n * The SchemaItemKey contains a SchemaItem's name and SchemaKey.\n * @beta\n */\nexport class SchemaItemKey {\n  private _name: ECName;\n  protected _schemaKey: SchemaKey;\n\n  constructor(name: string, schema: SchemaKey) {\n    this._name = new ECName(name);\n    this._schemaKey = schema;\n  }\n\n  public get schemaKey() { return this._schemaKey; }\n  public get name() { return this._name.name; }\n\n  public get schemaName() { return this.schemaKey.name; }\n\n  /** Returns the name in the format, {schemaName}.{name}. */\n  public get fullName() { return `${this.schemaName}.${this.name}`; }\n\n  /**\n   * Checks whether this SchemaItemKey matches the one provided.\n   * @param rhs The SchemaItemKey to compare to this.\n   */\n  // TODO: Need to add a match type\n  public matches(rhs: SchemaItemKey): boolean {\n    if (rhs.name !== this.name)\n      return false;\n\n    if (!rhs.schemaKey.matches(this.schemaKey, SchemaMatchType.Latest))\n      return false;\n\n    return true;\n  }\n\n  public matchesFullName(name: string): boolean {\n    const schemaVersion = this.schemaKey.version.toString().replace(/\\./g, \"\\\\.\");\n    const fullNameRegex = new RegExp(`^${this.schemaName}(\\\\.${schemaVersion})?[.:]${this.name}$`, \"i\");\n    return fullNameRegex.test(name);\n  }\n}\n"]}
+{"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,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,SAAS;IACZ,KAAK,GAAW,CAAC,CAAC;IAClB,MAAM,GAAW,CAAC,CAAC;IACnB,MAAM,GAAW,CAAC,CAAC;IAE3B;;;;OAIG;IACI,MAAM,CAAU,UAAU,GAAG,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,YAAY,IAAa,EAAE,KAAc,EAAE,KAAc;QACvD,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC7D,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAEhI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEjI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEjI,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;;AAGH;;;GAGG;AACH,MAAM,OAAO,SAAS;IACZ,KAAK,CAAS;IACd,QAAQ,CAAY;IAM5B,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,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAExD,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,GAAc,EAAE,YAA6B,eAAe,CAAC,KAAK;QAC/E,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,eAAe,CAAC,SAAS,CAAC;YAC/B,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;IAChB,KAAK,CAAS;IACd,UAAU,CAAY;IAE9B,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 { ECSchemaError, ECSchemaStatus } from \"./Exception\";\r\nimport { ECName } from \"./ECName\";\r\n\r\n/**\r\n * @public @preview\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   * Using a version with all zero is invalid\r\n   * for a schema, but it can be used to indicate\r\n   * \"no version has been specified\" when locating things\r\n   */\r\n  public static readonly NO_VERSION = new ECVersion(0, 0, 0);\r\n\r\n  /**\r\n   * The constructor will throw an ECSchemaError 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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\r\n\r\n    if (!write)\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECVersion, `The write version is missing from version string, ${versionString}`);\r\n\r\n    if (!minor)\r\n      throw new ECSchemaError(ECSchemaStatus.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 * @public @preview\r\n */\r\nexport class SchemaKey {\r\n  private _name: ECName;\r\n  private _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 ECSchemaError(ECSchemaStatus.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: SchemaKey, matchType: SchemaMatchType = SchemaMatchType.Exact): boolean {\r\n    switch (matchType) {\r\n      case SchemaMatchType.Identical:\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 * @public @preview\r\n */\r\nexport class SchemaItemKey {\r\n  private _name: ECName;\r\n  private _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

@@ -11,19 +11,19 @@ import { SchemaPropsGetter } from "./SchemaJsonLocater";
  * ```ts
  * [[include:IModelSchemas.loadFromDb]]
  * ```
- * @beta
+ * @beta Is this concept needed no that backend and frontend will have contexts cached on the iModel?
  */
 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.
+     * @throws [ECSchemaError]($ecschema-metadata) if the schema is not found or cannot be loaded.
      */
     getSchema(schemaName: string): 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.
+     * @throws [ECSchemaError]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */
     tryGetSchema(schemaName: string): Schema | undefined;
     /** Gets the SchemaContext used by the loader. */

package/lib/esm/SchemaLoader.js

@@ -4,7 +4,7 @@
 *--------------------------------------------------------------------------------------------*/
 import { SchemaContext } from "./Context";
 import { SchemaMatchType } from "./ECObjects";
-import { ECObjectsError, ECObjectsStatus } from "./Exception";
+import { ECSchemaError, ECSchemaStatus } from "./Exception";
 import { SchemaJsonLocater } from "./SchemaJsonLocater";
 import { ECVersion, SchemaKey } from "./SchemaKey";
 /**
@@ -17,7 +17,7 @@ import { ECVersion, SchemaKey } from "./SchemaKey";
  * ```ts
  * [[include:IModelSchemas.loadFromDb]]
  * ```
- * @beta
+ * @beta Is this concept needed no that backend and frontend will have contexts cached on the iModel?
  */
 export class SchemaLoader {
     _context;
@@ -28,17 +28,17 @@ export class SchemaLoader {
     }
     /** 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.
+     * @throws [ECSchemaError]($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}`);
+            throw new ECSchemaError(ECSchemaStatus.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.
+     * @throws [ECSchemaError]($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.

package/lib/esm/SchemaLoader.js.map

@@ -1 +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;IACf,QAAQ,CAAgB;IAEhC,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,CAAC,UAAkB;QACjC,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,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,UAAkB;QACpC,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,MAAM,CAAC;IAChB,CAAC;IAED,iDAAiD;IACjD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { SchemaContext } from \"./Context\";\nimport { SchemaMatchType } from \"./ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { SchemaJsonLocater, SchemaPropsGetter } from \"./SchemaJsonLocater\";\nimport { ECVersion, SchemaKey } from \"./SchemaKey\";\n\n/**\n * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.\n * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.\n * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]\n * is a possibility, thereby avoiding unnecessary schema retrievals from the function.\n *\n * ** Example **\n * ```ts\n * [[include:IModelSchemas.loadFromDb]]\n * ```\n * @beta\n */\nexport class SchemaLoader {\n  private _context: SchemaContext;\n\n  public constructor(getSchema: SchemaPropsGetter) {\n    this._context = new SchemaContext();\n    const locater = new SchemaJsonLocater(getSchema);\n    this._context.addLocater(locater);\n  }\n\n  /** Get a schema by name\n   * @param schemaName a string with the name of the schema to load.\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.\n   */\n  public getSchema(schemaName: string): Schema {\n    const schema = this.tryGetSchema(schemaName);\n    if (!schema)\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);\n\n    return schema;\n  }\n\n  /** Attempts to get a schema by name\n   * @param schemaName a string with the name of the schema to load.\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.\n   */\n  public tryGetSchema(schemaName: string): Schema | undefined {\n    // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.\n    const key = new SchemaKey(schemaName, new ECVersion(1, 0, 0));\n    const schema = this._context.getSchemaSync(key, SchemaMatchType.Latest);\n    return schema;\n  }\n\n  /** Gets the SchemaContext used by the loader. */\n  public get context(): SchemaContext {\n    return this._context;\n  }\n}\n"]}
+{"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,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE5D,OAAO,EAAE,iBAAiB,EAAqB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,YAAY;IACf,QAAQ,CAAgB;IAEhC,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,CAAC,UAAkB;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,oBAAoB,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC;QAE/F,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,UAAkB;QACpC,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,MAAM,CAAC;IAChB,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 { ECSchemaError, ECSchemaStatus } 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 Is this concept needed no that backend and frontend will have contexts cached on the iModel?\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 [ECSchemaError]($ecschema-metadata) if the schema is not found or cannot be loaded.\r\n   */\r\n  public getSchema(schemaName: string): Schema {\r\n    const schema = this.tryGetSchema(schemaName);\r\n    if (!schema)\r\n      throw new ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `reading schema=${schemaName}`);\r\n\r\n    return schema;\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 [ECSchemaError]($ecschema-metadata) if the schema exists, but cannot be loaded.\r\n   */\r\n  public tryGetSchema(schemaName: string): Schema | 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;\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

@@ -20,7 +20,7 @@ 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
+ * @public @preview
  */
 export interface ISchemaPartVisitor {
     /**
@@ -240,7 +240,7 @@ export interface ISchemaPartVisitor {
 }
 /**
  * A helper class to call methods on the provided [[ISchemaPartVisitor]].
- * @beta
+ * @public @preview
  */
 export declare class SchemaPartVisitorDelegate {
     private _visitor;

package/lib/esm/SchemaPartVisitorDelegate.js

@@ -12,7 +12,7 @@ function isCustomAttributeContainer(object) {
 }
 /**
  * A helper class to call methods on the provided [[ISchemaPartVisitor]].
- * @beta
+ * @public @preview
  */
 export class SchemaPartVisitorDelegate {
     _visitor;