@itwin/ecschema-metadata 3.6.0-dev.51 → 3.6.0-dev.53

package/lib/cjs/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,4CAAiG;AACjG,4CAA+D;AAC/D,4CAAwD;AAGxD,MAAM,YAAY,GAAG,uDAAuD,CAAC;AAE7E;;;GAGG;AACH,MAAsB,UAAU;IAO9B,YAAY,MAAc,EAAE,IAAY;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAa,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;YACd,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;SAClE;QACD,QAAQ,CAAC,cAAc,GAAG,IAAA,kCAAsB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtE,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,IAAA,qCAAyB,EAAC,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;YACxC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;SACpP;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE;YAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5Q;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;YACxC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,wCAAwC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClP;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE;YAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5Q;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,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;AAjJD,gCAiJC","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, schemaItemTypeToString, 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 = schemaItemTypeToString(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 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;;;AAGH,4CAAiG;AACjG,4CAA+D;AAC/D,4CAAwD;AAGxD,MAAM,YAAY,GAAG,uDAAuD,CAAC;AAE7E;;;GAGG;AACH,MAAsB,UAAU;IAO9B,YAAY,MAAc,EAAE,IAAY;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAa,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;YACd,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;SAClE;QACD,QAAQ,CAAC,cAAc,GAAG,IAAA,kCAAsB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtE,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,IAAA,qCAAyB,EAAC,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;YACxC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;SACpP;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE;YAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5Q;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;YACxC,IAAI,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACzE,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,wCAAwC,IAAI,CAAC,QAAQ,mCAAmC,eAAe,CAAC,MAAM,iDAAiD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClP;QAED,IAAI,SAAS,KAAK,eAAe,CAAC,aAAa,EAAE;YAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAS,CAAC,UAAU,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;gBACzF,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,yCAAyC,IAAI,CAAC,QAAQ,sCAAsC,eAAe,CAAC,aAAa,yDAAyD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5Q;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,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;AAjJD,gCAiJC","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 { SchemaItemProps } from \"../Deserialization/JsonProps\";\nimport { SchemaItemType, schemaItemTypeToString, schemaItemTypeToXmlString } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECVersion, SchemaItemKey } from \"../SchemaKey\";\nimport { Schema } from \"./Schema\";\n\nconst SCHEMAURL3_2 = \"https://dev.bentley.com/json_schemas/ec/32/schemaitem\";\n\n/**\n * An abstract class that supplies all of the common parts of a SchemaItem.\n * @beta\n */\nexport abstract class SchemaItem {\n  public readonly schemaItemType!: SchemaItemType; // allow the derived classes to define their own 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 = SCHEMAURL3_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 = schemaItemTypeToString(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\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 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"]}

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

