@itwin/ecschema-metadata 4.8.0-dev.9 → 4.9.0-dev.1

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

@@ -0,0 +1,65 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { ConstantProps } from "../Deserialization/JsonProps";
+import { SchemaItemType } from "../ECObjects";
+import { LazyLoadedPhenomenon } from "../Interfaces";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+/**
+ * A Constant is a specific type of Unit that represents a number.
+ * @beta
+ */
+export declare class Constant extends SchemaItem {
+    readonly schemaItemType: SchemaItemType.Constant;
+    protected _phenomenon?: LazyLoadedPhenomenon;
+    protected _definition: string;
+    protected _numerator?: number;
+    protected _denominator?: number;
+    constructor(schema: Schema, name: string);
+    get phenomenon(): LazyLoadedPhenomenon | undefined;
+    get definition(): string;
+    get numerator(): number;
+    get denominator(): number;
+    get hasNumerator(): boolean;
+    get hasDenominator(): boolean;
+    /**
+     * Save this Constants properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): ConstantProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(constantProps: ConstantProps): void;
+    fromJSON(constantProps: ConstantProps): Promise<void>;
+    /**
+     * @alpha Used in schema editing.
+     * @param phenomenon A LazyLoadedPhenomenon.
+     */
+    protected setPhenomenon(phenomenon: LazyLoadedPhenomenon): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setDefinition(definition: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setNumerator(numerator: number): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setDenominator(denominator: number): void;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableConstant extends Constant {
+    abstract setPhenomenon(phenomenon: LazyLoadedPhenomenon): void;
+    abstract setDefinition(definition: string): void;
+    abstract setNumerator(numerator: number): void;
+    abstract setDenominator(denominator: number): void;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+//# sourceMappingURL=Constant.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Constant.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Constant.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAGrD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,QAAS,SAAQ,UAAU;IACtC,SAAyB,cAAc,EAAG,cAAc,CAAC,QAAQ,CAAC;IAClE,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEpB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMxC,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,MAAM,CAA6B;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAmC;IACjE,IAAW,WAAW,IAAI,MAAM,CAAqC;IACrE,IAAW,YAAY,IAAI,OAAO,CAA4C;IAC9E,IAAW,cAAc,IAAI,OAAO,CAA8C;IAElF;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,aAAa;IAYzG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBlD,YAAY,CAAC,aAAa,EAAE,aAAa;IA8BnC,QAAQ,CAAC,aAAa,EAAE,aAAa;IAI3D;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAIxD;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM;IAI1C;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAIxC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;CAG7C;AACD;;;GAGG;AACH,8BAAsB,eAAgB,SAAQ,QAAQ;aAC3B,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,IAAI;aACrD,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;aACvC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Constant.js

@@ -0,0 +1,119 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { DelayedPromiseWithProps } from "../DelayedPromise";
+import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
+import { SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { SchemaItem } from "./SchemaItem";
+/**
+ * A Constant is a specific type of Unit that represents a number.
+ * @beta
+ */
+export class Constant extends SchemaItem {
+    constructor(schema, name) {
+        super(schema, name);
+        this.schemaItemType = SchemaItemType.Constant;
+        this._definition = "";
+    }
+    get phenomenon() { return this._phenomenon; }
+    get definition() { return this._definition; }
+    get numerator() { return this._numerator ?? 1.0; }
+    get denominator() { return this._denominator ?? 1.0; }
+    get hasNumerator() { return (this._numerator !== undefined); }
+    get hasDenominator() { return (this._denominator !== undefined); }
+    /**
+     * Save this Constants properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        if (this.phenomenon !== undefined)
+            schemaJson.phenomenon = this.phenomenon.fullName;
+        schemaJson.definition = this.definition;
+        if (this.hasNumerator)
+            schemaJson.numerator = this.numerator;
+        if (this.hasDenominator)
+            schemaJson.denominator = this.denominator;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        itemElement.setAttribute("definition", this.definition);
+        if (this.hasNumerator)
+            itemElement.setAttribute("numerator", this.numerator.toString());
+        if (this.hasDenominator)
+            itemElement.setAttribute("denominator", this.denominator.toString());
+        const phenomenon = await this.phenomenon;
+        if (undefined !== phenomenon) {
+            const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);
+            itemElement.setAttribute("phenomenon", phenomenonName);
+        }
+        return itemElement;
+    }
+    fromJSONSync(constantProps) {
+        super.fromJSONSync(constantProps);
+        const schemaItemKey = this.schema.getSchemaItemKey(constantProps.phenomenon);
+        if (!schemaItemKey)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);
+        this._phenomenon = new DelayedPromiseWithProps(schemaItemKey, async () => {
+            const phenom = await this.schema.lookupItem(schemaItemKey);
+            if (undefined === phenom)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);
+            return phenom;
+        });
+        if (this._definition !== "" && constantProps.definition.toLowerCase() !== this._definition.toLowerCase())
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Constant ${this.name} has an invalid 'definition' attribute.`);
+        else if (this._definition === "")
+            this._definition = constantProps.definition;
+        if (undefined !== constantProps.numerator) {
+            if (constantProps.numerator !== this._numerator)
+                this._numerator = constantProps.numerator;
+        }
+        if (undefined !== constantProps.denominator) {
+            if (constantProps.denominator !== this._denominator)
+                this._denominator = constantProps.denominator;
+        }
+    }
+    async fromJSON(constantProps) {
+        this.fromJSONSync(constantProps);
+    }
+    /**
+     * @alpha Used in schema editing.
+     * @param phenomenon A LazyLoadedPhenomenon.
+     */
+    setPhenomenon(phenomenon) {
+        this._phenomenon = phenomenon;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setDefinition(definition) {
+        this._definition = definition;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setNumerator(numerator) {
+        this._numerator = numerator;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setDenominator(denominator) {
+        this._denominator = denominator;
+    }
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export class MutableConstant extends Constant {
+}
+//# sourceMappingURL=Constant.js.map

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

@@ -0,0 +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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { DelayedPromiseWithProps } from \"../DelayedPromise\";\r\nimport { ConstantProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedPhenomenon } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { Phenomenon } from \"./Phenomenon\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/**\r\n * A Constant is a specific type of Unit that represents a number.\r\n * @beta\r\n */\r\nexport class Constant extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Constant; // eslint-disable-line\r\n  protected _phenomenon?: LazyLoadedPhenomenon;\r\n  protected _definition: string;\r\n  protected _numerator?: number;\r\n  protected _denominator?: number;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Constant;\r\n    this._definition = \"\";\r\n  }\r\n\r\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\r\n  public get definition(): string { return this._definition; }\r\n  public get numerator(): number { return this._numerator ?? 1.0; }\r\n  public get denominator(): number { return this._denominator ?? 1.0; }\r\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\r\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\r\n\r\n  /**\r\n   * Save this Constants properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): ConstantProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    if (this.phenomenon !== undefined)\r\n      schemaJson.phenomenon = this.phenomenon.fullName;\r\n    schemaJson.definition = this.definition;\r\n    if (this.hasNumerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (this.hasDenominator)\r\n      schemaJson.denominator = this.denominator;\r\n    return schemaJson as ConstantProps;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    if (this.hasNumerator)\r\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    if (this.hasDenominator)\r\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n\r\n    const phenomenon = await this.phenomenon;\r\n    if (undefined !== phenomenon) {\r\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\r\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\r\n    }\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(constantProps: ConstantProps) {\r\n    super.fromJSONSync(constantProps);\r\n\r\n    const schemaItemKey = this.schema.getSchemaItemKey(constantProps.phenomenon);\r\n    if (!schemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);\r\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(schemaItemKey,\r\n      async () => {\r\n        const phenom = await this.schema.lookupItem<Phenomenon>(schemaItemKey);\r\n        if (undefined === phenom)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${constantProps.phenomenon}.`);\r\n        return phenom;\r\n      });\r\n\r\n    if (this._definition !== \"\" && constantProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Constant ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = constantProps.definition;\r\n\r\n    if (undefined !== constantProps.numerator) {\r\n      if (constantProps.numerator !== this._numerator)\r\n        this._numerator = constantProps.numerator;\r\n    }\r\n\r\n    if (undefined !== constantProps.denominator) {\r\n      if (constantProps.denominator !== this._denominator)\r\n        this._denominator = constantProps.denominator;\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(constantProps: ConstantProps) {\r\n    this.fromJSONSync(constantProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   * @param phenomenon A LazyLoadedPhenomenon.\r\n   */\r\n  protected setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\r\n    this._phenomenon = phenomenon;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setNumerator(numerator: number) {\r\n    this._numerator = numerator;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setDenominator(denominator: number) {\r\n    this._denominator = denominator;\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableConstant extends Constant {\r\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): void;\r\n  public abstract override setDefinition(definition: string): void;\r\n  public abstract override setNumerator(numerator: number): void;\r\n  public abstract override setDenominator(denominator: number): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -0,0 +1,24 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { Schema } from "./Schema";
+/** @beta */
+export interface CustomAttribute {
+    className: string;
+    [propName: string]: any;
+}
+/** @internal */
+export interface CustomAttributeSet {
+    [Symbol.iterator]: () => IterableIterator<[string, CustomAttribute]>;
+    has(className: string): boolean;
+    get(className: string): CustomAttribute | undefined;
+}
+/** @beta */
+export interface CustomAttributeContainerProps {
+    customAttributes?: CustomAttributeSet;
+    fullName: string;
+    schema: Schema;
+}
+/** @internal */
+export declare function serializeCustomAttributes(customAttributes: CustomAttributeSet | undefined): any[] | undefined;
+//# sourceMappingURL=CustomAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CustomAttribute.d.ts","sourceRoot":"","sources":["../../../src/Metadata/CustomAttribute.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,YAAY;AACZ,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,kBAAkB;IACjC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,gBAAgB,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IACrE,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;CACrD;AAED,YAAY;AACZ,MAAM,WAAW,6BAA6B;IAC5C,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CAAC,gBAAgB,EAAE,kBAAkB,GAAG,SAAS,GAAG,GAAG,EAAE,GAAG,SAAS,CAc7G"}

package/lib/esm/Metadata/CustomAttribute.js

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+/** @internal */
+export function serializeCustomAttributes(customAttributes) {
+    if (undefined !== customAttributes) { // custom attributes is optional
+        const attributes = [];
+        for (const [, customAttribute] of customAttributes) {
+            const attribute = {};
+            Object.keys(customAttribute).map((property) => {
+                const propertyName = property.toString();
+                attribute[propertyName] = customAttribute[property];
+            });
+            attributes.push(attribute);
+        }
+        return (attributes.length > 0) ? attributes : undefined;
+    }
+    return undefined;
+}
+//# sourceMappingURL=CustomAttribute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CustomAttribute.js","sourceRoot":"","sources":["../../../src/Metadata/CustomAttribute.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAwBH,gBAAgB;AAChB,MAAM,UAAU,yBAAyB,CAAC,gBAAgD;IACxF,IAAI,SAAS,KAAK,gBAAgB,EAAE,CAAC,CAAC,gCAAgC;QACpE,MAAM,UAAU,GAAU,EAAE,CAAC;QAC7B,KAAK,MAAM,CAAC,EAAE,eAAe,CAAC,IAAI,gBAAgB,EAAE,CAAC;YACnD,MAAM,SAAS,GAA6B,EAAE,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,QAAa,EAAE,EAAE;gBACjD,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACzC,SAAS,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;YACH,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { Schema } from \"./Schema\";\r\n\r\n/** @beta */\r\nexport interface CustomAttribute {\r\n  className: string;\r\n  [propName: string]: any;\r\n}\r\n\r\n/** @internal */\r\nexport interface CustomAttributeSet {\r\n  [Symbol.iterator]: () => IterableIterator<[string, CustomAttribute]>;\r\n  has(className: string): boolean;\r\n  get(className: string): CustomAttribute | undefined;\r\n}\r\n\r\n/** @beta */\r\nexport interface CustomAttributeContainerProps {\r\n  customAttributes?: CustomAttributeSet;\r\n  fullName: string;\r\n  schema: Schema;\r\n}\r\n\r\n/** @internal */\r\nexport function serializeCustomAttributes(customAttributes: CustomAttributeSet | undefined): any[] | undefined {\r\n  if (undefined !== customAttributes) { // custom attributes is optional\r\n    const attributes: any[] = [];\r\n    for (const [, customAttribute] of customAttributes) {\r\n      const attribute: { [value: string]: any } = {};\r\n      Object.keys(customAttribute).map((property: any) => {\r\n        const propertyName = property.toString();\r\n        attribute[propertyName] = customAttribute[property];\r\n      });\r\n      attributes.push(attribute);\r\n    }\r\n    return (attributes.length > 0) ? attributes : undefined;\r\n  }\r\n  return undefined;\r\n}\r\n"]}

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

@@ -0,0 +1,44 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { CustomAttributeClassProps } from "../Deserialization/JsonProps";
+import { CustomAttributeContainerType, ECClassModifier, SchemaItemType } from "../ECObjects";
+import { ECClass } from "./Class";
+import { Schema } from "./Schema";
+/**
+ * A Typescript class representation of an ECCustomAttributeClass.
+ * @beta
+ */
+export declare class CustomAttributeClass extends ECClass {
+    readonly schemaItemType: SchemaItemType.CustomAttributeClass;
+    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).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): CustomAttributeClassProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(customAttributeProps: CustomAttributeClassProps): void;
+    fromJSON(customAttributeProps: CustomAttributeClassProps): Promise<void>;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setAppliesTo(containerType: CustomAttributeContainerType): void;
+}
+/**
+ * @internal
+ * An abstract class used for Schema editing.
+ */
+export declare abstract class MutableCAClass extends CustomAttributeClass {
+    abstract setAppliesTo(containerType: CustomAttributeContainerType): void;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+//# sourceMappingURL=CustomAttributeClass.d.ts.map

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

@@ -0,0 +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"}

package/lib/esm/Metadata/CustomAttributeClass.js

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { containerTypeToString, parseCustomAttributeContainerType, SchemaItemType, } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECClass } from "./Class";
+/**
+ * A Typescript class representation of an ECCustomAttributeClass.
+ * @beta
+ */
+export class CustomAttributeClass extends ECClass {
+    /**
+     * @deprecated in 4.8 use [[appliesTo]]
+     * */
+    get containerType() {
+        return this.appliesTo;
+    }
+    get appliesTo() {
+        if (undefined === this._appliesTo)
+            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).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.appliesTo = containerTypeToString(this.appliesTo);
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        itemElement.setAttribute("appliesTo", containerTypeToString(this.appliesTo));
+        return itemElement;
+    }
+    fromJSONSync(customAttributeProps) {
+        super.fromJSONSync(customAttributeProps);
+        const appliesTo = parseCustomAttributeContainerType(customAttributeProps.appliesTo);
+        if (undefined === appliesTo)
+            throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `${appliesTo} is not a valid CustomAttributeContainerType.`);
+        this._appliesTo = appliesTo;
+    }
+    async fromJSON(customAttributeProps) {
+        this.fromJSONSync(customAttributeProps);
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setAppliesTo(containerType) {
+        this._appliesTo = containerType;
+    }
+}
+/**
+ * @internal
+ * An abstract class used for Schema editing.
+ */
+export class MutableCAClass extends CustomAttributeClass {
+}
+//# sourceMappingURL=CustomAttributeClass.js.map

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

@@ -0,0 +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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { CustomAttributeClassProps } from \"../Deserialization/JsonProps\";\r\nimport {\r\n  containerTypeToString, CustomAttributeContainerType, ECClassModifier, parseCustomAttributeContainerType, SchemaItemType,\r\n} from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { ECClass } from \"./Class\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/**\r\n * A Typescript class representation of an ECCustomAttributeClass.\r\n * @beta\r\n */\r\nexport class CustomAttributeClass extends ECClass {\r\n  public override readonly schemaItemType!: SchemaItemType.CustomAttributeClass; // eslint-disable-line\r\n  protected _appliesTo?: CustomAttributeContainerType;\r\n\r\n  /**\r\n   * @deprecated in 4.8 use [[appliesTo]]\r\n   * */\r\n  public get containerType(): CustomAttributeContainerType {\r\n    return this.appliesTo;\r\n  }\r\n\r\n  public get appliesTo(): CustomAttributeContainerType {\r\n    if (undefined === this._appliesTo)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `The CustomAttributeClass ${this.name} does not have a CustomAttributeContainerType.`);\r\n    return this._appliesTo;\r\n  }\r\n\r\n  constructor(schema: Schema, name: string, modifier?: ECClassModifier) {\r\n    super(schema, name, modifier);\r\n    this.schemaItemType = SchemaItemType.CustomAttributeClass;\r\n  }\r\n\r\n  /**\r\n   * Save this CustomAttributeClasses properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): CustomAttributeClassProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.appliesTo = containerTypeToString(this.appliesTo);\r\n    return schemaJson as CustomAttributeClassProps;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n    itemElement.setAttribute(\"appliesTo\", containerTypeToString(this.appliesTo));\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(customAttributeProps: CustomAttributeClassProps) {\r\n    super.fromJSONSync(customAttributeProps);\r\n    const appliesTo = parseCustomAttributeContainerType(customAttributeProps.appliesTo);\r\n    if (undefined === appliesTo)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidContainerType, `${appliesTo} is not a valid CustomAttributeContainerType.`);\r\n    this._appliesTo = appliesTo;\r\n  }\r\n\r\n  public override async fromJSON(customAttributeProps: CustomAttributeClassProps) {\r\n    this.fromJSONSync(customAttributeProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setAppliesTo(containerType: CustomAttributeContainerType) {\r\n    this._appliesTo = containerType;\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for Schema editing.\r\n */\r\nexport abstract class MutableCAClass extends CustomAttributeClass {\r\n  public abstract override setAppliesTo(containerType: CustomAttributeContainerType): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -0,0 +1,78 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { EntityClassProps } from "../Deserialization/JsonProps";
+import { ECClassModifier, SchemaItemType, StrengthDirection } from "../ECObjects";
+import { 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";
+/**
+ * A Typescript class representation of an ECEntityClass.
+ * @beta
+ */
+export declare class EntityClass extends ECClass {
+    readonly schemaItemType: SchemaItemType.EntityClass;
+    protected _mixins?: LazyLoadedMixin[];
+    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
+    get mixins(): LazyLoadedMixin[];
+    getMixinsSync(): Iterable<Mixin>;
+    /**
+     *
+     * @param mixin
+     */
+    protected addMixin(mixin: Mixin): void;
+    /**
+     * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.
+     * @param name The name of the property to find.
+     */
+    getInheritedProperty(name: string): Promise<AnyProperty | undefined>;
+    /**
+     * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.
+     * @param name The name of the property to find.
+     */
+    getInheritedPropertySync(name: string): Property | undefined;
+    protected buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches?: boolean): Promise<void>;
+    protected buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches?: boolean): void;
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    /**
+     * Save this EntityClass' properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): EntityClassProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSON(entityClassProps: EntityClassProps): Promise<void>;
+    fromJSONSync(entityClassProps: EntityClassProps): void;
+}
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+export declare abstract class MutableEntityClass extends EntityClass {
+    abstract addMixin(mixin: Mixin): any;
+    abstract createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    abstract createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+/** @internal */
+export declare function createNavigationProperty(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+/** @internal */
+export declare function createNavigationPropertySync(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+//# sourceMappingURL=EntityClass.d.ts.map

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

@@ -0,0 +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"}