@itwin/core-backend 5.0.0-dev.90 → 5.0.0-dev.92

package/lib/esm/Category.d.ts

@@ -0,0 +1,136 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { CategoryProps, Code, CodeScopeProps, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+/** Defines the appearance for graphics in Geometric elements
+ * @public
+ */
+export declare class SubCategory extends DefinitionElement {
+    static get className(): string;
+    /** The Appearance parameters for this SubCategory */
+    appearance: SubCategoryAppearance;
+    /** Optional description of this SubCategory. */
+    description?: string;
+    protected constructor(props: SubCategoryProps, iModel: IModelDb);
+    toJSON(): SubCategoryProps;
+    /** Get the SubCategory's name (its Code value). */
+    getSubCategoryName(): string;
+    /** Get the Id of the SubCategory. */
+    getSubCategoryId(): Id64String;
+    /** Get the Id of this SubCategory's parent Category. */
+    getCategoryId(): Id64String;
+    /** Check if this is the default SubCategory of its parent Category. */
+    get isDefaultSubCategory(): boolean;
+    /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.
+     * @param iModel  The IModel
+     * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.
+     * @param codeValue The name of the SubCategory
+     */
+    static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code;
+    /** Create a new SubCategory
+     * @param iModelDb The iModel
+     * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]
+     * @param name The name of the SubCategory
+     * @param appearance The appearance settings to use for this SubCategory
+     * @returns The newly constructed SubCategory element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory;
+    /** Insert a new SubCategory
+     * @param iModelDb Insert into this iModel
+     * @param parentCategoryId Insert the new SubCategory as a child of this Category
+     * @param name The name of the SubCategory
+     * @param appearance The appearance settings to use for this SubCategory
+     * @returns The Id of the newly inserted SubCategory element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    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
+ */
+export declare class Category extends DefinitionElement {
+    static get className(): string;
+    rank: Rank;
+    description?: string;
+    protected constructor(props: CategoryProps, iModel: IModelDb);
+    toJSON(): CategoryProps;
+    /** Get the Id of the default SubCategory for this Category. */
+    myDefaultSubCategoryId(): Id64String;
+    /** Set the appearance of the default SubCategory for this Category */
+    setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;
+}
+/** Categorizes 2d GeometricElements.
+ * @public
+ */
+export declare class DrawingCategory extends Category {
+    static get className(): string;
+    protected constructor(opts: ElementProps, iModel: IModelDb);
+    /** Get the name of the CodeSpec that is used by DrawingCategory objects. */
+    static getCodeSpecName(): string;
+    /** Looks up the CategoryId of a DrawingCategory by model and name */
+    static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined;
+    /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.
+     * @param codeValue The name of the category
+     * @return A drawing category Code
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+    /** Create a new DrawingCategory
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name of the DrawingCategory
+     * @returns The newly constructed DrawingCategory element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory;
+    /** Insert a new DrawingCategory
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]
+     * @param name The name of the DrawingCategory
+     * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory
+     * @returns The Id of the newly inserted DrawingCategory element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    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
+ */
+export declare class SpatialCategory extends Category {
+    static get className(): string;
+    protected constructor(opts: ElementProps, iModel: IModelDb);
+    /** Get the name of the CodeSpec that is used by SpatialCategory objects. */
+    static getCodeSpecName(): string;
+    /** Looks up the CategoryId of a SpatialCategory by model and name */
+    static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined;
+    /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.
+     * @param codeValue The name of the category
+     * @return A spatial category Code
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+    /** Create a new SpatialCategory
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the SpatialCategory
+     * @returns The newly constructed SpatialCategory element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory;
+    /** Insert a new SpatialCategory
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel
+     * @param name The name of the SpatialCategory
+     * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory
+     * @returns The Id of the newly inserted SpatialCategory element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
+}
+//# sourceMappingURL=Category.d.ts.map

package/lib/esm/Category.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Category.d.ts","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACQ,aAAa,EAAE,IAAI,EAAE,cAAc,EAAY,YAAY,EAAE,IAAI,EAAE,qBAAqB,EAAE,gBAAgB,EACxH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,WAAY,SAAQ,iBAAiB;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA0B;IACxE,qDAAqD;IAC9C,UAAU,EAAE,qBAAqB,CAAC;IACzC,gDAAgD;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ;IAM/C,MAAM,IAAI,gBAAgB;IAQ1C,mDAAmD;IAC5C,kBAAkB,IAAI,MAAM;IACnC,qCAAqC;IAC9B,gBAAgB,IAAI,UAAU;IACrC,wDAAwD;IACjD,aAAa,IAAI,UAAU;IAClC,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,OAAO,CAA+F;IAEzI;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKrG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,WAAW;IAelK;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAIlK;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,iBAAiB;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAAuB;IAC9D,IAAI,EAAE,IAAI,CAAa;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ;IAM5C,MAAM,IAAI,aAAa;IAQvC,+DAA+D;IACxD,sBAAsB,IAAI,UAAU;IAE3C,sEAAsE;IAC/D,oBAAoB,CAAC,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,IAAI;CAQ9F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAO1K;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ;IAE1D,4EAA4E;WAC9D,eAAe,IAAI,MAAM;IAEvC,qEAAqE;WACvD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAK7H;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAUtG;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,KAAK,GAAG,qBAAqB,GAAG,UAAU;CAM1K"}

package/lib/esm/Category.js

@@ -0,0 +1,224 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Id64, JsonUtils } from "@itwin/core-bentley";
+import { BisCodeSpec, Code, Rank, SubCategoryAppearance, } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+import { CategoryOwnsSubCategories } from "./NavigationRelationship";
+/** Defines the appearance for graphics in Geometric elements
+ * @public
+ */
+export class SubCategory extends DefinitionElement {
+    static get className() { return "SubCategory"; }
+    /** The Appearance parameters for this SubCategory */
+    appearance;
+    /** Optional description of this SubCategory. */
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.appearance = new SubCategoryAppearance(props.appearance);
+        this.description = JsonUtils.asString(props.description);
+    }
+    toJSON() {
+        const val = super.toJSON();
+        val.appearance = this.appearance.toJSON();
+        if (this.description && this.description.length > 0)
+            val.description = this.description;
+        return val;
+    }
+    /** Get the SubCategory's name (its Code value). */
+    getSubCategoryName() { return this.code.value; }
+    /** Get the Id of the SubCategory. */
+    getSubCategoryId() { return this.id; }
+    /** Get the Id of this SubCategory's parent Category. */
+    getCategoryId() { return this.parent ? this.parent.id : Id64.invalid; }
+    /** Check if this is the default SubCategory of its parent Category. */
+    get isDefaultSubCategory() { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }
+    /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.
+     * @param iModel  The IModel
+     * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.
+     * @param codeValue The name of the SubCategory
+     */
+    static createCode(iModel, parentCategoryId, codeValue) {
+        const codeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);
+        return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });
+    }
+    /** Create a new SubCategory
+     * @param iModelDb The iModel
+     * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]
+     * @param name The name of the SubCategory
+     * @param appearance The appearance settings to use for this SubCategory
+     * @returns The newly constructed SubCategory element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, parentCategoryId, name, appearance) {
+        if (appearance instanceof SubCategoryAppearance)
+            appearance = appearance.toJSON();
+        const parentCategory = iModelDb.elements.getElement(parentCategoryId);
+        const subCategoryProps = {
+            classFullName: this.classFullName,
+            model: parentCategory.model,
+            parent: new CategoryOwnsSubCategories(parentCategoryId),
+            code: this.createCode(iModelDb, parentCategoryId, name),
+            appearance,
+        };
+        return new SubCategory(subCategoryProps, iModelDb);
+    }
+    /** Insert a new SubCategory
+     * @param iModelDb Insert into this iModel
+     * @param parentCategoryId Insert the new SubCategory as a child of this Category
+     * @param name The name of the SubCategory
+     * @param appearance The appearance settings to use for this SubCategory
+     * @returns The Id of the newly inserted SubCategory element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, parentCategoryId, name, appearance) {
+        const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);
+        return iModelDb.elements.insertElement(subCategory.toJSON());
+    }
+}
+/** A Category element is the target of the `category` member of [[GeometricElement]].
+ * @public
+ */
+export class Category extends DefinitionElement {
+    static get className() { return "Category"; }
+    rank = Rank.User;
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.rank = JsonUtils.asInt(props.rank);
+        this.description = JsonUtils.asString(props.description);
+    }
+    toJSON() {
+        const val = super.toJSON();
+        val.rank = this.rank;
+        if (this.description && this.description.length > 0)
+            val.description = this.description;
+        return val;
+    }
+    /** Get the Id of the default SubCategory for this Category. */
+    myDefaultSubCategoryId() { return IModelDb.getDefaultSubCategoryId(this.id); }
+    /** Set the appearance of the default SubCategory for this Category */
+    setDefaultAppearance(props) {
+        if (props instanceof SubCategoryAppearance)
+            props = props.toJSON();
+        const subCat = this.iModel.elements.getElement(this.myDefaultSubCategoryId());
+        subCat.appearance = new SubCategoryAppearance(props);
+        this.iModel.elements.updateElement(subCat.toJSON());
+    }
+}
+/** Categorizes 2d GeometricElements.
+ * @public
+ */
+export class DrawingCategory extends Category {
+    static get className() { return "DrawingCategory"; }
+    constructor(opts, iModel) { super(opts, iModel); }
+    /** Get the name of the CodeSpec that is used by DrawingCategory objects. */
+    static getCodeSpecName() { return BisCodeSpec.drawingCategory; }
+    /** Looks up the CategoryId of a DrawingCategory by model and name */
+    static queryCategoryIdByName(iModel, scopeModelId, categoryName) {
+        const code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);
+        return iModel.elements.queryElementIdByCode(code);
+    }
+    /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.
+     * @param codeValue The name of the category
+     * @return A drawing category Code
+     */
+    static createCode(iModel, scopeModelId, codeValue) {
+        const codeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());
+        return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+    /** Create a new DrawingCategory
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name of the DrawingCategory
+     * @returns The newly constructed DrawingCategory element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, name) {
+        const categoryProps = {
+            classFullName: this.classFullName,
+            model: definitionModelId,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            isPrivate: false,
+        };
+        return new DrawingCategory(categoryProps, iModelDb);
+    }
+    /** Insert a new DrawingCategory
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]
+     * @param name The name of the DrawingCategory
+     * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory
+     * @returns The Id of the newly inserted DrawingCategory element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, name, defaultAppearance) {
+        const category = this.create(iModelDb, definitionModelId, name);
+        const elements = iModelDb.elements;
+        category.id = elements.insertElement(category.toJSON());
+        category.setDefaultAppearance(defaultAppearance);
+        return category.id;
+    }
+}
+/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
+ * @public
+ */
+export class SpatialCategory extends Category {
+    static get className() { return "SpatialCategory"; }
+    constructor(opts, iModel) { super(opts, iModel); }
+    /** Get the name of the CodeSpec that is used by SpatialCategory objects. */
+    static getCodeSpecName() { return BisCodeSpec.spatialCategory; }
+    /** Looks up the CategoryId of a SpatialCategory by model and name */
+    static queryCategoryIdByName(iModel, scopeModelId, categoryName) {
+        const code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);
+        return iModel.elements.queryElementIdByCode(code);
+    }
+    /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.
+     * @param codeValue The name of the category
+     * @return A spatial category Code
+     */
+    static createCode(iModel, scopeModelId, codeValue) {
+        const codeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());
+        return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+    /** Create a new SpatialCategory
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the SpatialCategory
+     * @returns The newly constructed SpatialCategory element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, name) {
+        const categoryProps = {
+            classFullName: this.classFullName,
+            model: definitionModelId,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            isPrivate: false,
+        };
+        return new SpatialCategory(categoryProps, iModelDb);
+    }
+    /** Insert a new SpatialCategory
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel
+     * @param name The name of the SpatialCategory
+     * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory
+     * @returns The Id of the newly inserted SpatialCategory element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, name, defaultAppearance) {
+        const category = this.create(iModelDb, definitionModelId, name);
+        category.id = iModelDb.elements.insertElement(category.toJSON());
+        category.setDefaultAppearance(defaultAppearance);
+        return category.id;
+    }
+}
+//# sourceMappingURL=Category.js.map

package/lib/esm/Category.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,WAAW,EAAiB,IAAI,EAA0C,IAAI,EAAE,qBAAqB,GACtG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,iBAAiB;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,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,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,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,QAAQ,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,WAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,IAAI,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,qBAAqB;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,yBAAyB,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;CACF;AAED;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,IAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEe,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,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,qBAAqB;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,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,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,WAAW,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,IAAI,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;AAED;;GAEG;AACH,MAAM,OAAO,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,WAAW,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,IAAI,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","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\";\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  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  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"]}

package/lib/esm/ChangeSummaryManager.d.ts

@@ -0,0 +1,161 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { AccessToken, GuidString, Id64String } from "@itwin/core-bentley";
+import { ChangedValueState, ChangeOpCode, ChangesetRange } from "@itwin/core-common";
+import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
+/** Represents an instance of the `ChangeSummary` ECClass from the `ECDbChange` ECSchema
+ * combined with the information from the related `Changeset` instance (from the `IModelChange` ECSchema) from
+ * which the Change Summary was extracted.
+ *
+ * See also
+ * - [ChangeSummaryManager.queryChangeSummary]($backend)
+ * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)
+ * @beta
+ */
+export interface ChangeSummary {
+    id: Id64String;
+    changeSet: {
+        wsgId: GuidString;
+        parentWsgId: GuidString;
+        description: string;
+        pushDate: string;
+        userCreated: GuidString;
+    };
+}
+/** Represents an instance of the `InstanceChange` ECClass from the `ECDbChange` ECSchema
+ *
+ * See also
+ * - [ChangeSummaryManager.queryInstanceChange]($backend)
+ * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)
+ * @beta
+ */
+export interface InstanceChange {
+    id: Id64String;
+    summaryId: Id64String;
+    changedInstance: {
+        id: Id64String;
+        className: string;
+    };
+    opCode: ChangeOpCode;
+    isIndirect: boolean;
+}
+/** Options for [ChangeSummaryManager.createChangeSummaries]($backend).
+ * @beta
+ */
+export interface CreateChangeSummaryArgs extends TokenArg {
+    /** Id of the iTwin that contains the iModel */
+    iTwinId: GuidString;
+    /** Id of the iModel */
+    iModelId: GuidString;
+    /**
+     * Range of change sets
+     * - the Change Summary for the first and last versions are also included
+     * - if unspecified, all change sets until the latest version are processed
+     */
+    range: ChangesetRange;
+}
+/** Class to extract Change Summaries for a briefcase.
+ *
+ * See also:
+ * - [ChangeSummary Overview]($docs/learning/ChangeSummaries)
+ * @beta
+ */
+export declare class ChangeSummaryManager {
+    private static readonly _currentIModelChangeSchemaVersion;
+    /** Determines whether the *Change Cache file* is attached to the specified iModel or not
+     * @param iModel iModel to check whether a *Change Cache file* is attached
+     * @returns Returns true if the *Change Cache file* is attached to the iModel. false otherwise
+     */
+    static isChangeCacheAttached(iModel: IModelDb): boolean;
+    /** Attaches the *Change Cache file* to the specified iModel if it hasn't been attached yet.
+     * A new *Change Cache file* will be created for the iModel if it hasn't existed before.
+     * @param iModel iModel to attach the *Change Cache file* file to
+     * @throws [IModelError]($common)
+     */
+    static attachChangeCache(iModel: IModelDb): void;
+    /** Detaches the *Change Cache file* from the specified iModel.
+     * - note that this method will cause any pending (currently running or queued) queries to fail
+     * @param iModel iModel to detach the *Change Cache file* to
+     * @throws [IModelError]($common) in case of errors, e.g. if no *Change Cache file* was attached before.
+     */
+    static detachChangeCache(iModel: IModelDb): void;
+    private static openOrCreateChangesFile;
+    private static createChangeCacheFile;
+    private static openChangeCacheFile;
+    private static getExtendedSchemaPath;
+    private static isSummaryAlreadyExtracted;
+    private static addExtendedInfos;
+    /** Queries the ChangeSummary for the specified change summary id
+     *
+     * See also
+     * - `ECDbChange.ChangeSummary` ECClass in the *ECDbChange* ECSchema
+     * - [Change Summary Overview]($docs/learning/ChangeSummaries)
+     * @param iModel iModel
+     * @param changeSummaryId ECInstanceId of the ChangeSummary
+     * @returns Returns the requested ChangeSummary object
+     * @throws [IModelError]($common) If change summary does not exist for the specified id, or if the
+     * change cache file hasn't been attached, or in case of other errors.
+     */
+    static queryChangeSummary(iModel: BriefcaseDb, changeSummaryId: Id64String): ChangeSummary;
+    /** Queries the InstanceChange for the specified instance change id.
+     *
+     * See also
+     * - `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema
+     * - [Change Summary Overview]($docs/learning/ChangeSummaries)
+     * @param iModel iModel
+     * @param instanceChangeId ECInstanceId of the InstanceChange (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)
+     * @returns Returns the requested InstanceChange object (see `ECDbChange.InstanceChange` ECClass in the *ECDbChange* ECSchema)
+     * @throws [IModelError]($common) if instance change does not exist for the specified id, or if the
+     * change cache file hasn't been attached, or in case of other errors.
+     */
+    static queryInstanceChange(iModel: BriefcaseDb, instanceChangeId: Id64String): InstanceChange;
+    /** Retrieves the names of the properties whose values have changed for the given instance change
+     *
+     * See also [Change Summary Overview]($docs/learning/ChangeSummaries)
+     * @param iModel iModel
+     * @param instanceChangeId Id of the InstanceChange to query the properties whose values have changed
+     * @returns Returns names of the properties whose values have changed for the given instance change
+     * @throws [IModelError]($common) if the change cache file hasn't been attached, or in case of other errors.
+     */
+    static getChangedPropertyValueNames(iModel: IModelDb, instanceChangeId: Id64String): string[];
+    /** Builds the ECSQL to query the property value changes for the specified instance change and the specified ChangedValueState.
+     *
+     * See also [Change Summary Overview]($docs/learning/ChangeSummaries)
+     * @param iModel iModel
+     * @param instanceChangeInfo InstanceChange to query the property value changes for
+     *        changedInstance.className must be fully qualified and schema and class name must be escaped with square brackets if they collide with reserved ECSQL words: `[schema name].[class name]`
+     * @param changedValueState The Changed State to query the values for. This must correspond to the [InstanceChange.OpCode]($backend) of the InstanceChange.
+     * @param changedPropertyNames List of the property names for which values have changed for the specified instance change.
+     *        The list can be obtained by calling [ChangeSummaryManager.getChangedPropertyValueNames]($core-backend).
+     *        If omitted, the method will call the above method by itself. The parameter allows for checking first whether
+     *        an instance change has any property value changes at all. If there are no property value changes, this method
+     *        should not be called, as it will throw an error.
+     * @returns Returns the ECSQL that will retrieve the property value changes
+     * @throws [IModelError]($common) if instance change does not exist, if there are not property value changes for the instance change,
+     *        if the change cache file hasn't been attached, or in case of other errors.
+     */
+    static buildPropertyValueChangesECSql(iModel: IModelDb, instanceChangeInfo: {
+        id: Id64String;
+        summaryId: Id64String;
+        changedInstance: {
+            id: Id64String;
+            className: string;
+        };
+    }, changedValueState: ChangedValueState, changedPropertyNames?: string[]): string;
+    /**
+     * Creates a change summary for the last applied change set to the iModel
+     * @param accessToken A valid access token string
+     * @param iModel iModel to extract change summaries for. The iModel must not be a standalone iModel, and must have at least one change set applied to it.
+     * @returns The id of the extracted change summary.
+     * @beta
+     */
+    static createChangeSummary(accessToken: AccessToken, iModel: BriefcaseDb): Promise<Id64String>;
+    /**
+     * Creates change summaries for the specified iModel and a specified range of versions
+     * @note This may be an expensive operation - downloads the first version and starts applying the change sets, extracting summaries one by one
+     * @param args Arguments including the range of versions for which Change Summaries are to be created, and other necessary input for creation
+     */
+    static createChangeSummaries(args: CreateChangeSummaryArgs): Promise<Id64String[]>;
+}
+//# sourceMappingURL=ChangeSummaryManager.d.ts.map