@@ -1,77 +1,77 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { UnitProps } from "../Deserialization/JsonProps";
-import { SchemaItemType } from "../ECObjects";
-import { LazyLoadedPhenomenon, LazyLoadedUnitSystem } from "../Interfaces";
-import { Schema } from "./Schema";
-import { SchemaItem } from "./SchemaItem";
-/**
- * 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 declare class Unit extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Unit;
-    protected _phenomenon?: LazyLoadedPhenomenon;
-    protected _unitSystem?: LazyLoadedUnitSystem;
-    protected _definition: string;
-    protected _numerator?: number;
-    protected _denominator?: number;
-    protected _offset?: number;
-    constructor(schema: Schema, name: string);
-    get phenomenon(): LazyLoadedPhenomenon | undefined;
-    get unitSystem(): LazyLoadedUnitSystem | undefined;
-    get definition(): string;
-    get numerator(): number;
-    get offset(): number;
-    get denominator(): number;
-    get hasNumerator(): boolean;
-    get hasOffset(): boolean;
-    get hasDenominator(): boolean;
-    /**
-     * Returns true if a conversion can be calculated between the input units
-     * @alpha
-     */
-    static areCompatible(unitA: Unit, unitB: Unit): Promise<boolean>;
-    /**
-     * @alpha
-     */
-    static isUnit(object: any): object is Unit;
-    /**
-     * Save this Unit's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): UnitProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(unitProps: UnitProps): void;
-    fromJSON(unitProps: UnitProps): Promise<void>;
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
-    protected setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
-    protected setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
-    protected setDefinition(definition: string): Promise<void>;
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutableUnit extends Unit {
-    abstract setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;
-    abstract setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;
-    abstract setDefinition(definition: string): Promise<void>;
-    abstract setDisplayLabel(displayLabel: string): void;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { UnitProps } from "../Deserialization/JsonProps";
+import { SchemaItemType } from "../ECObjects";
+import { LazyLoadedPhenomenon, LazyLoadedUnitSystem } from "../Interfaces";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+/**
+ * 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 declare class Unit extends SchemaItem {
+    readonly schemaItemType: SchemaItemType.Unit;
+    protected _phenomenon?: LazyLoadedPhenomenon;
+    protected _unitSystem?: LazyLoadedUnitSystem;
+    protected _definition: string;
+    protected _numerator?: number;
+    protected _denominator?: number;
+    protected _offset?: number;
+    constructor(schema: Schema, name: string);
+    get phenomenon(): LazyLoadedPhenomenon | undefined;
+    get unitSystem(): LazyLoadedUnitSystem | undefined;
+    get definition(): string;
+    get numerator(): number;
+    get offset(): number;
+    get denominator(): number;
+    get hasNumerator(): boolean;
+    get hasOffset(): boolean;
+    get hasDenominator(): boolean;
+    /**
+     * Returns true if a conversion can be calculated between the input units
+     * @alpha
+     */
+    static areCompatible(unitA: Unit, unitB: Unit): Promise<boolean>;
+    /**
+     * @alpha
+     */
+    static isUnit(object: any): object is Unit;
+    /**
+     * Save this Unit's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): UnitProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(unitProps: UnitProps): void;
+    fromJSON(unitProps: UnitProps): Promise<void>;
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    protected setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    protected setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    protected setDefinition(definition: string): Promise<void>;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableUnit extends Unit {
+    abstract setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;
+    abstract setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;
+    abstract setDefinition(definition: string): Promise<void>;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
 //# sourceMappingURL=Unit.d.ts.map

package/lib/cjs/Metadata/Unit.js

@@ -1,163 +1,163 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MutableUnit = exports.Unit = void 0;
-const DelayedPromise_1 = require("../DelayedPromise");
-const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
-const ECObjects_1 = require("../ECObjects");
-const Exception_1 = require("../Exception");
-const SchemaItem_1 = require("./SchemaItem");
-/**
- * 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
- */
-class Unit extends SchemaItem_1.SchemaItem {
-    constructor(schema, name) {
-        super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Unit;
-        this._definition = "";
-    }
-    get phenomenon() { return this._phenomenon; }
-    get unitSystem() { return this._unitSystem; }
-    get definition() { return this._definition; }
-    get numerator() { var _a; return (_a = this._numerator) !== null && _a !== void 0 ? _a : 1.0; }
-    get offset() { var _a; return (_a = this._offset) !== null && _a !== void 0 ? _a : 0.0; }
-    get denominator() { var _a; return (_a = this._denominator) !== null && _a !== void 0 ? _a : 1.0; }
-    get hasNumerator() { return (this._numerator !== undefined); }
-    get hasOffset() { return (this._offset !== undefined); }
-    get hasDenominator() { return (this._denominator !== undefined); }
-    /**
-     * Returns true if a conversion can be calculated between the input units
-     * @alpha
-     */
-    static async areCompatible(unitA, unitB) {
-        const unitAPhenomenon = await unitA.phenomenon;
-        const unitBPhenomenon = await unitB.phenomenon;
-        if (!unitAPhenomenon || !unitBPhenomenon || !unitAPhenomenon.key.matches(unitBPhenomenon.key))
-            return false;
-        return true;
-    }
-    /**
-     * @alpha
-     */
-    static isUnit(object) {
-        return SchemaItem_1.SchemaItem.isSchemaItem(object) && object.schemaItemType === ECObjects_1.SchemaItemType.Unit;
-    }
-    /**
-     * Save this Unit's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone = false, includeSchemaVersion = false) {
-        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
-        schemaJson.phenomenon = this.phenomenon.fullName;
-        schemaJson.unitSystem = this.unitSystem.fullName;
-        schemaJson.definition = this.definition;
-        if (this.hasNumerator)
-            schemaJson.numerator = this.numerator;
-        if (this.hasDenominator)
-            schemaJson.denominator = this.denominator;
-        if (this.hasOffset)
-            schemaJson.offset = this.offset;
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        const phenomenon = await this.phenomenon;
-        if (undefined !== phenomenon) {
-            const phenomenonName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);
-            itemElement.setAttribute("phenomenon", phenomenonName);
-        }
-        const unitSystem = await this.unitSystem;
-        if (undefined !== unitSystem) {
-            const unitSystemName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);
-            itemElement.setAttribute("unitSystem", unitSystemName);
-        }
-        itemElement.setAttribute("definition", this.definition);
-        if (this.hasNumerator)
-            itemElement.setAttribute("numerator", this.numerator.toString());
-        if (this.hasDenominator)
-            itemElement.setAttribute("denominator", this.denominator.toString());
-        if (this.hasOffset)
-            itemElement.setAttribute("offset", this.offset.toString());
-        return itemElement;
-    }
-    fromJSONSync(unitProps) {
-        super.fromJSONSync(unitProps);
-        const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);
-        if (!phenomenonSchemaItemKey)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
-        this._phenomenon = new DelayedPromise_1.DelayedPromiseWithProps(phenomenonSchemaItemKey, async () => {
-            const phenom = await this.schema.lookupItem(phenomenonSchemaItemKey);
-            if (undefined === phenom)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
-            return phenom;
-        });
-        const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);
-        if (!unitSystemSchemaItemKey)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
-        this._unitSystem = new DelayedPromise_1.DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
-            const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey);
-            if (undefined === unitSystem)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
-            return unitSystem;
-        });
-        if (this._definition !== "" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);
-        else if (this._definition === "")
-            this._definition = unitProps.definition;
-        if (undefined !== unitProps.numerator) {
-            if (unitProps.numerator !== this._numerator)
-                this._numerator = unitProps.numerator;
-        }
-        if (undefined !== unitProps.denominator) {
-            if (unitProps.denominator !== this._denominator)
-                this._denominator = unitProps.denominator;
-        }
-        if (undefined !== unitProps.offset) {
-            if (unitProps.offset !== this._offset)
-                this._offset = unitProps.offset;
-        }
-    }
-    async fromJSON(unitProps) {
-        this.fromJSONSync(unitProps);
-    }
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
-    async setPhenomenon(phenomenon) {
-        this._phenomenon = phenomenon;
-    }
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
-    async setUnitSystem(unitSystem) {
-        this._unitSystem = unitSystem;
-    }
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
-    async setDefinition(definition) {
-        this._definition = definition;
-    }
-}
-exports.Unit = Unit;
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-class MutableUnit extends Unit {
-}
-exports.MutableUnit = MutableUnit;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableUnit = exports.Unit = void 0;
+const DelayedPromise_1 = require("../DelayedPromise");
+const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const SchemaItem_1 = require("./SchemaItem");
+/**
+ * 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
+ */
+class Unit extends SchemaItem_1.SchemaItem {
+    constructor(schema, name) {
+        super(schema, name);
+        this.schemaItemType = ECObjects_1.SchemaItemType.Unit;
+        this._definition = "";
+    }
+    get phenomenon() { return this._phenomenon; }
+    get unitSystem() { return this._unitSystem; }
+    get definition() { return this._definition; }
+    get numerator() { var _a; return (_a = this._numerator) !== null && _a !== void 0 ? _a : 1.0; }
+    get offset() { var _a; return (_a = this._offset) !== null && _a !== void 0 ? _a : 0.0; }
+    get denominator() { var _a; return (_a = this._denominator) !== null && _a !== void 0 ? _a : 1.0; }
+    get hasNumerator() { return (this._numerator !== undefined); }
+    get hasOffset() { return (this._offset !== undefined); }
+    get hasDenominator() { return (this._denominator !== undefined); }
+    /**
+     * Returns true if a conversion can be calculated between the input units
+     * @alpha
+     */
+    static async areCompatible(unitA, unitB) {
+        const unitAPhenomenon = await unitA.phenomenon;
+        const unitBPhenomenon = await unitB.phenomenon;
+        if (!unitAPhenomenon || !unitBPhenomenon || !unitAPhenomenon.key.matches(unitBPhenomenon.key))
+            return false;
+        return true;
+    }
+    /**
+     * @alpha
+     */
+    static isUnit(object) {
+        return SchemaItem_1.SchemaItem.isSchemaItem(object) && object.schemaItemType === ECObjects_1.SchemaItemType.Unit;
+    }
+    /**
+     * Save this Unit's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.phenomenon = this.phenomenon.fullName;
+        schemaJson.unitSystem = this.unitSystem.fullName;
+        schemaJson.definition = this.definition;
+        if (this.hasNumerator)
+            schemaJson.numerator = this.numerator;
+        if (this.hasDenominator)
+            schemaJson.denominator = this.denominator;
+        if (this.hasOffset)
+            schemaJson.offset = this.offset;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        const phenomenon = await this.phenomenon;
+        if (undefined !== phenomenon) {
+            const phenomenonName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);
+            itemElement.setAttribute("phenomenon", phenomenonName);
+        }
+        const unitSystem = await this.unitSystem;
+        if (undefined !== unitSystem) {
+            const unitSystemName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);
+            itemElement.setAttribute("unitSystem", unitSystemName);
+        }
+        itemElement.setAttribute("definition", this.definition);
+        if (this.hasNumerator)
+            itemElement.setAttribute("numerator", this.numerator.toString());
+        if (this.hasDenominator)
+            itemElement.setAttribute("denominator", this.denominator.toString());
+        if (this.hasOffset)
+            itemElement.setAttribute("offset", this.offset.toString());
+        return itemElement;
+    }
+    fromJSONSync(unitProps) {
+        super.fromJSONSync(unitProps);
+        const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);
+        if (!phenomenonSchemaItemKey)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
+        this._phenomenon = new DelayedPromise_1.DelayedPromiseWithProps(phenomenonSchemaItemKey, async () => {
+            const phenom = await this.schema.lookupItem(phenomenonSchemaItemKey);
+            if (undefined === phenom)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
+            return phenom;
+        });
+        const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);
+        if (!unitSystemSchemaItemKey)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
+        this._unitSystem = new DelayedPromise_1.DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
+            const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey);
+            if (undefined === unitSystem)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
+            return unitSystem;
+        });
+        if (this._definition !== "" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);
+        else if (this._definition === "")
+            this._definition = unitProps.definition;
+        if (undefined !== unitProps.numerator) {
+            if (unitProps.numerator !== this._numerator)
+                this._numerator = unitProps.numerator;
+        }
+        if (undefined !== unitProps.denominator) {
+            if (unitProps.denominator !== this._denominator)
+                this._denominator = unitProps.denominator;
+        }
+        if (undefined !== unitProps.offset) {
+            if (unitProps.offset !== this._offset)
+                this._offset = unitProps.offset;
+        }
+    }
+    async fromJSON(unitProps) {
+        this.fromJSONSync(unitProps);
+    }
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    async setPhenomenon(phenomenon) {
+        this._phenomenon = phenomenon;
+    }
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    async setUnitSystem(unitSystem) {
+        this._unitSystem = unitSystem;
+    }
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    async setDefinition(definition) {
+        this._definition = definition;
+    }
+}
+exports.Unit = Unit;
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+class MutableUnit extends Unit {
+}
+exports.MutableUnit = MutableUnit;
 //# sourceMappingURL=Unit.js.map

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

@@ -1,21 +1,21 @@
-/** @packageDocumentation
- * @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);
-}
-/**
- * @internal
- * Used for schema editing.
- */
-export declare abstract class MutableUnitSystem extends UnitSystem {
-    abstract setDisplayLabel(displayLabel: string): void;
-}
+/** @packageDocumentation
+ * @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);
+}
+/**
+ * @internal
+ * Used for schema editing.
+ */
+export declare abstract class MutableUnitSystem extends UnitSystem {
+    abstract setDisplayLabel(displayLabel: string): void;
+}
 //# sourceMappingURL=UnitSystem.d.ts.map

package/lib/cjs/Metadata/UnitSystem.js

@@ -1,30 +1,30 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MutableUnitSystem = exports.UnitSystem = void 0;
-const ECObjects_1 = require("../ECObjects");
-const SchemaItem_1 = require("./SchemaItem");
-/**
- * @beta
- */
-class UnitSystem extends SchemaItem_1.SchemaItem {
-    constructor(schema, name) {
-        super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.UnitSystem;
-    }
-}
-exports.UnitSystem = UnitSystem;
-/**
- * @internal
- * Used for schema editing.
- */
-class MutableUnitSystem extends UnitSystem {
-}
-exports.MutableUnitSystem = MutableUnitSystem;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableUnitSystem = exports.UnitSystem = void 0;
+const ECObjects_1 = require("../ECObjects");
+const SchemaItem_1 = require("./SchemaItem");
+/**
+ * @beta
+ */
+class UnitSystem extends SchemaItem_1.SchemaItem {
+    constructor(schema, name) {
+        super(schema, name);
+        this.schemaItemType = ECObjects_1.SchemaItemType.UnitSystem;
+    }
+}
+exports.UnitSystem = UnitSystem;
+/**
+ * @internal
+ * Used for schema editing.
+ */
+class MutableUnitSystem extends UnitSystem {
+}
+exports.MutableUnitSystem = MutableUnitSystem;
 //# sourceMappingURL=UnitSystem.js.map