@itwin/ecschema-metadata 5.0.0-dev.8 → 5.0.0-dev.83

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

@@ -1 +1 @@
-{"version":3,"file":"Constant.js","sourceRoot":"","sources":["../../../src/Metadata/Constant.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;AAE1C;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,UAAU;IAOtC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,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,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,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElF;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAC/B,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACnD,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,OAAO,UAA2B,CAAC;IACrC,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,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;QAEvE,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,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,aAA4B;QACvD,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAElC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,aAAa,CAAC,UAAU,GAAG,CAAC,CAAC;QAC1H,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,aAAa,EACrF,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,aAAa,CAAC,CAAC;YACvE,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,aAAa,CAAC,UAAU,GAAG,CAAC,CAAC;YAC1H,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,aAAa,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACtG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,gBAAgB,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACzH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,UAAU,CAAC;QAE9C,IAAI,SAAS,KAAK,aAAa,CAAC,SAAS,EAAE,CAAC;YAC1C,IAAI,aAAa,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBAC7C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC;QAC9C,CAAC;QAED,IAAI,SAAS,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC;YAC5C,IAAI,aAAa,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBACjD,IAAI,CAAC,YAAY,GAAG,aAAa,CAAC,WAAW,CAAC;QAClD,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,aAA4B;QACzD,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAgC;QACtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAAkB;QACxC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,SAAiB;QACtC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,eAAgB,SAAQ,QAAQ;CAMrD","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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\nimport { ConstantProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { LazyLoadedPhenomenon } from \"../Interfaces\";\nimport { SchemaItemKey } from \"../SchemaKey\";\nimport { Phenomenon } from \"./Phenomenon\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * A Constant is a specific type of Unit that represents a number.\n * @beta\n */\nexport class Constant extends SchemaItem {\n  public override readonly schemaItemType!: SchemaItemType.Constant;\n  protected _phenomenon?: LazyLoadedPhenomenon;\n  protected _definition: string;\n  protected _numerator?: number;\n  protected _denominator?: number;\n\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this.schemaItemType = SchemaItemType.Constant;\n    this._definition = \"\";\n  }\n\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\n  public get definition(): string { return this._definition; }\n  public get numerator(): number { return this._numerator ?? 1.0; }\n  public get denominator(): number { return this._denominator ?? 1.0; }\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\n\n  /**\n   * Save this Constants 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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): ConstantProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    if (this.phenomenon !== undefined)\n      schemaJson.phenomenon = this.phenomenon.fullName;\n    schemaJson.definition = this.definition;\n    if (this.hasNumerator)\n      schemaJson.numerator = this.numerator;\n    if (this.hasDenominator)\n      schemaJson.denominator = this.denominator;\n    return schemaJson as ConstantProps;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"definition\", this.definition);\n    if (this.hasNumerator)\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\n    if (this.hasDenominator)\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\n\n    const phenomenon = await this.phenomenon;\n    if (undefined !== phenomenon) {\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(constantProps: ConstantProps) {\n    super.fromJSONSync(constantProps);\n\n    const schemaItemKey = this.schema.getSchemaItemKey(constantProps.phenomenon);\n    if (!schemaItemKey)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(schemaItemKey,\n      async () => {\n        const phenom = await this.schema.lookupItem<Phenomenon>(schemaItemKey);\n        if (undefined === phenom)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);\n        return phenom;\n      });\n\n    if (this._definition !== \"\" && constantProps.definition.toLowerCase() !== this._definition.toLowerCase())\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Constant ${this.name} has an invalid 'definition' attribute.`);\n    else if (this._definition === \"\")\n      this._definition = constantProps.definition;\n\n    if (undefined !== constantProps.numerator) {\n      if (constantProps.numerator !== this._numerator)\n        this._numerator = constantProps.numerator;\n    }\n\n    if (undefined !== constantProps.denominator) {\n      if (constantProps.denominator !== this._denominator)\n        this._denominator = constantProps.denominator;\n    }\n  }\n\n  public override async fromJSON(constantProps: ConstantProps) {\n    this.fromJSONSync(constantProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   * @param phenomenon A LazyLoadedPhenomenon.\n   */\n  protected setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\n    this._phenomenon = phenomenon;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setDefinition(definition: string) {\n    this._definition = definition;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setNumerator(numerator: number) {\n    this._numerator = numerator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setDenominator(denominator: number) {\n    this._denominator = denominator;\n  }\n}\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableConstant extends Constant {\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): void;\n  public abstract override setDefinition(definition: string): void;\n  public abstract override setNumerator(numerator: number): void;\n  public abstract override setDenominator(denominator: number): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"Constant.js","sourceRoot":"","sources":["../../../src/Metadata/Constant.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;AAE1C;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,UAAU;IACb,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC;IAC3D,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrE,WAAW,CAAwB;IACnC,WAAW,CAAS;IACpB,UAAU,CAAU;IACpB,YAAY,CAAU;IAEhC,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,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC;IACjE,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,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElF;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAC/B,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QACnD,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,OAAO,UAA2B,CAAC;IACrC,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,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;QAEvE,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,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,aAA4B;QACvD,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAElC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,aAAa,CAAC,UAAU,GAAG,CAAC,CAAC;QAC1H,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,aAAa,EACrF,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;YACvE,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,aAAa,CAAC,UAAU,GAAG,CAAC,CAAC;YAC1H,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,aAAa,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACtG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,gBAAgB,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACzH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,UAAU,CAAC;QAE9C,IAAI,SAAS,KAAK,aAAa,CAAC,SAAS,EAAE,CAAC;YAC1C,IAAI,aAAa,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBAC7C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC;QAC9C,CAAC;QAED,IAAI,SAAS,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC;YAC5C,IAAI,aAAa,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBACjD,IAAI,CAAC,YAAY,GAAG,aAAa,CAAC,WAAW,CAAC;QAClD,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,aAA4B;QACzD,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAgC;QACtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAAkB;QACxC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,SAAiB;QACtC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,IAAiB;QACxC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,QAAQ;YACzD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAiB;QAC9C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,QAAQ,cAAc,CAAC,CAAC;IACxH,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,eAAgB,SAAQ,QAAQ;CAMrD","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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\nimport { ConstantProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { LazyLoadedPhenomenon } from \"../Interfaces\";\nimport { SchemaItemKey } from \"../SchemaKey\";\nimport { Phenomenon } from \"./Phenomenon\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * A Constant is a specific type of Unit that represents a number.\n * @beta\n */\nexport class Constant extends SchemaItem {\n  public override readonly schemaItemType = Constant.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Constant; }\n  protected _phenomenon?: LazyLoadedPhenomenon;\n  protected _definition: string;\n  protected _numerator?: number;\n  protected _denominator?: number;\n\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this._definition = \"\";\n  }\n\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\n  public get definition(): string { return this._definition; }\n  public get numerator(): number { return this._numerator ?? 1.0; }\n  public get denominator(): number { return this._denominator ?? 1.0; }\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\n\n  /**\n   * Save this Constants 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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): ConstantProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    if (this.phenomenon !== undefined)\n      schemaJson.phenomenon = this.phenomenon.fullName;\n    schemaJson.definition = this.definition;\n    if (this.hasNumerator)\n      schemaJson.numerator = this.numerator;\n    if (this.hasDenominator)\n      schemaJson.denominator = this.denominator;\n    return schemaJson as ConstantProps;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"definition\", this.definition);\n    if (this.hasNumerator)\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\n    if (this.hasDenominator)\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\n\n    const phenomenon = await this.phenomenon;\n    if (undefined !== phenomenon) {\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(constantProps: ConstantProps) {\n    super.fromJSONSync(constantProps);\n\n    const schemaItemKey = this.schema.getSchemaItemKey(constantProps.phenomenon);\n    if (!schemaItemKey)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(schemaItemKey,\n      async () => {\n        const phenom = await this.schema.lookupItem(schemaItemKey, Phenomenon);\n        if (undefined === phenom)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);\n        return phenom;\n      });\n\n    if (this._definition !== \"\" && constantProps.definition.toLowerCase() !== this._definition.toLowerCase())\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Constant ${this.name} has an invalid 'definition' attribute.`);\n    else if (this._definition === \"\")\n      this._definition = constantProps.definition;\n\n    if (undefined !== constantProps.numerator) {\n      if (constantProps.numerator !== this._numerator)\n        this._numerator = constantProps.numerator;\n    }\n\n    if (undefined !== constantProps.denominator) {\n      if (constantProps.denominator !== this._denominator)\n        this._denominator = constantProps.denominator;\n    }\n  }\n\n  public override async fromJSON(constantProps: ConstantProps) {\n    this.fromJSONSync(constantProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   * @param phenomenon A LazyLoadedPhenomenon.\n   */\n  protected setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\n    this._phenomenon = phenomenon;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setDefinition(definition: string) {\n    this._definition = definition;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setNumerator(numerator: number) {\n    this._numerator = numerator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setDenominator(denominator: number) {\n    this._denominator = denominator;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Constant.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Constant, false otherwise.\n   */\n  public static isConstant(item?: SchemaItem): item is Constant {\n    if (item && item.schemaItemType === SchemaItemType.Constant)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Constant.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Constant if it is a Constant, undefined otherwise.\n   */\n  public static assertIsConstant(item?: SchemaItem): asserts item is Constant {\n    if (!this.isConstant(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Constant}' (Constant)`);\n  }\n}\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableConstant extends Constant {\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): void;\n  public abstract override setDefinition(definition: string): void;\n  public abstract override setNumerator(numerator: number): void;\n  public abstract override setDenominator(denominator: number): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

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

@@ -2,22 +2,22 @@
  * @module Metadata
  */
 import { CustomAttributeClassProps } from "../Deserialization/JsonProps";
-import { CustomAttributeContainerType, ECClassModifier, SchemaItemType } from "../ECObjects";
+import { CustomAttributeContainerType, SchemaItemType } from "../ECObjects";
 import { ECClass } from "./Class";
-import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
 /**
  * A Typescript class representation of an ECCustomAttributeClass.
  * @beta
  */
 export declare class CustomAttributeClass extends ECClass {
-    readonly schemaItemType: SchemaItemType.CustomAttributeClass;
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
     protected _appliesTo?: CustomAttributeContainerType;
     /**
      * @deprecated in 4.8 use [[appliesTo]]
      * */
     get containerType(): CustomAttributeContainerType;
     get appliesTo(): CustomAttributeContainerType;
-    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
     /**
      * Save this CustomAttributeClasses properties to an object for serializing to JSON.
      * @param standalone Serialization includes only this object (as opposed to the full schema).
@@ -32,6 +32,18 @@ export declare class CustomAttributeClass extends ECClass {
      * @alpha Used in schema editing.
      */
     protected setAppliesTo(containerType: CustomAttributeContainerType): void;
+    /**
+     * Type guard to check if the SchemaItem is of type CustomAttributeClass.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a CustomAttributeClass, false otherwise.
+     */
+    static isCustomAttributeClass(item?: SchemaItem): item is CustomAttributeClass;
+    /**
+     * Type assertion to check if the SchemaItem is of type CustomAttributeClass.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to CustomAttributeClass if it is a CustomAttributeClass, undefined otherwise.
+     */
+    static assertIsCustomAttributeClass(item?: SchemaItem): asserts item is CustomAttributeClass;
 }
 /**
  * @internal

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

@@ -1 +1 @@
-{"version":3,"file":"CustomAttributeClass.d.ts","sourceRoot":"","sources":["../../../src/Metadata/CustomAttributeClass.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EACkB,4BAA4B,EAAE,eAAe,EAAqC,cAAc,EACxH,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,OAAO;IAC/C,SAAyB,cAAc,EAAG,cAAc,CAAC,oBAAoB,CAAC;IAC9E,SAAS,CAAC,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAEpD;;SAEK;IACL,IAAW,aAAa,IAAI,4BAA4B,CAEvD;IAED,IAAW,SAAS,IAAI,4BAA4B,CAInD;gBAEW,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe;IAKpE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,yBAAyB;IAMrH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,oBAAoB,EAAE,yBAAyB;IAQtD,QAAQ,CAAC,oBAAoB,EAAE,yBAAyB;IAI9E;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,4BAA4B;CAGnE;AACD;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,oBAAoB;aACtC,YAAY,CAAC,aAAa,EAAE,4BAA4B,GAAG,IAAI;aAC/D,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"CustomAttributeClass.d.ts","sourceRoot":"","sources":["../../../src/Metadata/CustomAttributeClass.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EACkB,4BAA4B,EAAqC,cAAc,EACvG,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,OAAO;IAC/C,SAAyB,cAAc,iBAAuC;IAC9E,WAA2B,cAAc,mBAAkD;IAC3F,SAAS,CAAC,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAEpD;;SAEK;IACL,IAAW,aAAa,IAAI,4BAA4B,CAEvD;IAED,IAAW,SAAS,IAAI,4BAA4B,CAInD;IAED;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,yBAAyB;IAMrH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,oBAAoB,EAAE,yBAAyB;IAQtD,QAAQ,CAAC,oBAAoB,EAAE,yBAAyB;IAI9E;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,4BAA4B;IAIlE;;;;OAIG;WACW,sBAAsB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,oBAAoB;IAOrF;;;;OAIG;WACW,4BAA4B,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,oBAAoB;CAIpG;AACD;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,oBAAoB;aACtC,YAAY,CAAC,aAAa,EAAE,4BAA4B,GAAG,IAAI;aAC/D,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/CustomAttributeClass.js

@@ -13,6 +13,9 @@ import { ECClass } from "./Class";
  * @beta
  */
 export class CustomAttributeClass extends ECClass {
+    schemaItemType = CustomAttributeClass.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.CustomAttributeClass; }
+    _appliesTo;
     /**
      * @deprecated in 4.8 use [[appliesTo]]
      * */
@@ -24,10 +27,6 @@ export class CustomAttributeClass extends ECClass {
             throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `The CustomAttributeClass ${this.name} does not have a CustomAttributeContainerType.`);
         return this._appliesTo;
     }
-    constructor(schema, name, modifier) {
-        super(schema, name, modifier);
-        this.schemaItemType = SchemaItemType.CustomAttributeClass;
-    }
     /**
      * Save this CustomAttributeClasses properties to an object for serializing to JSON.
      * @param standalone Serialization includes only this object (as opposed to the full schema).
@@ -60,6 +59,25 @@ export class CustomAttributeClass extends ECClass {
     setAppliesTo(containerType) {
         this._appliesTo = containerType;
     }
+    /**
+     * Type guard to check if the SchemaItem is of type CustomAttributeClass.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a CustomAttributeClass, false otherwise.
+     */
+    static isCustomAttributeClass(item) {
+        if (item && item.schemaItemType === SchemaItemType.CustomAttributeClass)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type CustomAttributeClass.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to CustomAttributeClass if it is a CustomAttributeClass, undefined otherwise.
+     */
+    static assertIsCustomAttributeClass(item) {
+        if (!this.isCustomAttributeClass(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.CustomAttributeClass}' (CustomAttributeClass)`);
+    }
 }
 /**
  * @internal

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

@@ -1 +1 @@
-{"version":3,"file":"CustomAttributeClass.js","sourceRoot":"","sources":["../../../src/Metadata/CustomAttributeClass.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,qBAAqB,EAAiD,iCAAiC,EAAE,cAAc,GACxH,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAO;IAI/C;;SAEK;IACL,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,SAAS;QAClB,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,4BAA4B,IAAI,CAAC,IAAI,gDAAgD,CAAC,CAAC;QACxJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,YAAY,MAAc,EAAE,IAAY,EAAE,QAA0B;QAClE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,oBAAoB,CAAC;IAC5D,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,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,OAAO,UAAuC,CAAC;IACjD,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7E,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,oBAA+C;QAC1E,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,iCAAiC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACpF,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,GAAG,SAAS,+CAA+C,CAAC,CAAC;QAC9H,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,oBAA+C;QAC5E,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,aAA2C;QAChE,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC;IAClC,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,cAAe,SAAQ,oBAAoB;CAGhE","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 { CustomAttributeClassProps } from \"../Deserialization/JsonProps\";\nimport {\n  containerTypeToString, CustomAttributeContainerType, ECClassModifier, parseCustomAttributeContainerType, SchemaItemType,\n} from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECClass } from \"./Class\";\nimport { Schema } from \"./Schema\";\n\n/**\n * A Typescript class representation of an ECCustomAttributeClass.\n * @beta\n */\nexport class CustomAttributeClass extends ECClass {\n  public override readonly schemaItemType!: SchemaItemType.CustomAttributeClass;\n  protected _appliesTo?: CustomAttributeContainerType;\n\n  /**\n   * @deprecated in 4.8 use [[appliesTo]]\n   * */\n  public get containerType(): CustomAttributeContainerType {\n    return this.appliesTo;\n  }\n\n  public get appliesTo(): CustomAttributeContainerType {\n    if (undefined === this._appliesTo)\n      throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `The CustomAttributeClass ${this.name} does not have a CustomAttributeContainerType.`);\n    return this._appliesTo;\n  }\n\n  constructor(schema: Schema, name: string, modifier?: ECClassModifier) {\n    super(schema, name, modifier);\n    this.schemaItemType = SchemaItemType.CustomAttributeClass;\n  }\n\n  /**\n   * Save this CustomAttributeClasses 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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): CustomAttributeClassProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.appliesTo = containerTypeToString(this.appliesTo);\n    return schemaJson as CustomAttributeClassProps;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"appliesTo\", containerTypeToString(this.appliesTo));\n    return itemElement;\n  }\n\n  public override fromJSONSync(customAttributeProps: CustomAttributeClassProps) {\n    super.fromJSONSync(customAttributeProps);\n    const appliesTo = parseCustomAttributeContainerType(customAttributeProps.appliesTo);\n    if (undefined === appliesTo)\n      throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `${appliesTo} is not a valid CustomAttributeContainerType.`);\n    this._appliesTo = appliesTo;\n  }\n\n  public override async fromJSON(customAttributeProps: CustomAttributeClassProps) {\n    this.fromJSONSync(customAttributeProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setAppliesTo(containerType: CustomAttributeContainerType) {\n    this._appliesTo = containerType;\n  }\n}\n/**\n * @internal\n * An abstract class used for Schema editing.\n */\nexport abstract class MutableCAClass extends CustomAttributeClass {\n  public abstract override setAppliesTo(containerType: CustomAttributeContainerType): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"CustomAttributeClass.js","sourceRoot":"","sources":["../../../src/Metadata/CustomAttributeClass.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,qBAAqB,EAAgC,iCAAiC,EAAE,cAAc,GACvG,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAO;IACtB,cAAc,GAAG,oBAAoB,CAAC,cAAc,CAAC;IACvE,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjF,UAAU,CAAgC;IAEpD;;SAEK;IACL,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,SAAS;QAClB,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,4BAA4B,IAAI,CAAC,IAAI,gDAAgD,CAAC,CAAC;QACxJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,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,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,OAAO,UAAuC,CAAC;IACjD,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7E,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,oBAA+C;QAC1E,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,iCAAiC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACpF,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,GAAG,SAAS,+CAA+C,CAAC,CAAC;QAC9H,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,oBAA+C;QAC5E,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,aAA2C;QAChE,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAiB;QACpD,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,oBAAoB;YACrE,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAiB;QAC1D,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC;YACpC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,oBAAoB,0BAA0B,CAAC,CAAC;IAChJ,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,cAAe,SAAQ,oBAAoB;CAGhE","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 { CustomAttributeClassProps } from \"../Deserialization/JsonProps\";\nimport {\n  containerTypeToString, CustomAttributeContainerType, parseCustomAttributeContainerType, SchemaItemType,\n} from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECClass } from \"./Class\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * A Typescript class representation of an ECCustomAttributeClass.\n * @beta\n */\nexport class CustomAttributeClass extends ECClass {\n  public override readonly schemaItemType = CustomAttributeClass.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.CustomAttributeClass; }\n  protected _appliesTo?: CustomAttributeContainerType;\n\n  /**\n   * @deprecated in 4.8 use [[appliesTo]]\n   * */\n  public get containerType(): CustomAttributeContainerType {\n    return this.appliesTo;\n  }\n\n  public get appliesTo(): CustomAttributeContainerType {\n    if (undefined === this._appliesTo)\n      throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `The CustomAttributeClass ${this.name} does not have a CustomAttributeContainerType.`);\n    return this._appliesTo;\n  }\n\n  /**\n   * Save this CustomAttributeClasses 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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): CustomAttributeClassProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.appliesTo = containerTypeToString(this.appliesTo);\n    return schemaJson as CustomAttributeClassProps;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"appliesTo\", containerTypeToString(this.appliesTo));\n    return itemElement;\n  }\n\n  public override fromJSONSync(customAttributeProps: CustomAttributeClassProps) {\n    super.fromJSONSync(customAttributeProps);\n    const appliesTo = parseCustomAttributeContainerType(customAttributeProps.appliesTo);\n    if (undefined === appliesTo)\n      throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `${appliesTo} is not a valid CustomAttributeContainerType.`);\n    this._appliesTo = appliesTo;\n  }\n\n  public override async fromJSON(customAttributeProps: CustomAttributeClassProps) {\n    this.fromJSONSync(customAttributeProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setAppliesTo(containerType: CustomAttributeContainerType) {\n    this._appliesTo = containerType;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type CustomAttributeClass.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a CustomAttributeClass, false otherwise.\n   */\n  public static isCustomAttributeClass(item?: SchemaItem): item is CustomAttributeClass {\n    if (item && item.schemaItemType === SchemaItemType.CustomAttributeClass)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type CustomAttributeClass.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to CustomAttributeClass if it is a CustomAttributeClass, undefined otherwise.\n   */\n  public static assertIsCustomAttributeClass(item?: SchemaItem): asserts item is CustomAttributeClass {\n    if (!this.isCustomAttributeClass(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.CustomAttributeClass}' (CustomAttributeClass)`);\n  }\n}\n/**\n * @internal\n * An abstract class used for Schema editing.\n */\nexport abstract class MutableCAClass extends CustomAttributeClass {\n  public abstract override setAppliesTo(containerType: CustomAttributeContainerType): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

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

@@ -2,21 +2,21 @@
  * @module Metadata
  */
 import { EntityClassProps } from "../Deserialization/JsonProps";
-import { ECClassModifier, SchemaItemType, StrengthDirection } from "../ECObjects";
-import { LazyLoadedMixin } from "../Interfaces";
+import { SchemaItemType, StrengthDirection } from "../ECObjects";
+import { HasMixins, LazyLoadedMixin } from "../Interfaces";
 import { ECClass } from "./Class";
 import { Mixin } from "./Mixin";
 import { AnyProperty, NavigationProperty, Property } from "./Property";
 import { RelationshipClass } from "./RelationshipClass";
-import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
 /**
  * A Typescript class representation of an ECEntityClass.
  * @beta
  */
-export declare class EntityClass extends ECClass {
-    readonly schemaItemType: SchemaItemType.EntityClass;
+export declare class EntityClass extends ECClass implements HasMixins {
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
     protected _mixins?: LazyLoadedMixin[];
-    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
     get mixins(): LazyLoadedMixin[];
     getMixinsSync(): Iterable<Mixin>;
     /**
@@ -60,6 +60,18 @@ export declare class EntityClass extends ECClass {
     toXml(schemaXml: Document): Promise<Element>;
     fromJSON(entityClassProps: EntityClassProps): Promise<void>;
     fromJSONSync(entityClassProps: EntityClassProps): void;
+    /**
+     * Type guard to check if the SchemaItem is of type EntityClass.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is an EntityClass, false otherwise.
+     */
+    static isEntityClass(item?: SchemaItem): item is EntityClass;
+    /**
+     * Type assertion to check if the SchemaItem is of type EntityClass.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to EntityClass if it is an EntityClass, undefined otherwise.
+     */
+    static assertIsEntityClass(item?: SchemaItem): asserts item is EntityClass;
 }
 /**
  * Hackish approach that works like a "friend class" so we can access protected members without making them public.

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

@@ -1 +1 @@
-{"version":3,"file":"EntityClass.d.ts","sourceRoot":"","sources":["../../../src/Metadata/EntityClass.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,eAAe,EAA0B,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAE1G,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACtC,SAAyB,cAAc,EAAG,cAAc,CAAC,WAAW,CAAC;IACrE,SAAS,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;gBAE1B,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe;IAKpE,IAAW,MAAM,IAAI,eAAe,EAAE,CAIrC;IAEO,aAAa,IAAI,QAAQ,CAAC,KAAK,CAAC;IAYxC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK;IAQ/B;;;OAGG;IACmB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAc1F;;;OAGG;IACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;cAsBnD,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;cAmBnI,sBAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,GAAE,OAAe,GAAG,IAAI;IAoB3I;;;;;OAKG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK;;;;;OAKG;IACH,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,gBAAgB;IAO5G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAY5C,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB;IAIjD,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;CAoBhE;AAED;;;GAGG;AACH,8BAAsB,kBAAmB,SAAQ,WAAW;aACjC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,GAAG;aAC3B,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;aACpJ,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE;AAED,gBAAgB;AAChB,wBAAsB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAsB3L;AAED,gBAAgB;AAChB,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB,CAsBhL"}
+{"version":3,"file":"EntityClass.d.ts","sourceRoot":"","sources":["../../../src/Metadata/EntityClass.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAA0B,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEzF,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,OAAQ,YAAW,SAAS;IAC3D,SAAyB,cAAc,iBAA8B;IACrE,WAA2B,cAAc,mBAAyC;IAClF,SAAS,CAAC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAEtC,IAAW,MAAM,IAAI,eAAe,EAAE,CAIrC;IAEO,aAAa,IAAI,QAAQ,CAAC,KAAK,CAAC;IAYxC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK;IAQ/B;;;OAGG;IACmB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAc1F;;;OAGG;IACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;cAsBnD,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;cAmBnI,sBAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,GAAE,OAAe,GAAG,IAAI;IAoB3I;;;;;OAKG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK;;;;;OAKG;IACH,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,gBAAgB;IAO5G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAY5C,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB;IAIjD,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;IAqB/D;;;;OAIG;WACW,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,WAAW;IAOnE;;;;OAIG;WACW,mBAAmB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW;CAIlF;AAED;;;GAGG;AACH,8BAAsB,kBAAmB,SAAQ,WAAW;aACjC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,GAAG;aAC3B,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;aACpJ,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE;AAED,gBAAgB;AAChB,wBAAsB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAsB3L;AAED,gBAAgB;AAChB,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB,CAsBhL"}

package/lib/esm/Metadata/EntityClass.js

@@ -10,16 +10,17 @@ import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils"
 import { parseStrengthDirection, SchemaItemType } from "../ECObjects";
 import { ECObjectsError, ECObjectsStatus } from "../Exception";
 import { ECClass } from "./Class";
+import { Mixin } from "./Mixin";
 import { NavigationProperty } from "./Property";
+import { RelationshipClass } from "./RelationshipClass";
 /**
  * A Typescript class representation of an ECEntityClass.
  * @beta
  */
 export class EntityClass extends ECClass {
-    constructor(schema, name, modifier) {
-        super(schema, name, modifier);
-        this.schemaItemType = SchemaItemType.EntityClass;
-    }
+    schemaItemType = EntityClass.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.EntityClass; }
+    _mixins;
     get mixins() {
         if (!this._mixins)
             return [];
@@ -29,7 +30,7 @@ export class EntityClass extends ECClass {
         if (!this._mixins)
             return function* () { }(); // empty iterable
         for (const mixin of this._mixins) {
-            const mObj = this.schema.lookupItemSync(mixin);
+            const mObj = this.schema.lookupItemSync(mixin, Mixin);
             if (mObj) {
                 yield mObj;
             }
@@ -73,7 +74,7 @@ export class EntityClass extends ECClass {
         }
         for (const mixin of this._mixins) {
             const mObj = this.schema.lookupItemSync(mixin);
-            if (mObj) {
+            if (mObj && ECClass.isECClass(mObj)) {
                 const result = mObj.getPropertySync(name, true);
                 if (result) {
                     return result;
@@ -164,7 +165,7 @@ export class EntityClass extends ECClass {
                 if (!mixinSchemaItemKey)
                     throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
                 this._mixins.push(new DelayedPromiseWithProps(mixinSchemaItemKey, async () => {
-                    const mixin = await this.schema.lookupItem(mixinSchemaItemKey);
+                    const mixin = await this.schema.lookupItem(mixinSchemaItemKey, Mixin);
                     if (undefined === mixin)
                         throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
                     return mixin;
@@ -172,6 +173,25 @@ export class EntityClass extends ECClass {
             }
         }
     }
+    /**
+     * Type guard to check if the SchemaItem is of type EntityClass.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is an EntityClass, false otherwise.
+     */
+    static isEntityClass(item) {
+        if (item && item.schemaItemType === SchemaItemType.EntityClass)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type EntityClass.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to EntityClass if it is an EntityClass, undefined otherwise.
+     */
+    static assertIsEntityClass(item) {
+        if (!this.isEntityClass(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.EntityClass}' (EntityClass)`);
+    }
 }
 /**
  * Hackish approach that works like a "friend class" so we can access protected members without making them public.
@@ -185,7 +205,7 @@ export async function createNavigationProperty(ecClass, name, relationship, dire
         throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);
     let resolvedRelationship;
     if (typeof (relationship) === "string") {
-        resolvedRelationship = await ecClass.schema.lookupItem(relationship);
+        resolvedRelationship = await ecClass.schema.lookupItem(relationship, RelationshipClass);
     }
     else
         resolvedRelationship = relationship;
@@ -206,7 +226,7 @@ export function createNavigationPropertySync(ecClass, name, relationship, direct
         throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);
     let resolvedRelationship;
     if (typeof (relationship) === "string") {
-        resolvedRelationship = ecClass.schema.lookupItemSync(relationship);
+        resolvedRelationship = ecClass.schema.lookupItemSync(relationship, RelationshipClass);
     }
     else
         resolvedRelationship = relationship;

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

@@ -1 +1 @@
-{"version":3,"file":"EntityClass.js","sourceRoot":"","sources":["../../../src/Metadata/EntityClass.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,EAAmB,sBAAsB,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAC1G,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,OAAO,EAAe,kBAAkB,EAAY,MAAM,YAAY,CAAC;AAIvE;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IAItC,YAAY,MAAc,EAAE,IAAY,EAAE,QAA0B;QAClE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,WAAW,CAAC;IACnD,CAAC;IAED,IAAW,MAAM;QACf,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,CAAC,aAAa;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO,QAAQ,CAAC,MAAuB,CAAC,EAAE,CAAC,CAAC,iBAAiB;QAE/D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAQ,KAAK,CAAC,CAAC;YACtD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,QAAQ,CAAC,KAAY;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7E,OAAO;IACT,CAAC;IAED;;;OAGG;IACa,KAAK,CAAC,oBAAoB,CAAC,IAAY;QACrD,IAAI,iBAAiB,GAAG,MAAM,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAE/D,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACzG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvB,iBAAiB,GAAG,IAAmB,CAAC;gBACxC,OAAO,iBAAiB,KAAK,SAAS,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,iBAA4C,CAAC;IACtD,CAAC;IAED;;;OAGG;IACa,wBAAwB,CAAC,IAAY;QACnD,MAAM,iBAAiB,GAAG,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,iBAAiB;YACnB,OAAO,iBAAiB,CAAC;QAE3B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAU,KAAK,CAAC,CAAC;YACxD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CAAC,MAAkB,EAAE,cAAoC,EAAE,kBAA2B,KAAK;QACpI,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACtH,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7G,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO;QAET,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEkB,sBAAsB,CAAC,MAAkB,EAAE,cAAoC,EAAE,kBAA2B,KAAK;QAClI,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACvG,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO;QAET,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACO,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7F,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,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YACxB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjE,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,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,SAAS,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAClG,YAAY,CAAC,WAAW,GAAG,SAAS,CAAC;YACrC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QAErC,IAAI,SAAS,KAAK,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC3C,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC9D,IAAI,CAAC,kBAAkB;oBACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,IAAI,0BAA0B,CAAC,CAAC;gBAC1I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAuB,kBAAkB,EACpF,KAAK,IAAI,EAAE;oBACT,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAQ,kBAAkB,CAAC,CAAC;oBACtE,IAAI,SAAS,KAAK,KAAK;wBACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,IAAI,0BAA0B,CAAC,CAAC;oBAC1I,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC,CAAC;YACR,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAW;CAK3D;AAED,gBAAgB;AAChB,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,OAAgB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;IAC5J,IAAI,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QACjC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,IAAI,gCAAgC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAElJ,IAAI,oBAAmD,CAAC;IACxD,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvC,oBAAoB,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAoB,YAAY,CAAC,CAAC;IAC1F,CAAC;;QACC,oBAAoB,GAAG,YAAY,CAAC;IAEtC,IAAI,CAAC,oBAAoB;QACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,mCAAmC,YAAY,8CAA8C,CAAC,CAAC,CAAE,2DAA2D;IAEpN,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,wBAAwB,EAAE,mCAAmC,SAAS,qCAAqC,CAAC,CAAC;QACxJ,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACjH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC5E,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,4BAA4B,CAAC,OAAgB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;IAC1J,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC;QAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,IAAI,gCAAgC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAElJ,IAAI,oBAAmD,CAAC;IACxD,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvC,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAoB,YAAY,CAAC,CAAC;IACxF,CAAC;;QACC,oBAAoB,GAAG,YAAY,CAAC;IAEtC,IAAI,CAAC,oBAAoB;QACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,mCAAmC,YAAY,8CAA8C,CAAC,CAAC,CAAE,2DAA2D;IAEpN,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,wBAAwB,EAAE,mCAAmC,SAAS,qCAAqC,CAAC,CAAC;QACxJ,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACjH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC5E,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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\nimport { EntityClassProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { ECClassModifier, parseStrengthDirection, SchemaItemType, StrengthDirection } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { LazyLoadedMixin } from \"../Interfaces\";\nimport { SchemaItemKey } from \"../SchemaKey\";\nimport { ECClass } from \"./Class\";\nimport { Mixin } from \"./Mixin\";\nimport { AnyProperty, NavigationProperty, Property } from \"./Property\";\nimport { RelationshipClass } from \"./RelationshipClass\";\nimport { Schema } from \"./Schema\";\n\n/**\n * A Typescript class representation of an ECEntityClass.\n * @beta\n */\nexport class EntityClass extends ECClass {\n  public override readonly schemaItemType!: SchemaItemType.EntityClass;\n  protected _mixins?: LazyLoadedMixin[];\n\n  constructor(schema: Schema, name: string, modifier?: ECClassModifier) {\n    super(schema, name, modifier);\n    this.schemaItemType = SchemaItemType.EntityClass;\n  }\n\n  public get mixins(): LazyLoadedMixin[] {\n    if (!this._mixins)\n      return [];\n    return this._mixins;\n  }\n\n  public *getMixinsSync(): Iterable<Mixin> {\n    if (!this._mixins)\n      return function* (): Iterable<Mixin> { }(); // empty iterable\n\n    for (const mixin of this._mixins) {\n      const mObj = this.schema.lookupItemSync<Mixin>(mixin);\n      if (mObj) {\n        yield mObj;\n      }\n    }\n  }\n\n  /**\n   *\n   * @param mixin\n   */\n  protected addMixin(mixin: Mixin) {\n    if (!this._mixins)\n      this._mixins = [];\n\n    this._mixins.push(new DelayedPromiseWithProps(mixin.key, async () => mixin));\n    return;\n  }\n\n  /**\n   * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.\n   * @param name The name of the property to find.\n   */\n  public override async getInheritedProperty(name: string): Promise<AnyProperty | undefined> {\n    let inheritedProperty = await super.getInheritedProperty(name);\n\n    if (!inheritedProperty && this._mixins) {\n      const mixinProps = await Promise.all(this._mixins.map(async (mixin) => (await mixin).getProperty(name)));\n      mixinProps.some((prop) => {\n        inheritedProperty = prop as AnyProperty;\n        return inheritedProperty !== undefined;\n      });\n    }\n\n    return inheritedProperty as AnyProperty | undefined;\n  }\n\n  /**\n   * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.\n   * @param name The name of the property to find.\n   */\n  public override getInheritedPropertySync(name: string): Property | undefined {\n    const inheritedProperty = super.getInheritedPropertySync(name);\n    if (inheritedProperty)\n      return inheritedProperty;\n\n    if (!this._mixins) {\n      return undefined;\n    }\n\n    for (const mixin of this._mixins) {\n      const mObj = this.schema.lookupItemSync<ECClass>(mixin);\n      if (mObj) {\n        const result = mObj.getPropertySync(name, true);\n        if (result) {\n          return result;\n        }\n      }\n    }\n\n    return undefined;\n  }\n\n  protected override async buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): Promise<void> {\n    if (!existingValues) {\n      existingValues = new Map<string, number>();\n    }\n\n    if (this.baseClass) {\n      ECClass.mergeProperties(result, existingValues, await (await this.baseClass).getProperties(resetBaseCaches), false);\n    }\n\n    for (const mixin of this.mixins) {\n      ECClass.mergeProperties(result, existingValues, await (await mixin).getProperties(resetBaseCaches), false);\n    }\n\n    if (!this.properties)\n      return;\n\n    ECClass.mergeProperties(result, existingValues, [...this.properties], true);\n  }\n\n  protected override buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): void {\n    if (!existingValues) {\n      existingValues = new Map<string, number>();\n    }\n\n    const baseClass = this.getBaseClassSync();\n    if (baseClass) {\n      ECClass.mergeProperties(result, existingValues, baseClass.getPropertiesSync(resetBaseCaches), false);\n    }\n\n    for (const mixin of this.getMixinsSync()) {\n      ECClass.mergeProperties(result, existingValues, mixin.getPropertiesSync(resetBaseCaches), false);\n    }\n\n    if (!this.properties)\n      return;\n\n    ECClass.mergeProperties(result, existingValues, [...this.properties], true);\n  }\n\n  /**\n   *\n   * @param name\n   * @param relationship\n   * @param direction\n   */\n  protected async createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\n    return this.addProperty(await createNavigationProperty(this, name, relationship, direction));\n  }\n\n  /**\n   *\n   * @param name\n   * @param relationship\n   * @param direction\n   */\n  protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\n    return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));\n  }\n\n  /**\n   * Save this EntityClass' 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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): EntityClassProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    if (this.mixins.length > 0)\n      schemaJson.mixins = this.mixins.map((mixin) => mixin.fullName);\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n\n    for (const mixin of this.getMixinsSync()) {\n      const mixinElement = schemaXml.createElement(\"BaseClass\");\n      const mixinName = XmlSerializationUtils.createXmlTypedName(this.schema, mixin.schema, mixin.name);\n      mixinElement.textContent = mixinName;\n      itemElement.appendChild(mixinElement);\n    }\n    return itemElement;\n  }\n\n  public override async fromJSON(entityClassProps: EntityClassProps) {\n    this.fromJSONSync(entityClassProps);\n  }\n\n  public override fromJSONSync(entityClassProps: EntityClassProps) {\n    super.fromJSONSync(entityClassProps);\n\n    if (undefined !== entityClassProps.mixins) {\n      if (!this._mixins)\n        this._mixins = [];\n      for (const name of entityClassProps.mixins) {\n        const mixinSchemaItemKey = this.schema.getSchemaItemKey(name);\n        if (!mixinSchemaItemKey)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin (\"${name}\") that cannot be found.`);\n        this._mixins.push(new DelayedPromiseWithProps<SchemaItemKey, Mixin>(mixinSchemaItemKey,\n          async () => {\n            const mixin = await this.schema.lookupItem<Mixin>(mixinSchemaItemKey);\n            if (undefined === mixin)\n              throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin (\"${name}\") that cannot be found.`);\n            return mixin;\n          }));\n      }\n    }\n  }\n}\n\n/**\n * Hackish approach that works like a \"friend class\" so we can access protected members without making them public.\n * @internal\n */\nexport abstract class MutableEntityClass extends EntityClass {\n  public abstract override addMixin(mixin: Mixin): any;\n  public abstract override createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;\n  public abstract override createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n\n/** @internal */\nexport async function createNavigationProperty(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\n  if (await ecClass.getProperty(name))\n    throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);\n\n  let resolvedRelationship: RelationshipClass | undefined;\n  if (typeof (relationship) === \"string\") {\n    resolvedRelationship = await ecClass.schema.lookupItem<RelationshipClass>(relationship);\n  } else\n    resolvedRelationship = relationship;\n\n  if (!resolvedRelationship)\n    throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);  // eslint-disable-line @typescript-eslint/no-base-to-string\n\n  if (typeof (direction) === \"string\") {\n    const tmpDirection = parseStrengthDirection(direction);\n    if (undefined === tmpDirection)\n      throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);\n    direction = tmpDirection;\n  }\n\n  const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);\n  return new NavigationProperty(ecClass, name, lazyRelationship, direction);\n}\n\n/** @internal */\nexport function createNavigationPropertySync(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\n  if (ecClass.getPropertySync(name))\n    throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);\n\n  let resolvedRelationship: RelationshipClass | undefined;\n  if (typeof (relationship) === \"string\") {\n    resolvedRelationship = ecClass.schema.lookupItemSync<RelationshipClass>(relationship);\n  } else\n    resolvedRelationship = relationship;\n\n  if (!resolvedRelationship)\n    throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);  // eslint-disable-line @typescript-eslint/no-base-to-string\n\n  if (typeof (direction) === \"string\") {\n    const tmpDirection = parseStrengthDirection(direction);\n    if (undefined === tmpDirection)\n      throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);\n    direction = tmpDirection;\n  }\n\n  const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);\n  return new NavigationProperty(ecClass, name, lazyRelationship, direction);\n}\n"]}
+{"version":3,"file":"EntityClass.js","sourceRoot":"","sources":["../../../src/Metadata/EntityClass.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,sBAAsB,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAe,kBAAkB,EAAY,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IACb,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC;IAC9D,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IACxE,OAAO,CAAqB;IAEtC,IAAW,MAAM;QACf,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,CAAC,aAAa;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO,QAAQ,CAAC,MAAuB,CAAC,EAAE,CAAC,CAAC,iBAAiB;QAE/D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACtD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,QAAQ,CAAC,KAAY;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7E,OAAO;IACT,CAAC;IAED;;;OAGG;IACa,KAAK,CAAC,oBAAoB,CAAC,IAAY;QACrD,IAAI,iBAAiB,GAAG,MAAM,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAE/D,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACzG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvB,iBAAiB,GAAG,IAAmB,CAAC;gBACxC,OAAO,iBAAiB,KAAK,SAAS,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,iBAA4C,CAAC;IACtD,CAAC;IAED;;;OAGG;IACa,wBAAwB,CAAC,IAAY;QACnD,MAAM,iBAAiB,GAAG,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,iBAAiB;YACnB,OAAO,iBAAiB,CAAC;QAE3B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,IAAI,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CAAC,MAAkB,EAAE,cAAoC,EAAE,kBAA2B,KAAK;QACpI,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACtH,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7G,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO;QAET,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEkB,sBAAsB,CAAC,MAAkB,EAAE,cAAoC,EAAE,kBAA2B,KAAK;QAClI,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACvG,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO;QAET,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACO,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7F,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,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YACxB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjE,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,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,SAAS,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAClG,YAAY,CAAC,WAAW,GAAG,SAAS,CAAC;YACrC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QAErC,IAAI,SAAS,KAAK,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC3C,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC9D,IAAI,CAAC,kBAAkB;oBACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,IAAI,0BAA0B,CAAC,CAAC;gBAC1I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAuB,kBAAkB,EACpF,KAAK,IAAI,EAAE;oBACT,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;oBACtE,IAAI,SAAS,KAAK,KAAK;wBACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,IAAI,0BAA0B,CAAC,CAAC;oBAC1I,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC,CAAC;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,WAAW;YAC5D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAiB;QACjD,IAAG,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,WAAW,iBAAiB,CAAC,CAAC;IAC9H,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAW;CAK3D;AAED,gBAAgB;AAChB,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,OAAgB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;IAC5J,IAAI,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QACjC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,IAAI,gCAAgC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAElJ,IAAI,oBAAmD,CAAC;IACxD,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvC,oBAAoB,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAC1F,CAAC;;QACC,oBAAoB,GAAG,YAAY,CAAC;IAEtC,IAAI,CAAC,oBAAoB;QACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,mCAAmC,YAAY,8CAA8C,CAAC,CAAC,CAAE,2DAA2D;IAEpN,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,wBAAwB,EAAE,mCAAmC,SAAS,qCAAqC,CAAC,CAAC;QACxJ,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACjH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC5E,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,4BAA4B,CAAC,OAAgB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;IAC1J,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC;QAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,IAAI,gCAAgC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAElJ,IAAI,oBAAmD,CAAC;IACxD,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvC,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IACxF,CAAC;;QACC,oBAAoB,GAAG,YAAY,CAAC;IAEtC,IAAI,CAAC,oBAAoB;QACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,mCAAmC,YAAY,8CAA8C,CAAC,CAAC,CAAE,2DAA2D;IAEpN,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,wBAAwB,EAAE,mCAAmC,SAAS,qCAAqC,CAAC,CAAC;QACxJ,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACjH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC5E,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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\nimport { EntityClassProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { parseStrengthDirection, SchemaItemType, StrengthDirection } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { HasMixins, LazyLoadedMixin } from \"../Interfaces\";\nimport { SchemaItemKey } from \"../SchemaKey\";\nimport { ECClass } from \"./Class\";\nimport { Mixin } from \"./Mixin\";\nimport { AnyProperty, NavigationProperty, Property } from \"./Property\";\nimport { RelationshipClass } from \"./RelationshipClass\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * A Typescript class representation of an ECEntityClass.\n * @beta\n */\nexport class EntityClass extends ECClass implements HasMixins {\n  public override readonly schemaItemType = EntityClass.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.EntityClass; }\n  protected _mixins?: LazyLoadedMixin[];\n\n  public get mixins(): LazyLoadedMixin[] {\n    if (!this._mixins)\n      return [];\n    return this._mixins;\n  }\n\n  public *getMixinsSync(): Iterable<Mixin> {\n    if (!this._mixins)\n      return function* (): Iterable<Mixin> { }(); // empty iterable\n\n    for (const mixin of this._mixins) {\n      const mObj = this.schema.lookupItemSync(mixin, Mixin);\n      if (mObj) {\n        yield mObj;\n      }\n    }\n  }\n\n  /**\n   *\n   * @param mixin\n   */\n  protected addMixin(mixin: Mixin) {\n    if (!this._mixins)\n      this._mixins = [];\n\n    this._mixins.push(new DelayedPromiseWithProps(mixin.key, async () => mixin));\n    return;\n  }\n\n  /**\n   * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.\n   * @param name The name of the property to find.\n   */\n  public override async getInheritedProperty(name: string): Promise<AnyProperty | undefined> {\n    let inheritedProperty = await super.getInheritedProperty(name);\n\n    if (!inheritedProperty && this._mixins) {\n      const mixinProps = await Promise.all(this._mixins.map(async (mixin) => (await mixin).getProperty(name)));\n      mixinProps.some((prop) => {\n        inheritedProperty = prop as AnyProperty;\n        return inheritedProperty !== undefined;\n      });\n    }\n\n    return inheritedProperty as AnyProperty | undefined;\n  }\n\n  /**\n   * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.\n   * @param name The name of the property to find.\n   */\n  public override getInheritedPropertySync(name: string): Property | undefined {\n    const inheritedProperty = super.getInheritedPropertySync(name);\n    if (inheritedProperty)\n      return inheritedProperty;\n\n    if (!this._mixins) {\n      return undefined;\n    }\n\n    for (const mixin of this._mixins) {\n      const mObj = this.schema.lookupItemSync(mixin);\n      if (mObj && ECClass.isECClass(mObj)) {\n        const result = mObj.getPropertySync(name, true);\n        if (result) {\n          return result;\n        }\n      }\n    }\n\n    return undefined;\n  }\n\n  protected override async buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): Promise<void> {\n    if (!existingValues) {\n      existingValues = new Map<string, number>();\n    }\n\n    if (this.baseClass) {\n      ECClass.mergeProperties(result, existingValues, await (await this.baseClass).getProperties(resetBaseCaches), false);\n    }\n\n    for (const mixin of this.mixins) {\n      ECClass.mergeProperties(result, existingValues, await (await mixin).getProperties(resetBaseCaches), false);\n    }\n\n    if (!this.properties)\n      return;\n\n    ECClass.mergeProperties(result, existingValues, [...this.properties], true);\n  }\n\n  protected override buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): void {\n    if (!existingValues) {\n      existingValues = new Map<string, number>();\n    }\n\n    const baseClass = this.getBaseClassSync();\n    if (baseClass) {\n      ECClass.mergeProperties(result, existingValues, baseClass.getPropertiesSync(resetBaseCaches), false);\n    }\n\n    for (const mixin of this.getMixinsSync()) {\n      ECClass.mergeProperties(result, existingValues, mixin.getPropertiesSync(resetBaseCaches), false);\n    }\n\n    if (!this.properties)\n      return;\n\n    ECClass.mergeProperties(result, existingValues, [...this.properties], true);\n  }\n\n  /**\n   *\n   * @param name\n   * @param relationship\n   * @param direction\n   */\n  protected async createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\n    return this.addProperty(await createNavigationProperty(this, name, relationship, direction));\n  }\n\n  /**\n   *\n   * @param name\n   * @param relationship\n   * @param direction\n   */\n  protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\n    return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));\n  }\n\n  /**\n   * Save this EntityClass' 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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): EntityClassProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    if (this.mixins.length > 0)\n      schemaJson.mixins = this.mixins.map((mixin) => mixin.fullName);\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n\n    for (const mixin of this.getMixinsSync()) {\n      const mixinElement = schemaXml.createElement(\"BaseClass\");\n      const mixinName = XmlSerializationUtils.createXmlTypedName(this.schema, mixin.schema, mixin.name);\n      mixinElement.textContent = mixinName;\n      itemElement.appendChild(mixinElement);\n    }\n    return itemElement;\n  }\n\n  public override async fromJSON(entityClassProps: EntityClassProps) {\n    this.fromJSONSync(entityClassProps);\n  }\n\n  public override fromJSONSync(entityClassProps: EntityClassProps) {\n    super.fromJSONSync(entityClassProps);\n\n    if (undefined !== entityClassProps.mixins) {\n      if (!this._mixins)\n        this._mixins = [];\n      for (const name of entityClassProps.mixins) {\n        const mixinSchemaItemKey = this.schema.getSchemaItemKey(name);\n        if (!mixinSchemaItemKey)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin (\"${name}\") that cannot be found.`);\n        this._mixins.push(new DelayedPromiseWithProps<SchemaItemKey, Mixin>(mixinSchemaItemKey,\n          async () => {\n            const mixin = await this.schema.lookupItem(mixinSchemaItemKey, Mixin);\n            if (undefined === mixin)\n              throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin (\"${name}\") that cannot be found.`);\n            return mixin;\n          }));\n      }\n    }\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type EntityClass.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is an EntityClass, false otherwise.\n   */\n  public static isEntityClass(item?: SchemaItem): item is EntityClass {\n    if (item && item.schemaItemType === SchemaItemType.EntityClass)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type EntityClass.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to EntityClass if it is an EntityClass, undefined otherwise.\n   */\n  public static assertIsEntityClass(item?: SchemaItem): asserts item is EntityClass {\n    if(!this.isEntityClass(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.EntityClass}' (EntityClass)`);\n  }\n}\n\n/**\n * Hackish approach that works like a \"friend class\" so we can access protected members without making them public.\n * @internal\n */\nexport abstract class MutableEntityClass extends EntityClass {\n  public abstract override addMixin(mixin: Mixin): any;\n  public abstract override createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;\n  public abstract override createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n\n/** @internal */\nexport async function createNavigationProperty(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\n  if (await ecClass.getProperty(name))\n    throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);\n\n  let resolvedRelationship: RelationshipClass | undefined;\n  if (typeof (relationship) === \"string\") {\n    resolvedRelationship = await ecClass.schema.lookupItem(relationship, RelationshipClass);\n  } else\n    resolvedRelationship = relationship;\n\n  if (!resolvedRelationship)\n    throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);  // eslint-disable-line @typescript-eslint/no-base-to-string\n\n  if (typeof (direction) === \"string\") {\n    const tmpDirection = parseStrengthDirection(direction);\n    if (undefined === tmpDirection)\n      throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);\n    direction = tmpDirection;\n  }\n\n  const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);\n  return new NavigationProperty(ecClass, name, lazyRelationship, direction);\n}\n\n/** @internal */\nexport function createNavigationPropertySync(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\n  if (ecClass.getPropertySync(name))\n    throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);\n\n  let resolvedRelationship: RelationshipClass | undefined;\n  if (typeof (relationship) === \"string\") {\n    resolvedRelationship = ecClass.schema.lookupItemSync(relationship, RelationshipClass);\n  } else\n    resolvedRelationship = relationship;\n\n  if (!resolvedRelationship)\n    throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);  // eslint-disable-line @typescript-eslint/no-base-to-string\n\n  if (typeof (direction) === \"string\") {\n    const tmpDirection = parseStrengthDirection(direction);\n    if (undefined === tmpDirection)\n      throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);\n    direction = tmpDirection;\n  }\n\n  const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);\n  return new NavigationProperty(ecClass, name, lazyRelationship, direction);\n}\n"]}

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

@@ -19,7 +19,8 @@ export type AnyEnumerator = Enumerator<string | number>;
  * @beta
  */
 export declare class Enumeration extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Enumeration;
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
     protected _type?: PrimitiveType.Integer | PrimitiveType.String;
     protected _isStrict: boolean;
     protected _enumerators: AnyEnumerator[];
@@ -75,6 +76,18 @@ export declare class Enumeration extends SchemaItem {
      * @alpha Used in schema editing.
      */
     protected setIsStrict(isStrict: boolean): void;
+    /**
+     * Type guard to check if the SchemaItem is of type Enumeration.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is an Enumeration, false otherwise.
+     */
+    static isEnumeration(item?: SchemaItem): item is Enumeration;
+    /**
+     * Type assertion to check if the SchemaItem is of type Enumeration.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.
+     */
+    static assertIsEnumeration(item?: SchemaItem): asserts item is Enumeration;
 }
 /** @internal
  * An abstract class used for schema editing.

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

@@ -1 +1 @@
-{"version":3,"file":"Enumeration.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,gBAAgB,EAAmB,MAAM,8BAA8B,CAAC;AACjF,OAAO,EAAE,aAAa,EAAyB,cAAc,EAAE,MAAM,cAAc,CAAC;AAGpF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY;AACZ,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAExD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,UAAU;IACzC,SAAyB,cAAc,EAAG,cAAc,CAAC,WAAW,CAAC;IACrE,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC;IAC/D,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC;IAExC,IAAW,WAAW,oBAAgC;IACtD,IAAW,IAAI,6DAAyB;IACxC,IAAW,QAAQ,YAA6B;gBAEpC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM;IAQtG,IAAW,KAAK,IAAI,OAAO,CAAiD;IAC5E,IAAW,QAAQ,IAAI,OAAO,CAAgD;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAInE;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS;IAC5D,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS;IAKnE;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAShC;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,aAAa;IAWlH;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa;IAIjD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,gBAAgB;IAe5G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAqBlD,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;IA6BzC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB;IAIjE;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO;CAIxC;AAED;;GAEG;AACH,8BAAsB,kBAAmB,SAAQ,WAAW;aACjC,aAAa,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;aAC9C,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;aACpC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Enumeration.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,gBAAgB,EAAmB,MAAM,8BAA8B,CAAC;AACjF,OAAO,EAAE,aAAa,EAAyB,cAAc,EAAE,MAAM,cAAc,CAAC;AAGpF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY;AACZ,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAExD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,UAAU;IACzC,SAAyB,cAAc,iBAA8B;IACrE,WAA2B,cAAc,mBAAyC;IAClF,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC;IAC/D,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC;IAExC,IAAW,WAAW,oBAAgC;IACtD,IAAW,IAAI,6DAAyB;IACxC,IAAW,QAAQ,YAA6B;gBAEpC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM;IAOtG,IAAW,KAAK,IAAI,OAAO,CAAiD;IAC5E,IAAW,QAAQ,IAAI,OAAO,CAAgD;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAInE;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS;IAC5D,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS;IAKnE;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAShC;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,aAAa;IAWlH;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa;IAIjD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,gBAAgB;IAe5G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAqBlD,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;IA6BzC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB;IAIjE;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO;IAIvC;;;;OAIG;WACW,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,WAAW;IAInE;;;;OAIG;WACW,mBAAmB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW;CAIlF;AAED;;GAEG;AACH,8BAAsB,kBAAmB,SAAQ,WAAW;aACjC,aAAa,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;aAC9C,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;aACpC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Enumeration.js

@@ -15,12 +15,16 @@ import { SchemaItem } from "./SchemaItem";
  * @beta
  */
 export class Enumeration extends SchemaItem {
+    schemaItemType = Enumeration.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.Enumeration; }
+    _type;
+    _isStrict;
+    _enumerators;
     get enumerators() { return this._enumerators; }
     get type() { return this._type; }
     get isStrict() { return this._isStrict; }
     constructor(schema, name, primitiveType) {
         super(schema, name);
-        this.schemaItemType = SchemaItemType.Enumeration;
         this._type = primitiveType;
         this._isStrict = true;
         this._enumerators = [];
@@ -153,6 +157,23 @@ export class Enumeration extends SchemaItem {
     setIsStrict(isStrict) {
         this._isStrict = isStrict;
     }
+    /**
+     * Type guard to check if the SchemaItem is of type Enumeration.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is an Enumeration, false otherwise.
+     */
+    static isEnumeration(item) {
+        return item?.schemaItemType === SchemaItemType.Enumeration;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type Enumeration.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.
+     */
+    static assertIsEnumeration(item) {
+        if (!this.isEnumeration(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Enumeration}' (Enumeration)`);
+    }
 }
 /** @internal
  * An abstract class used for schema editing.

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

@@ -1 +1 @@
-{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAiB,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE5E,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAa1C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,UAAU;IAMzC,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,YAAY,MAAc,EAAE,IAAY,EAAE,aAA4D;QACpG,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,KAAK,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAQM,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAY,EAAE,KAAsB;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAsB,EAAE,EAAE;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACnD,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YAC1I,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,2CAA2C,KAAK,IAAI,CAAC,CAAC;QAC9I,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAY,EAAE,KAAsB,EAAE,KAAc,EAAE,WAAoB;QAChG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,oDAAoD;YACjG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,4DAA4D;YAC1G,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+CAA+C;QAC3F,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,wDAAwD,IAAI,yBAAyB,CAAC,CAAC;QAC7K,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAyB;QAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpC,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,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK;gBACrB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YACzB,IAAI,SAAS,KAAK,WAAW;gBAC3B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,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;QACjD,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YACzB,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC5D,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxG,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,UAAU,CAAC,KAAK;gBAChC,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW;gBACtC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAClE,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC;YACrC,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,gBAAgB,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,EAAE,gBAAgB,CAAC,0BAA0B,EAAkB,CAAC;oBAC/K,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;;oBAElC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;YACpK,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,oBAAoB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACnD,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QACjN,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAC/C,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;gBACnE,4JAA4J;gBAC5J,0FAA0F;gBAC1F,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YACzH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAiB;QACrC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;CAEF;AAED;;GAEG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAW;CAI3D","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 { ECSpecVersion, SchemaReadHelper } from \"../Deserialization/Helper\";\nimport { EnumerationProps, EnumeratorProps } from \"../Deserialization/JsonProps\";\nimport { PrimitiveType, primitiveTypeToString, SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECName } from \"../ECName\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/** @beta */\nexport interface Enumerator<T> {\n  readonly name: string;\n  readonly value: T;\n  readonly label?: string;\n  readonly description?: string;\n}\n\n/** @beta */\nexport type AnyEnumerator = Enumerator<string | number>;\n\n/**\n * A Typescript class representation of an ECEnumeration.\n * @beta\n */\nexport class Enumeration extends SchemaItem {\n  public override readonly schemaItemType!: SchemaItemType.Enumeration;\n  protected _type?: PrimitiveType.Integer | PrimitiveType.String;\n  protected _isStrict: boolean;\n  protected _enumerators: AnyEnumerator[];\n\n  public get enumerators() { return this._enumerators; }\n  public get type() { return this._type; }\n  public get isStrict() { return this._isStrict; }\n\n  constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String) {\n    super(schema, name);\n    this.schemaItemType = SchemaItemType.Enumeration;\n    this._type = primitiveType;\n    this._isStrict = true;\n    this._enumerators = [];\n  }\n\n  public get isInt(): boolean { return this._type === PrimitiveType.Integer; }\n  public get isString(): boolean { return this._type === PrimitiveType.String; }\n\n  /**\n   * Gets an enumerator that matches the name provided.\n   * @param name The ECName of the Enumerator to find.\n   */\n  public getEnumeratorByName(name: string): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());\n  }\n\n  /**\n   * Gets an enumerator that matches the value provided.\n   * @param value The value of the Enumerator to find.\n   */\n  public getEnumerator(value: string): Enumerator<string> | undefined;\n  public getEnumerator(value: number): Enumerator<number> | undefined;\n  public getEnumerator(value: string | number): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.value === value);\n  }\n\n  /**\n   * Checks whether there already exists an enumerator with this name or this value\n   * @param name The name of the enumerator we are trying to create\n   * @param value The value of the enumerator we are trying to create\n   * @internal\n   */\n  private findDuplicateEnumerators(name: string, value: string | number) {\n    this._enumerators.forEach((element: AnyEnumerator) => { // Name and value must be unique within the ECEnumerations\n      if (element.name.toLowerCase() === name.toLowerCase())\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);\n      if (element.value === value)\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);\n    });\n  }\n\n  /**\n   * Creates an Enumerator with the provided name and value as well as optional parameters label and description\n   * @param name The name of the enumerator\n   * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.\n   * @param label A localized display label that is used instead of the name in a GUI.\n   * @param description A localized description for the enumerator.\n   * @return AnyEnumerator object\n   */\n  public createEnumerator(name: string, value: string | number, label?: string, description?: string): AnyEnumerator {\n    if (this.isInt && typeof (value) === \"string\") // throws if backing type is int and value is string\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);\n    if (!this.isInt && typeof (value) === \"number\") // also throws if backing type is string and value is number\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);\n    this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any\n    if (!ECName.validate(name))\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);\n    return { name, value, label, description };\n  }\n\n  /**\n   * Adds enumerator to list of enumerators on this Enumeration\n   * @param enumerator The enumerator to add\n   */\n  protected addEnumerator(enumerator: AnyEnumerator) {\n    this.enumerators.push(enumerator);\n  }\n\n  /**\n   * Save this Enumeration'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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): EnumerationProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = (this.isInt) ? \"int\" : \"string\";\n    schemaJson.isStrict = this.isStrict;\n    schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {\n      const enumJson: any = { name, value };\n      if (undefined !== label)\n        enumJson.label = label;\n      if (undefined !== description)\n        enumJson.description = description;\n      return enumJson;\n    });\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    if (undefined !== this.type)\n      itemElement.setAttribute(\"backingTypeName\", primitiveTypeToString(this.type));\n    itemElement.setAttribute(\"isStrict\", String(this.isStrict));\n\n    for (const enumerator of this.enumerators) {\n      const enumElement = schemaXml.createElement(\"ECEnumerator\");\n      enumElement.setAttribute(\"name\", enumerator.name);\n      const enumValue = typeof enumerator.value === \"string\" ? enumerator.value : enumerator.value.toString();\n      enumElement.setAttribute(\"value\", enumValue);\n      if (undefined !== enumerator.label)\n        enumElement.setAttribute(\"displayLabel\", enumerator.label);\n      if (undefined !== enumerator.description)\n        enumElement.setAttribute(\"description\", enumerator.description);\n      itemElement.appendChild(enumElement);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(enumerationProps: EnumerationProps) {\n    super.fromJSONSync(enumerationProps);\n    if (undefined === this._type) {\n      if (/int/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.Integer;\n      } else if (/string/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.String;\n      } else {\n        if (SchemaReadHelper.isECSpecVersionNewer({readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion} as ECSpecVersion))\n          this._type = PrimitiveType.String;\n        else\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\n      }\n    } else {\n      const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;\n      if (!primitiveTypePattern.test(enumerationProps.type))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be \"${(this.isInt) ? \"int\" : \"string\"}\", not \"${(this.isInt) ? \"string\" : \"int\"}\".`);\n    }\n    this._isStrict = enumerationProps.isStrict;\n\n    if (undefined !== enumerationProps.enumerators) {\n      enumerationProps.enumerators.forEach((enumerator: EnumeratorProps) => {\n        // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.\n        // Throws ECObjectsError if there are duplicate names or values present in the enumeration\n        this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));\n      });\n    }\n  }\n\n  public override async fromJSON(enumerationProps: EnumerationProps) {\n    this.fromJSONSync(enumerationProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setIsStrict(isStrict: boolean) {\n    this._isStrict = isStrict;\n  }\n\n}\n\n/** @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableEnumeration extends Enumeration {\n  public abstract override addEnumerator(enumerator: AnyEnumerator): void;\n  public abstract override setIsStrict(isStrict: boolean): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAiB,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE5E,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAa1C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,UAAU;IAChB,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC;IAC9D,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IACxE,KAAK,CAAgD;IACrD,SAAS,CAAU;IACnB,YAAY,CAAkB;IAExC,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,YAAY,MAAc,EAAE,IAAY,EAAE,aAA4D;QACpG,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,KAAK,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAQM,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAY,EAAE,KAAsB;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAsB,EAAE,EAAE;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACnD,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YAC1I,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,2CAA2C,KAAK,IAAI,CAAC,CAAC;QAC9I,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAY,EAAE,KAAsB,EAAE,KAAc,EAAE,WAAoB;QAChG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,oDAAoD;YACjG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,4DAA4D;YAC1G,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+CAA+C;QAC3F,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,wDAAwD,IAAI,yBAAyB,CAAC,CAAC;QAC7K,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAyB;QAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpC,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,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK;gBACrB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YACzB,IAAI,SAAS,KAAK,WAAW;gBAC3B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,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;QACjD,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YACzB,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC5D,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxG,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,UAAU,CAAC,KAAK;gBAChC,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW;gBACtC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAClE,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC;YACrC,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,gBAAgB,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,EAAE,gBAAgB,CAAC,0BAA0B,EAAkB,CAAC;oBAC/K,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;;oBAElC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;YACpK,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,oBAAoB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACnD,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QACjN,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAC/C,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;gBACnE,4JAA4J;gBAC5J,0FAA0F;gBAC1F,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YACzH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAiB;QACrC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,OAAO,IAAI,EAAE,cAAc,KAAK,cAAc,CAAC,WAAW,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAiB;QACjD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,WAAW,iBAAiB,CAAC,CAAC;IAC9H,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAW;CAI3D","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 { ECSpecVersion, SchemaReadHelper } from \"../Deserialization/Helper\";\nimport { EnumerationProps, EnumeratorProps } from \"../Deserialization/JsonProps\";\nimport { PrimitiveType, primitiveTypeToString, SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { ECName } from \"../ECName\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/** @beta */\nexport interface Enumerator<T> {\n  readonly name: string;\n  readonly value: T;\n  readonly label?: string;\n  readonly description?: string;\n}\n\n/** @beta */\nexport type AnyEnumerator = Enumerator<string | number>;\n\n/**\n * A Typescript class representation of an ECEnumeration.\n * @beta\n */\nexport class Enumeration extends SchemaItem {\n  public override readonly schemaItemType = Enumeration.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Enumeration; }\n  protected _type?: PrimitiveType.Integer | PrimitiveType.String;\n  protected _isStrict: boolean;\n  protected _enumerators: AnyEnumerator[];\n\n  public get enumerators() { return this._enumerators; }\n  public get type() { return this._type; }\n  public get isStrict() { return this._isStrict; }\n\n  constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String) {\n    super(schema, name);\n    this._type = primitiveType;\n    this._isStrict = true;\n    this._enumerators = [];\n  }\n\n  public get isInt(): boolean { return this._type === PrimitiveType.Integer; }\n  public get isString(): boolean { return this._type === PrimitiveType.String; }\n\n  /**\n   * Gets an enumerator that matches the name provided.\n   * @param name The ECName of the Enumerator to find.\n   */\n  public getEnumeratorByName(name: string): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());\n  }\n\n  /**\n   * Gets an enumerator that matches the value provided.\n   * @param value The value of the Enumerator to find.\n   */\n  public getEnumerator(value: string): Enumerator<string> | undefined;\n  public getEnumerator(value: number): Enumerator<number> | undefined;\n  public getEnumerator(value: string | number): AnyEnumerator | undefined {\n    return this.enumerators.find((item) => item.value === value);\n  }\n\n  /**\n   * Checks whether there already exists an enumerator with this name or this value\n   * @param name The name of the enumerator we are trying to create\n   * @param value The value of the enumerator we are trying to create\n   * @internal\n   */\n  private findDuplicateEnumerators(name: string, value: string | number) {\n    this._enumerators.forEach((element: AnyEnumerator) => { // Name and value must be unique within the ECEnumerations\n      if (element.name.toLowerCase() === name.toLowerCase())\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);\n      if (element.value === value)\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);\n    });\n  }\n\n  /**\n   * Creates an Enumerator with the provided name and value as well as optional parameters label and description\n   * @param name The name of the enumerator\n   * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.\n   * @param label A localized display label that is used instead of the name in a GUI.\n   * @param description A localized description for the enumerator.\n   * @return AnyEnumerator object\n   */\n  public createEnumerator(name: string, value: string | number, label?: string, description?: string): AnyEnumerator {\n    if (this.isInt && typeof (value) === \"string\") // throws if backing type is int and value is string\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);\n    if (!this.isInt && typeof (value) === \"number\") // also throws if backing type is string and value is number\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);\n    this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any\n    if (!ECName.validate(name))\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);\n    return { name, value, label, description };\n  }\n\n  /**\n   * Adds enumerator to list of enumerators on this Enumeration\n   * @param enumerator The enumerator to add\n   */\n  protected addEnumerator(enumerator: AnyEnumerator) {\n    this.enumerators.push(enumerator);\n  }\n\n  /**\n   * Save this Enumeration'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 override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): EnumerationProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = (this.isInt) ? \"int\" : \"string\";\n    schemaJson.isStrict = this.isStrict;\n    schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {\n      const enumJson: any = { name, value };\n      if (undefined !== label)\n        enumJson.label = label;\n      if (undefined !== description)\n        enumJson.description = description;\n      return enumJson;\n    });\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    if (undefined !== this.type)\n      itemElement.setAttribute(\"backingTypeName\", primitiveTypeToString(this.type));\n    itemElement.setAttribute(\"isStrict\", String(this.isStrict));\n\n    for (const enumerator of this.enumerators) {\n      const enumElement = schemaXml.createElement(\"ECEnumerator\");\n      enumElement.setAttribute(\"name\", enumerator.name);\n      const enumValue = typeof enumerator.value === \"string\" ? enumerator.value : enumerator.value.toString();\n      enumElement.setAttribute(\"value\", enumValue);\n      if (undefined !== enumerator.label)\n        enumElement.setAttribute(\"displayLabel\", enumerator.label);\n      if (undefined !== enumerator.description)\n        enumElement.setAttribute(\"description\", enumerator.description);\n      itemElement.appendChild(enumElement);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(enumerationProps: EnumerationProps) {\n    super.fromJSONSync(enumerationProps);\n    if (undefined === this._type) {\n      if (/int/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.Integer;\n      } else if (/string/i.test(enumerationProps.type)) {\n        this._type = PrimitiveType.String;\n      } else {\n        if (SchemaReadHelper.isECSpecVersionNewer({readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion} as ECSpecVersion))\n          this._type = PrimitiveType.String;\n        else\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\n      }\n    } else {\n      const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;\n      if (!primitiveTypePattern.test(enumerationProps.type))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be \"${(this.isInt) ? \"int\" : \"string\"}\", not \"${(this.isInt) ? \"string\" : \"int\"}\".`);\n    }\n    this._isStrict = enumerationProps.isStrict;\n\n    if (undefined !== enumerationProps.enumerators) {\n      enumerationProps.enumerators.forEach((enumerator: EnumeratorProps) => {\n        // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.\n        // Throws ECObjectsError if there are duplicate names or values present in the enumeration\n        this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));\n      });\n    }\n  }\n\n  public override async fromJSON(enumerationProps: EnumerationProps) {\n    this.fromJSONSync(enumerationProps);\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setIsStrict(isStrict: boolean) {\n    this._isStrict = isStrict;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Enumeration.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is an Enumeration, false otherwise.\n   */\n  public static isEnumeration(item?: SchemaItem): item is Enumeration {\n    return item?.schemaItemType === SchemaItemType.Enumeration;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Enumeration.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.\n   */\n  public static assertIsEnumeration(item?: SchemaItem): asserts item is Enumeration {\n    if (!this.isEnumeration(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Enumeration}' (Enumeration)`);\n  }\n}\n\n/** @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableEnumeration extends Enumeration {\n  public abstract override addEnumerator(enumerator: AnyEnumerator): void;\n  public abstract override setIsStrict(isStrict: boolean): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}