@itwin/ecschema-metadata 3.6.0-dev.36 → 3.6.0-dev.38

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

@@ -1,55 +1,55 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { MixinProps } from "../Deserialization/JsonProps";
-import { SchemaItemType, StrengthDirection } from "../ECObjects";
-import { LazyLoadedEntityClass } from "../Interfaces";
-import { ECClass } from "./Class";
-import { EntityClass } from "./EntityClass";
-import { NavigationProperty } from "./Property";
-import { RelationshipClass } from "./RelationshipClass";
-import { Schema } from "./Schema";
-/**
- * A Typescript class representation of a Mixin.
- * @beta
- */
-export declare class Mixin extends ECClass {
-    readonly schemaItemType: SchemaItemType.Mixin;
-    protected _appliesTo?: LazyLoadedEntityClass;
-    get appliesTo(): LazyLoadedEntityClass | undefined;
-    constructor(schema: Schema, name: string);
-    /**
-     *
-     * @param name
-     * @param relationship
-     * @param direction
-     */
-    protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
-    protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
-    /**
-     * @alpha Used for schema editing.
-     */
-    protected setAppliesTo(appliesTo: LazyLoadedEntityClass): void;
-    /**
-     * Save this Mixin's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): MixinProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(mixinProps: MixinProps): void;
-    fromJSON(mixinProps: MixinProps): Promise<void>;
-    applicableTo(entityClass: EntityClass): Promise<boolean>;
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutableMixin extends Mixin {
-    abstract setAppliesTo(entityClass: LazyLoadedEntityClass): void;
-    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;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { MixinProps } from "../Deserialization/JsonProps";
+import { SchemaItemType, StrengthDirection } from "../ECObjects";
+import { LazyLoadedEntityClass } from "../Interfaces";
+import { ECClass } from "./Class";
+import { EntityClass } from "./EntityClass";
+import { NavigationProperty } from "./Property";
+import { RelationshipClass } from "./RelationshipClass";
+import { Schema } from "./Schema";
+/**
+ * A Typescript class representation of a Mixin.
+ * @beta
+ */
+export declare class Mixin extends ECClass {
+    readonly schemaItemType: SchemaItemType.Mixin;
+    protected _appliesTo?: LazyLoadedEntityClass;
+    get appliesTo(): LazyLoadedEntityClass | undefined;
+    constructor(schema: Schema, name: string);
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    /**
+     * @alpha Used for schema editing.
+     */
+    protected setAppliesTo(appliesTo: LazyLoadedEntityClass): void;
+    /**
+     * Save this Mixin's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): MixinProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(mixinProps: MixinProps): void;
+    fromJSON(mixinProps: MixinProps): Promise<void>;
+    applicableTo(entityClass: EntityClass): Promise<boolean>;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableMixin extends Mixin {
+    abstract setAppliesTo(entityClass: LazyLoadedEntityClass): void;
+    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;
+}
 //# sourceMappingURL=Mixin.d.ts.map

package/lib/cjs/Metadata/Mixin.js

@@ -1,114 +1,114 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MutableMixin = exports.Mixin = void 0;
-const DelayedPromise_1 = require("../DelayedPromise");
-const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
-const ECObjects_1 = require("../ECObjects");
-const Exception_1 = require("../Exception");
-const Class_1 = require("./Class");
-const EntityClass_1 = require("./EntityClass");
-/**
- * A Typescript class representation of a Mixin.
- * @beta
- */
-class Mixin extends Class_1.ECClass {
-    constructor(schema, name) {
-        super(schema, name, ECObjects_1.ECClassModifier.Abstract);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Mixin;
-    }
-    get appliesTo() {
-        return this._appliesTo;
-    }
-    /**
-     *
-     * @param name
-     * @param relationship
-     * @param direction
-     */
-    async createNavigationProperty(name, relationship, direction) {
-        return this.addProperty(await (0, EntityClass_1.createNavigationProperty)(this, name, relationship, direction));
-    }
-    createNavigationPropertySync(name, relationship, direction) {
-        return this.addProperty((0, EntityClass_1.createNavigationPropertySync)(this, name, relationship, direction));
-    }
-    /**
-     * @alpha Used for schema editing.
-     */
-    setAppliesTo(appliesTo) {
-        this._appliesTo = appliesTo;
-    }
-    /**
-     * Save this Mixin's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone = false, includeSchemaVersion = false) {
-        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
-        if (undefined !== this.appliesTo) {
-            schemaJson.appliesTo = this.appliesTo.fullName;
-        }
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        // When CustomAttributes are added, there must be a check to see if the ECCustomAttributes
-        // already exist for this item before creating a new one to apply IsMixin
-        const customAttributes = schemaXml.createElement("ECCustomAttributes");
-        const isMixinElement = schemaXml.createElement("IsMixin");
-        const coreCustomSchema = this.schema.getReferenceSync("CoreCustomAttributes");
-        if (undefined !== coreCustomSchema) {
-            const xmlns = `CoreCustomAttributes.${coreCustomSchema.schemaKey.version.toString()}`;
-            isMixinElement.setAttribute("xmlns", xmlns);
-        }
-        const appliesToElement = schemaXml.createElement("AppliesToEntityClass");
-        const appliesTo = await this.appliesTo;
-        if (undefined !== appliesTo) {
-            const appliesToName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, appliesTo.schema, appliesTo.name);
-            appliesToElement.textContent = appliesToName;
-            isMixinElement.appendChild(appliesToElement);
-        }
-        customAttributes.appendChild(isMixinElement);
-        itemElement.appendChild(customAttributes);
-        return itemElement;
-    }
-    fromJSONSync(mixinProps) {
-        super.fromJSONSync(mixinProps);
-        const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);
-        if (!entityClassSchemaItemKey)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
-        this._appliesTo = new DelayedPromise_1.DelayedPromiseWithProps(entityClassSchemaItemKey, async () => {
-            const appliesTo = await this.schema.lookupItem(entityClassSchemaItemKey);
-            if (undefined === appliesTo)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
-            return appliesTo;
-        });
-    }
-    async fromJSON(mixinProps) {
-        this.fromJSONSync(mixinProps);
-    }
-    async applicableTo(entityClass) {
-        if (!this.appliesTo)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);
-        const appliesTo = await this.appliesTo;
-        if (appliesTo === undefined)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);
-        return appliesTo.is(entityClass);
-    }
-}
-exports.Mixin = Mixin;
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-class MutableMixin extends Mixin {
-}
-exports.MutableMixin = MutableMixin;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableMixin = exports.Mixin = void 0;
+const DelayedPromise_1 = require("../DelayedPromise");
+const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const Class_1 = require("./Class");
+const EntityClass_1 = require("./EntityClass");
+/**
+ * A Typescript class representation of a Mixin.
+ * @beta
+ */
+class Mixin extends Class_1.ECClass {
+    constructor(schema, name) {
+        super(schema, name, ECObjects_1.ECClassModifier.Abstract);
+        this.schemaItemType = ECObjects_1.SchemaItemType.Mixin;
+    }
+    get appliesTo() {
+        return this._appliesTo;
+    }
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    async createNavigationProperty(name, relationship, direction) {
+        return this.addProperty(await (0, EntityClass_1.createNavigationProperty)(this, name, relationship, direction));
+    }
+    createNavigationPropertySync(name, relationship, direction) {
+        return this.addProperty((0, EntityClass_1.createNavigationPropertySync)(this, name, relationship, direction));
+    }
+    /**
+     * @alpha Used for schema editing.
+     */
+    setAppliesTo(appliesTo) {
+        this._appliesTo = appliesTo;
+    }
+    /**
+     * Save this Mixin's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        if (undefined !== this.appliesTo) {
+            schemaJson.appliesTo = this.appliesTo.fullName;
+        }
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        // When CustomAttributes are added, there must be a check to see if the ECCustomAttributes
+        // already exist for this item before creating a new one to apply IsMixin
+        const customAttributes = schemaXml.createElement("ECCustomAttributes");
+        const isMixinElement = schemaXml.createElement("IsMixin");
+        const coreCustomSchema = this.schema.getReferenceSync("CoreCustomAttributes");
+        if (undefined !== coreCustomSchema) {
+            const xmlns = `CoreCustomAttributes.${coreCustomSchema.schemaKey.version.toString()}`;
+            isMixinElement.setAttribute("xmlns", xmlns);
+        }
+        const appliesToElement = schemaXml.createElement("AppliesToEntityClass");
+        const appliesTo = await this.appliesTo;
+        if (undefined !== appliesTo) {
+            const appliesToName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, appliesTo.schema, appliesTo.name);
+            appliesToElement.textContent = appliesToName;
+            isMixinElement.appendChild(appliesToElement);
+        }
+        customAttributes.appendChild(isMixinElement);
+        itemElement.appendChild(customAttributes);
+        return itemElement;
+    }
+    fromJSONSync(mixinProps) {
+        super.fromJSONSync(mixinProps);
+        const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);
+        if (!entityClassSchemaItemKey)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+        this._appliesTo = new DelayedPromise_1.DelayedPromiseWithProps(entityClassSchemaItemKey, async () => {
+            const appliesTo = await this.schema.lookupItem(entityClassSchemaItemKey);
+            if (undefined === appliesTo)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+            return appliesTo;
+        });
+    }
+    async fromJSON(mixinProps) {
+        this.fromJSONSync(mixinProps);
+    }
+    async applicableTo(entityClass) {
+        if (!this.appliesTo)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);
+        const appliesTo = await this.appliesTo;
+        if (appliesTo === undefined)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);
+        return appliesTo.is(entityClass);
+    }
+}
+exports.Mixin = Mixin;
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+class MutableMixin extends Mixin {
+}
+exports.MutableMixin = MutableMixin;
 //# sourceMappingURL=Mixin.js.map

package/lib/cjs/Metadata/Mixin.js.map

@@ -1 +1 @@
-{"version":3,"file":"Mixin.js","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAAkF;AAClF,4CAA+D;AAG/D,mCAAkC;AAClC,+CAAoG;AAKpG;;;GAGG;AACH,MAAa,KAAM,SAAQ,eAAO;IAQhC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,2BAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,KAAK,CAAC;IAC7C,CAAC;IAPD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAOD;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,IAAA,sCAAwB,EAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAES,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,IAAA,0CAA4B,EAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,SAAgC;QACrD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IACD;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YAChC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SAChD;QACD,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,0FAA0F;QAC1F,yEAAyE;QACzE,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACvE,MAAM,cAAc,GAAG,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;QAC9E,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,KAAK,GAAG,wBAAwB,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtF,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SAC7C;QAED,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,aAAa,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;YAC9G,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;SAC9C;QAED,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAC7C,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAE1C,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,UAAsB;QACjD,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC/B,MAAM,wBAAwB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACpF,IAAI,CAAC,wBAAwB;YAC3B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QACrH,IAAI,CAAC,UAAU,GAAG,IAAI,wCAAuB,CAA6B,wBAAwB,EAChG,KAAK,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAc,wBAAwB,CAAC,CAAC;YACtF,IAAI,SAAS,KAAK,SAAS;gBACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACrH,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,UAAsB;QACnD,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,WAAwB;QAChD,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,uCAAuC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEjH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEtH,OAAO,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AAtGD,sBAsGC;AACD;;;GAGG;AACH,MAAsB,YAAa,SAAQ,KAAK;CAK/C;AALD,oCAKC","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 { MixinProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { ECClassModifier, SchemaItemType, StrengthDirection } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { LazyLoadedEntityClass } from \"../Interfaces\";\nimport { SchemaItemKey } from \"../SchemaKey\";\nimport { ECClass } from \"./Class\";\nimport { createNavigationProperty, createNavigationPropertySync, EntityClass } from \"./EntityClass\";\nimport { NavigationProperty } from \"./Property\";\nimport { RelationshipClass } from \"./RelationshipClass\";\nimport { Schema } from \"./Schema\";\n\n/**\n * A Typescript class representation of a Mixin.\n * @beta\n */\nexport class Mixin extends ECClass {\n  public override readonly schemaItemType!: SchemaItemType.Mixin; // eslint-disable-line\n  protected _appliesTo?: LazyLoadedEntityClass;\n\n  public get appliesTo(): LazyLoadedEntityClass | undefined {\n    return this._appliesTo;\n  }\n\n  constructor(schema: Schema, name: string) {\n    super(schema, name, ECClassModifier.Abstract);\n    this.schemaItemType = SchemaItemType.Mixin;\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  protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\n    return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));\n  }\n\n  /**\n   * @alpha Used for schema editing.\n   */\n  protected setAppliesTo(appliesTo: LazyLoadedEntityClass) {\n    this._appliesTo = appliesTo;\n  }\n  /**\n   * Save this Mixin'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): MixinProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    if (undefined !== this.appliesTo) {\n      schemaJson.appliesTo = this.appliesTo.fullName;\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\n    // When CustomAttributes are added, there must be a check to see if the ECCustomAttributes\n    // already exist for this item before creating a new one to apply IsMixin\n    const customAttributes = schemaXml.createElement(\"ECCustomAttributes\");\n    const isMixinElement = schemaXml.createElement(\"IsMixin\");\n    const coreCustomSchema = this.schema.getReferenceSync(\"CoreCustomAttributes\");\n    if (undefined !== coreCustomSchema) {\n      const xmlns = `CoreCustomAttributes.${coreCustomSchema.schemaKey.version.toString()}`;\n      isMixinElement.setAttribute(\"xmlns\", xmlns);\n    }\n\n    const appliesToElement = schemaXml.createElement(\"AppliesToEntityClass\");\n    const appliesTo = await this.appliesTo;\n    if (undefined !== appliesTo) {\n      const appliesToName = XmlSerializationUtils.createXmlTypedName(this.schema, appliesTo.schema, appliesTo.name);\n      appliesToElement.textContent = appliesToName;\n      isMixinElement.appendChild(appliesToElement);\n    }\n\n    customAttributes.appendChild(isMixinElement);\n    itemElement.appendChild(customAttributes);\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(mixinProps: MixinProps) {\n    super.fromJSONSync(mixinProps);\n    const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);\n    if (!entityClassSchemaItemKey)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);\n    this._appliesTo = new DelayedPromiseWithProps<SchemaItemKey, EntityClass>(entityClassSchemaItemKey,\n      async () => {\n        const appliesTo = await this.schema.lookupItem<EntityClass>(entityClassSchemaItemKey);\n        if (undefined === appliesTo)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);\n        return appliesTo;\n      });\n  }\n\n  public override async fromJSON(mixinProps: MixinProps) {\n    this.fromJSONSync(mixinProps);\n  }\n\n  public async applicableTo(entityClass: EntityClass) {\n    if (!this.appliesTo)\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);\n\n    const appliesTo = await this.appliesTo;\n    if (appliesTo === undefined)\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);\n\n    return appliesTo.is(entityClass);\n  }\n}\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableMixin extends Mixin {\n  public abstract override setAppliesTo(entityClass: LazyLoadedEntityClass): void;\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"]}
+{"version":3,"file":"Mixin.js","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAAkF;AAClF,4CAA+D;AAG/D,mCAAkC;AAClC,+CAAoG;AAKpG;;;GAGG;AACH,MAAa,KAAM,SAAQ,eAAO;IAQhC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,2BAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,KAAK,CAAC;IAC7C,CAAC;IAPD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAOD;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,IAAA,sCAAwB,EAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAES,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,IAAA,0CAA4B,EAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,SAAgC;QACrD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IACD;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YAChC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SAChD;QACD,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,0FAA0F;QAC1F,yEAAyE;QACzE,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACvE,MAAM,cAAc,GAAG,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;QAC9E,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,KAAK,GAAG,wBAAwB,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtF,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SAC7C;QAED,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,aAAa,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;YAC9G,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;SAC9C;QAED,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAC7C,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAE1C,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,UAAsB;QACjD,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC/B,MAAM,wBAAwB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACpF,IAAI,CAAC,wBAAwB;YAC3B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QACrH,IAAI,CAAC,UAAU,GAAG,IAAI,wCAAuB,CAA6B,wBAAwB,EAChG,KAAK,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAc,wBAAwB,CAAC,CAAC;YACtF,IAAI,SAAS,KAAK,SAAS;gBACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACrH,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,UAAsB;QACnD,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,WAAwB;QAChD,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,uCAAuC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEjH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEtH,OAAO,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AAtGD,sBAsGC;AACD;;;GAGG;AACH,MAAsB,YAAa,SAAQ,KAAK;CAK/C;AALD,oCAKC","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 { MixinProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { ECClassModifier, SchemaItemType, StrengthDirection } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedEntityClass } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { ECClass } from \"./Class\";\r\nimport { createNavigationProperty, createNavigationPropertySync, EntityClass } from \"./EntityClass\";\r\nimport { NavigationProperty } from \"./Property\";\r\nimport { RelationshipClass } from \"./RelationshipClass\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/**\r\n * A Typescript class representation of a Mixin.\r\n * @beta\r\n */\r\nexport class Mixin extends ECClass {\r\n  public override readonly schemaItemType!: SchemaItemType.Mixin; // eslint-disable-line\r\n  protected _appliesTo?: LazyLoadedEntityClass;\r\n\r\n  public get appliesTo(): LazyLoadedEntityClass | undefined {\r\n    return this._appliesTo;\r\n  }\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name, ECClassModifier.Abstract);\r\n    this.schemaItemType = SchemaItemType.Mixin;\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param name\r\n   * @param relationship\r\n   * @param direction\r\n   */\r\n  protected async createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\r\n    return this.addProperty(await createNavigationProperty(this, name, relationship, direction));\r\n  }\r\n\r\n  protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\r\n    return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));\r\n  }\r\n\r\n  /**\r\n   * @alpha Used for schema editing.\r\n   */\r\n  protected setAppliesTo(appliesTo: LazyLoadedEntityClass) {\r\n    this._appliesTo = appliesTo;\r\n  }\r\n  /**\r\n   * Save this Mixin's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): MixinProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    if (undefined !== this.appliesTo) {\r\n      schemaJson.appliesTo = this.appliesTo.fullName;\r\n    }\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n\r\n    // When CustomAttributes are added, there must be a check to see if the ECCustomAttributes\r\n    // already exist for this item before creating a new one to apply IsMixin\r\n    const customAttributes = schemaXml.createElement(\"ECCustomAttributes\");\r\n    const isMixinElement = schemaXml.createElement(\"IsMixin\");\r\n    const coreCustomSchema = this.schema.getReferenceSync(\"CoreCustomAttributes\");\r\n    if (undefined !== coreCustomSchema) {\r\n      const xmlns = `CoreCustomAttributes.${coreCustomSchema.schemaKey.version.toString()}`;\r\n      isMixinElement.setAttribute(\"xmlns\", xmlns);\r\n    }\r\n\r\n    const appliesToElement = schemaXml.createElement(\"AppliesToEntityClass\");\r\n    const appliesTo = await this.appliesTo;\r\n    if (undefined !== appliesTo) {\r\n      const appliesToName = XmlSerializationUtils.createXmlTypedName(this.schema, appliesTo.schema, appliesTo.name);\r\n      appliesToElement.textContent = appliesToName;\r\n      isMixinElement.appendChild(appliesToElement);\r\n    }\r\n\r\n    customAttributes.appendChild(isMixinElement);\r\n    itemElement.appendChild(customAttributes);\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(mixinProps: MixinProps) {\r\n    super.fromJSONSync(mixinProps);\r\n    const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);\r\n    if (!entityClassSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);\r\n    this._appliesTo = new DelayedPromiseWithProps<SchemaItemKey, EntityClass>(entityClassSchemaItemKey,\r\n      async () => {\r\n        const appliesTo = await this.schema.lookupItem<EntityClass>(entityClassSchemaItemKey);\r\n        if (undefined === appliesTo)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);\r\n        return appliesTo;\r\n      });\r\n  }\r\n\r\n  public override async fromJSON(mixinProps: MixinProps) {\r\n    this.fromJSONSync(mixinProps);\r\n  }\r\n\r\n  public async applicableTo(entityClass: EntityClass) {\r\n    if (!this.appliesTo)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);\r\n\r\n    const appliesTo = await this.appliesTo;\r\n    if (appliesTo === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);\r\n\r\n    return appliesTo.is(entityClass);\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableMixin extends Mixin {\r\n  public abstract override setAppliesTo(entityClass: LazyLoadedEntityClass): void;\r\n  public abstract override createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;\r\n  public abstract override createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -1,56 +1,56 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
-import { Format } from "./Format";
-import { InvertedUnit } from "./InvertedUnit";
-import { Schema } from "./Schema";
-import { Unit } from "./Unit";
-/**
- * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
- */
-export declare class OverrideFormat {
-    private _precision?;
-    private _units?;
-    /** The Format that this OverrideFormat is extending */
-    readonly parent: Format;
-    /** The name of this OverrideFormat.
-     *
-     * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.
-     */
-    readonly name: string;
-    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>);
-    get precision(): DecimalPrecision | FractionalPrecision;
-    get units(): [Unit | InvertedUnit, string | undefined][] | undefined;
-    get fullName(): string;
-    get roundFactor(): number;
-    get type(): FormatType;
-    get minWidth(): number | undefined;
-    get scientificType(): ScientificType | undefined;
-    get showSignOption(): ShowSignOption;
-    get decimalSeparator(): string;
-    get thousandSeparator(): string;
-    get uomSeparator(): string;
-    get stationSeparator(): string;
-    get stationOffsetSize(): number | undefined;
-    get formatTraits(): FormatTraits;
-    get spacer(): string | undefined;
-    get includeZero(): boolean | undefined;
-    hasFormatTrait(formatTrait: FormatTraits): boolean;
-    /** Returns the format string of this override in the Xml full name format.
-     * @alpha
-     */
-    fullNameXml(koqSchema: Schema): string;
-    /**
-     * Creates a valid OverrideFormat fullName from the parent Format and overridden units.
-     * @param parent The parent Format.
-     * @param unitAndLabels The overridden unit and labels collection.
-     */
-    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string;
-    /**
-     * @internal
-     */
-    static isOverrideFormat(object: any): object is OverrideFormat;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
+import { Format } from "./Format";
+import { InvertedUnit } from "./InvertedUnit";
+import { Schema } from "./Schema";
+import { Unit } from "./Unit";
+/**
+ * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
+ * @beta
+ */
+export declare class OverrideFormat {
+    private _precision?;
+    private _units?;
+    /** The Format that this OverrideFormat is extending */
+    readonly parent: Format;
+    /** The name of this OverrideFormat.
+     *
+     * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.
+     */
+    readonly name: string;
+    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>);
+    get precision(): DecimalPrecision | FractionalPrecision;
+    get units(): [Unit | InvertedUnit, string | undefined][] | undefined;
+    get fullName(): string;
+    get roundFactor(): number;
+    get type(): FormatType;
+    get minWidth(): number | undefined;
+    get scientificType(): ScientificType | undefined;
+    get showSignOption(): ShowSignOption;
+    get decimalSeparator(): string;
+    get thousandSeparator(): string;
+    get uomSeparator(): string;
+    get stationSeparator(): string;
+    get stationOffsetSize(): number | undefined;
+    get formatTraits(): FormatTraits;
+    get spacer(): string | undefined;
+    get includeZero(): boolean | undefined;
+    hasFormatTrait(formatTrait: FormatTraits): boolean;
+    /** Returns the format string of this override in the Xml full name format.
+     * @alpha
+     */
+    fullNameXml(koqSchema: Schema): string;
+    /**
+     * Creates a valid OverrideFormat fullName from the parent Format and overridden units.
+     * @param parent The parent Format.
+     * @param unitAndLabels The overridden unit and labels collection.
+     */
+    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string;
+    /**
+     * @internal
+     */
+    static isOverrideFormat(object: any): object is OverrideFormat;
+}
 //# sourceMappingURL=OverrideFormat.d.ts.map