@itwin/core-backend 5.1.0-dev.27 → 5.1.0-dev.29

package/lib/cjs/Category.d.ts

@@ -7,7 +7,7 @@ import { DefinitionElement } from "./Element";
 import { IModelDb } from "./IModelDb";
 import { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from "./Entity";
 /** Defines the appearance for graphics in Geometric elements
- * @public
+ * @public @preview
  */
 export declare class SubCategory extends DefinitionElement {
     static get className(): string;
@@ -69,7 +69,7 @@ export declare class SubCategory extends DefinitionElement {
     static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
 /** A Category element is the target of the `category` member of [[GeometricElement]].
- * @public
+ * @public @preview
  */
 export declare class Category extends DefinitionElement {
     static get className(): string;
@@ -101,7 +101,7 @@ export declare class Category extends DefinitionElement {
     setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;
 }
 /** Categorizes 2d GeometricElements.
- * @public
+ * @public @preview
  */
 export declare class DrawingCategory extends Category {
     static get className(): string;
@@ -136,7 +136,7 @@ export declare class DrawingCategory extends Category {
     static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
 /** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
- * @public
+ * @public @preview
  */
 export declare class SpatialCategory extends Category {
     static get className(): string;

package/lib/cjs/Category.js

@@ -14,7 +14,7 @@ const Element_1 = require("./Element");
 const IModelDb_1 = require("./IModelDb");
 const NavigationRelationship_1 = require("./NavigationRelationship");
 /** Defines the appearance for graphics in Geometric elements
- * @public
+ * @public @preview
  */
 class SubCategory extends Element_1.DefinitionElement {
     static get className() { return "SubCategory"; }
@@ -127,7 +127,7 @@ class SubCategory extends Element_1.DefinitionElement {
 }
 exports.SubCategory = SubCategory;
 /** A Category element is the target of the `category` member of [[GeometricElement]].
- * @public
+ * @public @preview
  */
 class Category extends Element_1.DefinitionElement {
     static get className() { return "Category"; }
@@ -191,7 +191,7 @@ class Category extends Element_1.DefinitionElement {
 }
 exports.Category = Category;
 /** Categorizes 2d GeometricElements.
- * @public
+ * @public @preview
  */
 class DrawingCategory extends Category {
     static get className() { return "DrawingCategory"; }
@@ -247,7 +247,7 @@ class DrawingCategory extends Category {
 }
 exports.DrawingCategory = DrawingCategory;
 /** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
- * @public
+ * @public @preview
  */
 class SpatialCategory extends Category {
     static get className() { return "SpatialCategory"; }

package/lib/cjs/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAC9C,yCAAsC;AACtC,qEAAqE;AAGrE;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,mCAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,kDAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AApHH,kCAqHC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,2BAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,kBAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,mCAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAjEH,4BAkEC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,0CAyDC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAvDD,0CAuDC","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 iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * SubCategory custom HandledProps include 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"description\", source: \"Class\" },\n    { propertyName: \"properties\", source: \"Class\" },\n  ];\n\n  /**\n   * SubCategory deserializes 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\n    const elProps = super.deserialize(props) as SubCategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    if (props.row.properties !== '') {\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\n    } else {\n      elProps.appearance = undefined;\n    }\n    return elProps;\n  }\n\n  /**\n   * SubCategory serialize 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (props.description !== undefined) {\n      inst.description = props.description;\n    }\n    if (props.appearance !== undefined) {\n      inst.properties = JSON.stringify(props.appearance);\n    }\n    return inst;\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * Category custom HandledProps include 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"rank\", source: \"Class\" },\n    { propertyName: \"description\", source: \"Class\" },\n  ];\n\n  /**\n   * Category deserializes 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\n    const elProps = super.deserialize(props) as CategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    elProps.rank = JsonUtils.asInt(props.row.rank);\n    return elProps;\n  }\n\n  /**\n   * Category serialize 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (undefined !== props.description) {\n      inst.description = props.description;\n    }\n    inst.rank = props.rank;\n    return inst;\n  }\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAC9C,yCAAsC;AACtC,qEAAqE;AAGrE;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,mCAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,kDAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AApHH,kCAqHC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,2BAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,kBAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,mCAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAjEH,4BAkEC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,0CAyDC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAvDD,0CAuDC","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 iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public @preview\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * SubCategory custom HandledProps include 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"description\", source: \"Class\" },\n    { propertyName: \"properties\", source: \"Class\" },\n  ];\n\n  /**\n   * SubCategory deserializes 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\n    const elProps = super.deserialize(props) as SubCategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    if (props.row.properties !== '') {\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\n    } else {\n      elProps.appearance = undefined;\n    }\n    return elProps;\n  }\n\n  /**\n   * SubCategory serialize 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (props.description !== undefined) {\n      inst.description = props.description;\n    }\n    if (props.appearance !== undefined) {\n      inst.properties = JSON.stringify(props.appearance);\n    }\n    return inst;\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public @preview\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * Category custom HandledProps include 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"rank\", source: \"Class\" },\n    { propertyName: \"description\", source: \"Class\" },\n  ];\n\n  /**\n   * Category deserializes 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\n    const elProps = super.deserialize(props) as CategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    elProps.rank = JsonUtils.asInt(props.row.rank);\n    return elProps;\n  }\n\n  /**\n   * Category serialize 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (undefined !== props.description) {\n      inst.description = props.description;\n    }\n    inst.rank = props.rank;\n    return inst;\n  }\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public @preview\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public @preview\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}

package/lib/cjs/CodeSpecs.d.ts

@@ -5,7 +5,7 @@ import { Id64String } from "@itwin/core-bentley";
 import { CodeScopeSpec, CodeSpec, CodeSpecProperties } from "@itwin/core-common";
 import { IModelDb } from "./IModelDb";
 /** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
- * @public
+ * @public @preview
  */
 export declare class CodeSpecs {
     private static tableName;

package/lib/cjs/CodeSpecs.js

@@ -11,7 +11,7 @@ exports.CodeSpecs = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 /** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
- * @public
+ * @public @preview
  */
 class CodeSpecs {
     static tableName = "bis_CodeSpec";

package/lib/cjs/CodeSpecs.js.map

@@ -1 +1 @@
-{"version":3,"file":"CodeSpecs.js","sourceRoot":"","sources":["../../src/CodeSpecs.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6F;AAC7F,oDAA8F;AAI9F;;GAEG;AACH,MAAa,SAAS;IACZ,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC;IAClC,OAAO,CAAW;IAClB,gBAAgB,GAAe,EAAE,CAAC;IAE1C,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3B,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,SAAS,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE;YACrG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8DAA8D;IACvD,OAAO,CAAC,IAAY;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE;YACL,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,UAAsB;QACnC,wEAAwE;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QAEf,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,uEAAuE;IAChE,KAAK,CAAC,UAAsB;QACjC,IAAI,CAAC;YACH,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,IAAY;QAC3B,wEAAwE;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC/E,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QACf,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,UAAU,KAAK,SAAS;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,yEAAyE;IAClE,OAAO,CAAC,IAAY;QACzB,IAAI,CAAC;YACH,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,QAAgB,EAAE,UAA8B;QACrE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,MAAM,IAAI,GAAsC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7G,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;QAE/E,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,gHAAgH;YAChH,8FAA8F;YAC9F,2GAA2G;YAC3G,iGAAiG;YACjG,aAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,kIAAkI;YAClI,2FAA2F;YAC3F,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjJ,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,+DAA+D;QACpF,MAAM,CAAC,mBAAmB,CAAC,eAAe,SAAS,CAAC,SAAS,wCAAwC,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9G,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,EAAE,KAAK,uBAAQ,CAAC,cAAc;gBAChC,MAAM,IAAI,2BAAY,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,OAAO,mBAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAiBM,MAAM,CAAC,cAAiC,EAAE,KAA+C;QAC9F,IAAI,cAAc,YAAY,sBAAQ,EAAE,CAAC;YACvC,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;YAC/E,cAAc,CAAC,EAAE,GAAG,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,KAAK,KAAK,SAAS;YACrB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAEjE,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,sBAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED;;;KAGC;IACM,gBAAgB,CAAC,QAAkB;QACxC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,SAAS,CAAC,SAAS,kCAAkC,EAAE,CAAC,IAAI,EAAE,EAAE;YACzG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,uBAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,IAAI,EAAE;gBACzC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,EAAc;QACxB,IAAI,mBAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAEtE,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,mCAAmC,SAAS,CAAC,SAAS,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YACpH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YAEtE,OAAO,sBAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/G,CAAC,CAAC,CAAC;IACL,CAAC;;AAxKH,8BAyKC","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 Codes\n */\n\nimport { BentleyError, DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { CodeScopeSpec, CodeSpec, CodeSpecProperties, IModelError } from \"@itwin/core-common\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CodeService } from \"./CodeService\";\n\n/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]\n * @public\n */\nexport class CodeSpecs {\n  private static tableName = \"bis_CodeSpec\";\n  private _imodel: IModelDb;\n  private _loadedCodeSpecs: CodeSpec[] = [];\n\n  constructor(imodel: IModelDb) {\n    this._imodel = imodel;\n    if (imodel.isBriefcaseDb()) {\n      imodel.onChangesetApplied.addListener(() => this._loadedCodeSpecs.length = 0);\n    }\n  }\n\n  private findByName(name: string): Id64String | undefined {\n    return this._imodel.withSqliteStatement(`SELECT Id FROM ${CodeSpecs.tableName} WHERE Name=?`, (stmt) => {\n      stmt.bindString(1, name);\n      return stmt.nextRow() ? stmt.getValueId(0) : undefined;\n    });\n  }\n\n  /** Look up the Id of the CodeSpec with the specified name. */\n  public queryId(name: string): Id64String {\n    const id = this.findByName(name);\n    if (!id)\n      throw new IModelError(IModelStatus.NotFound, \"CodeSpec not found\");\n    return id;\n  }\n\n  /** Look up a CodeSpec by Id. The CodeSpec will be loaded from the database if necessary.\n   * @param codeSpecId The Id of the CodeSpec to load\n   * @returns The CodeSpec with the specified Id\n   * @throws [[IModelError]] if the Id is invalid or if no CodeSpec with that Id could be found.\n   */\n  public getById(codeSpecId: Id64String): CodeSpec {\n    // good chance it is already loaded - check there before running a query\n    const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.id === codeSpecId);\n    if (found !== undefined)\n      return found;\n\n    // must load this codespec\n    const loadedCodeSpec = this.load(codeSpecId);\n    this._loadedCodeSpecs.push(loadedCodeSpec);\n    return loadedCodeSpec;\n  }\n\n  /** Returns true if the IModelDb has a CodeSpec of the specified Id. */\n  public hasId(codeSpecId: Id64String): boolean {\n    try {\n      return undefined !== this.getById(codeSpecId);\n    } catch {\n      return false;\n    }\n  }\n\n  /** Look up a CodeSpec by name. The CodeSpec will be loaded from the database if necessary.\n   * @param name The name of the CodeSpec to load\n   * @returns The CodeSpec with the specified name\n   * @throws [[IModelError]] if no CodeSpec with the specified name could be found.\n   */\n  public getByName(name: string): CodeSpec {\n    // good chance it is already loaded - check there before running a query\n    const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.name === name);\n    if (found !== undefined)\n      return found;\n    const codeSpecId = this.queryId(name);\n    if (codeSpecId === undefined)\n      throw new IModelError(IModelStatus.NotFound, \"CodeSpec not found\");\n    return this.getById(codeSpecId);\n  }\n\n  /** Returns true if the IModelDb has a CodeSpec of the specified name. */\n  public hasName(name: string): boolean {\n    try {\n      return undefined !== this.getByName(name);\n    } catch {\n      return false;\n    }\n  }\n\n  private insertCodeSpec(specName: string, properties: CodeSpecProperties): Id64String {\n    const iModel = this._imodel;\n    const spec: CodeService.BisCodeSpecIndexProps = { name: specName.trim(), props: JSON.stringify(properties) };\n    if (this.findByName(spec.name))\n      throw new IModelError(IModelStatus.DuplicateName, \"CodeSpec already exists\");\n\n    const internalCodes = iModel.codeService?.internalCodes;\n    if (internalCodes) {\n      // Since there is no lock on the codespec table, to add a codespec to an iModel it must first be reserved in the\n      // internal code index via `internalCodes.reserveBisCodeSpecs` prior to calling this function.\n      // This ensures that the Ids will be unique, and the property values consistent, even if more than one user\n      // adds them without pushing their changes. The call to `verifyBisCodeSpec` will throw otherwise.\n      internalCodes.reader.verifyBisCodeSpec(spec);\n    } else {\n      // If this iModel doesn't have an internal code index, we have no way of coordinating the Ids for CodeSpecs across multiple users.\n      // Just look in this briefcase to find the currently highest used Id and hope for the best.\n      spec.id = iModel.withSqliteStatement(`SELECT MAX(Id) FROM ${CodeSpecs.tableName}`, (stmt) => stmt.nextRow() ? stmt.getValueInteger(0) + 1 : 1);\n    }\n\n    const id = spec.id!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n    iModel.withSqliteStatement(`INSERT INTO ${CodeSpecs.tableName}(Id,Name,JsonProperties) VALUES(?,?,?)`, (stmt) => {\n      stmt.bindInteger(1, id);\n      stmt.bindString(2, spec.name);\n      stmt.bindString(3, spec.props);\n      const rc = stmt.step();\n      if (rc !== DbResult.BE_SQLITE_DONE)\n        throw new BentleyError(rc, \"Error inserting codeSpec\");\n    });\n\n    return Id64.fromLocalAndBriefcaseIds(id, 0);\n  }\n\n  /** Add a new CodeSpec to the iModel.\n   * @param codeSpec The CodeSpec to insert\n   * @returns The Id of the persistent CodeSpec.\n   * @note If successful, this method will assign a valid CodeSpecId to the supplied CodeSpec\n   * @throws IModelError if the insertion fails\n   */\n  public insert(codeSpec: CodeSpec): Id64String;\n\n  /** Add a new CodeSpec to the IModelDb.\n   * @param name The name for the new CodeSpec.\n   * @param properties The properties or the CodeSpec. For backwards compatibility this may also be a `CodeScopeSpec.Type`.\n   * @returns The Id of the persistent CodeSpec.\n   * @throws IModelError if the insertion fails\n   */\n  public insert(name: string, properties: CodeSpecProperties | CodeScopeSpec.Type): Id64String;\n  public insert(codeSpecOrName: CodeSpec | string, props?: CodeSpecProperties | CodeScopeSpec.Type): Id64String {\n    if (codeSpecOrName instanceof CodeSpec) {\n      const id = this.insertCodeSpec(codeSpecOrName.name, codeSpecOrName.properties);\n      codeSpecOrName.id = id;\n      return id;\n    }\n    if (props === undefined)\n      throw new IModelError(IModelStatus.BadArg, \"Invalid argument\");\n\n    if (typeof props === \"object\")\n      return this.insertCodeSpec(codeSpecOrName, props);\n\n    const spec = CodeSpec.create(this._imodel, codeSpecOrName, props);\n    return this.insertCodeSpec(spec.name, spec.properties);\n  }\n\n  /** Update the Json properties of an existing CodeSpec.\n * @param codeSpec The codeSpec holding Json properties values to update\n * @throws if unable to update the codeSpec.\n */\n  public updateProperties(codeSpec: CodeSpec): void {\n    this._imodel.withSqliteStatement(`UPDATE ${CodeSpecs.tableName} SET JsonProperties=? WHERE Id=?`, (stmt) => {\n      stmt.bindString(1, JSON.stringify(codeSpec.properties));\n      stmt.bindId(2, codeSpec.id);\n      if (DbResult.BE_SQLITE_DONE !== stmt.step())\n        throw new IModelError(IModelStatus.BadArg, \"error updating CodeSpec properties\");\n    });\n  }\n\n  /** Load a CodeSpec from the iModel\n   * @param id  The persistent Id of the CodeSpec to load\n   */\n  public load(id: Id64String): CodeSpec {\n    if (Id64.isInvalid(id))\n      throw new IModelError(IModelStatus.InvalidId, \"Invalid codeSpecId\");\n\n    return this._imodel.withSqliteStatement(`SELECT Name,JsonProperties FROM ${CodeSpecs.tableName} WHERE Id=?`, (stmt) => {\n      stmt.bindId(1, id);\n      if (!stmt.nextRow())\n        throw new IModelError(IModelStatus.InvalidId, \"CodeSpec not found\");\n\n      return CodeSpec.createFromJson(this._imodel, id, stmt.getValueString(0), JSON.parse(stmt.getValueString(1)));\n    });\n  }\n}\n"]}
+{"version":3,"file":"CodeSpecs.js","sourceRoot":"","sources":["../../src/CodeSpecs.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6F;AAC7F,oDAA8F;AAI9F;;GAEG;AACH,MAAa,SAAS;IACZ,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC;IAClC,OAAO,CAAW;IAClB,gBAAgB,GAAe,EAAE,CAAC;IAE1C,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3B,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,SAAS,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE;YACrG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8DAA8D;IACvD,OAAO,CAAC,IAAY;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE;YACL,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,UAAsB;QACnC,wEAAwE;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QAEf,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,uEAAuE;IAChE,KAAK,CAAC,UAAsB;QACjC,IAAI,CAAC;YACH,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,IAAY;QAC3B,wEAAwE;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC/E,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QACf,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,UAAU,KAAK,SAAS;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,yEAAyE;IAClE,OAAO,CAAC,IAAY;QACzB,IAAI,CAAC;YACH,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,QAAgB,EAAE,UAA8B;QACrE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,MAAM,IAAI,GAAsC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7G,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;QAE/E,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,gHAAgH;YAChH,8FAA8F;YAC9F,2GAA2G;YAC3G,iGAAiG;YACjG,aAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,kIAAkI;YAClI,2FAA2F;YAC3F,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjJ,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,EAAG,CAAC,CAAC,+DAA+D;QACpF,MAAM,CAAC,mBAAmB,CAAC,eAAe,SAAS,CAAC,SAAS,wCAAwC,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9G,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,EAAE,KAAK,uBAAQ,CAAC,cAAc;gBAChC,MAAM,IAAI,2BAAY,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,OAAO,mBAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAiBM,MAAM,CAAC,cAAiC,EAAE,KAA+C;QAC9F,IAAI,cAAc,YAAY,sBAAQ,EAAE,CAAC;YACvC,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;YAC/E,cAAc,CAAC,EAAE,GAAG,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,KAAK,KAAK,SAAS;YACrB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAEjE,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,sBAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED;;;KAGC;IACM,gBAAgB,CAAC,QAAkB;QACxC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,SAAS,CAAC,SAAS,kCAAkC,EAAE,CAAC,IAAI,EAAE,EAAE;YACzG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,uBAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,IAAI,EAAE;gBACzC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,EAAc;QACxB,IAAI,mBAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAEtE,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,mCAAmC,SAAS,CAAC,SAAS,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;YACpH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YAEtE,OAAO,sBAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/G,CAAC,CAAC,CAAC;IACL,CAAC;;AAxKH,8BAyKC","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 Codes\n */\n\nimport { BentleyError, DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { CodeScopeSpec, CodeSpec, CodeSpecProperties, IModelError } from \"@itwin/core-common\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CodeService } from \"./CodeService\";\n\n/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]\n * @public @preview\n */\nexport class CodeSpecs {\n  private static tableName = \"bis_CodeSpec\";\n  private _imodel: IModelDb;\n  private _loadedCodeSpecs: CodeSpec[] = [];\n\n  constructor(imodel: IModelDb) {\n    this._imodel = imodel;\n    if (imodel.isBriefcaseDb()) {\n      imodel.onChangesetApplied.addListener(() => this._loadedCodeSpecs.length = 0);\n    }\n  }\n\n  private findByName(name: string): Id64String | undefined {\n    return this._imodel.withSqliteStatement(`SELECT Id FROM ${CodeSpecs.tableName} WHERE Name=?`, (stmt) => {\n      stmt.bindString(1, name);\n      return stmt.nextRow() ? stmt.getValueId(0) : undefined;\n    });\n  }\n\n  /** Look up the Id of the CodeSpec with the specified name. */\n  public queryId(name: string): Id64String {\n    const id = this.findByName(name);\n    if (!id)\n      throw new IModelError(IModelStatus.NotFound, \"CodeSpec not found\");\n    return id;\n  }\n\n  /** Look up a CodeSpec by Id. The CodeSpec will be loaded from the database if necessary.\n   * @param codeSpecId The Id of the CodeSpec to load\n   * @returns The CodeSpec with the specified Id\n   * @throws [[IModelError]] if the Id is invalid or if no CodeSpec with that Id could be found.\n   */\n  public getById(codeSpecId: Id64String): CodeSpec {\n    // good chance it is already loaded - check there before running a query\n    const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.id === codeSpecId);\n    if (found !== undefined)\n      return found;\n\n    // must load this codespec\n    const loadedCodeSpec = this.load(codeSpecId);\n    this._loadedCodeSpecs.push(loadedCodeSpec);\n    return loadedCodeSpec;\n  }\n\n  /** Returns true if the IModelDb has a CodeSpec of the specified Id. */\n  public hasId(codeSpecId: Id64String): boolean {\n    try {\n      return undefined !== this.getById(codeSpecId);\n    } catch {\n      return false;\n    }\n  }\n\n  /** Look up a CodeSpec by name. The CodeSpec will be loaded from the database if necessary.\n   * @param name The name of the CodeSpec to load\n   * @returns The CodeSpec with the specified name\n   * @throws [[IModelError]] if no CodeSpec with the specified name could be found.\n   */\n  public getByName(name: string): CodeSpec {\n    // good chance it is already loaded - check there before running a query\n    const found = this._loadedCodeSpecs.find((codeSpec) => codeSpec.name === name);\n    if (found !== undefined)\n      return found;\n    const codeSpecId = this.queryId(name);\n    if (codeSpecId === undefined)\n      throw new IModelError(IModelStatus.NotFound, \"CodeSpec not found\");\n    return this.getById(codeSpecId);\n  }\n\n  /** Returns true if the IModelDb has a CodeSpec of the specified name. */\n  public hasName(name: string): boolean {\n    try {\n      return undefined !== this.getByName(name);\n    } catch {\n      return false;\n    }\n  }\n\n  private insertCodeSpec(specName: string, properties: CodeSpecProperties): Id64String {\n    const iModel = this._imodel;\n    const spec: CodeService.BisCodeSpecIndexProps = { name: specName.trim(), props: JSON.stringify(properties) };\n    if (this.findByName(spec.name))\n      throw new IModelError(IModelStatus.DuplicateName, \"CodeSpec already exists\");\n\n    const internalCodes = iModel.codeService?.internalCodes;\n    if (internalCodes) {\n      // Since there is no lock on the codespec table, to add a codespec to an iModel it must first be reserved in the\n      // internal code index via `internalCodes.reserveBisCodeSpecs` prior to calling this function.\n      // This ensures that the Ids will be unique, and the property values consistent, even if more than one user\n      // adds them without pushing their changes. The call to `verifyBisCodeSpec` will throw otherwise.\n      internalCodes.reader.verifyBisCodeSpec(spec);\n    } else {\n      // If this iModel doesn't have an internal code index, we have no way of coordinating the Ids for CodeSpecs across multiple users.\n      // Just look in this briefcase to find the currently highest used Id and hope for the best.\n      spec.id = iModel.withSqliteStatement(`SELECT MAX(Id) FROM ${CodeSpecs.tableName}`, (stmt) => stmt.nextRow() ? stmt.getValueInteger(0) + 1 : 1);\n    }\n\n    const id = spec.id!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n    iModel.withSqliteStatement(`INSERT INTO ${CodeSpecs.tableName}(Id,Name,JsonProperties) VALUES(?,?,?)`, (stmt) => {\n      stmt.bindInteger(1, id);\n      stmt.bindString(2, spec.name);\n      stmt.bindString(3, spec.props);\n      const rc = stmt.step();\n      if (rc !== DbResult.BE_SQLITE_DONE)\n        throw new BentleyError(rc, \"Error inserting codeSpec\");\n    });\n\n    return Id64.fromLocalAndBriefcaseIds(id, 0);\n  }\n\n  /** Add a new CodeSpec to the iModel.\n   * @param codeSpec The CodeSpec to insert\n   * @returns The Id of the persistent CodeSpec.\n   * @note If successful, this method will assign a valid CodeSpecId to the supplied CodeSpec\n   * @throws IModelError if the insertion fails\n   */\n  public insert(codeSpec: CodeSpec): Id64String;\n\n  /** Add a new CodeSpec to the IModelDb.\n   * @param name The name for the new CodeSpec.\n   * @param properties The properties or the CodeSpec. For backwards compatibility this may also be a `CodeScopeSpec.Type`.\n   * @returns The Id of the persistent CodeSpec.\n   * @throws IModelError if the insertion fails\n   */\n  public insert(name: string, properties: CodeSpecProperties | CodeScopeSpec.Type): Id64String;\n  public insert(codeSpecOrName: CodeSpec | string, props?: CodeSpecProperties | CodeScopeSpec.Type): Id64String {\n    if (codeSpecOrName instanceof CodeSpec) {\n      const id = this.insertCodeSpec(codeSpecOrName.name, codeSpecOrName.properties);\n      codeSpecOrName.id = id;\n      return id;\n    }\n    if (props === undefined)\n      throw new IModelError(IModelStatus.BadArg, \"Invalid argument\");\n\n    if (typeof props === \"object\")\n      return this.insertCodeSpec(codeSpecOrName, props);\n\n    const spec = CodeSpec.create(this._imodel, codeSpecOrName, props);\n    return this.insertCodeSpec(spec.name, spec.properties);\n  }\n\n  /** Update the Json properties of an existing CodeSpec.\n * @param codeSpec The codeSpec holding Json properties values to update\n * @throws if unable to update the codeSpec.\n */\n  public updateProperties(codeSpec: CodeSpec): void {\n    this._imodel.withSqliteStatement(`UPDATE ${CodeSpecs.tableName} SET JsonProperties=? WHERE Id=?`, (stmt) => {\n      stmt.bindString(1, JSON.stringify(codeSpec.properties));\n      stmt.bindId(2, codeSpec.id);\n      if (DbResult.BE_SQLITE_DONE !== stmt.step())\n        throw new IModelError(IModelStatus.BadArg, \"error updating CodeSpec properties\");\n    });\n  }\n\n  /** Load a CodeSpec from the iModel\n   * @param id  The persistent Id of the CodeSpec to load\n   */\n  public load(id: Id64String): CodeSpec {\n    if (Id64.isInvalid(id))\n      throw new IModelError(IModelStatus.InvalidId, \"Invalid codeSpecId\");\n\n    return this._imodel.withSqliteStatement(`SELECT Name,JsonProperties FROM ${CodeSpecs.tableName} WHERE Id=?`, (stmt) => {\n      stmt.bindId(1, id);\n      if (!stmt.nextRow())\n        throw new IModelError(IModelStatus.InvalidId, \"CodeSpec not found\");\n\n      return CodeSpec.createFromJson(this._imodel, id, stmt.getValueString(0), JSON.parse(stmt.getValueString(1)));\n    });\n  }\n}\n"]}

package/lib/cjs/DisplayStyle.d.ts

@@ -10,7 +10,7 @@ import { DeserializeEntityArgs, ECSqlRow } from "./Entity";
 /** A DisplayStyle defines the parameters for 'styling' the contents of a view.
  * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
  * Many ViewDefinitions may share the same DisplayStyle.
- * @public
+ * @public @preview
  */
 export declare abstract class DisplayStyle extends DefinitionElement {
     static get className(): string;
@@ -32,7 +32,7 @@ export declare abstract class DisplayStyle extends DefinitionElement {
     loadScheduleScript(): RenderSchedule.ScriptReference | undefined;
 }
 /** A DisplayStyle for 2d views.
- * @public
+ * @public @preview
  */
 export declare class DisplayStyle2d extends DisplayStyle {
     static get className(): string;
@@ -62,7 +62,7 @@ export declare class DisplayStyle2d extends DisplayStyle {
  * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).
  * These idiosyncrasies will be addressed in a future version of core-backend.
  * @see [[DisplayStyle3d.create]].
- * @public
+ * @public @preview
  */
 export interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, "backgroundColor" | "scheduleScript"> {
     /** If supplied, the [ViewFlags]($common) applied by the display style.
@@ -73,7 +73,7 @@ export interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettings
 }
 /** A DisplayStyle for 3d views.
  * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).
- * @public
+ * @public @preview
  */
 export declare class DisplayStyle3d extends DisplayStyle {
     static get className(): string;

package/lib/cjs/DisplayStyle.js

@@ -14,7 +14,7 @@ const Element_1 = require("./Element");
 /** A DisplayStyle defines the parameters for 'styling' the contents of a view.
  * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
  * Many ViewDefinitions may share the same DisplayStyle.
- * @public
+ * @public @preview
  */
 class DisplayStyle extends Element_1.DefinitionElement {
     static get className() { return "DisplayStyle"; }
@@ -136,7 +136,7 @@ class DisplayStyle extends Element_1.DefinitionElement {
 }
 exports.DisplayStyle = DisplayStyle;
 /** A DisplayStyle for 2d views.
- * @public
+ * @public @preview
  */
 class DisplayStyle2d extends DisplayStyle {
     static get className() { return "DisplayStyle2d"; }
@@ -184,7 +184,7 @@ class DisplayStyle2d extends DisplayStyle {
 exports.DisplayStyle2d = DisplayStyle2d;
 /** A DisplayStyle for 3d views.
  * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).
- * @public
+ * @public @preview
  */
 class DisplayStyle3d extends DisplayStyle {
     static get className() { return "DisplayStyle3d"; }

package/lib/cjs/DisplayStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAG4B;AAC5B,uCAA8D;AAK9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,YAAY;IACL,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAsB,CAAC;QAC9D,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC;QAC5D,qDAAqD;QACrD,IAAI,CAAC,cAAc,EAAE,0BAA0B,IAAI,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;YACpG,MAAM,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,gBAAgB,CAAC;YACxE,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7E,MAAM,GAAG,GAAa,EAAE,CAAC;gBACzB,gCAAiB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,EAAU,EAAE,EAAE;oBACvE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,gBAAgB,GAAG,GAAG,CAAC;YACvD,CAAC;QACH,CAAC;QACD,wDAAwD;QACxD,IAAI,cAAc,EAAE,4BAA4B,IAAI,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;YACnG,MAAM,cAAc,GAA+B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,CAAC;YAChG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,GAAG,4BAAc,CAAC,MAAM,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;QACtH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,YAAY;IACL,MAAM,CAAU,SAAS,CAAC,KAAwB,EAAE,MAAgB;QACzE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;YACtD,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QAE7C,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,kBAAqC,EAAE,kBAAqC;QACjJ,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,eAAe,GAAmC,EAAE,CAAC;YAC3D,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC1C,GAAG,CAAC,WAAW,CAAC;gBAChB,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBACxF,IAAI,mBAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;oBACnC,eAAe,CAAC,IAAI,CAAC,EAAC,GAAG,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAC,CAAC,CAAC;YACrE,CAAC;YACD,QAAQ,CAAC,cAAc,GAAG,eAAe,CAAC;QAC5C,CAAC;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,MAAM,sBAAsB,GAAc,EAAE,CAAC;YAC7C,KAAK,MAAM,eAAe,IAAI,QAAQ,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAC9D,IAAI,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACxB,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YAED,IAAI,CAAC,KAAK,sBAAsB,CAAC,MAAM;gBACrC,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACrH,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;QACnC,CAAC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,wBAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;QACnC,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;YAC7C,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;QACrB,CAAC;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAlID,oCAkIC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAuB;IAEjD,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEtE,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA5CD,wCA4CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAyB;IAEnD,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExE,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAErC,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;YAC1C,KAAK,MAAM,aAAa,IAAI,aAAa,EAAE,CAAC;gBAC1C,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,kBAAuC,EAAE,kBAAuC;QACrJ,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC;YAC3H,IAAI,gBAAgB,EAAE,OAAO,IAAI,mBAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,EAAE,QAAQ,EAAE,CAAC;gBAC/B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtF,CAAC;YAED,IAAI,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;gBAChE,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC7F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,mBAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;wBACtC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtD,CAAC;gBACH,CAAC;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;YACrF,CAAC;YAED,MAAM,MAAM,GAAG,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC5E,IAAI,MAAM,EAAE,CAAC;gBACX,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;wBACxB,MAAM,aAAa,GAAG,gCAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;wBAC7E,MAAM,qBAAqB,GAAiB,EAAE,CAAC;wBAC/C,KAAK,MAAM,aAAa,IAAI,aAAa,EAAE,CAAC;4BAC1C,MAAM,qBAAqB,GAAe,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;4BACrF,IAAI,mBAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,CAAC;gCAC5C,qBAAqB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;4BACpD,CAAC;wBACH,CAAC;wBACD,KAAK,CAAC,aAAa,GAAG,gCAAiB,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;oBACjF,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA1HD,wCA0HC","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 ViewDefinitions\n */\n\nimport { CompressedId64Set, Id64, Id64Array, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\n  DisplayStyleProps, DisplayStyleSettings, DisplayStyleSubCategoryProps, EntityReferenceSet, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\n} from \"@itwin/core-common\";\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\nimport { DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\n * Many ViewDefinitions may share the same DisplayStyle.\n * @public\n */\nexport abstract class DisplayStyle extends DefinitionElement {\n  public static override get className(): string { return \"DisplayStyle\"; }\n  public abstract get settings(): DisplayStyleSettings;\n\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n\n  /** @beta */\n  public static override deserialize(props: DeserializeEntityArgs): DisplayStyleProps {\n    const elProps = super.deserialize(props) as DisplayStyleProps;\n    const displayOptions = props.options?.element?.displayStyle;\n    // Uncompress excludedElements if they are compressed\n    if (!displayOptions?.compressExcludedElementIds && elProps.jsonProperties?.styles?.excludedElements) {\n      const excludedElements = elProps.jsonProperties.styles.excludedElements;\n      if (typeof excludedElements === \"string\" && excludedElements.startsWith(\"+\")) {\n        const ids: string[] = [];\n        CompressedId64Set.decompressSet(excludedElements).forEach((id: string) => {\n          ids.push(id);\n        });\n        elProps.jsonProperties.styles.excludedElements = ids;\n      }\n    }\n    // Omit Schedule Script Element Ids if the option is set\n    if (displayOptions?.omitScheduleScriptElementIds && elProps.jsonProperties?.styles?.scheduleScript) {\n      const scheduleScript: RenderSchedule.ScriptProps = elProps.jsonProperties.styles.scheduleScript;\n      elProps.jsonProperties.styles.scheduleScript = RenderSchedule.Script.removeScheduleScriptElementIds(scheduleScript);\n    }\n    return elProps;\n  }\n\n  /** @beta */\n  public static override serialize(props: DisplayStyleProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    return inst;\n  }\n\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\n   * @param codeValue The DisplayStyle name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    for (const [id] of this.settings.subCategoryOverrides) {\n      referenceIds.addElement(id);\n    }\n\n    for (const excludedElementId of this.settings.excludedElementIds)\n      referenceIds.addElement(excludedElementId);\n\n    if (this.settings.renderTimeline) {\n      referenceIds.addElement(this.settings.renderTimeline);\n    } else {\n      const script = this.loadScheduleScript();\n      if (script)\n        script.script.discloseIds(referenceIds);\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\n      return;\n\n    const settings = targetElementProps.jsonProperties.styles;\n    if (settings.subCategoryOvr) {\n      const targetOverrides: DisplayStyleSubCategoryProps[] = [];\n      for (const ovr of settings.subCategoryOvr) {\n        ovr.subCategory;\n        const targetSubCategoryId = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\n        if (Id64.isValid(targetSubCategoryId))\n          targetOverrides.push({...ovr, subCategory: targetSubCategoryId});\n      }\n      settings.subCategoryOvr = targetOverrides;\n    }\n\n    if (settings.excludedElements) {\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\n      const excludedTargetElements: Id64Array = [];\n      for (const excludedElement of excluded) {\n        const remapped = context.findTargetElementId(excludedElement);\n        if (Id64.isValid(remapped))\n          excludedTargetElements.push(remapped);\n      }\n\n      if (0 === excludedTargetElements.length)\n        delete settings.excludedElements;\n      else\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excludedTargetElements));\n    }\n\n    if (settings.renderTimeline) {\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\n      if (Id64.isValid(renderTimeline))\n        settings.renderTimeline = renderTimeline;\n      else\n        delete settings.renderTimeline;\n    } else if (settings.scheduleScript) {\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\n      if (scheduleScript.length > 0)\n        settings.scheduleScript = scheduleScript;\n      else\n        delete settings.scheduleScript;\n    }\n  }\n\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\n    let script;\n    let sourceId;\n    if (this.settings.renderTimeline) {\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\n      if (timeline) {\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\n        sourceId = timeline.id;\n      }\n    } else if (this.settings.scheduleScriptProps) {\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\n      sourceId = this.id;\n    }\n\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\n  }\n}\n\n/** A DisplayStyle for 2d views.\n * @public\n */\nexport class DisplayStyle2d extends DisplayStyle {\n  public static override get className(): string { return \"DisplayStyle2d\"; }\n  private readonly _settings: DisplayStyleSettings;\n\n  public get settings(): DisplayStyleSettings { return this._settings; }\n\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\n  }\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle2d\n   * @returns The newly constructed DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\n    const displayStyleProps: DisplayStyleProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      isPrivate: false,\n      jsonProperties: {\n        styles: {\n          backgroundColor: 0,\n          monochromeColor: ColorDef.white.toJSON(),\n          viewflags: ViewFlags.defaults,\n        },\n      },\n    };\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\n  }\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\n   * @param name The name of the DisplayStyle2d\n   * @returns The Id of the newly inserted DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n\n/** Describes initial settings for a new [[DisplayStyle3d]].\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\n * These idiosyncrasies will be addressed in a future version of core-backend.\n * @see [[DisplayStyle3d.create]].\n * @public\n */\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\n   */\n  viewFlags?: ViewFlags;\n  backgroundColor?: ColorDef | number;\n}\n\n/** A DisplayStyle for 3d views.\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\n * @public\n */\nexport class DisplayStyle3d extends DisplayStyle {\n  public static override get className(): string { return \"DisplayStyle3d\"; }\n  private readonly _settings: DisplayStyle3dSettings;\n\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\n\n  protected constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    for (const textureId of this.settings.environment.sky.textureIds)\n      referenceIds.addElement(textureId);\n\n    if (this.settings.planProjectionSettings)\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\n        referenceIds.addElement(planProjectionSetting[0]);\n\n    const groups = this.settings.contours.groups;\n    for (const group of groups) {\n      const subCategories = group.subCategories;\n      for (const subCategoryId of subCategories) {\n        referenceIds.addElement(subCategoryId);\n      }\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n    if (context.isBetweenIModels) {\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\n\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\n\n      if (skyBoxImageProps?.textures) {\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\n      }\n\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\n          if (Id64.isValidId64(remappedModelId)) {\n            remappedPlanProjections[remappedModelId] = entry[1];\n          }\n        }\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\n      }\n\n      const groups = targetElementProps?.jsonProperties?.styles?.contours?.groups;\n      if (groups) {\n        for (const group of groups) {\n          if (group.subCategories) {\n            const subCategories = CompressedId64Set.decompressArray(group.subCategories);\n            const remappedSubCategories: Id64String[] = [];\n            for (const subCategoryId of subCategories) {\n              const remappedSubCategoryId: Id64String = context.findTargetElementId(subCategoryId);\n              if (Id64.isValidId64(remappedSubCategoryId)) {\n                remappedSubCategories.push(remappedSubCategoryId);\n              }\n            }\n            group.subCategories = CompressedId64Set.sortAndCompress(remappedSubCategories);\n          }\n        }\n      }\n    }\n  }\n\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle3d\n   * @returns The newly constructed DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\n    options = options ?? {};\n    let viewflags = options.viewFlags?.toJSON();\n    if (!viewflags)\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\n\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\n\n    const settings: DisplayStyle3dSettingsProps = {\n      ...options,\n      viewflags,\n      backgroundColor,\n    };\n\n    const displayStyleProps: DisplayStyle3dProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      jsonProperties: { styles: settings },\n      isPrivate: false,\n\n    };\n\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\n  }\n  /**\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\n   * @param name The name of the DisplayStyle3d\n   * @returns The Id of the newly inserted DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n"]}
+{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAG4B;AAC5B,uCAA8D;AAK9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,YAAY;IACL,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAsB,CAAC;QAC9D,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC;QAC5D,qDAAqD;QACrD,IAAI,CAAC,cAAc,EAAE,0BAA0B,IAAI,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;YACpG,MAAM,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,gBAAgB,CAAC;YACxE,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7E,MAAM,GAAG,GAAa,EAAE,CAAC;gBACzB,gCAAiB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,EAAU,EAAE,EAAE;oBACvE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,gBAAgB,GAAG,GAAG,CAAC;YACvD,CAAC;QACH,CAAC;QACD,wDAAwD;QACxD,IAAI,cAAc,EAAE,4BAA4B,IAAI,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;YACnG,MAAM,cAAc,GAA+B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,CAAC;YAChG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,GAAG,4BAAc,CAAC,MAAM,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;QACtH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,YAAY;IACL,MAAM,CAAU,SAAS,CAAC,KAAwB,EAAE,MAAgB;QACzE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;YACtD,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QAE7C,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,kBAAqC,EAAE,kBAAqC;QACjJ,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,eAAe,GAAmC,EAAE,CAAC;YAC3D,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC1C,GAAG,CAAC,WAAW,CAAC;gBAChB,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBACxF,IAAI,mBAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;oBACnC,eAAe,CAAC,IAAI,CAAC,EAAC,GAAG,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAC,CAAC,CAAC;YACrE,CAAC;YACD,QAAQ,CAAC,cAAc,GAAG,eAAe,CAAC;QAC5C,CAAC;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,MAAM,sBAAsB,GAAc,EAAE,CAAC;YAC7C,KAAK,MAAM,eAAe,IAAI,QAAQ,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;gBAC9D,IAAI,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACxB,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YAED,IAAI,CAAC,KAAK,sBAAsB,CAAC,MAAM;gBACrC,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACrH,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;QACnC,CAAC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,wBAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;QACnC,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;YAC7C,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;QACrB,CAAC;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAlID,oCAkIC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAuB;IAEjD,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEtE,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA5CD,wCA4CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IACvC,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC1D,SAAS,CAAyB;IAEnD,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAExE,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAErC,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;YAC1C,KAAK,MAAM,aAAa,IAAI,aAAa,EAAE,CAAC;gBAC1C,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,kBAAuC,EAAE,kBAAuC;QACrJ,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,CAAC;YAC3H,IAAI,gBAAgB,EAAE,OAAO,IAAI,mBAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,EAAE,QAAQ,EAAE,CAAC;gBAC/B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtF,CAAC;YAED,IAAI,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;gBAChE,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC7F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,mBAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;wBACtC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtD,CAAC;gBACH,CAAC;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;YACrF,CAAC;YAED,MAAM,MAAM,GAAG,kBAAkB,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC5E,IAAI,MAAM,EAAE,CAAC;gBACX,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC3B,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;wBACxB,MAAM,aAAa,GAAG,gCAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;wBAC7E,MAAM,qBAAqB,GAAiB,EAAE,CAAC;wBAC/C,KAAK,MAAM,aAAa,IAAI,aAAa,EAAE,CAAC;4BAC1C,MAAM,qBAAqB,GAAe,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;4BACrF,IAAI,mBAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,CAAC;gCAC5C,qBAAqB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;4BACpD,CAAC;wBACH,CAAC;wBACD,KAAK,CAAC,aAAa,GAAG,gCAAiB,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;oBACjF,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA1HD,wCA0HC","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 ViewDefinitions\n */\n\nimport { CompressedId64Set, Id64, Id64Array, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\n  DisplayStyleProps, DisplayStyleSettings, DisplayStyleSubCategoryProps, EntityReferenceSet, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\n} from \"@itwin/core-common\";\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\nimport { DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\n * Many ViewDefinitions may share the same DisplayStyle.\n * @public @preview\n */\nexport abstract class DisplayStyle extends DefinitionElement {\n  public static override get className(): string { return \"DisplayStyle\"; }\n  public abstract get settings(): DisplayStyleSettings;\n\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n\n  /** @beta */\n  public static override deserialize(props: DeserializeEntityArgs): DisplayStyleProps {\n    const elProps = super.deserialize(props) as DisplayStyleProps;\n    const displayOptions = props.options?.element?.displayStyle;\n    // Uncompress excludedElements if they are compressed\n    if (!displayOptions?.compressExcludedElementIds && elProps.jsonProperties?.styles?.excludedElements) {\n      const excludedElements = elProps.jsonProperties.styles.excludedElements;\n      if (typeof excludedElements === \"string\" && excludedElements.startsWith(\"+\")) {\n        const ids: string[] = [];\n        CompressedId64Set.decompressSet(excludedElements).forEach((id: string) => {\n          ids.push(id);\n        });\n        elProps.jsonProperties.styles.excludedElements = ids;\n      }\n    }\n    // Omit Schedule Script Element Ids if the option is set\n    if (displayOptions?.omitScheduleScriptElementIds && elProps.jsonProperties?.styles?.scheduleScript) {\n      const scheduleScript: RenderSchedule.ScriptProps = elProps.jsonProperties.styles.scheduleScript;\n      elProps.jsonProperties.styles.scheduleScript = RenderSchedule.Script.removeScheduleScriptElementIds(scheduleScript);\n    }\n    return elProps;\n  }\n\n  /** @beta */\n  public static override serialize(props: DisplayStyleProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    return inst;\n  }\n\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\n   * @param codeValue The DisplayStyle name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    for (const [id] of this.settings.subCategoryOverrides) {\n      referenceIds.addElement(id);\n    }\n\n    for (const excludedElementId of this.settings.excludedElementIds)\n      referenceIds.addElement(excludedElementId);\n\n    if (this.settings.renderTimeline) {\n      referenceIds.addElement(this.settings.renderTimeline);\n    } else {\n      const script = this.loadScheduleScript();\n      if (script)\n        script.script.discloseIds(referenceIds);\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\n      return;\n\n    const settings = targetElementProps.jsonProperties.styles;\n    if (settings.subCategoryOvr) {\n      const targetOverrides: DisplayStyleSubCategoryProps[] = [];\n      for (const ovr of settings.subCategoryOvr) {\n        ovr.subCategory;\n        const targetSubCategoryId = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\n        if (Id64.isValid(targetSubCategoryId))\n          targetOverrides.push({...ovr, subCategory: targetSubCategoryId});\n      }\n      settings.subCategoryOvr = targetOverrides;\n    }\n\n    if (settings.excludedElements) {\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\n      const excludedTargetElements: Id64Array = [];\n      for (const excludedElement of excluded) {\n        const remapped = context.findTargetElementId(excludedElement);\n        if (Id64.isValid(remapped))\n          excludedTargetElements.push(remapped);\n      }\n\n      if (0 === excludedTargetElements.length)\n        delete settings.excludedElements;\n      else\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excludedTargetElements));\n    }\n\n    if (settings.renderTimeline) {\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\n      if (Id64.isValid(renderTimeline))\n        settings.renderTimeline = renderTimeline;\n      else\n        delete settings.renderTimeline;\n    } else if (settings.scheduleScript) {\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\n      if (scheduleScript.length > 0)\n        settings.scheduleScript = scheduleScript;\n      else\n        delete settings.scheduleScript;\n    }\n  }\n\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\n    let script;\n    let sourceId;\n    if (this.settings.renderTimeline) {\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\n      if (timeline) {\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\n        sourceId = timeline.id;\n      }\n    } else if (this.settings.scheduleScriptProps) {\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\n      sourceId = this.id;\n    }\n\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\n  }\n}\n\n/** A DisplayStyle for 2d views.\n * @public @preview\n */\nexport class DisplayStyle2d extends DisplayStyle {\n  public static override get className(): string { return \"DisplayStyle2d\"; }\n  private readonly _settings: DisplayStyleSettings;\n\n  public get settings(): DisplayStyleSettings { return this._settings; }\n\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\n  }\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle2d\n   * @returns The newly constructed DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\n    const displayStyleProps: DisplayStyleProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      isPrivate: false,\n      jsonProperties: {\n        styles: {\n          backgroundColor: 0,\n          monochromeColor: ColorDef.white.toJSON(),\n          viewflags: ViewFlags.defaults,\n        },\n      },\n    };\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\n  }\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\n   * @param name The name of the DisplayStyle2d\n   * @returns The Id of the newly inserted DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n\n/** Describes initial settings for a new [[DisplayStyle3d]].\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\n * These idiosyncrasies will be addressed in a future version of core-backend.\n * @see [[DisplayStyle3d.create]].\n * @public @preview\n */\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\n   */\n  viewFlags?: ViewFlags;\n  backgroundColor?: ColorDef | number;\n}\n\n/** A DisplayStyle for 3d views.\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\n * @public @preview\n */\nexport class DisplayStyle3d extends DisplayStyle {\n  public static override get className(): string { return \"DisplayStyle3d\"; }\n  private readonly _settings: DisplayStyle3dSettings;\n\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\n\n  protected constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    for (const textureId of this.settings.environment.sky.textureIds)\n      referenceIds.addElement(textureId);\n\n    if (this.settings.planProjectionSettings)\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\n        referenceIds.addElement(planProjectionSetting[0]);\n\n    const groups = this.settings.contours.groups;\n    for (const group of groups) {\n      const subCategories = group.subCategories;\n      for (const subCategoryId of subCategories) {\n        referenceIds.addElement(subCategoryId);\n      }\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelElementCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n    if (context.isBetweenIModels) {\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\n\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\n\n      if (skyBoxImageProps?.textures) {\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\n      }\n\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\n          if (Id64.isValidId64(remappedModelId)) {\n            remappedPlanProjections[remappedModelId] = entry[1];\n          }\n        }\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\n      }\n\n      const groups = targetElementProps?.jsonProperties?.styles?.contours?.groups;\n      if (groups) {\n        for (const group of groups) {\n          if (group.subCategories) {\n            const subCategories = CompressedId64Set.decompressArray(group.subCategories);\n            const remappedSubCategories: Id64String[] = [];\n            for (const subCategoryId of subCategories) {\n              const remappedSubCategoryId: Id64String = context.findTargetElementId(subCategoryId);\n              if (Id64.isValidId64(remappedSubCategoryId)) {\n                remappedSubCategories.push(remappedSubCategoryId);\n              }\n            }\n            group.subCategories = CompressedId64Set.sortAndCompress(remappedSubCategories);\n          }\n        }\n      }\n    }\n  }\n\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle3d\n   * @returns The newly constructed DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\n    options = options ?? {};\n    let viewflags = options.viewFlags?.toJSON();\n    if (!viewflags)\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\n\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\n\n    const settings: DisplayStyle3dSettingsProps = {\n      ...options,\n      viewflags,\n      backgroundColor,\n    };\n\n    const displayStyleProps: DisplayStyle3dProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      jsonProperties: { styles: settings },\n      isPrivate: false,\n\n    };\n\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\n  }\n  /**\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\n   * @param name The name of the DisplayStyle3d\n   * @returns The Id of the newly inserted DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n"]}