@itwin/ecschema-metadata 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/Metadata/SchemaItem.d.ts

@@ -2,7 +2,7 @@
  * @module Metadata
  */
 import { SchemaItemProps } from "../Deserialization/JsonProps";
-import { SchemaItemType } from "../ECObjects";
+import { SchemaItemType, SupportedSchemaItemType } from "../ECObjects";
 import { SchemaItemKey } from "../SchemaKey";
 import { Schema } from "./Schema";
 /**
@@ -10,7 +10,16 @@ import { Schema } from "./Schema";
  * @beta
  */
 export declare abstract class SchemaItem {
-    readonly schemaItemType: SchemaItemType;
+    /**
+     * Get the type of item represented by this class
+     * @beta
+     */
+    static get schemaItemType(): SupportedSchemaItemType;
+    /**
+     * Get the type of item represented by this instance
+     * @beta
+     */
+    abstract get schemaItemType(): SchemaItemType;
     readonly schema: Schema;
     protected _key: SchemaItemKey;
     protected _description?: string;

package/lib/esm/Metadata/SchemaItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaItem.d.ts","sourceRoot":"","sources":["../../../src/Metadata/SchemaItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAA6B,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAa,aAAa,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAIlC;;;GAGG;AACH,8BAAsB,UAAU;IAC9B,SAAgB,cAAc,EAAG,cAAc,CAAC;IAChD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,IAAI,WAA4B;IAC3C,IAAW,QAAQ,WAAqF;IACxG,IAAW,GAAG,kBAAwB;IACtC,IAAW,KAAK,uBAA0B;IAC1C,IAAW,WAAW,uBAAgC;IAGtD;;;;OAIG;IACI,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAe3D,eAAe;IAGpC,gBAAgB;IACH,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAclD,YAAY,CAAC,eAAe,EAAE,eAAe;IAiBvC,QAAQ,CAAC,eAAe,EAAE,eAAe;IAiBtD;;;;;OAKG;WACW,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAU/D;;;;OAIG;WACW,UAAU,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,EAAE,UAAU,GAAG,aAAa,GAAG,OAAO;IAQ/G;;MAEE;WACY,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,UAAU;IAO7D;;;OAGG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM;IAI9B;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,MAAM;IAI9C;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;CAG7C"}
+{"version":3,"file":"SchemaItem.d.ts","sourceRoot":"","sources":["../../../src/Metadata/SchemaItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAA0B,cAAc,EAA6B,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAE1H,OAAO,EAAa,aAAa,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,8BAAsB,UAAU;IAC9B;;;OAGG;IACH,WAAkB,cAAc,IAAI,uBAAuB,CAA6C;IAExG;;;OAGG;IACH,aAAoB,cAAc,IAAI,cAAc,CAAC;IACrD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,IAAI,WAA4B;IAC3C,IAAW,QAAQ,WAAqF;IACxG,IAAW,GAAG,kBAAwB;IACtC,IAAW,KAAK,uBAA0B;IAC1C,IAAW,WAAW,uBAAgC;IAGtD;;;;OAIG;IACI,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAe3D,eAAe;IAGpC,gBAAgB;IACH,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAclD,YAAY,CAAC,eAAe,EAAE,eAAe;IAiBvC,QAAQ,CAAC,eAAe,EAAE,eAAe;IAiBtD;;;;;OAKG;WACW,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAU/D;;;;OAIG;WACW,UAAU,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,EAAE,UAAU,GAAG,aAAa,GAAG,OAAO;IAQ/G;;MAEE;WACY,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,UAAU;IAO7D;;;OAGG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM;IAI9B;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,MAAM;IAI9C;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;CAG7C"}

package/lib/esm/Metadata/SchemaItem.js

@@ -5,15 +5,24 @@
 /** @packageDocumentation
  * @module Metadata
  */
-import { schemaItemTypeToXmlString } from "../ECObjects";
+import { ECSchemaNamespaceUris } from "../Constants";
+import { AbstractSchemaItemType, SchemaItemType, schemaItemTypeToXmlString } from "../ECObjects";
 import { ECObjectsError, ECObjectsStatus } from "../Exception";
 import { ECVersion, SchemaItemKey } from "../SchemaKey";
-const SCHEMAURL3_2 = "https://dev.bentley.com/json_schemas/ec/32/schemaitem";
 /**
  * An abstract class that supplies all of the common parts of a SchemaItem.
  * @beta
  */
 export class SchemaItem {
+    /**
+     * Get the type of item represented by this class
+     * @beta
+     */
+    static get schemaItemType() { return AbstractSchemaItemType.SchemaItem; }
+    schema;
+    _key;
+    _description;
+    _label;
     constructor(schema, name) {
         this._key = new SchemaItemKey(name, schema.schemaKey);
         this.schema = schema;
@@ -32,7 +41,7 @@ export class SchemaItem {
     toJSON(standalone = false, includeSchemaVersion = false) {
         const itemJson = {};
         if (standalone) {
-            itemJson.$schema = SCHEMAURL3_2; // $schema is required
+            itemJson.$schema = ECSchemaNamespaceUris.SCHEMAITEMURL3_2; // $schema is required
             itemJson.schema = this.schema.name;
             itemJson.name = this.name; // name is required
             if (includeSchemaVersion) // check flag to see if we should output version
@@ -104,6 +113,7 @@ export class SchemaItem {
     static equalByKey(thisSchemaItem, thatSchemaItemOrKey) {
         if (!thatSchemaItemOrKey)
             return true;
+        SchemaItemType.EntityClass;
         const key = SchemaItem.isSchemaItem(thatSchemaItemOrKey) ? thatSchemaItemOrKey.key : thatSchemaItemOrKey;
         return thisSchemaItem.key.matches(key);
     }

package/lib/esm/Metadata/SchemaItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaItem.js","sourceRoot":"","sources":["../../../src/Metadata/SchemaItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAkB,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAGxD,MAAM,YAAY,GAAG,uDAAuD,CAAC;AAE7E;;;GAGG;AACH,MAAM,OAAgB,UAAU;IAO9B,YAAY,MAAc,EAAE,IAAY;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxG,IAAW,GAAG,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEtD,wLAAwL;IACxL;;;;OAIG;IACI,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QAC9E,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAC9C,IAAI,UAAU,EAAE,CAAC;YACf,QAAQ,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,sBAAsB;YACvD,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,mBAAmB;YAC9C,IAAI,oBAAoB,EAAE,gDAAgD;gBACxE,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnE,CAAC;QACD,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC9B,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;YAChC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAE1C,OAAO,QAA2B,CAAC;IACrC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,KAAK,CAAC,SAAmB;QACpC,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACtD,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;YAChC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAE5D,mGAAmG;QAEnG,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,YAAY,CAAC,eAAgC;QAClD,IAAI,SAAS,KAAK,eAAe,CAAC,KAAK;YACrC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC;QAEtC,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC;QAEhD,IAAI,SAAS,KAAK,eAAe,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrP,CAAC;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;QAC7Q,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,eAAgC;QACpD,IAAI,SAAS,KAAK,eAAe,CAAC,KAAK;YACrC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC;QAEtC,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC;QAEhD,IAAI,SAAS,KAAK,eAAe,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,wCAAwC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnP,CAAC;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;QAC7Q,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,QAAgB;QAC1C,MAAM,OAAO,GAAG,4EAA4E,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5G,2FAA2F;QAC3F,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAC1C,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAExB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,cAA0B,EAAE,mBAAgD;QACnG,IAAI,CAAC,mBAAmB;YACtB,OAAO,IAAI,CAAC;QAEd,MAAM,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACzG,OAAO,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;;MAEE;IACK,MAAM,CAAC,YAAY,CAAC,MAAW;QACpC,MAAM,UAAU,GAAG,MAAoB,CAAC;QAExC,OAAO,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;eACtF,UAAU,CAAC,cAAc,KAAK,SAAS,CAAC;IACtD,CAAC;IAED;;;OAGG;IACO,OAAO,CAAC,IAAY;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACO,eAAe,CAAC,YAAoB;QAC5C,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,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 { SchemaItemProps } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItemType, schemaItemTypeToXmlString } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { ECVersion, SchemaItemKey } from \"../SchemaKey\";\r\nimport { Schema } from \"./Schema\";\r\n\r\nconst SCHEMAURL3_2 = \"https://dev.bentley.com/json_schemas/ec/32/schemaitem\";\r\n\r\n/**\r\n * An abstract class that supplies all of the common parts of a SchemaItem.\r\n * @beta\r\n */\r\nexport abstract class SchemaItem {\r\n  public readonly schemaItemType!: SchemaItemType; // allow the derived classes to define their own schemaItemType\r\n  public readonly schema: Schema;\r\n  protected _key: SchemaItemKey;\r\n  protected _description?: string;\r\n  protected _label?: string;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    this._key = new SchemaItemKey(name, schema.schemaKey);\r\n    this.schema = schema;\r\n  }\r\n\r\n  public get name() { return this.key.name; }\r\n  public get fullName() { return this.key.schemaKey ? `${this.key.schemaName}.${this.name}` : this.name; }\r\n  public get key() { return this._key; }\r\n  public get label() { return this._label; }\r\n  public get description() { return this._description; }\r\n\r\n  // Proposal: Create protected setter methods for description and label? For UnitSystems as an example, where using createFromProps isn't that necessary and can just use basic create().\r\n  /**\r\n   * Save this SchemaItem's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false) {\r\n    const itemJson: { [value: string]: any } = {};\r\n    if (standalone) {\r\n      itemJson.$schema = SCHEMAURL3_2; // $schema is required\r\n      itemJson.schema = this.schema.name;\r\n      itemJson.name = this.name; // name is required\r\n      if (includeSchemaVersion) // check flag to see if we should output version\r\n        itemJson.schemaVersion = this.key.schemaKey.version.toString();\r\n    }\r\n    itemJson.schemaItemType = this.schemaItemType;\r\n    if (undefined !== this.label)\r\n      itemJson.label = this.label;\r\n    if (undefined !== this.description)\r\n      itemJson.description = this.description;\r\n\r\n    return itemJson as SchemaItemProps;\r\n  }\r\n\r\n  /** @internal */\r\n  public async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemType = schemaItemTypeToXmlString(this.schemaItemType);\r\n    const itemElement = schemaXml.createElement(itemType);\r\n    itemElement.setAttribute(\"typeName\", this.name);\r\n    if (undefined !== this.label)\r\n      itemElement.setAttribute(\"displayLabel\", this.label);\r\n    if (undefined !== this.description)\r\n      itemElement.setAttribute(\"description\", this.description);\r\n\r\n    // When all schema items support custom attributes they should be added here rather than in ECClass\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public fromJSONSync(schemaItemProps: SchemaItemProps) {\r\n    if (undefined !== schemaItemProps.label)\r\n      this._label = schemaItemProps.label;\r\n\r\n    this._description = schemaItemProps.description;\r\n\r\n    if (undefined !== schemaItemProps.schema) {\r\n      if (schemaItemProps.schema.toLowerCase() !== this.schema.name.toLowerCase())\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem '${this.fullName}' with a different schema name, ${schemaItemProps.schema}, than the current Schema of this SchemaItem, ${this.schema.fullName}.`);\r\n    }\r\n\r\n    if (undefined !== schemaItemProps.schemaVersion) {\r\n      if (this.key.schemaKey.version.compare(ECVersion.fromString(schemaItemProps.schemaVersion)))\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem '${this.fullName}' with a different schema version, ${schemaItemProps.schemaVersion}, than the current Schema version of this SchemaItem, ${this.key.schemaKey.version}.`);\r\n    }\r\n  }\r\n\r\n  public async fromJSON(schemaItemProps: SchemaItemProps) {\r\n    if (undefined !== schemaItemProps.label)\r\n      this._label = schemaItemProps.label;\r\n\r\n    this._description = schemaItemProps.description;\r\n\r\n    if (undefined !== schemaItemProps.schema) {\r\n      if (schemaItemProps.schema.toLowerCase() !== this.schema.name.toLowerCase())\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem ${this.fullName}' with a different schema name, ${schemaItemProps.schema}, than the current Schema of this SchemaItem, ${this.schema.fullName}`);\r\n    }\r\n\r\n    if (undefined !== schemaItemProps.schemaVersion) {\r\n      if (this.key.schemaKey.version.compare(ECVersion.fromString(schemaItemProps.schemaVersion)))\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem '${this.fullName}' with a different schema version, ${schemaItemProps.schemaVersion}, than the current Schema version of this SchemaItem, ${this.key.schemaKey.version}.`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Parses the given full name, {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}, into two separate strings.\r\n   * @note  The schema name can be a schema alias.\r\n   * @param fullName The full name to be parsed.\r\n   * @returns A tuple of the parsed Schema name and Schema Item name.  If the full name does not contain a '.' or ':', the second string in the tuple will returned the exact string pass in.\r\n   */\r\n  public static parseFullName(fullName: string): [string, string] {\r\n    const matches = /^([a-zA-Z_]+[a-zA-Z0-9_]*(\\.\\d+\\.\\d+\\.\\d+)?)[.:]([a-zA-Z_]+[a-zA-Z0-9_]*)$/.exec(fullName);\r\n\r\n    // The first match will be the full string match, the second three will be the three groups\r\n    if (matches === null || matches.length !== 4)\r\n      return [\"\", fullName];\r\n\r\n    return [matches[1], matches[3]];\r\n  }\r\n\r\n  /**\r\n   * Indicates if the two SchemaItem objects are equal by comparing their respective [[key]] properties.\r\n   * @param thisSchemaItem The first SchemaItem.\r\n   * @param thatSchemaItemOrKey The second SchemaItem or SchemaItemKey.\r\n   */\r\n  public static equalByKey(thisSchemaItem: SchemaItem, thatSchemaItemOrKey?: SchemaItem | SchemaItemKey): boolean {\r\n    if (!thatSchemaItemOrKey)\r\n      return true;\r\n\r\n    const key = SchemaItem.isSchemaItem(thatSchemaItemOrKey) ? thatSchemaItemOrKey.key : thatSchemaItemOrKey;\r\n    return thisSchemaItem.key.matches(key);\r\n  }\r\n\r\n  /**\r\n  * @internal\r\n  */\r\n  public static isSchemaItem(object: any): object is SchemaItem {\r\n    const schemaItem = object as SchemaItem;\r\n\r\n    return schemaItem !== undefined && schemaItem.key !== undefined && schemaItem.schema !== undefined\r\n             && schemaItem.schemaItemType !== undefined;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected setName(name: string) {\r\n    this._key = new SchemaItemKey(name, this.schema.schemaKey);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected setDisplayLabel(displayLabel: string) {\r\n    this._label = displayLabel;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected setDescription(description: string) {\r\n    this._description = description;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaItem.js","sourceRoot":"","sources":["../../../src/Metadata/SchemaItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAErD,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,yBAAyB,EAA2B,MAAM,cAAc,CAAC;AAC1H,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAGxD;;;GAGG;AACH,MAAM,OAAgB,UAAU;IAC9B;;;OAGG;IACI,MAAM,KAAK,cAAc,KAA8B,OAAO,sBAAsB,CAAC,UAAU,CAAA,CAAC,CAAC;IAOxF,MAAM,CAAS;IACrB,IAAI,CAAgB;IACpB,YAAY,CAAU;IACtB,MAAM,CAAU;IAE1B,YAAY,MAAc,EAAE,IAAY;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxG,IAAW,GAAG,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEtD,wLAAwL;IACxL;;;;OAIG;IACI,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QAC9E,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAC9C,IAAI,UAAU,EAAE,CAAC;YACf,QAAQ,CAAC,OAAO,GAAG,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,sBAAsB;YACjF,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,mBAAmB;YAC9C,IAAI,oBAAoB,EAAE,gDAAgD;gBACxE,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnE,CAAC;QACD,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC9B,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;YAChC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAE1C,OAAO,QAA2B,CAAC;IACrC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,KAAK,CAAC,SAAmB;QACpC,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACtD,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;YAChC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAE5D,mGAAmG;QAEnG,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,YAAY,CAAC,eAAgC;QAClD,IAAI,SAAS,KAAK,eAAe,CAAC,KAAK;YACrC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC;QAEtC,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC;QAEhD,IAAI,SAAS,KAAK,eAAe,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrP,CAAC;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;QAC7Q,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,eAAgC;QACpD,IAAI,SAAS,KAAK,eAAe,CAAC,KAAK;YACrC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC;QAEtC,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC;QAEhD,IAAI,SAAS,KAAK,eAAe,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,wCAAwC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnP,CAAC;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE,CAAC;YAChD,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;QAC7Q,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,QAAgB;QAC1C,MAAM,OAAO,GAAG,4EAA4E,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5G,2FAA2F;QAC3F,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAC1C,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAExB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,cAA0B,EAAE,mBAAgD;QACnG,IAAI,CAAC,mBAAmB;YACtB,OAAO,IAAI,CAAC;QACd,cAAc,CAAC,WAAW,CAAA;QAC1B,MAAM,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACzG,OAAO,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;;MAEE;IACK,MAAM,CAAC,YAAY,CAAC,MAAW;QACpC,MAAM,UAAU,GAAG,MAAoB,CAAC;QAExC,OAAO,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;eACtF,UAAU,CAAC,cAAc,KAAK,SAAS,CAAC;IACtD,CAAC;IAED;;;OAGG;IACO,OAAO,CAAC,IAAY;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACO,eAAe,CAAC,YAAoB;QAC5C,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,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 { ECSchemaNamespaceUris } from \"../Constants\";\nimport { SchemaItemProps } from \"../Deserialization/JsonProps\";\nimport { AbstractSchemaItemType, SchemaItemType, schemaItemTypeToXmlString, SupportedSchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECVersion, SchemaItemKey } from \"../SchemaKey\";\nimport { Schema } from \"./Schema\";\n\n/**\n * An abstract class that supplies all of the common parts of a SchemaItem.\n * @beta\n */\nexport abstract class SchemaItem {\n  /**\n   * Get the type of item represented by this class\n   * @beta\n   */\n  public static get schemaItemType(): SupportedSchemaItemType { return AbstractSchemaItemType.SchemaItem }\n\n  /**\n   * Get the type of item represented by this instance\n   * @beta\n   */\n  public abstract get schemaItemType(): SchemaItemType;\n  public readonly schema: Schema;\n  protected _key: SchemaItemKey;\n  protected _description?: string;\n  protected _label?: string;\n\n  constructor(schema: Schema, name: string) {\n    this._key = new SchemaItemKey(name, schema.schemaKey);\n    this.schema = schema;\n  }\n\n  public get name() { return this.key.name; }\n  public get fullName() { return this.key.schemaKey ? `${this.key.schemaName}.${this.name}` : this.name; }\n  public get key() { return this._key; }\n  public get label() { return this._label; }\n  public get description() { return this._description; }\n\n  // Proposal: Create protected setter methods for description and label? For UnitSystems as an example, where using createFromProps isn't that necessary and can just use basic create().\n  /**\n   * Save this SchemaItem's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false) {\n    const itemJson: { [value: string]: any } = {};\n    if (standalone) {\n      itemJson.$schema = ECSchemaNamespaceUris.SCHEMAITEMURL3_2; // $schema is required\n      itemJson.schema = this.schema.name;\n      itemJson.name = this.name; // name is required\n      if (includeSchemaVersion) // check flag to see if we should output version\n        itemJson.schemaVersion = this.key.schemaKey.version.toString();\n    }\n    itemJson.schemaItemType = this.schemaItemType;\n    if (undefined !== this.label)\n      itemJson.label = this.label;\n    if (undefined !== this.description)\n      itemJson.description = this.description;\n\n    return itemJson as SchemaItemProps;\n  }\n\n  /** @internal */\n  public async toXml(schemaXml: Document): Promise<Element> {\n    const itemType = schemaItemTypeToXmlString(this.schemaItemType);\n    const itemElement = schemaXml.createElement(itemType);\n    itemElement.setAttribute(\"typeName\", this.name);\n    if (undefined !== this.label)\n      itemElement.setAttribute(\"displayLabel\", this.label);\n    if (undefined !== this.description)\n      itemElement.setAttribute(\"description\", this.description);\n\n    // When all schema items support custom attributes they should be added here rather than in ECClass\n\n    return itemElement;\n  }\n\n  public fromJSONSync(schemaItemProps: SchemaItemProps) {\n    if (undefined !== schemaItemProps.label)\n      this._label = schemaItemProps.label;\n\n    this._description = schemaItemProps.description;\n\n    if (undefined !== schemaItemProps.schema) {\n      if (schemaItemProps.schema.toLowerCase() !== this.schema.name.toLowerCase())\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem '${this.fullName}' with a different schema name, ${schemaItemProps.schema}, than the current Schema of this SchemaItem, ${this.schema.fullName}.`);\n    }\n\n    if (undefined !== schemaItemProps.schemaVersion) {\n      if (this.key.schemaKey.version.compare(ECVersion.fromString(schemaItemProps.schemaVersion)))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem '${this.fullName}' with a different schema version, ${schemaItemProps.schemaVersion}, than the current Schema version of this SchemaItem, ${this.key.schemaKey.version}.`);\n    }\n  }\n\n  public async fromJSON(schemaItemProps: SchemaItemProps) {\n    if (undefined !== schemaItemProps.label)\n      this._label = schemaItemProps.label;\n\n    this._description = schemaItemProps.description;\n\n    if (undefined !== schemaItemProps.schema) {\n      if (schemaItemProps.schema.toLowerCase() !== this.schema.name.toLowerCase())\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem ${this.fullName}' with a different schema name, ${schemaItemProps.schema}, than the current Schema of this SchemaItem, ${this.schema.fullName}`);\n    }\n\n    if (undefined !== schemaItemProps.schemaVersion) {\n      if (this.key.schemaKey.version.compare(ECVersion.fromString(schemaItemProps.schemaVersion)))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to deserialize the SchemaItem '${this.fullName}' with a different schema version, ${schemaItemProps.schemaVersion}, than the current Schema version of this SchemaItem, ${this.key.schemaKey.version}.`);\n    }\n  }\n\n  /**\n   * Parses the given full name, {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}, into two separate strings.\n   * @note  The schema name can be a schema alias.\n   * @param fullName The full name to be parsed.\n   * @returns A tuple of the parsed Schema name and Schema Item name.  If the full name does not contain a '.' or ':', the second string in the tuple will returned the exact string pass in.\n   */\n  public static parseFullName(fullName: string): [string, string] {\n    const matches = /^([a-zA-Z_]+[a-zA-Z0-9_]*(\\.\\d+\\.\\d+\\.\\d+)?)[.:]([a-zA-Z_]+[a-zA-Z0-9_]*)$/.exec(fullName);\n\n    // The first match will be the full string match, the second three will be the three groups\n    if (matches === null || matches.length !== 4)\n      return [\"\", fullName];\n\n    return [matches[1], matches[3]];\n  }\n\n  /**\n   * Indicates if the two SchemaItem objects are equal by comparing their respective [[key]] properties.\n   * @param thisSchemaItem The first SchemaItem.\n   * @param thatSchemaItemOrKey The second SchemaItem or SchemaItemKey.\n   */\n  public static equalByKey(thisSchemaItem: SchemaItem, thatSchemaItemOrKey?: SchemaItem | SchemaItemKey): boolean {\n    if (!thatSchemaItemOrKey)\n      return true;\n    SchemaItemType.EntityClass\n    const key = SchemaItem.isSchemaItem(thatSchemaItemOrKey) ? thatSchemaItemOrKey.key : thatSchemaItemOrKey;\n    return thisSchemaItem.key.matches(key);\n  }\n\n  /**\n  * @internal\n  */\n  public static isSchemaItem(object: any): object is SchemaItem {\n    const schemaItem = object as SchemaItem;\n\n    return schemaItem !== undefined && schemaItem.key !== undefined && schemaItem.schema !== undefined\n             && schemaItem.schemaItemType !== undefined;\n  }\n\n  /**\n   * @alpha\n   * Used for schema editing.\n   */\n  protected setName(name: string) {\n    this._key = new SchemaItemKey(name, this.schema.schemaKey);\n  }\n\n  /**\n   * @alpha\n   * Used for schema editing.\n   */\n  protected setDisplayLabel(displayLabel: string) {\n    this._label = displayLabel;\n  }\n\n  /**\n   * @alpha\n   * Used for schema editing.\n   */\n  protected setDescription(description: string) {\n    this._description = description;\n  }\n}\n\n"]}

package/lib/esm/Metadata/Unit.d.ts

@@ -12,7 +12,8 @@ import { SchemaItem } from "./SchemaItem";
  * @beta
  */
 export declare class Unit extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Unit;
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
     protected _phenomenon?: LazyLoadedPhenomenon;
     protected _unitSystem?: LazyLoadedUnitSystem;
     protected _definition: string;
@@ -63,6 +64,12 @@ export declare class Unit extends SchemaItem {
      * Used for schema editing.
      */
     protected setDefinition(definition: string): Promise<void>;
+    /**
+     * Type assertion to check if the SchemaItem is of type Unit.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Unit if it is a Unit, undefined otherwise.
+     */
+    static assertIsUnit(item?: SchemaItem): asserts item is Unit;
 }
 /**
  * @internal

package/lib/esm/Metadata/Unit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Unit.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAG3E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,UAAU;IAClC,SAAyB,cAAc,EAAG,cAAc,CAAC,IAAI,CAAC;IAC9D,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEf,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMxC,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,MAAM,CAA6B;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAmC;IACjE,IAAW,MAAM,IAAI,MAAM,CAAgC;IAC3D,IAAW,WAAW,IAAI,MAAM,CAAqC;IACrE,IAAW,YAAY,IAAI,OAAO,CAA4C;IAC9E,IAAW,SAAS,IAAI,OAAO,CAAyC;IACxE,IAAW,cAAc,IAAI,OAAO,CAA8C;IAElF;;;OAGG;WACiB,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7E;;OAEG;WACW,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,IAAI;IAIjD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,mBAAmB;IAc/G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA0BlD,YAAY,CAAC,SAAS,EAAE,mBAAmB;IA8CrC,QAAQ,CAAC,SAAS,EAAE,mBAAmB;IAI7D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,MAAM;CAGjD;AACD;;;GAGG;AACH,8BAAsB,WAAY,SAAQ,IAAI;aACnB,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Unit.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAG3E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,UAAU;IAClC,SAAyB,cAAc,iBAAuB;IAC9D,WAA2B,cAAc,mBAAkC;IAC3E,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEf,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,MAAM,CAA6B;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAmC;IACjE,IAAW,MAAM,IAAI,MAAM,CAAgC;IAC3D,IAAW,WAAW,IAAI,MAAM,CAAqC;IACrE,IAAW,YAAY,IAAI,OAAO,CAA4C;IAC9E,IAAW,SAAS,IAAI,OAAO,CAAyC;IACxE,IAAW,cAAc,IAAI,OAAO,CAA8C;IAElF;;;OAGG;WACiB,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7E;;OAEG;WACW,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,IAAI;IAIjD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,mBAAmB;IAc/G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA0BlD,YAAY,CAAC,SAAS,EAAE,mBAAmB;IA8CrC,QAAQ,CAAC,SAAS,EAAE,mBAAmB;IAI7D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhD;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI;CAIpE;AACD;;;GAGG;AACH,8BAAsB,WAAY,SAAQ,IAAI;aACnB,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Unit.js

@@ -9,16 +9,25 @@ import { DelayedPromiseWithProps } from "../DelayedPromise";
 import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
 import { SchemaItemType } from "../ECObjects";
 import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { Phenomenon } from "./Phenomenon";
 import { SchemaItem } from "./SchemaItem";
+import { UnitSystem } from "./UnitSystem";
 /**
  * An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a
  * first-class concept is to allow the iModel to not be dependent on any hard-coded Units
  * @beta
  */
 export class Unit extends SchemaItem {
+    schemaItemType = Unit.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.Unit; }
+    _phenomenon;
+    _unitSystem;
+    _definition;
+    _numerator;
+    _denominator;
+    _offset;
     constructor(schema, name) {
         super(schema, name);
-        this.schemaItemType = SchemaItemType.Unit;
         this._definition = "";
     }
     get phenomenon() { return this._phenomenon; }
@@ -93,7 +102,7 @@ export class Unit extends SchemaItem {
         if (!phenomenonSchemaItemKey)
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
         this._phenomenon = new DelayedPromiseWithProps(phenomenonSchemaItemKey, async () => {
-            const phenom = await this.schema.lookupItem(phenomenonSchemaItemKey);
+            const phenom = await this.schema.lookupItem(phenomenonSchemaItemKey, Phenomenon);
             if (undefined === phenom)
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
             return phenom;
@@ -102,7 +111,7 @@ export class Unit extends SchemaItem {
         if (!unitSystemSchemaItemKey)
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
         this._unitSystem = new DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
-            const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey);
+            const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey, UnitSystem);
             if (undefined === unitSystem)
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
             return unitSystem;
@@ -148,6 +157,15 @@ export class Unit extends SchemaItem {
     async setDefinition(definition) {
         this._definition = definition;
     }
+    /**
+     * Type assertion to check if the SchemaItem is of type Unit.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Unit if it is a Unit, undefined otherwise.
+     */
+    static assertIsUnit(item) {
+        if (!this.isUnit(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Unit}' (Unit)`);
+    }
 }
 /**
  * @internal

package/lib/esm/Metadata/Unit.js.map

@@ -1 +1 @@
-{"version":3,"file":"Unit.js","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAK/D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;;;GAIG;AACH,MAAM,OAAO,IAAK,SAAQ,UAAU;IASlC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC;IACjE,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC;IAC3D,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;IACrE,IAAW,YAAY,KAAc,OAAO,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAC9E,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IACxE,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElF;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,KAAW,EAAE,KAAW;QACxD,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAC/C,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAE/C,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC;YAC3F,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,MAAW;QAC9B,OAAO,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,IAAI,IAAI,CAAC,YAAY;YACnB,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,IAAI,IAAI,CAAC,cAAc;YACrB,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,IAAI,CAAC,SAAS;YAChB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAClC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACzD,CAAC;QAED,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY;YACnB,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,cAAc;YACrB,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,IAAI,CAAC,SAAS;YAChB,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,SAA8B;QACzD,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,uBAAuB,CAAC,CAAC;YACjF,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,uBAAuB,CAAC,CAAC;YACrF,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YAClG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACrH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC;QAE1C,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC;QAC1C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC;YACxC,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBAC7C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;QAC9C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO;gBACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,SAA8B;QAC3D,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,WAAY,SAAQ,IAAI;CAK7C","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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\r\nimport { SchemaItemUnitProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedPhenomenon, LazyLoadedUnitSystem } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { Phenomenon } from \"./Phenomenon\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { UnitSystem } from \"./UnitSystem\";\r\n\r\n/**\r\n * An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a\r\n * first-class concept is to allow the iModel to not be dependent on any hard-coded Units\r\n * @beta\r\n */\r\nexport class Unit extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Unit;\r\n  protected _phenomenon?: LazyLoadedPhenomenon;\r\n  protected _unitSystem?: LazyLoadedUnitSystem;\r\n  protected _definition: string;\r\n  protected _numerator?: number;\r\n  protected _denominator?: number;\r\n  protected _offset?: number;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Unit;\r\n    this._definition = \"\";\r\n  }\r\n\r\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\r\n  public get unitSystem(): LazyLoadedUnitSystem | undefined { return this._unitSystem; }\r\n  public get definition(): string { return this._definition; }\r\n  public get numerator(): number { return this._numerator ?? 1.0; }\r\n  public get offset(): number { return this._offset ?? 0.0; }\r\n  public get denominator(): number { return this._denominator ?? 1.0; }\r\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\r\n  public get hasOffset(): boolean { return (this._offset !== undefined); }\r\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\r\n\r\n  /**\r\n   * Returns true if a conversion can be calculated between the input units\r\n   * @alpha\r\n   */\r\n  public static async areCompatible(unitA: Unit, unitB: Unit): Promise<boolean> {\r\n    const unitAPhenomenon = await unitA.phenomenon;\r\n    const unitBPhenomenon = await unitB.phenomenon;\r\n\r\n    if (!unitAPhenomenon || !unitBPhenomenon || !unitAPhenomenon.key.matches(unitBPhenomenon.key))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   */\r\n  public static isUnit(object: any): object is Unit {\r\n    return SchemaItem.isSchemaItem(object) && object.schemaItemType === SchemaItemType.Unit;\r\n  }\r\n\r\n  /**\r\n   * Save this Unit's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): SchemaItemUnitProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.phenomenon = this.phenomenon!.fullName;\r\n    schemaJson.unitSystem = this.unitSystem!.fullName;\r\n    schemaJson.definition = this.definition;\r\n    if (this.hasNumerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (this.hasDenominator)\r\n      schemaJson.denominator = this.denominator;\r\n    if (this.hasOffset)\r\n      schemaJson.offset = this.offset;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n\r\n    const phenomenon = await this.phenomenon;\r\n    if (undefined !== phenomenon) {\r\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\r\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\r\n    }\r\n\r\n    const unitSystem = await this.unitSystem;\r\n    if (undefined !== unitSystem) {\r\n      const unitSystemName = XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);\r\n      itemElement.setAttribute(\"unitSystem\", unitSystemName);\r\n    }\r\n\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    if (this.hasNumerator)\r\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    if (this.hasDenominator)\r\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n    if (this.hasOffset)\r\n      itemElement.setAttribute(\"offset\", this.offset.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(unitProps: SchemaItemUnitProps) {\r\n    super.fromJSONSync(unitProps);\r\n\r\n    const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);\r\n    if (!phenomenonSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(phenomenonSchemaItemKey,\r\n      async () => {\r\n        const phenom = await this.schema.lookupItem<Phenomenon>(phenomenonSchemaItemKey);\r\n        if (undefined === phenom)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n        return phenom;\r\n      });\r\n\r\n    const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);\r\n    if (!unitSystemSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n    this._unitSystem = new DelayedPromiseWithProps<SchemaItemKey, UnitSystem>(unitSystemSchemaItemKey,\r\n      async () => {\r\n        const unitSystem = await this.schema.lookupItem<UnitSystem>(unitSystemSchemaItemKey);\r\n        if (undefined === unitSystem)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n        return unitSystem;\r\n      });\r\n\r\n    if (this._definition !== \"\" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = unitProps.definition;\r\n\r\n    if (undefined !== unitProps.numerator) {\r\n      if (unitProps.numerator !== this._numerator)\r\n        this._numerator = unitProps.numerator;\r\n    }\r\n\r\n    if (undefined !== unitProps.denominator) {\r\n      if (unitProps.denominator !== this._denominator)\r\n        this._denominator = unitProps.denominator;\r\n    }\r\n\r\n    if (undefined !== unitProps.offset) {\r\n      if (unitProps.offset !== this._offset)\r\n        this._offset = unitProps.offset;\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(unitProps: SchemaItemUnitProps) {\r\n    this.fromJSONSync(unitProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\r\n    this._phenomenon = phenomenon;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\r\n    this._unitSystem = unitSystem;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableUnit extends Unit {\r\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;\r\n  public abstract override setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;\r\n  public abstract override setDefinition(definition: string): Promise<void>;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"Unit.js","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;GAIG;AACH,MAAM,OAAO,IAAK,SAAQ,UAAU;IACT,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IACvD,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,WAAW,CAAwB;IACnC,WAAW,CAAwB;IACnC,WAAW,CAAS;IACpB,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,OAAO,CAAU;IAE3B,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC;IACjE,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC;IAC3D,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;IACrE,IAAW,YAAY,KAAc,OAAO,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAC9E,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IACxE,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElF;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,KAAW,EAAE,KAAW;QACxD,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAC/C,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAE/C,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC;YAC3F,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,MAAW;QAC9B,OAAO,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,IAAI,IAAI,CAAC,YAAY;YACnB,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,IAAI,IAAI,CAAC,cAAc;YACrB,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,IAAI,CAAC,SAAS;YAChB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAClC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACzD,CAAC;QAED,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY;YACnB,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,cAAc;YACrB,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,IAAI,CAAC,SAAS;YAChB,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,SAA8B;QACzD,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;YACjF,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;YACrF,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YAClG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACrH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC;QAE1C,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC;QAC1C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC;YACxC,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBAC7C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;QAC9C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO;gBACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,SAA8B;QAC3D,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,IAAI,UAAU,CAAC,CAAC;IAChH,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,WAAY,SAAQ,IAAI;CAK7C","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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\r\nimport { SchemaItemUnitProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedPhenomenon, LazyLoadedUnitSystem } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { Phenomenon } from \"./Phenomenon\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { UnitSystem } from \"./UnitSystem\";\r\n\r\n/**\r\n * An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a\r\n * first-class concept is to allow the iModel to not be dependent on any hard-coded Units\r\n * @beta\r\n */\r\nexport class Unit extends SchemaItem {\r\n  public override readonly schemaItemType = Unit.schemaItemType;\r\n  public static override get schemaItemType() { return SchemaItemType.Unit; }\r\n  protected _phenomenon?: LazyLoadedPhenomenon;\r\n  protected _unitSystem?: LazyLoadedUnitSystem;\r\n  protected _definition: string;\r\n  protected _numerator?: number;\r\n  protected _denominator?: number;\r\n  protected _offset?: number;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this._definition = \"\";\r\n  }\r\n\r\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\r\n  public get unitSystem(): LazyLoadedUnitSystem | undefined { return this._unitSystem; }\r\n  public get definition(): string { return this._definition; }\r\n  public get numerator(): number { return this._numerator ?? 1.0; }\r\n  public get offset(): number { return this._offset ?? 0.0; }\r\n  public get denominator(): number { return this._denominator ?? 1.0; }\r\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\r\n  public get hasOffset(): boolean { return (this._offset !== undefined); }\r\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\r\n\r\n  /**\r\n   * Returns true if a conversion can be calculated between the input units\r\n   * @alpha\r\n   */\r\n  public static async areCompatible(unitA: Unit, unitB: Unit): Promise<boolean> {\r\n    const unitAPhenomenon = await unitA.phenomenon;\r\n    const unitBPhenomenon = await unitB.phenomenon;\r\n\r\n    if (!unitAPhenomenon || !unitBPhenomenon || !unitAPhenomenon.key.matches(unitBPhenomenon.key))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   */\r\n  public static isUnit(object: any): object is Unit {\r\n    return SchemaItem.isSchemaItem(object) && object.schemaItemType === SchemaItemType.Unit;\r\n  }\r\n\r\n  /**\r\n   * Save this Unit's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): SchemaItemUnitProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.phenomenon = this.phenomenon!.fullName;\r\n    schemaJson.unitSystem = this.unitSystem!.fullName;\r\n    schemaJson.definition = this.definition;\r\n    if (this.hasNumerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (this.hasDenominator)\r\n      schemaJson.denominator = this.denominator;\r\n    if (this.hasOffset)\r\n      schemaJson.offset = this.offset;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n\r\n    const phenomenon = await this.phenomenon;\r\n    if (undefined !== phenomenon) {\r\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\r\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\r\n    }\r\n\r\n    const unitSystem = await this.unitSystem;\r\n    if (undefined !== unitSystem) {\r\n      const unitSystemName = XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);\r\n      itemElement.setAttribute(\"unitSystem\", unitSystemName);\r\n    }\r\n\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    if (this.hasNumerator)\r\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    if (this.hasDenominator)\r\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n    if (this.hasOffset)\r\n      itemElement.setAttribute(\"offset\", this.offset.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(unitProps: SchemaItemUnitProps) {\r\n    super.fromJSONSync(unitProps);\r\n\r\n    const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);\r\n    if (!phenomenonSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(phenomenonSchemaItemKey,\r\n      async () => {\r\n        const phenom = await this.schema.lookupItem(phenomenonSchemaItemKey, Phenomenon);\r\n        if (undefined === phenom)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n        return phenom;\r\n      });\r\n\r\n    const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);\r\n    if (!unitSystemSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n    this._unitSystem = new DelayedPromiseWithProps<SchemaItemKey, UnitSystem>(unitSystemSchemaItemKey,\r\n      async () => {\r\n        const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey, UnitSystem);\r\n        if (undefined === unitSystem)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n        return unitSystem;\r\n      });\r\n\r\n    if (this._definition !== \"\" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = unitProps.definition;\r\n\r\n    if (undefined !== unitProps.numerator) {\r\n      if (unitProps.numerator !== this._numerator)\r\n        this._numerator = unitProps.numerator;\r\n    }\r\n\r\n    if (undefined !== unitProps.denominator) {\r\n      if (unitProps.denominator !== this._denominator)\r\n        this._denominator = unitProps.denominator;\r\n    }\r\n\r\n    if (undefined !== unitProps.offset) {\r\n      if (unitProps.offset !== this._offset)\r\n        this._offset = unitProps.offset;\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(unitProps: SchemaItemUnitProps) {\r\n    this.fromJSONSync(unitProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\r\n    this._phenomenon = phenomenon;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\r\n    this._unitSystem = unitSystem;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type Unit.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to Unit if it is a Unit, undefined otherwise.\r\n   */\r\n  public static assertIsUnit(item?: SchemaItem): asserts item is Unit {\r\n    if(!this.isUnit(item))\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Unit}' (Unit)`);\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableUnit extends Unit {\r\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;\r\n  public abstract override setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;\r\n  public abstract override setDefinition(definition: string): Promise<void>;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

package/lib/esm/Metadata/UnitSystem.d.ts

@@ -2,14 +2,25 @@
  * @module Metadata
  */
 import { SchemaItemType } from "../ECObjects";
-import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
 /**
  * @beta
  */
 export declare class UnitSystem extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.UnitSystem;
-    constructor(schema: Schema, name: string);
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
+    /**
+     * Type guard to check if the SchemaItem is of type UnitSystem.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a UnitSystem, false otherwise.
+     */
+    static isUnitSystem(item?: SchemaItem): item is UnitSystem;
+    /**
+     * Type assertion to check if the SchemaItem is of type UnitSystem.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.
+     */
+    static assertIsUnitSystem(item?: SchemaItem): asserts item is UnitSystem;
 }
 /**
  * @internal

package/lib/esm/Metadata/UnitSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UnitSystem.d.ts","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,EAAG,cAAc,CAAC,UAAU,CAAC;gBAExD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAIzC;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"UnitSystem.d.ts","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,iBAA6B;IACpE,WAA2B,cAAc,mBAAwC;IAEjF;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,UAAU;IAOjE;;;;OAIG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU;CAIhF;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/UnitSystem.js

@@ -6,14 +6,32 @@
  * @module Metadata
  */
 import { SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
 import { SchemaItem } from "./SchemaItem";
 /**
  * @beta
  */
 export class UnitSystem extends SchemaItem {
-    constructor(schema, name) {
-        super(schema, name);
-        this.schemaItemType = SchemaItemType.UnitSystem;
+    schemaItemType = UnitSystem.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.UnitSystem; }
+    /**
+     * Type guard to check if the SchemaItem is of type UnitSystem.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a UnitSystem, false otherwise.
+     */
+    static isUnitSystem(item) {
+        if (item && item.schemaItemType === SchemaItemType.UnitSystem)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type UnitSystem.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.
+     */
+    static assertIsUnitSystem(item) {
+        if (!this.isUnitSystem(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.UnitSystem}' (UnitSystem)`);
     }
 }
 /**

package/lib/esm/Metadata/UnitSystem.js.map

@@ -1 +1 @@
-{"version":3,"file":"UnitSystem.js","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IAGxC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IAClD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,UAAU;CAEzD","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 { SchemaItemType } from \"../ECObjects\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/**\r\n * @beta\r\n */\r\nexport class UnitSystem extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.UnitSystem;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.UnitSystem;\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * Used for schema editing.\r\n */\r\nexport abstract class MutableUnitSystem extends UnitSystem {\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"UnitSystem.js","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IACf,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7D,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU;YAC3D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,UAAU,gBAAgB,CAAC,CAAC;IAC5H,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,UAAU;CAEzD","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 { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * @beta\n */\nexport class UnitSystem extends SchemaItem {\n  public override readonly schemaItemType = UnitSystem.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.UnitSystem; }\n\n  /**\n   * Type guard to check if the SchemaItem is of type UnitSystem.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a UnitSystem, false otherwise.\n   */\n  public static isUnitSystem(item?: SchemaItem): item is UnitSystem {\n    if (item && item.schemaItemType === SchemaItemType.UnitSystem)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type UnitSystem.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.\n   */\n  public static assertIsUnitSystem(item?: SchemaItem): asserts item is UnitSystem {\n    if (!this.isUnitSystem(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.UnitSystem}' (UnitSystem)`);\n  }\n}\n\n/**\n * @internal\n * Used for schema editing.\n */\nexport abstract class MutableUnitSystem extends UnitSystem {\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

package/lib/esm/PropertyTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyTypes.js","sourceRoot":"","sources":["../../src/PropertyTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAW9D;;GAEG;AACH,MAAM,CAAN,IAAY,YA4BX;AA5BD,WAAY,YAAY;IACtB,mDAAa,CAAA;IACb,+DAAmB,CAAA;IACnB,2DAAiB,CAAA;IACjB,qDAAc,CAAA;IACd,iEAAoB,CAAA;IACpB,uDAAe,CAAA;IACf,mEAAqB,CAAA;IACrB,yDAAgB,CAAA;IAChB,qEAAsB,CAAA;IACtB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,gFAA2B,CAAA;IAC3B,4FAAiC,CAAA;IACjC,kDAAY,CAAA;IACZ,8DAAkB,CAAA;IAClB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,8EAA0B,CAAA;IAC1B,0FAAgC,CAAA;IAChC,4DAAiB,CAAA;IACjB,wEAAuB,CAAA;AACzB,CAAC,EA5BW,YAAY,KAAZ,YAAY,QA4BvB;AAED,YAAY;AACZ,MAAM,KAAW,iBAAiB,CAyBjC;AAzBD,WAAiB,iBAAiB;IAChC,SAAgB,OAAO,CAAC,CAAe;QACrC,OAAO,CAAC,CAAC,KAAK,CAAC,8BAAsB,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,WAAW,CAAC,CAAe;QACzC,OAAO,CAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAFe,6BAAW,cAE1B,CAAA;IACD,SAAgB,QAAQ,CAAC,CAAe;QACtC,OAAO,CAAC,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IAFe,0BAAQ,WAEvB,CAAA;IACD,SAAgB,YAAY,CAAC,CAAe;QAC1C,OAAO,CAAC,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IAFe,8BAAY,eAE3B,CAAA;IACD,SAAgB,aAAa,CAAC,CAAe;QAC3C,OAAO,CAAC,CAAC,KAAK,CAAC,qCAA4B,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAFe,+BAAa,gBAE5B,CAAA;IACD,SAAgB,OAAO,CAAC,CAAe;QACrC,OAAO,CAAC,8BAAsB,CAAC;IACjC,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,gBAAgB,CAAC,CAAe;QAC9C,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtB,CAAC;IAFe,kCAAgB,mBAE/B,CAAA;IACD,SAAgB,iBAAiB,CAAC,CAAgB;QAChD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAFe,mCAAiB,oBAEhC,CAAA;AACH,CAAC,EAzBgB,iBAAiB,KAAjB,iBAAiB,QAyBjC;AAED,YAAY;AACZ,MAAM,UAAU,oBAAoB,CAAC,IAAkB;IACrD,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAC5F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAClC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,gBAAgB,CAAC;IACtF,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC;QACtC,OAAO,oBAAoB,CAAC;IAC9B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;AAChF,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 { PrimitiveType } from \"./ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\n\r\n/** @beta */\r\nconst enum PropertyFlags { // eslint-disable-line no-restricted-syntax\r\n  Primitive = 0x01,\r\n  Struct = 0x02,\r\n  Array = 0x04,\r\n  Navigation = 0x08,\r\n  Enumeration = 0x10,\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport enum PropertyType {\r\n  Struct = 0x02, // PropertyFlags.Struct\r\n  Struct_Array = 0x06, // PropertyFlags.Struct | PropertyFlags.Array\r\n  Navigation = 0x08, // PropertyFlags.Navigation\r\n  Binary = 0x101, // PrimitiveType.Binary\r\n  Binary_Array = 0x105, // PrimitiveType.Binary | PropertyFlags.Array\r\n  Boolean = 0x201, // PrimitiveType.Boolean\r\n  Boolean_Array = 0x205, // PrimitiveType.Boolean | PropertyFlags.Array\r\n  DateTime = 0x301, // PrimitiveType.DateTime\r\n  DateTime_Array = 0x305, // PrimitiveType.DateTime | PropertyFlags.Array\r\n  Double = 0x401, // PrimitiveType.Double\r\n  Double_Array = 0x405, // PrimitiveType.Double | PropertyFlags.Array\r\n  Integer = 0x501, // PrimitiveType.Integer\r\n  Integer_Array = 0x505, // PrimitiveType.Integer | PropertyFlags.Array\r\n  Integer_Enumeration = 0x511, // PrimitiveType.Integer | PropertyFlags.Enumeration\r\n  Integer_Enumeration_Array = 0x515, // PrimitiveType.Integer | PropertyFlags.Enumeration | PropertyFlags.Array\r\n  Long = 0x601, // PrimitiveType.Long\r\n  Long_Array = 0x605, // PrimitiveType.Long | PropertyFlags.Array\r\n  Point2d = 0x701, // PrimitiveType.Point2d\r\n  Point2d_Array = 0x705, // PrimitiveType.Point2d | PropertyFlags.Array\r\n  Point3d = 0x801, // PrimitiveType.Point3d\r\n  Point3d_Array = 0x805, // PrimitiveType.Point3d | PropertyFlags.Array\r\n  String = 0x901, // PrimitiveType.String\r\n  String_Array = 0x905, // PrimitiveType.String | PropertyFlags.Array\r\n  String_Enumeration = 0x911, // PrimitiveType.String | PropertyFlags.Enumeration\r\n  String_Enumeration_Array = 0x915, // PrimitiveType.String | PropertyFlags.Enumeration | PropertyFlags.Array\r\n  IGeometry = 0xA01, // PrimitiveType.IGeometry\r\n  IGeometry_Array = 0xA05, // PrimitiveType.IGeometry | PropertyFlags.Array\r\n}\r\n\r\n/** @beta */\r\nexport namespace PropertyTypeUtils {\r\n  export function isArray(t: PropertyType) {\r\n    return (t === (PropertyFlags.Array | t));\r\n  }\r\n  export function isPrimitive(t: PropertyType) {\r\n    return (t === (PropertyFlags.Primitive | t));\r\n  }\r\n  export function isStruct(t: PropertyType) {\r\n    return (t === (PropertyFlags.Struct | t));\r\n  }\r\n  export function isNavigation(t: PropertyType) {\r\n    return (t === (PropertyFlags.Navigation | t));\r\n  }\r\n  export function isEnumeration(t: PropertyType) {\r\n    return (t === (PropertyFlags.Enumeration | t));\r\n  }\r\n  export function asArray(t: PropertyType): PropertyType {\r\n    return t | PropertyFlags.Array;\r\n  }\r\n  export function getPrimitiveType(t: PropertyType): PrimitiveType {\r\n    return (0xFF01 & t);\r\n  }\r\n  export function fromPrimitiveType(t: PrimitiveType): PropertyType {\r\n    return t | 0;\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport function propertyTypeToString(type: PropertyType) {\r\n  if (PropertyTypeUtils.isPrimitive(type))\r\n    return (PropertyTypeUtils.isArray(type)) ? \"PrimitiveArrayProperty\" : \"PrimitiveProperty\";\r\n  if (PropertyTypeUtils.isStruct(type))\r\n    return (PropertyTypeUtils.isArray(type)) ? \"StructArrayProperty\" : \"StructProperty\";\r\n  if (PropertyTypeUtils.isNavigation(type))\r\n    return \"NavigationProperty\";\r\n  throw new ECObjectsError(ECObjectsStatus.InvalidType, \"Invalid propertyType\");\r\n}\r\n"]}
+{"version":3,"file":"PropertyTypes.js","sourceRoot":"","sources":["../../src/PropertyTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAW9D;;GAEG;AACH,MAAM,CAAN,IAAY,YA4BX;AA5BD,WAAY,YAAY;IACtB,mDAAa,CAAA;IACb,+DAAmB,CAAA;IACnB,2DAAiB,CAAA;IACjB,qDAAc,CAAA;IACd,iEAAoB,CAAA;IACpB,uDAAe,CAAA;IACf,mEAAqB,CAAA;IACrB,yDAAgB,CAAA;IAChB,qEAAsB,CAAA;IACtB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,gFAA2B,CAAA;IAC3B,4FAAiC,CAAA;IACjC,kDAAY,CAAA;IACZ,8DAAkB,CAAA;IAClB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,8EAA0B,CAAA;IAC1B,0FAAgC,CAAA;IAChC,4DAAiB,CAAA;IACjB,wEAAuB,CAAA;AACzB,CAAC,EA5BW,YAAY,KAAZ,YAAY,QA4BvB;AAED,YAAY;AACZ,MAAM,KAAW,iBAAiB,CAyBjC;AAzBD,WAAiB,iBAAiB;IAChC,SAAgB,OAAO,CAAC,CAAe;QACrC,OAAO,CAAC,CAAC,KAAK,CAAC,8BAAsB,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,WAAW,CAAC,CAAe;QACzC,OAAO,CAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAFe,6BAAW,cAE1B,CAAA;IACD,SAAgB,QAAQ,CAAC,CAAe;QACtC,OAAO,CAAC,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IAFe,0BAAQ,WAEvB,CAAA;IACD,SAAgB,YAAY,CAAC,CAAe;QAC1C,OAAO,CAAC,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IAFe,8BAAY,eAE3B,CAAA;IACD,SAAgB,aAAa,CAAC,CAAe;QAC3C,OAAO,CAAC,CAAC,KAAK,CAAC,qCAA4B,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAFe,+BAAa,gBAE5B,CAAA;IACD,SAAgB,OAAO,CAAC,CAAe;QACrC,OAAO,CAAC,8BAAsB,CAAC;IACjC,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,gBAAgB,CAAC,CAAe;QAC9C,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtB,CAAC;IAFe,kCAAgB,mBAE/B,CAAA;IACD,SAAgB,iBAAiB,CAAC,CAAgB;QAChD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAFe,mCAAiB,oBAEhC,CAAA;AACH,CAAC,EAzBgB,iBAAiB,KAAjB,iBAAiB,QAyBjC;AAED,YAAY;AACZ,MAAM,UAAU,oBAAoB,CAAC,IAAkB;IACrD,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAC5F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAClC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,gBAAgB,CAAC;IACtF,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC;QACtC,OAAO,oBAAoB,CAAC;IAC9B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;AAChF,CAAC","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 { PrimitiveType } from \"./ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\n\n/** @beta */\nconst enum PropertyFlags { // eslint-disable-line no-restricted-syntax\n  Primitive = 0x01,\n  Struct = 0x02,\n  Array = 0x04,\n  Navigation = 0x08,\n  Enumeration = 0x10,\n}\n\n/**\n * @beta\n */\nexport enum PropertyType {\n  Struct = 0x02, // PropertyFlags.Struct\n  Struct_Array = 0x06, // PropertyFlags.Struct | PropertyFlags.Array\n  Navigation = 0x08, // PropertyFlags.Navigation\n  Binary = 0x101, // PrimitiveType.Binary\n  Binary_Array = 0x105, // PrimitiveType.Binary | PropertyFlags.Array\n  Boolean = 0x201, // PrimitiveType.Boolean\n  Boolean_Array = 0x205, // PrimitiveType.Boolean | PropertyFlags.Array\n  DateTime = 0x301, // PrimitiveType.DateTime\n  DateTime_Array = 0x305, // PrimitiveType.DateTime | PropertyFlags.Array\n  Double = 0x401, // PrimitiveType.Double\n  Double_Array = 0x405, // PrimitiveType.Double | PropertyFlags.Array\n  Integer = 0x501, // PrimitiveType.Integer\n  Integer_Array = 0x505, // PrimitiveType.Integer | PropertyFlags.Array\n  Integer_Enumeration = 0x511, // PrimitiveType.Integer | PropertyFlags.Enumeration\n  Integer_Enumeration_Array = 0x515, // PrimitiveType.Integer | PropertyFlags.Enumeration | PropertyFlags.Array\n  Long = 0x601, // PrimitiveType.Long\n  Long_Array = 0x605, // PrimitiveType.Long | PropertyFlags.Array\n  Point2d = 0x701, // PrimitiveType.Point2d\n  Point2d_Array = 0x705, // PrimitiveType.Point2d | PropertyFlags.Array\n  Point3d = 0x801, // PrimitiveType.Point3d\n  Point3d_Array = 0x805, // PrimitiveType.Point3d | PropertyFlags.Array\n  String = 0x901, // PrimitiveType.String\n  String_Array = 0x905, // PrimitiveType.String | PropertyFlags.Array\n  String_Enumeration = 0x911, // PrimitiveType.String | PropertyFlags.Enumeration\n  String_Enumeration_Array = 0x915, // PrimitiveType.String | PropertyFlags.Enumeration | PropertyFlags.Array\n  IGeometry = 0xA01, // PrimitiveType.IGeometry\n  IGeometry_Array = 0xA05, // PrimitiveType.IGeometry | PropertyFlags.Array\n}\n\n/** @beta */\nexport namespace PropertyTypeUtils {\n  export function isArray(t: PropertyType) {\n    return (t === (PropertyFlags.Array | t));\n  }\n  export function isPrimitive(t: PropertyType) {\n    return (t === (PropertyFlags.Primitive | t));\n  }\n  export function isStruct(t: PropertyType) {\n    return (t === (PropertyFlags.Struct | t));\n  }\n  export function isNavigation(t: PropertyType) {\n    return (t === (PropertyFlags.Navigation | t));\n  }\n  export function isEnumeration(t: PropertyType) {\n    return (t === (PropertyFlags.Enumeration | t));\n  }\n  export function asArray(t: PropertyType): PropertyType {\n    return t | PropertyFlags.Array;\n  }\n  export function getPrimitiveType(t: PropertyType): PrimitiveType {\n    return (0xFF01 & t);\n  }\n  export function fromPrimitiveType(t: PrimitiveType): PropertyType {\n    return t | 0;\n  }\n}\n\n/** @beta */\nexport function propertyTypeToString(type: PropertyType) {\n  if (PropertyTypeUtils.isPrimitive(type))\n    return (PropertyTypeUtils.isArray(type)) ? \"PrimitiveArrayProperty\" : \"PrimitiveProperty\";\n  if (PropertyTypeUtils.isStruct(type))\n    return (PropertyTypeUtils.isArray(type)) ? \"StructArrayProperty\" : \"StructProperty\";\n  if (PropertyTypeUtils.isNavigation(type))\n    return \"NavigationProperty\";\n  throw new ECObjectsError(ECObjectsStatus.InvalidType, \"Invalid propertyType\");\n}\n"]}

package/lib/esm/SchemaJsonLocater.d.ts

@@ -24,19 +24,19 @@ export declare class SchemaJsonLocater implements ISchemaLocater {
      * @param context The [SchemaContext] used to facilitate schema location.
      * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */
-    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
     /**
      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
      * @param schemaKey The SchemaKey describing the schema to get from the cache.
      * @param matchType The match type to use when locating the schema
      */
-    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    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 context The [SchemaContext] used to facilitate schema location.
      * @throws [Error]($ecschema-metadata) if the schema exists, but cannot be loaded.
      */
-    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, _matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+    getSchemaSync(schemaKey: SchemaKey, _matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
 }
 //# sourceMappingURL=SchemaJsonLocater.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaJsonLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaJsonLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;AAEhF;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,cAAc;IACnC,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,iBAAiB;IAExD;;;;;OAKG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAKpJ;;;;OAIG;IACU,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAY/I;;;;;OAKG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;CAS3I"}
+{"version":3,"file":"SchemaJsonLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaJsonLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,WAAW,GAAG,SAAS,CAAC;AAEhF;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,cAAc;IACnC,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,iBAAiB;IAExD;;;;;OAKG;IACU,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAK7H;;;;OAIG;IACU,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAYrI;;;;;OAKG;IACI,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAOpH"}

package/lib/esm/SchemaJsonLocater.js

@@ -10,6 +10,7 @@ import { Schema } from "./Metadata/Schema";
  * @beta
  */
 export class SchemaJsonLocater {
+    _getSchema;
     constructor(_getSchema) {
         this._getSchema = _getSchema;
     }
@@ -21,7 +22,7 @@ export class SchemaJsonLocater {
      */
     async getSchema(schemaKey, matchType, context) {
         await this.getSchemaInfo(schemaKey, matchType, context);
-        return await context.getCachedSchema(schemaKey, matchType);
+        return context.getCachedSchema(schemaKey, matchType);
     }
     /**
      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
@@ -47,8 +48,7 @@ export class SchemaJsonLocater {
         const schemaProps = this._getSchema(schemaKey.name);
         if (!schemaProps)
             return undefined;
-        context = context ? context : new SchemaContext();
-        return Schema.fromJsonSync(schemaProps, context);
+        return Schema.fromJsonSync(schemaProps, context || new SchemaContext());
     }
 }
 //# sourceMappingURL=SchemaJsonLocater.js.map

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;IAC5B,YAA2B,UAA6B;QAA7B,eAAU,GAAV,UAAU,CAAmB;IAAI,CAAC;IAE7D;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAmB,SAA8B,EAAE,SAA0B,EAAE,OAAsB;QACzH,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,OAAO,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAM,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,SAA8B,EAAE,SAA0B,EAAE,OAAsB;QAC3G,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,CAAmB,SAA8B,EAAE,UAA2B,EAAE,OAAsB;QACxH,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,WAAW;YACd,OAAO,SAAS,CAAC;QAEnB,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,aAAa,EAAE,CAAC;QAClD,OAAO,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAM,CAAC;IACxD,CAAC;CAEF","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 * @beta\r\n */\r\nexport type SchemaPropsGetter = (schemaName: string) => SchemaProps | undefined;\r\n\r\n/**\r\n * A  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 * @beta\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 [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.\r\n   */\r\n  public async getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\r\n    await this.getSchemaInfo(schemaKey, matchType, context);\r\n    return await context.getCachedSchema(schemaKey, matchType) as T;\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: Readonly<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<T extends Schema>(schemaKey: Readonly<SchemaKey>, _matchType: SchemaMatchType, context: SchemaContext): T | undefined {\r\n    const schemaProps = this._getSchema(schemaKey.name);\r\n    if (!schemaProps)\r\n      return undefined;\r\n\r\n    context = context ? context : new SchemaContext();\r\n    return Schema.fromJsonSync(schemaProps, context) as T;\r\n  }\r\n\r\n}\r\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":["/*---------------------------------------------------------------------------------------------\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"]}

package/lib/esm/SchemaKey.d.ts

@@ -10,6 +10,12 @@ export declare class ECVersion {
     private _read;
     private _write;
     private _minor;
+    /**
+     * Using a version with all zero is invalid
+     * for a schema, but it can be used to indicate
+     * "no version has been specified" when locating things
+     */
+    static readonly NO_VERSION: ECVersion;
     /**
      * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
      * @param read Can support up to 999.
@@ -76,7 +82,7 @@ export declare class SchemaKey {
      * @param rhs The SchemaKey to compare with
      * @param matchType The match type to use for comparison.
      */
-    matches(rhs: Readonly<SchemaKey>, matchType?: SchemaMatchType): boolean;
+    matches(rhs: SchemaKey, matchType?: SchemaMatchType): boolean;
     /**
      * Deserializes a SchemaKeyProps JSON object into a SchemaKey object.
      * @param props SchemaKeyProps

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;;;;;;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,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAuC,GAAG,OAAO;IA2BrG;;;;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,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"}

package/lib/esm/SchemaKey.js

@@ -12,6 +12,15 @@ import { ECName } from "./ECName";
  * @beta
  */
 export class ECVersion {
+    _read = 0;
+    _write = 0;
+    _minor = 0;
+    /**
+     * Using a version with all zero is invalid
+     * for a schema, but it can be used to indicate
+     * "no version has been specified" when locating things
+     */
+    static NO_VERSION = new ECVersion(0, 0, 0);
     /**
      * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
      * @param read Can support up to 999.
@@ -20,9 +29,6 @@ export class ECVersion {
      *
      */
     constructor(read, write, minor) {
-        this._read = 0;
-        this._write = 0;
-        this._minor = 0;
         if (undefined !== read)
             this._read = read;
         if (undefined !== write)
@@ -80,6 +86,8 @@ export class ECVersion {
  * @beta
  */
 export class SchemaKey {
+    _name;
+    _version;
     constructor(name, readOrVersion, writeVersion, minorVersion) {
         this._name = new ECName(name);
         if (readOrVersion !== undefined && typeof (readOrVersion) !== "number")
@@ -180,6 +188,8 @@ export class SchemaKey {
  * @beta
  */
 export class SchemaItemKey {
+    _name;
+    _schemaKey;
     constructor(name, schema) {
         this._name = new ECName(name);
         this._schemaKey = schema;