package/lib/esm/ChangeSummaryManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeSummaryManager.d.ts","sourceRoot":"","sources":["../../src/ChangeSummaryManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAoB,UAAU,EAAE,UAAU,EAAwB,MAAM,qBAAqB,CAAC;AAClH,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,cAAc,EAA8B,MAAM,oBAAoB,CAAC;AAMjH,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAO7D;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,UAAU,CAAC;IACf,SAAS,EAAE;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,WAAW,EAAE,UAAU,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,UAAU,CAAA;KAAE,CAAC;CAC3H;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,UAAU,CAAC;IACf,SAAS,EAAE,UAAU,CAAC;IACtB,eAAe,EAAE;QAAE,EAAE,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IACvD,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,QAAQ;IACvD,+CAA+C;IAC/C,OAAO,EAAE,UAAU,CAAC;IAEpB,uBAAuB;IACvB,QAAQ,EAAE,UAAU,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,cAAc,CAAC;CACvB;AAED;;;;;GAKG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iCAAiC,CAAmC;IAE5F;;;OAGG;WACW,qBAAqB,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO;IAO9D;;;;OAIG;WACW,iBAAiB,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI;IAmBvD;;;;OAIG;WACW,iBAAiB,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI;IAUvD,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAuBtC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAYpC,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAmBlC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAEpC,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAWxC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAuB/B;;;;;;;;;;OAUG;WACW,kBAAkB,CAAC,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,UAAU,GAAG,aAAa;IAejG;;;;;;;;;;OAUG;WACW,mBAAmB,CAAC,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,UAAU,GAAG,cAAc;IA0BpG;;;;;;;OAOG;WACW,4BAA4B,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,GAAG,MAAM,EAAE;IA4BpG;;;;;;;;;;;;;;;OAeG;WACW,8BAA8B,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE;QAAE,EAAE,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,UAAU,CAAC;QAAC,eAAe,EAAE;YAAE,EAAE,EAAE,UAAU,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM;IAyBpQ;;;;;;OAMG;WACiB,mBAAmB,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAyC3G;;;;OAIG;WACiB,qBAAqB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAyChG"}