@itwin/ecschema-metadata 5.0.0-dev.98 → 5.0.0

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

@@ -12,24 +12,36 @@ import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
 /**
  * A Typescript class representation of a Mixin.
- * @beta
+ * @public @preview
  */
 export declare class Mixin extends ECClass {
     readonly schemaItemType: SchemaItemType;
+    /** @internal */
     static get schemaItemType(): SchemaItemType;
-    protected _appliesTo?: LazyLoadedEntityClass;
+    private _appliesTo?;
     get appliesTo(): LazyLoadedEntityClass | undefined;
+    /** @internal */
     constructor(schema: Schema, name: string);
     /**
      *
      * @param name
      * @param relationship
      * @param direction
+     * @internal
      */
     protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     * @returns
+     *
+     * @internal
+     */
     protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
     /**
-     * @alpha Used for schema editing.
+     * @internal
      */
     protected setAppliesTo(appliesTo: LazyLoadedEntityClass): void;
     /**
@@ -53,6 +65,7 @@ export declare class Mixin extends ECClass {
      * Type assertion to check if the SchemaItem is of type Mixin.
      * @param item The SchemaItem to check.
      * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.
+     * @internal
      */
     static assertIsMixin(item?: SchemaItem): asserts item is Mixin;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Mixin.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAmB,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAElF,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAA0D,WAAW,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,KAAM,SAAQ,OAAO;IAChC,SAAyB,cAAc,iBAAwB;IAC/D,WAA2B,cAAc,mBAAmC;IAC5E,SAAS,CAAC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IAE7C,IAAW,SAAS,IAAI,qBAAqB,GAAG,SAAS,CAExD;gBAEW,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIxC;;;;;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,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,qBAAqB;IAGvD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,UAAU;IAQtG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA2BlD,YAAY,CAAC,UAAU,EAAE,UAAU;IAc7B,QAAQ,CAAC,UAAU,EAAE,UAAU;IAIxC,YAAY,CAAC,WAAW,EAAE,WAAW;IAWlD;;;;OAIG;WACW,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,KAAK;IAOvD;;;;OAIG;WACW,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK;CAItE;AACD;;;GAGG;AACH,8BAAsB,YAAa,SAAQ,KAAK;aACrB,YAAY,CAAC,WAAW,EAAE,qBAAqB,GAAG,IAAI;aACtD,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"}
+{"version":3,"file":"Mixin.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAmB,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAElF,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAA0D,WAAW,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,KAAM,SAAQ,OAAO;IAChC,SAAyB,cAAc,iBAAwB;IAC/D,gBAAgB;IAChB,WAA2B,cAAc,mBAAmC;IAC5E,OAAO,CAAC,UAAU,CAAC,CAAwB;IAE3C,IAAW,SAAS,IAAI,qBAAqB,GAAG,SAAS,CAExD;IAED,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIxC;;;;;;OAMG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK;;;;;;;;OAQG;IACH,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,qBAAqB;IAIvD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,UAAU;IAQtG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA2BlD,YAAY,CAAC,UAAU,EAAE,UAAU;IAc7B,QAAQ,CAAC,UAAU,EAAE,UAAU;IAIxC,YAAY,CAAC,WAAW,EAAE,WAAW;IAWlD;;;;OAIG;WACW,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,KAAK;IAOvD;;;;;OAKG;WACW,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK;CAItE;AACD;;;GAGG;AACH,8BAAsB,YAAa,SAAQ,KAAK;aACrB,YAAY,CAAC,WAAW,EAAE,qBAAqB,GAAG,IAAI;aACtD,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"}

package/lib/cjs/Metadata/Mixin.js

@@ -16,15 +16,17 @@ const Class_1 = require("./Class");
 const EntityClass_1 = require("./EntityClass");
 /**
  * A Typescript class representation of a Mixin.
- * @beta
+ * @public @preview
  */
 class Mixin extends Class_1.ECClass {
     schemaItemType = Mixin.schemaItemType;
+    /** @internal */
     static get schemaItemType() { return ECObjects_1.SchemaItemType.Mixin; }
     _appliesTo;
     get appliesTo() {
         return this._appliesTo;
     }
+    /** @internal */
     constructor(schema, name) {
         super(schema, name, ECObjects_1.ECClassModifier.Abstract);
     }
@@ -33,15 +35,25 @@ class Mixin extends Class_1.ECClass {
      * @param name
      * @param relationship
      * @param direction
+     * @internal
      */
     async createNavigationProperty(name, relationship, direction) {
         return this.addProperty(await (0, EntityClass_1.createNavigationProperty)(this, name, relationship, direction));
     }
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     * @returns
+     *
+     * @internal
+     */
     createNavigationPropertySync(name, relationship, direction) {
         return this.addProperty((0, EntityClass_1.createNavigationPropertySync)(this, name, relationship, direction));
     }
     /**
-     * @alpha Used for schema editing.
+     * @internal
      */
     setAppliesTo(appliesTo) {
         this._appliesTo = appliesTo;
@@ -85,11 +97,11 @@ class Mixin extends Class_1.ECClass {
         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}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
         this._appliesTo = new DelayedPromise_1.DelayedPromiseWithProps(entityClassSchemaItemKey, async () => {
             const appliesTo = await this.schema.lookupItem(entityClassSchemaItemKey, EntityClass_1.EntityClass);
             if (undefined === appliesTo)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
             return appliesTo;
         });
     }
@@ -98,10 +110,10 @@ class Mixin extends Class_1.ECClass {
     }
     async applicableTo(entityClass) {
         if (!this.appliesTo)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.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}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);
         return appliesTo.is(entityClass);
     }
     /**
@@ -118,10 +130,11 @@ class Mixin extends Class_1.ECClass {
      * Type assertion to check if the SchemaItem is of type Mixin.
      * @param item The SchemaItem to check.
      * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.
+     * @internal
      */
     static assertIsMixin(item) {
         if (!this.isMixin(item))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Mixin}' (Mixin)`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Mixin}' (Mixin)`);
     }
 }
 exports.Mixin = Mixin;

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;AAMpG;;;GAGG;AACH,MAAa,KAAM,SAAQ,eAAO;IACP,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IACxD,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,UAAU,CAAyB;IAE7C,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,2BAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;;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,CAAC;YACjC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACjD,CAAC;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,CAAC;YACnC,MAAM,KAAK,GAAG,wBAAwB,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtF,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;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,CAAC;YAC5B,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;QAC/C,CAAC;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,EAAE,yBAAW,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;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,IAAiB;QACrC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,KAAK;YACtD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACrB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,KAAK,WAAW,CAAC,CAAC;IAClH,CAAC;CACF;AA5HD,sBA4HC;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\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * A Typescript class representation of a Mixin.\n * @beta\n */\nexport class Mixin extends ECClass {\n  public override readonly schemaItemType = Mixin.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Mixin; }\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  }\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(entityClassSchemaItemKey, EntityClass);\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   * Type guard to check if the SchemaItem is of type Mixin.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Mixin, false otherwise.\n   */\n  public static isMixin(item?: SchemaItem): item is Mixin {\n    if (item && item.schemaItemType === SchemaItemType.Mixin)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Mixin.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.\n   */\n  public static assertIsMixin(item?: SchemaItem): asserts item is Mixin {\n    if (!this.isMixin(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Mixin}' (Mixin)`);\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,4CAA6D;AAG7D,mCAAkC;AAClC,+CAAoG;AAMpG;;;GAGG;AACH,MAAa,KAAM,SAAQ,eAAO;IACP,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC/D,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,UAAU,CAAyB;IAE3C,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,2BAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;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;IAED;;;;;;;;OAQG;IACO,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;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,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACjD,CAAC;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,CAAC;YACnC,MAAM,KAAK,GAAG,wBAAwB,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtF,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;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,CAAC;YAC5B,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;QAC/C,CAAC;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,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QACnH,IAAI,CAAC,UAAU,GAAG,IAAI,wCAAuB,CAA6B,wBAAwB,EAChG,KAAK,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,wBAAwB,EAAE,yBAAW,CAAC,CAAC;YACtF,IAAI,SAAS,KAAK,SAAS;gBACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACnH,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,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,uCAAuC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAE/G,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEpH,OAAO,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,IAAiB;QACrC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,KAAK;YACtD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACrB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,KAAK,WAAW,CAAC,CAAC;IAChH,CAAC;CACF;AA1ID,sBA0IC;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 { ECSchemaError, ECSchemaStatus } 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\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * A Typescript class representation of a Mixin.\n * @public @preview\n */\nexport class Mixin extends ECClass {\n  public override readonly schemaItemType = Mixin.schemaItemType;\n  /** @internal */\n  public static override get schemaItemType() { return SchemaItemType.Mixin; }\n  private _appliesTo?: LazyLoadedEntityClass;\n\n  public get appliesTo(): LazyLoadedEntityClass | undefined {\n    return this._appliesTo;\n  }\n\n  /** @internal */\n  constructor(schema: Schema, name: string) {\n    super(schema, name, ECClassModifier.Abstract);\n  }\n\n  /**\n   *\n   * @param name\n   * @param relationship\n   * @param direction\n   * @internal\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   * @returns\n   *\n   * @internal\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   * @internal\n   */\n  protected setAppliesTo(appliesTo: LazyLoadedEntityClass) {\n    this._appliesTo = appliesTo;\n  }\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 ECSchemaError(ECSchemaStatus.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(entityClassSchemaItemKey, EntityClass);\n        if (undefined === appliesTo)\n          throw new ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);\n\n    const appliesTo = await this.appliesTo;\n    if (appliesTo === undefined)\n      throw new ECSchemaError(ECSchemaStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);\n\n    return appliesTo.is(entityClass);\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Mixin.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Mixin, false otherwise.\n   */\n  public static isMixin(item?: SchemaItem): item is Mixin {\n    if (item && item.schemaItemType === SchemaItemType.Mixin)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Mixin.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.\n   * @internal\n   */\n  public static assertIsMixin(item?: SchemaItem): asserts item is Mixin {\n    if (!this.isMixin(item))\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Mixin}' (Mixin)`);\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"]}

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

@@ -3,21 +3,20 @@
  */
 import { DecimalPrecision, FormatProps, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
 import { Format } from "./Format";
-import { InvertedUnit } from "./InvertedUnit";
 import { Schema } from "./Schema";
 import { SchemaItemOverrideFormatProps } from "../Deserialization/JsonProps";
-import { Unit } from "./Unit";
+import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
 /**
- * @beta
+ * @public @preview
  */
 export interface OverrideFormatProps {
-    name: string;
-    precision?: number;
-    unitAndLabels?: Array<[string, string | undefined]>;
+    readonly name: string;
+    readonly precision?: number;
+    readonly unitAndLabels?: Array<[string, string | undefined]>;
 }
 /**
  * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
+ * @public @preview
  */
 export declare class OverrideFormat {
     private _precision?;
@@ -29,9 +28,10 @@ export declare class 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]>);
+    /** @internal */
+    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>);
     get precision(): DecimalPrecision | FractionalPrecision;
-    get units(): [Unit | InvertedUnit, string | undefined][] | undefined;
+    get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;
     get fullName(): string;
     get roundFactor(): number;
     get type(): FormatType;
@@ -48,7 +48,7 @@ export declare class OverrideFormat {
     get includeZero(): boolean | undefined;
     hasFormatTrait(formatTrait: FormatTraits): boolean;
     /** Returns the format string of this override in the Xml full name format.
-     * @alpha
+     * @internal
      */
     fullNameXml(koqSchema: Schema): string;
     /**
@@ -56,7 +56,7 @@ export declare class OverrideFormat {
      * @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;
+    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): string;
     /** Parses the format string into the parts that make up an Override Format
      * @param formatString
      */
@@ -64,7 +64,7 @@ export declare class OverrideFormat {
     /**
      * @internal
      */
-    static isOverrideFormat(object: any): object is OverrideFormat;
+    static isOverrideFormat(format: unknown): format is OverrideFormat;
     /**
      * Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.
      * If the precision and/or units properties have been overriden, the returned object will contain a "name" and a "parent" property.

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

@@ -1 +1 @@
-{"version":3,"file":"OverrideFormat.d.ts","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAmB,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACrK,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAI9B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAC,CAAyC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAmD;IAElE,uDAAuD;IACvD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAQhJ,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAsF;IACpJ,IAAW,KAAK,4DAA4E;IAG5F,IAAW,QAAQ,IAAI,MAAM,CAAsB;IACnD,IAAW,WAAW,IAAI,MAAM,CAAoC;IACpE,IAAW,IAAI,IAAI,UAAU,CAA6B;IAC1D,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAiC;IAC1E,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAuC;IAC9F,IAAW,cAAc,IAAI,cAAc,CAAuC;IAClF,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,CAA0C;IAChF,IAAW,YAAY,IAAI,MAAM,CAAqC;IACtE,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAA0C;IAC5F,IAAW,YAAY,IAAI,YAAY,CAAqC;IAC5E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA+B;IACtE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAoC;IAE1E,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;OAEG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAkB7C;;;;OAIG;WACW,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,MAAM;IAgBxL;;OAEG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,mBAAmB;IA4D1E;;OAEG;WACW,gBAAgB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,cAAc;IAMrE;;;;;OAKG;IACI,cAAc,IAAI,6BAA6B;CA+BvD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,WAAW,CAE3E"}
+{"version":3,"file":"OverrideFormat.d.ts","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAmB,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACrK,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAE7E,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAC9D;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAC,CAAyC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAuE;IAEtF,uDAAuD;IACvD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAQpK,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAE7D;IAED,IAAW,KAAK,IAAI,aAAa,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAE3G;IAGD,IAAW,QAAQ,IAAI,MAAM,CAAsB;IACnD,IAAW,WAAW,IAAI,MAAM,CAAoC;IACpE,IAAW,IAAI,IAAI,UAAU,CAA6B;IAC1D,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAiC;IAC1E,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAuC;IAC9F,IAAW,cAAc,IAAI,cAAc,CAAuC;IAClF,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,CAA0C;IAChF,IAAW,YAAY,IAAI,MAAM,CAAqC;IACtE,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAA0C;IAC5F,IAAW,YAAY,IAAI,YAAY,CAAqC;IAC5E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA+B;IACtE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAoC;IAE1E,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;OAEG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAsB7C;;;;OAIG;WACW,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,MAAM;IAgB5M;;OAEG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,mBAAmB;IA0D1E;;OAEG;WACW,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,cAAc;IAMzE;;;;;OAKG;IACI,cAAc,IAAI,6BAA6B;CA+BvD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,WAAW,CAE3E"}

package/lib/cjs/Metadata/OverrideFormat.js

@@ -15,7 +15,7 @@ const core_quantity_1 = require("@itwin/core-quantity");
 const Exception_1 = require("../Exception");
 /**
  * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
+ * @public @preview
  */
 class OverrideFormat {
     _precision;
@@ -27,6 +27,7 @@ class OverrideFormat {
      * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.
      */
     name;
+    /** @internal */
     constructor(parent, precision, unitAndLabels) {
         this.parent = parent;
         this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);
@@ -34,8 +35,12 @@ class OverrideFormat {
         this._units = unitAndLabels;
     }
     // Properties that can be overriden
-    get precision() { return (undefined === this._precision) ? this.parent.precision : this._precision; }
-    get units() { return (undefined === this._units) ? this.parent.units : this._units; }
+    get precision() {
+        return (undefined === this._precision) ? this.parent.precision : this._precision;
+    }
+    get units() {
+        return (undefined === this._units) ? this.parent.units : this._units;
+    }
     // Properties that cannot be overriden
     get fullName() { return this.name; }
     get roundFactor() { return this.parent.roundFactor; }
@@ -55,7 +60,7 @@ class OverrideFormat {
         return (this.parent.formatTraits & formatTrait) === formatTrait;
     }
     /** Returns the format string of this override in the Xml full name format.
-     * @alpha
+     * @internal
      */
     fullNameXml(koqSchema) {
         let fullName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);
@@ -64,8 +69,11 @@ class OverrideFormat {
         if (undefined === this._units)
             return fullName;
         for (const [unit, unitLabel] of this._units) {
+            const unitSchema = koqSchema.context.getSchemaSync(unit.schemaKey);
+            if (unitSchema === undefined)
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The unit schema ${unit.schemaKey} is not found in the context.`);
             fullName += "[";
-            fullName += XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);
+            fullName += XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(koqSchema, unitSchema, unit.name);
             if (unitLabel !== undefined)
                 fullName += `|${unitLabel}`;
             fullName += `]`;
@@ -96,8 +104,8 @@ class OverrideFormat {
     static parseFormatString(formatString) {
         const match = formatString.split(core_quantity_1.formatStringRgx); // split string based on regex groups
         if (undefined === match[1])
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);
-        const returnValue = { name: match[1] };
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);
+        let precision;
         if (undefined !== match[2] && undefined !== match[3]) {
             const overrideString = match[2];
             const tokens = [];
@@ -111,41 +119,41 @@ class OverrideFormat {
             if (overrideString.length > 0 && undefined === tokens.find((token) => {
                 return "" !== token; // there is at least one token that is not empty.
             })) {
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
             }
             // The first override parameter overrides the default precision of the format
             const precisionIndx = 0;
             if (tokens.length >= precisionIndx + 1) {
                 if (tokens[precisionIndx].length > 0) {
-                    const precision = Number.parseInt(tokens[precisionIndx], 10);
+                    precision = Number.parseInt(tokens[precisionIndx], 10);
                     if (Number.isNaN(precision))
-                        throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);
-                    returnValue.precision = precision;
+                        throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);
                 }
             }
         }
         let i = 4;
+        let unitAndLabels;
         while (i < match.length - 1) { // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value
             if (undefined === match[i])
                 break;
             // Unit override required
             if (undefined === match[i + 1])
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-            if (undefined === returnValue.unitAndLabels)
-                returnValue.unitAndLabels = [];
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
+            if (undefined === unitAndLabels)
+                unitAndLabels = [];
             if (undefined !== match[i + 2]) // matches '|'
-                returnValue.unitAndLabels.push([match[i + 1], match[i + 3] ?? ""]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)
+                unitAndLabels.push([match[i + 1], match[i + 3] ?? ""]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)
             else
-                returnValue.unitAndLabels.push([match[i + 1], undefined]); // add unit name
+                unitAndLabels.push([match[i + 1], undefined]); // add unit name
             i += 4;
         }
-        return returnValue;
+        return { name: match[1], precision, unitAndLabels };
     }
     /**
      * @internal
      */
-    static isOverrideFormat(object) {
-        const overrideFormat = object;
+    static isOverrideFormat(format) {
+        const overrideFormat = format;
         return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined && overrideFormat.parent.schemaItemType === ECObjects_1.SchemaItemType.Format;
     }
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAkOH,wCAEC;AAlOD,oFAAiF;AACjF,4CAA8C;AAC9C,wDAAqK;AAOrK,4CAA+D;AAW/D;;;GAGG;AACH,MAAa,cAAc;IACjB,UAAU,CAA0C;IACpD,MAAM,CAAoD;IAElE,uDAAuD;IACvC,MAAM,CAAS;IAE/B;;;OAGG;IACa,IAAI,CAAS;IAE7B,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAC9B,CAAC;IAED,mCAAmC;IACnC,IAAW,SAAS,KAA6C,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpJ,IAAW,KAAK,KAAK,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5F,sCAAsC;IACtC,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChF,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC5F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1E,cAAc,CAAC,WAAyB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,KAAK,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,SAAiB;QAClC,IAAI,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzG,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,QAAQ,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE/C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5C,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,SAAS,EAAE,CAAC;YAC9B,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC7K,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE/B,IAAI,SAAS;YACX,QAAQ,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE1C,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,aAAa;YAC3C,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;;gBAEjC,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,GAAG,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,YAAoB;QAClD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,+BAAe,CAAC,CAAC,CAAC,qCAAqC;QACxF,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,sBAAsB,YAAY,0CAA0C,CAAC,CAAC;QAExI,MAAM,WAAW,GAAwB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAE5D,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,2FAA2F;YAC5G,IAAI,OAAO,CAAC;YAEZ,uDAAuD;YACvD,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/D,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACxD,OAAO,GAAG,OAAO,GAAG,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnE,OAAO,EAAE,KAAK,KAAK,CAAC,CAAC,iDAAiD;YACxE,CAAC,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,CAAC;YAED,6EAA6E;YAC7E,MAAM,aAAa,GAAW,CAAC,CAAC;YAEhC,IAAI,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvC,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC7D,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;wBACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,sBAAsB,YAAY,iDAAiD,MAAM,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;oBAC3L,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;gBACpC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAE,mJAAmJ;YACjL,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;gBACxB,MAAM;YACR,yBAAyB;YACzB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE9D,IAAI,SAAS,KAAK,WAAW,CAAC,aAAa;gBACzC,WAAW,CAAC,aAAa,GAAG,EAAE,CAAC;YAEjC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc;gBAC5C,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,4GAA4G;;gBAEhL,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,gBAAgB;YAE7E,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAW;QACxC,MAAM,cAAc,GAAG,MAAwB,CAAC;QAEhD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM,CAAC;IACpL,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAA4C,CAAC;QAElF,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3C,yEAAyE;YACzE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAED,sCAAsC;QACtC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,kCAAkC;YAClC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;iBACf,CAAC,CAAC;YACL,CAAC;YAED,UAAU,CAAC,SAAS,GAAG;gBACrB,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;gBACvD,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBACxE,KAAK;aACN,CAAC;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAnMD,wCAmMC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,MAA+B;IAC5D,OAAO,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;AAC7F,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 { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { DecimalPrecision, FormatProps, formatStringRgx, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"@itwin/core-quantity\";\nimport { Format } from \"./Format\";\nimport { InvertedUnit } from \"./InvertedUnit\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItemOverrideFormatProps } from \"../Deserialization/JsonProps\";\nimport { Unit } from \"./Unit\";\nimport { Mutable } from \"@itwin/core-bentley\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\n\n/**\n * @beta\n */\nexport interface OverrideFormatProps {\n  name: string;\n  precision?: number;\n  unitAndLabels?: Array<[string, string | undefined]>; // Tuple of [unit name | unit label]\n}\n\n/**\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\n * @beta\n */\nexport class OverrideFormat {\n  private _precision?: DecimalPrecision | FractionalPrecision;\n  private _units?: Array<[Unit | InvertedUnit, string | undefined]>;\n\n  /** The Format that this OverrideFormat is extending */\n  public readonly parent: Format;\n\n  /** The name of this OverrideFormat.\n   *\n   * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.\n   */\n  public readonly name: string;\n\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>) {\n    this.parent = parent;\n    this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);\n    this._precision = precision;\n    this._units = unitAndLabels;\n  }\n\n  // Properties that can be overriden\n  public get precision(): DecimalPrecision | FractionalPrecision { return (undefined === this._precision) ? this.parent.precision : this._precision; }\n  public get units() { return (undefined === this._units) ? this.parent.units : this._units; }\n\n  // Properties that cannot be overriden\n  public get fullName(): string { return this.name; }\n  public get roundFactor(): number { return this.parent.roundFactor; }\n  public get type(): FormatType { return this.parent.type; }\n  public get minWidth(): number | undefined { return this.parent.minWidth; }\n  public get scientificType(): ScientificType | undefined { return this.parent.scientificType; }\n  public get showSignOption(): ShowSignOption { return this.parent.showSignOption; }\n  public get decimalSeparator(): string { return this.parent.decimalSeparator; }\n  public get thousandSeparator(): string { return this.parent.thousandSeparator; }\n  public get uomSeparator(): string { return this.parent.uomSeparator; }\n  public get stationSeparator(): string { return this.parent.stationSeparator; }\n  public get stationOffsetSize(): number | undefined { return this.parent.stationOffsetSize; }\n  public get formatTraits(): FormatTraits { return this.parent.formatTraits; }\n  public get spacer(): string | undefined { return this.parent.spacer; }\n  public get includeZero(): boolean | undefined { return this.parent.includeZero; }\n\n  public hasFormatTrait(formatTrait: FormatTraits) {\n    return (this.parent.formatTraits & formatTrait) === formatTrait;\n  }\n\n  /** Returns the format string of this override in the Xml full name format.\n   * @alpha\n   */\n  public fullNameXml(koqSchema: Schema): string {\n    let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);\n\n    if (undefined !== this.precision)\n      fullName += `(${this.precision.toString()})`;\n\n    if (undefined === this._units)\n      return fullName;\n    for (const [unit, unitLabel] of this._units) {\n      fullName += \"[\";\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);\n      if (unitLabel !== undefined)\n        fullName += `|${unitLabel}`;\n      fullName += `]`;\n    }\n    return fullName;\n  }\n\n  /**\n   * Creates a valid OverrideFormat fullName from the parent Format and overridden units.\n   * @param parent The parent Format.\n   * @param unitAndLabels The overridden unit and labels collection.\n   */\n  public static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string {\n    let fullName = parent.fullName;\n\n    if (precision)\n      fullName += `(${precision.toString()})`;\n\n    if (undefined === unitAndLabels)\n      return fullName;\n    for (const [unit, unitLabel] of unitAndLabels)\n      if (undefined === unitLabel)\n        fullName += `[${unit.fullName}]`;\n      else\n        fullName += `[${unit.fullName}|${unitLabel}]`;\n    return fullName;\n  }\n\n  /** Parses the format string into the parts that make up an Override Format\n   * @param formatString\n   */\n  public static parseFormatString(formatString: string): OverrideFormatProps {\n    const match = formatString.split(formatStringRgx); // split string based on regex groups\n    if (undefined === match[1])\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);\n\n    const returnValue: OverrideFormatProps = { name: match[1] };\n\n    if (undefined !== match[2] && undefined !== match[3]) {\n      const overrideString = match[2];\n      const tokens: string[] = [];\n      let prevPos = 1; // Initial position is the character directly after the opening '(' in the override string.\n      let currPos;\n\n      // TODO need to include `,` as a valid search argument.\n      while (-1 !== (currPos = overrideString.indexOf(\")\", prevPos))) {\n        tokens.push(overrideString.substring(prevPos, currPos));\n        prevPos = currPos + 1;\n      }\n\n      if (overrideString.length > 0 && undefined === tokens.find((token) => {\n        return \"\" !== token; // there is at least one token that is not empty.\n      })) {\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\n      }\n\n      // The first override parameter overrides the default precision of the format\n      const precisionIndx: number = 0;\n\n      if (tokens.length >= precisionIndx + 1) {\n        if (tokens[precisionIndx].length > 0) {\n          const precision = Number.parseInt(tokens[precisionIndx], 10);\n          if (Number.isNaN(precision))\n            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);\n          returnValue.precision = precision;\n        }\n      }\n    }\n\n    let i = 4;\n    while (i < match.length - 1) {  // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value\n      if (undefined === match[i])\n        break;\n      // Unit override required\n      if (undefined === match[i + 1])\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\n\n      if (undefined === returnValue.unitAndLabels)\n        returnValue.unitAndLabels = [];\n\n      if (undefined !== match[i + 2]) // matches '|'\n        returnValue.unitAndLabels.push([match[i + 1], match[i + 3] ?? \"\"]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)\n      else\n        returnValue.unitAndLabels.push([match[i + 1], undefined]); // add unit name\n\n      i += 4;\n    }\n\n    return returnValue;\n  }\n\n  /**\n   * @internal\n   */\n  public static isOverrideFormat(object: any): object is OverrideFormat {\n    const overrideFormat = object as OverrideFormat;\n\n    return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined && overrideFormat.parent.schemaItemType === SchemaItemType.Format;\n  }\n\n  /**\n   * Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.\n   * If the precision and/or units properties have been overriden, the returned object will contain a \"name\" and a \"parent\" property.\n   * The \"name\" property identifies the OverrideFormat object itself and the \"parent\" property identifies the Format that has been overriden.\n   * This method is not intended for complete serialization as it does not serialize any of the schema item properties.\n   */\n  public getFormatProps(): SchemaItemOverrideFormatProps {\n    const formatJson = this.parent.toJSON() as Mutable<SchemaItemOverrideFormatProps>;\n\n    if (this.parent.fullName !== this.fullName) {\n      // Update name and parent properties to distinguish it from parent Format\n      formatJson.name = this.fullName;\n      formatJson.parent = this.parent.fullName;\n    }\n\n    // Update Precision overriden property\n    formatJson.precision = this.precision;\n\n    if (this.units !== undefined) {\n      // Update Units overriden property\n      const units = [];\n      for (const unit of this.units) {\n        units.push({\n          name: unit[0].fullName,\n          label: unit[1],\n        });\n      }\n\n      formatJson.composite = {\n        spacer: (this.spacer !== \" \") ? this.spacer : undefined,\n        includeZero: (this.includeZero === false) ? this.includeZero : undefined,\n        units,\n      };\n    }\n\n    return formatJson;\n  }\n}\n\n/**\n * @internal\n */\nexport function getFormatProps(format: Format | OverrideFormat): FormatProps {\n  return OverrideFormat.isOverrideFormat(format) ? format.getFormatProps() : format.toJSON();\n}\n"]}
+{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAyOH,wCAEC;AAzOD,oFAAiF;AACjF,4CAA8C;AAC9C,wDAAqK;AAMrK,4CAA6D;AAW7D;;;GAGG;AACH,MAAa,cAAc;IACjB,UAAU,CAA0C;IACpD,MAAM,CAAwE;IAEtF,uDAAuD;IACvC,MAAM,CAAS;IAE/B;;;OAGG;IACa,IAAI,CAAS;IAE7B,gBAAgB;IAChB,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAoF;QAClK,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAC9B,CAAC;IAED,mCAAmC;IACnC,IAAW,SAAS;QAClB,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;IACnF,CAAC;IAED,IAAW,KAAK;QACd,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IACvE,CAAC;IAED,sCAAsC;IACtC,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChF,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC5F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1E,cAAc,CAAC,WAAyB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,KAAK,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,SAAiB;QAClC,IAAI,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzG,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,QAAQ,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE/C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACnE,IAAG,UAAU,KAAK,SAAS;gBACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,SAAS,+BAA+B,CAAC,CAAC;YAE1H,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACvF,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,SAAS,EAAE,CAAC;YAC9B,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAoF;QACjM,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE/B,IAAI,SAAS;YACX,QAAQ,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE1C,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,aAAa;YAC3C,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;;gBAEjC,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,GAAG,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,YAAoB;QAClD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,+BAAe,CAAC,CAAC,CAAC,qCAAqC;QACxF,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,sBAAsB,YAAY,0CAA0C,CAAC,CAAC;QAEtI,IAAI,SAA2C,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,2FAA2F;YAC5G,IAAI,OAAO,CAAC;YAEZ,uDAAuD;YACvD,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/D,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACxD,OAAO,GAAG,OAAO,GAAG,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnE,OAAO,EAAE,KAAK,KAAK,CAAC,CAAC,iDAAiD;YACxE,CAAC,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,6EAA6E;YAC7E,MAAM,aAAa,GAAW,CAAC,CAAC;YAChC,IAAI,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvC,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC;oBACvD,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;wBACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,sBAAsB,YAAY,iDAAiD,MAAM,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;gBAC3L,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,IAAI,aAAmD,CAAC;QACxD,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAE,mJAAmJ;YACjL,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;gBACxB,MAAM;YACR,yBAAyB;YACzB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE5D,IAAI,SAAS,KAAK,aAAa;gBAC7B,aAAa,GAAG,EAAE,CAAC;YAErB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc;gBAC5C,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,4GAA4G;;gBAEpK,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,gBAAgB;YAEjE,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAe;QAC5C,MAAM,cAAc,GAAG,MAAiC,CAAC;QAEzD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM,CAAC;IACpL,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAA4C,CAAC;QAElF,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3C,yEAAyE;YACzE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3C,CAAC;QAED,sCAAsC;QACtC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,kCAAkC;YAClC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC;oBACT,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;oBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;iBACf,CAAC,CAAC;YACL,CAAC;YAED,UAAU,CAAC,SAAS,GAAG;gBACrB,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;gBACvD,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBACxE,KAAK;aACN,CAAC;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AA3MD,wCA2MC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,MAA+B;IAC5D,OAAO,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;AAC7F,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 { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { DecimalPrecision, FormatProps, formatStringRgx, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"@itwin/core-quantity\";\nimport { Format } from \"./Format\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItemOverrideFormatProps } from \"../Deserialization/JsonProps\";\nimport { Mutable } from \"@itwin/core-bentley\";\nimport { LazyLoadedInvertedUnit, LazyLoadedUnit } from \"../Interfaces\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\n\n/**\n * @public @preview\n */\nexport interface OverrideFormatProps {\n  readonly name: string;\n  readonly precision?: number;\n  readonly unitAndLabels?: Array<[string, string | undefined]>; // Tuple of [unit name | unit label]\n}\n\n/**\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\n * @public @preview\n */\nexport class OverrideFormat {\n  private _precision?: DecimalPrecision | FractionalPrecision;\n  private _units?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>;\n\n  /** The Format that this OverrideFormat is extending */\n  public readonly parent: Format;\n\n  /** The name of this OverrideFormat.\n   *\n   * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.\n   */\n  public readonly name: string;\n\n  /** @internal */\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>) {\n    this.parent = parent;\n    this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);\n    this._precision = precision;\n    this._units = unitAndLabels;\n  }\n\n  // Properties that can be overriden\n  public get precision(): DecimalPrecision | FractionalPrecision {\n    return (undefined === this._precision) ? this.parent.precision : this._precision;\n  }\n\n  public get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined {\n    return (undefined === this._units) ? this.parent.units : this._units;\n  }\n\n  // Properties that cannot be overriden\n  public get fullName(): string { return this.name; }\n  public get roundFactor(): number { return this.parent.roundFactor; }\n  public get type(): FormatType { return this.parent.type; }\n  public get minWidth(): number | undefined { return this.parent.minWidth; }\n  public get scientificType(): ScientificType | undefined { return this.parent.scientificType; }\n  public get showSignOption(): ShowSignOption { return this.parent.showSignOption; }\n  public get decimalSeparator(): string { return this.parent.decimalSeparator; }\n  public get thousandSeparator(): string { return this.parent.thousandSeparator; }\n  public get uomSeparator(): string { return this.parent.uomSeparator; }\n  public get stationSeparator(): string { return this.parent.stationSeparator; }\n  public get stationOffsetSize(): number | undefined { return this.parent.stationOffsetSize; }\n  public get formatTraits(): FormatTraits { return this.parent.formatTraits; }\n  public get spacer(): string | undefined { return this.parent.spacer; }\n  public get includeZero(): boolean | undefined { return this.parent.includeZero; }\n\n  public hasFormatTrait(formatTrait: FormatTraits) {\n    return (this.parent.formatTraits & formatTrait) === formatTrait;\n  }\n\n  /** Returns the format string of this override in the Xml full name format.\n   * @internal\n   */\n  public fullNameXml(koqSchema: Schema): string {\n    let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);\n\n    if (undefined !== this.precision)\n      fullName += `(${this.precision.toString()})`;\n\n    if (undefined === this._units)\n      return fullName;\n    for (const [unit, unitLabel] of this._units) {\n      const unitSchema = koqSchema.context.getSchemaSync(unit.schemaKey);\n      if(unitSchema === undefined)\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The unit schema ${unit.schemaKey} is not found in the context.`);\n\n      fullName += \"[\";\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unitSchema, unit.name);\n      if (unitLabel !== undefined)\n        fullName += `|${unitLabel}`;\n      fullName += `]`;\n    }\n    return fullName;\n  }\n\n  /**\n   * Creates a valid OverrideFormat fullName from the parent Format and overridden units.\n   * @param parent The parent Format.\n   * @param unitAndLabels The overridden unit and labels collection.\n   */\n  public static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): string {\n    let fullName = parent.fullName;\n\n    if (precision)\n      fullName += `(${precision.toString()})`;\n\n    if (undefined === unitAndLabels)\n      return fullName;\n    for (const [unit, unitLabel] of unitAndLabels)\n      if (undefined === unitLabel)\n        fullName += `[${unit.fullName}]`;\n      else\n        fullName += `[${unit.fullName}|${unitLabel}]`;\n    return fullName;\n  }\n\n  /** Parses the format string into the parts that make up an Override Format\n   * @param formatString\n   */\n  public static parseFormatString(formatString: string): OverrideFormatProps {\n    const match = formatString.split(formatStringRgx); // split string based on regex groups\n    if (undefined === match[1])\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity is missing a format.`);\n\n    let precision: OverrideFormatProps[\"precision\"];\n    if (undefined !== match[2] && undefined !== match[3]) {\n      const overrideString = match[2];\n      const tokens: string[] = [];\n      let prevPos = 1; // Initial position is the character directly after the opening '(' in the override string.\n      let currPos;\n\n      // TODO need to include `,` as a valid search argument.\n      while (-1 !== (currPos = overrideString.indexOf(\")\", prevPos))) {\n        tokens.push(overrideString.substring(prevPos, currPos));\n        prevPos = currPos + 1;\n      }\n\n      if (overrideString.length > 0 && undefined === tokens.find((token) => {\n        return \"\" !== token; // there is at least one token that is not empty.\n      })) {\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\n      }\n\n      // The first override parameter overrides the default precision of the format\n      const precisionIndx: number = 0;\n      if (tokens.length >= precisionIndx + 1) {\n        if (tokens[precisionIndx].length > 0) {\n          precision = Number.parseInt(tokens[precisionIndx], 10);\n          if (Number.isNaN(precision))\n            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity has a precision override '${tokens[precisionIndx]}' that is not number.`);\n        }\n      }\n    }\n\n    let i = 4;\n    let unitAndLabels: OverrideFormatProps[\"unitAndLabels\"];\n    while (i < match.length - 1) {  // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value\n      if (undefined === match[i])\n        break;\n      // Unit override required\n      if (undefined === match[i + 1])\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\n\n      if (undefined === unitAndLabels)\n        unitAndLabels = [];\n\n      if (undefined !== match[i + 2]) // matches '|'\n        unitAndLabels.push([match[i + 1], match[i + 3] ?? \"\"]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)\n      else\n        unitAndLabels.push([match[i + 1], undefined]); // add unit name\n\n      i += 4;\n    }\n\n    return { name: match[1], precision, unitAndLabels };\n  }\n\n  /**\n   * @internal\n   */\n  public static isOverrideFormat(format: unknown): format is OverrideFormat {\n    const overrideFormat = format as Partial<OverrideFormat>;\n\n    return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined && overrideFormat.parent.schemaItemType === SchemaItemType.Format;\n  }\n\n  /**\n   * Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.\n   * If the precision and/or units properties have been overriden, the returned object will contain a \"name\" and a \"parent\" property.\n   * The \"name\" property identifies the OverrideFormat object itself and the \"parent\" property identifies the Format that has been overriden.\n   * This method is not intended for complete serialization as it does not serialize any of the schema item properties.\n   */\n  public getFormatProps(): SchemaItemOverrideFormatProps {\n    const formatJson = this.parent.toJSON() as Mutable<SchemaItemOverrideFormatProps>;\n\n    if (this.parent.fullName !== this.fullName) {\n      // Update name and parent properties to distinguish it from parent Format\n      formatJson.name = this.fullName;\n      formatJson.parent = this.parent.fullName;\n    }\n\n    // Update Precision overriden property\n    formatJson.precision = this.precision;\n\n    if (this.units !== undefined) {\n      // Update Units overriden property\n      const units = [];\n      for (const unit of this.units) {\n        units.push({\n          name: unit[0].fullName,\n          label: unit[1],\n        });\n      }\n\n      formatJson.composite = {\n        spacer: (this.spacer !== \" \") ? this.spacer : undefined,\n        includeZero: (this.includeZero === false) ? this.includeZero : undefined,\n        units,\n      };\n    }\n\n    return formatJson;\n  }\n}\n\n/**\n * @internal\n */\nexport function getFormatProps(format: Format | OverrideFormat): FormatProps {\n  return OverrideFormat.isOverrideFormat(format) ? format.getFormatProps() : format.toJSON();\n}\n"]}

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

@@ -5,11 +5,13 @@ import { PhenomenonProps } from "../Deserialization/JsonProps";
 import { SchemaItemType } from "../ECObjects";
 import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
-/** @beta */
+/** @public @preview */
 export declare class Phenomenon extends SchemaItem {
     readonly schemaItemType: SchemaItemType;
+    /** @internal */
     static get schemaItemType(): SchemaItemType;
-    protected _definition: string;
+    private _definition;
+    /** @internal */
     constructor(schema: Schema, name: string);
     get definition(): string;
     /**
@@ -22,6 +24,11 @@ export declare class Phenomenon extends SchemaItem {
     toXml(schemaXml: Document): Promise<Element>;
     fromJSONSync(phenomenonProps: PhenomenonProps): void;
     fromJSON(phenomenonProps: PhenomenonProps): Promise<void>;
+    /**
+     *
+     * @param definition
+     * @internal
+     */
     protected setDefinition(definition: string): Promise<void>;
     /**
      * Type guard to check if the SchemaItem is of type Phenomenon.
@@ -33,6 +40,7 @@ export declare class Phenomenon extends SchemaItem {
      * Type assertion to check if the SchemaItem is of type Phenomenon.
      * @param item The SchemaItem to check.
      * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.
+     * @internal
      */
     static assertIsPhenomenon(item?: SchemaItem): asserts item is Phenomenon;
 }

package/lib/cjs/Metadata/Phenomenon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Phenomenon.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY;AACZ,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,iBAA6B;IACpE,WAA2B,cAAc,mBAAwC;IACjF,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;gBAElB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,UAAU,IAAI,MAAM,CAA6B;IAE5D;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,eAAe;IAM3G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,eAAe,EAAE,eAAe;IAQvC,QAAQ,CAAC,eAAe,EAAE,eAAe;cAI/C,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhD;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,UAAU;IAOjE;;;;OAIG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU;CAIhF;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Phenomenon.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,uBAAuB;AACvB,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,iBAA6B;IACpE,gBAAgB;IAChB,WAA2B,cAAc,mBAAwC;IACjF,OAAO,CAAC,WAAW,CAAS;IAE5B,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,UAAU,IAAI,MAAM,CAA6B;IAE5D;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,eAAe;IAM3G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,eAAe,EAAE,eAAe;IAQvC,QAAQ,CAAC,eAAe,EAAE,eAAe;IAI/D;;;;OAIG;cACa,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhD;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,UAAU;IAOjE;;;;;OAKG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU;CAIhF;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/Phenomenon.js

@@ -11,11 +11,13 @@ exports.MutablePhenomenon = exports.Phenomenon = void 0;
 const ECObjects_1 = require("../ECObjects");
 const Exception_1 = require("../Exception");
 const SchemaItem_1 = require("./SchemaItem");
-/** @beta */
+/** @public @preview */
 class Phenomenon extends SchemaItem_1.SchemaItem {
     schemaItemType = Phenomenon.schemaItemType;
+    /** @internal */
     static get schemaItemType() { return ECObjects_1.SchemaItemType.Phenomenon; }
     _definition; // Contains a combination of Phenomena names which form this Phenomenon. Each Phenomena name is separated by a * and may have an exponent, specified using parentheses
+    /** @internal */
     constructor(schema, name) {
         super(schema, name);
         this._definition = "";
@@ -40,13 +42,18 @@ class Phenomenon extends SchemaItem_1.SchemaItem {
     fromJSONSync(phenomenonProps) {
         super.fromJSONSync(phenomenonProps);
         if (this._definition !== "" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);
         else if (this._definition === "")
             this._definition = phenomenonProps.definition;
     }
     async fromJSON(phenomenonProps) {
         this.fromJSONSync(phenomenonProps);
     }
+    /**
+     *
+     * @param definition
+     * @internal
+     */
     async setDefinition(definition) {
         this._definition = definition;
     }
@@ -64,10 +71,11 @@ class Phenomenon extends SchemaItem_1.SchemaItem {
      * Type assertion to check if the SchemaItem is of type Phenomenon.
      * @param item The SchemaItem to check.
      * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.
+     * @internal
      */
     static assertIsPhenomenon(item) {
         if (!this.isPhenomenon(item))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Phenomenon}' (Phenomenon)`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Phenomenon}' (Phenomenon)`);
     }
 }
 exports.Phenomenon = Phenomenon;

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

@@ -1 +1 @@
-{"version":3,"file":"Phenomenon.js","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,4CAA8C;AAC9C,4CAA+D;AAE/D,6CAA0C;AAE1C,YAAY;AACZ,MAAa,UAAW,SAAQ,uBAAU;IACf,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7D,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IACvE,WAAW,CAAS,CAAC,sKAAsK;IAErM,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE5D;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,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,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,eAAgC;QAC3D,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,eAAe,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACxG,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,kBAAkB,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aAC3H,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC;IAClD,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,eAAgC;QAC7D,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrC,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,UAAU;YAC3D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,UAAU,gBAAgB,CAAC,CAAC;IAC5H,CAAC;CACF;AAnED,gCAmEC;AAED;;;GAGG;AACH,MAAsB,iBAAkB,SAAQ,UAAU;CAGzD;AAHD,8CAGC","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 { PhenomenonProps } from \"../Deserialization/JsonProps\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/** @beta */\nexport class Phenomenon extends SchemaItem {\n  public override readonly schemaItemType = Phenomenon.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Phenomenon; }\n  protected _definition: string; // Contains a combination of Phenomena names which form this Phenomenon. Each Phenomena name is separated by a * and may have an exponent, specified using parentheses\n\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this._definition = \"\";\n  }\n\n  public get definition(): string { return this._definition; }\n\n  /**\n   * Save this Phenomenon'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): PhenomenonProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.definition = this.definition;\n    return schemaJson;\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    return itemElement;\n  }\n\n  public override fromJSONSync(phenomenonProps: PhenomenonProps) {\n    super.fromJSONSync(phenomenonProps);\n    if (this._definition !== \"\" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);\n    else if (this._definition === \"\")\n      this._definition = phenomenonProps.definition;\n  }\n\n  public override async fromJSON(phenomenonProps: PhenomenonProps) {\n    this.fromJSONSync(phenomenonProps);\n  }\n\n  protected async setDefinition(definition: string) {\n    this._definition = definition;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Phenomenon.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Phenomenon, false otherwise.\n   */\n  public static isPhenomenon(item?: SchemaItem): item is Phenomenon {\n    if (item && item.schemaItemType === SchemaItemType.Phenomenon)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Phenomenon.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.\n   */\n  public static assertIsPhenomenon(item?: SchemaItem): asserts item is Phenomenon {\n    if (!this.isPhenomenon(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Phenomenon}' (Phenomenon)`);\n  }\n}\n\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutablePhenomenon extends Phenomenon {\n  public abstract override setDefinition(definition: string): Promise<void>;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"Phenomenon.js","sourceRoot":"","sources":["../../../src/Metadata/Phenomenon.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,4CAA8C;AAC9C,4CAA6D;AAE7D,6CAA0C;AAE1C,uBAAuB;AACvB,MAAa,UAAW,SAAQ,uBAAU;IACf,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACpE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IACzE,WAAW,CAAS,CAAC,sKAAsK;IAEnM,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE5D;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,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,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,eAAgC;QAC3D,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,eAAe,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACxG,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,kBAAkB,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACzH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC;IAClD,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,eAAgC;QAC7D,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,UAAU;YAC3D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,UAAU,gBAAgB,CAAC,CAAC;IAC1H,CAAC;CACF;AA3ED,gCA2EC;AAED;;;GAGG;AACH,MAAsB,iBAAkB,SAAQ,UAAU;CAGzD;AAHD,8CAGC","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 { PhenomenonProps } from \"../Deserialization/JsonProps\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/** @public @preview */\nexport class Phenomenon extends SchemaItem {\n  public override readonly schemaItemType = Phenomenon.schemaItemType;\n  /** @internal */\n  public static override get schemaItemType() { return SchemaItemType.Phenomenon; }\n  private _definition: string; // Contains a combination of Phenomena names which form this Phenomenon. Each Phenomena name is separated by a * and may have an exponent, specified using parentheses\n\n  /** @internal */\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this._definition = \"\";\n  }\n\n  public get definition(): string { return this._definition; }\n\n  /**\n   * Save this Phenomenon'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): PhenomenonProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.definition = this.definition;\n    return schemaJson;\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    return itemElement;\n  }\n\n  public override fromJSONSync(phenomenonProps: PhenomenonProps) {\n    super.fromJSONSync(phenomenonProps);\n    if (this._definition !== \"\" && phenomenonProps.definition.toLowerCase() !== this._definition.toLowerCase())\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Phenomenon ${this.name} has an invalid 'definition' attribute.`);\n    else if (this._definition === \"\")\n      this._definition = phenomenonProps.definition;\n  }\n\n  public override async fromJSON(phenomenonProps: PhenomenonProps) {\n    this.fromJSONSync(phenomenonProps);\n  }\n\n  /**\n   *\n   * @param definition\n   * @internal\n   */\n  protected async setDefinition(definition: string) {\n    this._definition = definition;\n  }\n\n  /**\n   * Type guard to check if the SchemaItem is of type Phenomenon.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Phenomenon, false otherwise.\n   */\n  public static isPhenomenon(item?: SchemaItem): item is Phenomenon {\n    if (item && item.schemaItemType === SchemaItemType.Phenomenon)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Phenomenon.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Phenomenon if it is a Phenomenon, undefined otherwise.\n   * @internal\n   */\n  public static assertIsPhenomenon(item?: SchemaItem): asserts item is Phenomenon {\n    if (!this.isPhenomenon(item))\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Phenomenon}' (Phenomenon)`);\n  }\n}\n\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutablePhenomenon extends Phenomenon {\n  public abstract override setDefinition(definition: string): Promise<void>;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}