@itwin/core-common 4.0.0-dev.28 → 4.0.0-dev.30

package/lib/esm/Code.js

@@ -1,264 +1,264 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Codes
- */
-import { Id64, JsonUtils } from "@itwin/core-bentley";
-/**
- * A three-part structure containing information about the [Code]($docs/bis/guide/fundamentals/codes) of an Element
- * @public
- */
-export class Code {
-    constructor(codeProps) {
-        this.spec = Id64.fromJSON(codeProps.spec);
-        this.scope = JsonUtils.asString(codeProps.scope);
-        this.value = JsonUtils.asString(codeProps.value);
-    }
-    /** The [CodeValue]($docs/bis/guide/fundamentals/codes.md#codevalue-property) of the Element
-     * @note Leading and trailing whitespace is invalid so is automatically trimmed.
-     */
-    get value() { return this._value ?? ""; }
-    set value(val) { this._value = val?.trim(); }
-    /** Create an empty, non-unique code with no special meaning. */
-    static createEmpty() {
-        const id = Id64.fromLocalAndBriefcaseIds(1, 0);
-        return new Code({ spec: id, scope: id });
-    }
-    static fromJSON(json) { return json ? new Code(json) : Code.createEmpty(); }
-    toJSON() { return { spec: this.spec, scope: this.scope, value: this.value }; }
-    equals(other) { return Code.equalCodes(this, other); }
-    /** @internal */
-    static equalCodes(c1, c2) {
-        return c1.spec === c2.spec && c1.scope === c2.scope && c1.value === c2.value;
-    }
-    /** Determine whether this Code is valid. */
-    static isValid(c) { return Id64.isValidId64(c.spec); }
-    /** Determine if this code is valid but not otherwise meaningful (and therefore not necessarily unique) */
-    static isEmpty(c) { return this.isValid(c) && (c.value === undefined || c.value === ""); }
-}
-/** Names of the internal BIS CodeSpecs. These names match those specified by the native library.
- * For other domains, the best practice is to include the domain name or alias as part of the CodeSpec name to ensure global uniqueness.
- * @public
-* @extensions
-* @see [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec)
- */
-export var BisCodeSpec;
-(function (BisCodeSpec) {
-    /** The name of the standard [[CodeSpec]] used when creating *empty* codes.
-     * @see [[Code.createEmpty]]
-     */
-    BisCodeSpec["nullCodeSpec"] = "bis:NullCodeSpec";
-    /** @internal */
-    BisCodeSpec["annotationFrameStyle"] = "bis:AnnotationFrameStyle";
-    /** @internal */
-    BisCodeSpec["annotationLeaderStyle"] = "bis:AnnotationLeaderStyle";
-    /** @internal */
-    BisCodeSpec["annotationTextStyle"] = "bis:AnnotationTextStyle";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem2d]($backend) elements.
-     * @see [AuxCoordSystem2d.createCode]($backend)
-     */
-    BisCodeSpec["auxCoordSystem2d"] = "bis:AuxCoordSystem2d";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem3d]($backend) elements.
-     * @see [AuxCoordSystem3d.createCode]($backend)
-     */
-    BisCodeSpec["auxCoordSystem3d"] = "bis:AuxCoordSystem3d";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystemSpatial]($backend) elements.
-     * @see [AuxCoordSystemSpatial.createCode]($backend)
-     */
-    BisCodeSpec["auxCoordSystemSpatial"] = "bis:AuxCoordSystemSpatial";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [CategorySelector]($backend) elements.
-     * @see [CategorySelector.createCode]($backend)
-     */
-    BisCodeSpec["categorySelector"] = "bis:CategorySelector";
-    /** @internal */
-    BisCodeSpec["colorBook"] = "bis:ColorBook";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [DisplayStyle]($backend) elements.
-     * @see [DisplayStyle.createCode]($backend)
-     */
-    BisCodeSpec["displayStyle"] = "bis:DisplayStyle";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Drawing]($backend) elements.
-     * @see [Drawing.createCode]($backend)
-     */
-    BisCodeSpec["drawing"] = "bis:Drawing";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [DrawingCategory]($backend) elements.
-     * @see [DrawingCategory.createCode]($backend)
-     */
-    BisCodeSpec["drawingCategory"] = "bis:DrawingCategory";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSource]($backend) elements.
-     * @note This CodeSpec is not automatically created, so use [ExternalSource.ensureCodeSpec]($backend) to make sure that it exists.
-     * @see [ExternalSource.createCode]($backend)
-     */
-    BisCodeSpec["externalSource"] = "bis:ExternalSource";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSourceAttachment]($backend) elements.
-     * @note This CodeSpec is not automatically created, so use [ExternalSourceAttachment.ensureCodeSpec]($backend) to make sure that it exists.
-     * @see [ExternalSource.createCode]($backend)
-     */
-    BisCodeSpec["externalSourceAttachment"] = "bis:ExternalSourceAttachment";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [GeometryPart]($backend) elements.
-     * @see [GeometryPart.createCode]($backend)
-     */
-    BisCodeSpec["geometryPart"] = "bis:GeometryPart";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [GraphicalType2d]($backend) elements.
-     * @see [GraphicalType2d.createCode]($backend)
-     */
-    BisCodeSpec["graphicalType2d"] = "bis:GraphicalType2d";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [LineStyle]($backend) elements.
-     * @see [LineStyle.createCode]($backend)
-     */
-    BisCodeSpec["lineStyle"] = "bis:LineStyle";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [LinkElement]($backend) elements.
-     * @see [LinkElement.createCode]($backend)
-     */
-    BisCodeSpec["linkElement"] = "bis:LinkElement";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [ModelSelector]($backend) elements.
-     * @see [ModelSelector.createCode]($backend)
-     */
-    BisCodeSpec["modelSelector"] = "bis:ModelSelector";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalMaterial]($backend) elements.
-     * @see [PhysicalMaterial.createCode]($backend)
-     */
-    BisCodeSpec["physicalMaterial"] = "bis:PhysicalMaterial";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalType]($backend) elements.
-     * @see [PhysicalType.createCode]($backend)
-     */
-    BisCodeSpec["physicalType"] = "bis:PhysicalType";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [InformationPartitionElement]($backend) elements.
-     * @see [InformationPartitionElement.createCode]($backend)
-     */
-    BisCodeSpec["informationPartitionElement"] = "bis:InformationPartitionElement";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [RenderMaterialElement]($backend) elements.
-     * @see [RenderMaterialElement.createCode]($backend)
-     */
-    BisCodeSpec["renderMaterial"] = "bis:RenderMaterial";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Sheet]($backend) elements.
-     * @see [Sheet.createCode]($backend)
-     */
-    BisCodeSpec["sheet"] = "bis:Sheet";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialCategory]($backend) elements.
-     * @see [SpatialCategory.createCode]($backend)
-     */
-    BisCodeSpec["spatialCategory"] = "bis:SpatialCategory";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialLocationType]($backend) elements.
-     * @see [SpatialLocationType.createCode]($backend)
-     */
-    BisCodeSpec["spatialLocationType"] = "bis:SpatialLocationType";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [SubCategory]($backend) elements.
-     * @see [SubCategory.createCode]($backend)
-     */
-    BisCodeSpec["subCategory"] = "bis:SubCategory";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Subject]($backend) elements.
-     * @see [Subject.createCode]($backend)
-     */
-    BisCodeSpec["subject"] = "bis:Subject";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe2d]($backend) elements.
-     * @see [TemplateRecipe2d.createCode]($backend)
-     */
-    BisCodeSpec["templateRecipe2d"] = "bis:TemplateRecipe2d";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe3d]($backend) elements.
-     * @see [TemplateRecipe3d.createCode]($backend)
-     */
-    BisCodeSpec["templateRecipe3d"] = "bis:TemplateRecipe3d";
-    /** @internal */
-    BisCodeSpec["textAnnotationSeed"] = "bis:TextAnnotationSeed";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Texture]($backend) elements.
-     * @see [Texture.createCode]($backend)
-     */
-    BisCodeSpec["texture"] = "bis:Texture";
-    /** The name of the standard [[CodeSpec]] used when creating codes for [ViewDefinition]($backend) elements.
-     * @see [ViewDefinition.createCode]($backend)
-     */
-    BisCodeSpec["viewDefinition"] = "bis:ViewDefinition";
-})(BisCodeSpec || (BisCodeSpec = {}));
-/** The scope of the Code.
- * @public
- */
-export var CodeScopeSpec;
-(function (CodeScopeSpec) {
-    /** The standard ways the CodeScope can be specified.
-     * @public
-     */
-    let Type;
-    (function (Type) {
-        /** The Code value must be unique within (at least) the iModel repository */
-        Type[Type["Repository"] = 1] = "Repository";
-        /** The Code value must be unique within the scope of the Model */
-        Type[Type["Model"] = 2] = "Model";
-        /** The Code value must be unique among other children of the same parent element */
-        Type[Type["ParentElement"] = 3] = "ParentElement";
-        /** The Code value must be unique among other elements also scoped by the same element */
-        Type[Type["RelatedElement"] = 4] = "RelatedElement";
-    })(Type = CodeScopeSpec.Type || (CodeScopeSpec.Type = {}));
-    /**
-     * Requirements for how the CodeScope Element is identified.
-     * @public
-     */
-    let ScopeRequirement;
-    (function (ScopeRequirement) {
-        /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */
-        ScopeRequirement[ScopeRequirement["ElementId"] = 1] = "ElementId";
-        /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */
-        ScopeRequirement[ScopeRequirement["FederationGuid"] = 2] = "FederationGuid";
-    })(ScopeRequirement = CodeScopeSpec.ScopeRequirement || (CodeScopeSpec.ScopeRequirement = {}));
-})(CodeScopeSpec || (CodeScopeSpec = {}));
-/** A [Code Specification]($docs/bis/guide/references/glossary#codespec) captures the rules for encoding and decoding significant business information into
- * and from a Code (string). This specification is used to generate and validate Codes.
- *
- * A CodeSpec defines the format of a Code for a certain type of Element in an IModel.
- * A CodeSpec can identify an external system that maintains and/or assigns Codes.
- * @public
- */
-export class CodeSpec {
-    constructor(iModel, id, name, properties) {
-        this.iModel = iModel;
-        this.id = id;
-        this.name = name;
-        this.properties = properties ?? { scopeSpec: { type: CodeScopeSpec.Type.Repository } };
-    }
-    /** Create a new CodeSpec from the specified parameters
-     * > Note: CodeSpec.id will not be valid until inserted
-     * @see [CodeSpecs.insert]($backend)
-     */
-    static create(iModel, name, scopeType, scopeReq) {
-        const props = { scopeSpec: { type: scopeType } };
-        if (scopeReq)
-            props.scopeSpec.fGuidRequired = scopeReq === CodeScopeSpec.ScopeRequirement.FederationGuid;
-        return new CodeSpec(iModel, Id64.invalid, name, props);
-    }
-    /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.
-     * @internal
-     */
-    static createFromJson(iModel, id, name, properties) {
-        return new CodeSpec(iModel, id, name, properties);
-    }
-    /** Will be true if the id of this CodeSpec is valid. */
-    get isValid() { return Id64.isValid(this.id); }
-    /** The scope type of this CodeSpec. */
-    get scopeType() { return this.properties.scopeSpec.type; }
-    set scopeType(scopeType) { this.properties.scopeSpec.type = scopeType; }
-    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or
-     * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).
-     */
-    get scopeReq() {
-        return this.properties.scopeSpec.fGuidRequired ? CodeScopeSpec.ScopeRequirement.FederationGuid : CodeScopeSpec.ScopeRequirement.ElementId;
-    }
-    set scopeReq(req) {
-        if (CodeScopeSpec.ScopeRequirement.FederationGuid === req)
-            this.properties.scopeSpec.fGuidRequired = true;
-        else
-            this.properties.scopeSpec.fGuidRequired = undefined;
-    }
-    /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.
-     * @deprecated in 3.6 Use scopeReq instead.
-     */
-    get isManagedWithIModel() {
-        return this.properties.spec?.isManagedWithDgnDb ?? true;
-    }
-    set isManagedWithIModel(value) {
-        if (!this.properties.spec)
-            this.properties.spec = {};
-        this.properties.spec.isManagedWithDgnDb = value;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Codes
+ */
+import { Id64, JsonUtils } from "@itwin/core-bentley";
+/**
+ * A three-part structure containing information about the [Code]($docs/bis/guide/fundamentals/codes) of an Element
+ * @public
+ */
+export class Code {
+    constructor(codeProps) {
+        this.spec = Id64.fromJSON(codeProps.spec);
+        this.scope = JsonUtils.asString(codeProps.scope);
+        this.value = JsonUtils.asString(codeProps.value);
+    }
+    /** The [CodeValue]($docs/bis/guide/fundamentals/codes.md#codevalue-property) of the Element
+     * @note Leading and trailing whitespace is invalid so is automatically trimmed.
+     */
+    get value() { return this._value ?? ""; }
+    set value(val) { this._value = val?.trim(); }
+    /** Create an empty, non-unique code with no special meaning. */
+    static createEmpty() {
+        const id = Id64.fromLocalAndBriefcaseIds(1, 0);
+        return new Code({ spec: id, scope: id });
+    }
+    static fromJSON(json) { return json ? new Code(json) : Code.createEmpty(); }
+    toJSON() { return { spec: this.spec, scope: this.scope, value: this.value }; }
+    equals(other) { return Code.equalCodes(this, other); }
+    /** @internal */
+    static equalCodes(c1, c2) {
+        return c1.spec === c2.spec && c1.scope === c2.scope && c1.value === c2.value;
+    }
+    /** Determine whether this Code is valid. */
+    static isValid(c) { return Id64.isValidId64(c.spec); }
+    /** Determine if this code is valid but not otherwise meaningful (and therefore not necessarily unique) */
+    static isEmpty(c) { return this.isValid(c) && (c.value === undefined || c.value === ""); }
+}
+/** Names of the internal BIS CodeSpecs. These names match those specified by the native library.
+ * For other domains, the best practice is to include the domain name or alias as part of the CodeSpec name to ensure global uniqueness.
+ * @public
+* @extensions
+* @see [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec)
+ */
+export var BisCodeSpec;
+(function (BisCodeSpec) {
+    /** The name of the standard [[CodeSpec]] used when creating *empty* codes.
+     * @see [[Code.createEmpty]]
+     */
+    BisCodeSpec["nullCodeSpec"] = "bis:NullCodeSpec";
+    /** @internal */
+    BisCodeSpec["annotationFrameStyle"] = "bis:AnnotationFrameStyle";
+    /** @internal */
+    BisCodeSpec["annotationLeaderStyle"] = "bis:AnnotationLeaderStyle";
+    /** @internal */
+    BisCodeSpec["annotationTextStyle"] = "bis:AnnotationTextStyle";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem2d]($backend) elements.
+     * @see [AuxCoordSystem2d.createCode]($backend)
+     */
+    BisCodeSpec["auxCoordSystem2d"] = "bis:AuxCoordSystem2d";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem3d]($backend) elements.
+     * @see [AuxCoordSystem3d.createCode]($backend)
+     */
+    BisCodeSpec["auxCoordSystem3d"] = "bis:AuxCoordSystem3d";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystemSpatial]($backend) elements.
+     * @see [AuxCoordSystemSpatial.createCode]($backend)
+     */
+    BisCodeSpec["auxCoordSystemSpatial"] = "bis:AuxCoordSystemSpatial";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [CategorySelector]($backend) elements.
+     * @see [CategorySelector.createCode]($backend)
+     */
+    BisCodeSpec["categorySelector"] = "bis:CategorySelector";
+    /** @internal */
+    BisCodeSpec["colorBook"] = "bis:ColorBook";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [DisplayStyle]($backend) elements.
+     * @see [DisplayStyle.createCode]($backend)
+     */
+    BisCodeSpec["displayStyle"] = "bis:DisplayStyle";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Drawing]($backend) elements.
+     * @see [Drawing.createCode]($backend)
+     */
+    BisCodeSpec["drawing"] = "bis:Drawing";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [DrawingCategory]($backend) elements.
+     * @see [DrawingCategory.createCode]($backend)
+     */
+    BisCodeSpec["drawingCategory"] = "bis:DrawingCategory";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSource]($backend) elements.
+     * @note This CodeSpec is not automatically created, so use [ExternalSource.ensureCodeSpec]($backend) to make sure that it exists.
+     * @see [ExternalSource.createCode]($backend)
+     */
+    BisCodeSpec["externalSource"] = "bis:ExternalSource";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSourceAttachment]($backend) elements.
+     * @note This CodeSpec is not automatically created, so use [ExternalSourceAttachment.ensureCodeSpec]($backend) to make sure that it exists.
+     * @see [ExternalSource.createCode]($backend)
+     */
+    BisCodeSpec["externalSourceAttachment"] = "bis:ExternalSourceAttachment";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [GeometryPart]($backend) elements.
+     * @see [GeometryPart.createCode]($backend)
+     */
+    BisCodeSpec["geometryPart"] = "bis:GeometryPart";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [GraphicalType2d]($backend) elements.
+     * @see [GraphicalType2d.createCode]($backend)
+     */
+    BisCodeSpec["graphicalType2d"] = "bis:GraphicalType2d";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [LineStyle]($backend) elements.
+     * @see [LineStyle.createCode]($backend)
+     */
+    BisCodeSpec["lineStyle"] = "bis:LineStyle";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [LinkElement]($backend) elements.
+     * @see [LinkElement.createCode]($backend)
+     */
+    BisCodeSpec["linkElement"] = "bis:LinkElement";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [ModelSelector]($backend) elements.
+     * @see [ModelSelector.createCode]($backend)
+     */
+    BisCodeSpec["modelSelector"] = "bis:ModelSelector";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalMaterial]($backend) elements.
+     * @see [PhysicalMaterial.createCode]($backend)
+     */
+    BisCodeSpec["physicalMaterial"] = "bis:PhysicalMaterial";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalType]($backend) elements.
+     * @see [PhysicalType.createCode]($backend)
+     */
+    BisCodeSpec["physicalType"] = "bis:PhysicalType";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [InformationPartitionElement]($backend) elements.
+     * @see [InformationPartitionElement.createCode]($backend)
+     */
+    BisCodeSpec["informationPartitionElement"] = "bis:InformationPartitionElement";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [RenderMaterialElement]($backend) elements.
+     * @see [RenderMaterialElement.createCode]($backend)
+     */
+    BisCodeSpec["renderMaterial"] = "bis:RenderMaterial";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Sheet]($backend) elements.
+     * @see [Sheet.createCode]($backend)
+     */
+    BisCodeSpec["sheet"] = "bis:Sheet";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialCategory]($backend) elements.
+     * @see [SpatialCategory.createCode]($backend)
+     */
+    BisCodeSpec["spatialCategory"] = "bis:SpatialCategory";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialLocationType]($backend) elements.
+     * @see [SpatialLocationType.createCode]($backend)
+     */
+    BisCodeSpec["spatialLocationType"] = "bis:SpatialLocationType";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [SubCategory]($backend) elements.
+     * @see [SubCategory.createCode]($backend)
+     */
+    BisCodeSpec["subCategory"] = "bis:SubCategory";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Subject]($backend) elements.
+     * @see [Subject.createCode]($backend)
+     */
+    BisCodeSpec["subject"] = "bis:Subject";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe2d]($backend) elements.
+     * @see [TemplateRecipe2d.createCode]($backend)
+     */
+    BisCodeSpec["templateRecipe2d"] = "bis:TemplateRecipe2d";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe3d]($backend) elements.
+     * @see [TemplateRecipe3d.createCode]($backend)
+     */
+    BisCodeSpec["templateRecipe3d"] = "bis:TemplateRecipe3d";
+    /** @internal */
+    BisCodeSpec["textAnnotationSeed"] = "bis:TextAnnotationSeed";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Texture]($backend) elements.
+     * @see [Texture.createCode]($backend)
+     */
+    BisCodeSpec["texture"] = "bis:Texture";
+    /** The name of the standard [[CodeSpec]] used when creating codes for [ViewDefinition]($backend) elements.
+     * @see [ViewDefinition.createCode]($backend)
+     */
+    BisCodeSpec["viewDefinition"] = "bis:ViewDefinition";
+})(BisCodeSpec || (BisCodeSpec = {}));
+/** The scope of the Code.
+ * @public
+ */
+export var CodeScopeSpec;
+(function (CodeScopeSpec) {
+    /** The standard ways the CodeScope can be specified.
+     * @public
+     */
+    let Type;
+    (function (Type) {
+        /** The Code value must be unique within (at least) the iModel repository */
+        Type[Type["Repository"] = 1] = "Repository";
+        /** The Code value must be unique within the scope of the Model */
+        Type[Type["Model"] = 2] = "Model";
+        /** The Code value must be unique among other children of the same parent element */
+        Type[Type["ParentElement"] = 3] = "ParentElement";
+        /** The Code value must be unique among other elements also scoped by the same element */
+        Type[Type["RelatedElement"] = 4] = "RelatedElement";
+    })(Type = CodeScopeSpec.Type || (CodeScopeSpec.Type = {}));
+    /**
+     * Requirements for how the CodeScope Element is identified.
+     * @public
+     */
+    let ScopeRequirement;
+    (function (ScopeRequirement) {
+        /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */
+        ScopeRequirement[ScopeRequirement["ElementId"] = 1] = "ElementId";
+        /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */
+        ScopeRequirement[ScopeRequirement["FederationGuid"] = 2] = "FederationGuid";
+    })(ScopeRequirement = CodeScopeSpec.ScopeRequirement || (CodeScopeSpec.ScopeRequirement = {}));
+})(CodeScopeSpec || (CodeScopeSpec = {}));
+/** A [Code Specification]($docs/bis/guide/references/glossary#codespec) captures the rules for encoding and decoding significant business information into
+ * and from a Code (string). This specification is used to generate and validate Codes.
+ *
+ * A CodeSpec defines the format of a Code for a certain type of Element in an IModel.
+ * A CodeSpec can identify an external system that maintains and/or assigns Codes.
+ * @public
+ */
+export class CodeSpec {
+    constructor(iModel, id, name, properties) {
+        this.iModel = iModel;
+        this.id = id;
+        this.name = name;
+        this.properties = properties ?? { scopeSpec: { type: CodeScopeSpec.Type.Repository } };
+    }
+    /** Create a new CodeSpec from the specified parameters
+     * > Note: CodeSpec.id will not be valid until inserted
+     * @see [CodeSpecs.insert]($backend)
+     */
+    static create(iModel, name, scopeType, scopeReq) {
+        const props = { scopeSpec: { type: scopeType } };
+        if (scopeReq)
+            props.scopeSpec.fGuidRequired = scopeReq === CodeScopeSpec.ScopeRequirement.FederationGuid;
+        return new CodeSpec(iModel, Id64.invalid, name, props);
+    }
+    /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.
+     * @internal
+     */
+    static createFromJson(iModel, id, name, properties) {
+        return new CodeSpec(iModel, id, name, properties);
+    }
+    /** Will be true if the id of this CodeSpec is valid. */
+    get isValid() { return Id64.isValid(this.id); }
+    /** The scope type of this CodeSpec. */
+    get scopeType() { return this.properties.scopeSpec.type; }
+    set scopeType(scopeType) { this.properties.scopeSpec.type = scopeType; }
+    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or
+     * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).
+     */
+    get scopeReq() {
+        return this.properties.scopeSpec.fGuidRequired ? CodeScopeSpec.ScopeRequirement.FederationGuid : CodeScopeSpec.ScopeRequirement.ElementId;
+    }
+    set scopeReq(req) {
+        if (CodeScopeSpec.ScopeRequirement.FederationGuid === req)
+            this.properties.scopeSpec.fGuidRequired = true;
+        else
+            this.properties.scopeSpec.fGuidRequired = undefined;
+    }
+    /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.
+     * @deprecated in 3.6 Use scopeReq instead.
+     */
+    get isManagedWithIModel() {
+        return this.properties.spec?.isManagedWithDgnDb ?? true;
+    }
+    set isManagedWithIModel(value) {
+        if (!this.properties.spec)
+            this.properties.spec = {};
+        this.properties.spec.isManagedWithDgnDb = value;
+    }
+}
 //# sourceMappingURL=Code.js.map

package/lib/esm/Code.js.map

@@ -1 +1 @@
-{"version":3,"file":"Code.js","sourceRoot":"","sources":["../../src/Code.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAwB9E;;;GAGG;AACH,MAAM,OAAO,IAAI;IAYf,YAAY,SAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAXD;;OAEG;IACH,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC;IAChD,IAAW,KAAK,CAAC,GAAW,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAS5D,gEAAgE;IACzD,MAAM,CAAC,WAAW;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAU,IAAU,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACxF,MAAM,KAAgB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACzF,MAAM,CAAC,KAAW,IAAa,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5E,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAC,EAAa,EAAE,EAAa;QACnD,OAAO,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,CAAC;IAC/E,CAAC;IACD,4CAA4C;IACrC,MAAM,CAAC,OAAO,CAAC,CAAY,IAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjF,0GAA0G;IACnG,MAAM,CAAC,OAAO,CAAC,CAAY,IAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;CACtH;AAED;;;;;GAKG;AACH,MAAM,CAAN,IAAY,WA6HX;AA7HD,WAAY,WAAW;IACrB;;OAEG;IACH,gDAAiC,CAAA;IACjC,gBAAgB;IAChB,gEAAiD,CAAA;IACjD,gBAAgB;IAChB,kEAAmD,CAAA;IACnD,gBAAgB;IAChB,8DAA+C,CAAA;IAC/C;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,kEAAmD,CAAA;IACnD;;OAEG;IACH,wDAAyC,CAAA;IACzC,gBAAgB;IAChB,0CAA2B,CAAA;IAC3B;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,sCAAuB,CAAA;IACvB;;OAEG;IACH,sDAAuC,CAAA;IACvC;;;OAGG;IACH,oDAAqC,CAAA;IACrC;;;OAGG;IACH,wEAAyD,CAAA;IACzD;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,sDAAuC,CAAA;IACvC;;OAEG;IACH,0CAA2B,CAAA;IAC3B;;OAEG;IACH,8CAA+B,CAAA;IAC/B;;OAEG;IACH,kDAAmC,CAAA;IACnC;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,8EAA+D,CAAA;IAC/D;;OAEG;IACH,oDAAqC,CAAA;IACrC;;OAEG;IACH,kCAAmB,CAAA;IACnB;;OAEG;IACH,sDAAuC,CAAA;IACvC;;OAEG;IACH,8DAA+C,CAAA;IAC/C;;OAEG;IACH,8CAA+B,CAAA;IAC/B;;OAEG;IACH,sCAAuB,CAAA;IACvB;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,wDAAyC,CAAA;IACzC,gBAAgB;IAChB,4DAA6C,CAAA;IAC7C;;OAEG;IACH,sCAAuB,CAAA;IACvB;;OAEG;IACH,oDAAqC,CAAA;AACvC,CAAC,EA7HW,WAAW,KAAX,WAAW,QA6HtB;AAED;;GAEG;AACH,MAAM,KAAW,aAAa,CAyB7B;AAzBD,WAAiB,aAAa;IAC5B;;OAEG;IACH,IAAY,IASX;IATD,WAAY,IAAI;QACd,4EAA4E;QAC5E,2CAAc,CAAA;QACd,kEAAkE;QAClE,iCAAS,CAAA;QACT,oFAAoF;QACpF,iDAAiB,CAAA;QACjB,yFAAyF;QACzF,mDAAkB,CAAA;IACpB,CAAC,EATW,IAAI,GAAJ,kBAAI,KAAJ,kBAAI,QASf;IAED;;;OAGG;IACH,IAAY,gBAKX;IALD,WAAY,gBAAgB;QAC1B,2HAA2H;QAC3H,iEAAa,CAAA;QACb,iHAAiH;QACjH,2EAAkB,CAAA;IACpB,CAAC,EALW,gBAAgB,GAAhB,8BAAgB,KAAhB,8BAAgB,QAK3B;AACH,CAAC,EAzBgB,aAAa,KAAb,aAAa,QAyB7B;AAuBD;;;;;;GAMG;AACH,MAAM,OAAO,QAAQ;IAanB,YAAoB,MAAc,EAAE,EAAc,EAAE,IAAY,EAAE,UAA+B;QAC/F,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;IACzF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,MAAc,EAAE,IAAY,EAAE,SAA6B,EAAE,QAAyC;QACzH,MAAM,KAAK,GAAuB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;QACrE,IAAI,QAAQ;YACV,KAAK,CAAC,SAAS,CAAC,aAAa,GAAG,QAAQ,KAAK,aAAa,CAAC,gBAAgB,CAAC,cAAc,CAAC;QAE7F,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,MAAc,EAAE,EAAc,EAAE,IAAY,EAAE,UAA+B;QACxG,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,wDAAwD;IACxD,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/D,uCAAuC;IACvC,IAAW,SAAS,KAAyB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACrF,IAAW,SAAS,CAAC,SAA6B,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;IAEnG;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC;IAC5I,CAAC;IACD,IAAW,QAAQ,CAAC,GAAmC;QACrD,IAAI,aAAa,CAAC,gBAAgB,CAAC,cAAc,KAAK,GAAG;YACvD,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC;;YAE/C,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,kBAAkB,IAAI,IAAI,CAAC;IAC1D,CAAC;IACD,IAAW,mBAAmB,CAAC,KAAc;QAC3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI;YACvB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC;QAE5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClD,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 Codes\n */\n\nimport { GuidString, Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport { IModel } from \"./IModel\";\n\n/**\n * The ElementId of the element that defines the scope for a Code value.\n * @note For insert or update, you may supply the FederationGuid of the scope element and it will be converted to the ElementId of that element.\n * @public\n * @extensions\n */\nexport type CodeScopeProps = Id64String | GuidString;\n\n/** The parameters that define a Code\n * @public\n * @extensions\n */\nexport interface CodeProps {\n  /** Either the stringified 64-bit Id of the CodeSpec for this code, or the name of the CodeSpec. */\n  spec: Id64String | string;\n  /** Either the ElementId or the FederationGuid of the element that provides the scope for this code. */\n  scope: CodeScopeProps;\n  /** the value of this code. May be undefined. */\n  value?: string;\n}\n\n/**\n * A three-part structure containing information about the [Code]($docs/bis/guide/fundamentals/codes) of an Element\n * @public\n */\nexport class Code implements CodeProps {\n  /** The id of the [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec) of the Element */\n  public spec: Id64String;\n  /** The [CodeScope]($docs/bis/guide/fundamentals/codes.md#codescope-property) of the Element */\n  public scope: Id64String;\n  /** The [CodeValue]($docs/bis/guide/fundamentals/codes.md#codevalue-property) of the Element\n   * @note Leading and trailing whitespace is invalid so is automatically trimmed.\n   */\n  public get value() { return this._value ?? \"\"; }\n  public set value(val: string) { this._value = val?.trim(); }\n  private _value?: string;\n\n  constructor(codeProps: CodeProps) {\n    this.spec = Id64.fromJSON(codeProps.spec);\n    this.scope = JsonUtils.asString(codeProps.scope);\n    this.value = JsonUtils.asString(codeProps.value);\n  }\n\n  /** Create an empty, non-unique code with no special meaning. */\n  public static createEmpty(): Code {\n    const id = Id64.fromLocalAndBriefcaseIds(1, 0);\n    return new Code({ spec: id, scope: id });\n  }\n\n  public static fromJSON(json?: any): Code { return json ? new Code(json) : Code.createEmpty(); }\n  public toJSON(): CodeProps { return { spec: this.spec, scope: this.scope, value: this.value }; }\n  public equals(other: Code): boolean { return Code.equalCodes(this, other); }\n  /** @internal */\n  public static equalCodes(c1: CodeProps, c2: CodeProps): boolean {\n    return c1.spec === c2.spec && c1.scope === c2.scope && c1.value === c2.value;\n  }\n  /** Determine whether this Code is valid. */\n  public static isValid(c: CodeProps): boolean { return Id64.isValidId64(c.spec); }\n  /** Determine if this code is valid but not otherwise meaningful (and therefore not necessarily unique) */\n  public static isEmpty(c: CodeProps): boolean { return this.isValid(c) && (c.value === undefined || c.value === \"\"); }\n}\n\n/** Names of the internal BIS CodeSpecs. These names match those specified by the native library.\n * For other domains, the best practice is to include the domain name or alias as part of the CodeSpec name to ensure global uniqueness.\n * @public\n* @extensions\n* @see [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec)\n */\nexport enum BisCodeSpec {\n  /** The name of the standard [[CodeSpec]] used when creating *empty* codes.\n   * @see [[Code.createEmpty]]\n   */\n  nullCodeSpec = \"bis:NullCodeSpec\",\n  /** @internal */\n  annotationFrameStyle = \"bis:AnnotationFrameStyle\",\n  /** @internal */\n  annotationLeaderStyle = \"bis:AnnotationLeaderStyle\",\n  /** @internal */\n  annotationTextStyle = \"bis:AnnotationTextStyle\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem2d]($backend) elements.\n   * @see [AuxCoordSystem2d.createCode]($backend)\n   */\n  auxCoordSystem2d = \"bis:AuxCoordSystem2d\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem3d]($backend) elements.\n   * @see [AuxCoordSystem3d.createCode]($backend)\n   */\n  auxCoordSystem3d = \"bis:AuxCoordSystem3d\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystemSpatial]($backend) elements.\n   * @see [AuxCoordSystemSpatial.createCode]($backend)\n   */\n  auxCoordSystemSpatial = \"bis:AuxCoordSystemSpatial\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [CategorySelector]($backend) elements.\n   * @see [CategorySelector.createCode]($backend)\n   */\n  categorySelector = \"bis:CategorySelector\",\n  /** @internal */\n  colorBook = \"bis:ColorBook\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [DisplayStyle]($backend) elements.\n   * @see [DisplayStyle.createCode]($backend)\n   */\n  displayStyle = \"bis:DisplayStyle\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Drawing]($backend) elements.\n   * @see [Drawing.createCode]($backend)\n   */\n  drawing = \"bis:Drawing\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [DrawingCategory]($backend) elements.\n   * @see [DrawingCategory.createCode]($backend)\n   */\n  drawingCategory = \"bis:DrawingCategory\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSource]($backend) elements.\n   * @note This CodeSpec is not automatically created, so use [ExternalSource.ensureCodeSpec]($backend) to make sure that it exists.\n   * @see [ExternalSource.createCode]($backend)\n   */\n  externalSource = \"bis:ExternalSource\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSourceAttachment]($backend) elements.\n   * @note This CodeSpec is not automatically created, so use [ExternalSourceAttachment.ensureCodeSpec]($backend) to make sure that it exists.\n   * @see [ExternalSource.createCode]($backend)\n   */\n  externalSourceAttachment = \"bis:ExternalSourceAttachment\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [GeometryPart]($backend) elements.\n   * @see [GeometryPart.createCode]($backend)\n   */\n  geometryPart = \"bis:GeometryPart\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [GraphicalType2d]($backend) elements.\n   * @see [GraphicalType2d.createCode]($backend)\n   */\n  graphicalType2d = \"bis:GraphicalType2d\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [LineStyle]($backend) elements.\n   * @see [LineStyle.createCode]($backend)\n   */\n  lineStyle = \"bis:LineStyle\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [LinkElement]($backend) elements.\n   * @see [LinkElement.createCode]($backend)\n   */\n  linkElement = \"bis:LinkElement\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ModelSelector]($backend) elements.\n   * @see [ModelSelector.createCode]($backend)\n   */\n  modelSelector = \"bis:ModelSelector\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalMaterial]($backend) elements.\n   * @see [PhysicalMaterial.createCode]($backend)\n   */\n  physicalMaterial = \"bis:PhysicalMaterial\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalType]($backend) elements.\n   * @see [PhysicalType.createCode]($backend)\n   */\n  physicalType = \"bis:PhysicalType\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [InformationPartitionElement]($backend) elements.\n   * @see [InformationPartitionElement.createCode]($backend)\n   */\n  informationPartitionElement = \"bis:InformationPartitionElement\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [RenderMaterialElement]($backend) elements.\n   * @see [RenderMaterialElement.createCode]($backend)\n   */\n  renderMaterial = \"bis:RenderMaterial\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Sheet]($backend) elements.\n   * @see [Sheet.createCode]($backend)\n   */\n  sheet = \"bis:Sheet\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialCategory]($backend) elements.\n   * @see [SpatialCategory.createCode]($backend)\n   */\n  spatialCategory = \"bis:SpatialCategory\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialLocationType]($backend) elements.\n   * @see [SpatialLocationType.createCode]($backend)\n   */\n  spatialLocationType = \"bis:SpatialLocationType\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [SubCategory]($backend) elements.\n   * @see [SubCategory.createCode]($backend)\n   */\n  subCategory = \"bis:SubCategory\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Subject]($backend) elements.\n   * @see [Subject.createCode]($backend)\n   */\n  subject = \"bis:Subject\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe2d]($backend) elements.\n   * @see [TemplateRecipe2d.createCode]($backend)\n   */\n  templateRecipe2d = \"bis:TemplateRecipe2d\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe3d]($backend) elements.\n   * @see [TemplateRecipe3d.createCode]($backend)\n   */\n  templateRecipe3d = \"bis:TemplateRecipe3d\",\n  /** @internal */\n  textAnnotationSeed = \"bis:TextAnnotationSeed\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Texture]($backend) elements.\n   * @see [Texture.createCode]($backend)\n   */\n  texture = \"bis:Texture\",\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ViewDefinition]($backend) elements.\n   * @see [ViewDefinition.createCode]($backend)\n   */\n  viewDefinition = \"bis:ViewDefinition\",\n}\n\n/** The scope of the Code.\n * @public\n */\nexport namespace CodeScopeSpec {\n  /** The standard ways the CodeScope can be specified.\n   * @public\n   */\n  export enum Type {\n    /** The Code value must be unique within (at least) the iModel repository */\n    Repository = 1,\n    /** The Code value must be unique within the scope of the Model */\n    Model = 2,\n    /** The Code value must be unique among other children of the same parent element */\n    ParentElement = 3,\n    /** The Code value must be unique among other elements also scoped by the same element */\n    RelatedElement = 4,\n  }\n\n  /**\n   * Requirements for how the CodeScope Element is identified.\n   * @public\n   */\n  export enum ScopeRequirement {\n    /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */\n    ElementId = 1,\n    /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */\n    FederationGuid = 2,\n  }\n}\n\n/**\n * The JSON properties of a CodeSpec\n * @public\n */\nexport interface CodeSpecProperties {\n  scopeSpec: {\n    /** the type of CodeSpec */\n    type: CodeScopeSpec.Type;\n    /** If true, the federationGuid of the scope element identifies the scope, for Codes that are globally unique.\n     * Otherwise, the ElementId of the scopeElement is used, for Codes that are scoped only within a single iModel.\n     */\n    fGuidRequired?: boolean;\n    /** The relationship className (in the form \"schema:class\"), when `type` is `CodeScopeSpec.Type.RelatedElement` */\n    relationship?: string;\n  };\n  spec?: {\n    isManagedWithDgnDb?: boolean;\n  };\n  version?: string;\n}\n\n/** A [Code Specification]($docs/bis/guide/references/glossary#codespec) captures the rules for encoding and decoding significant business information into\n * and from a Code (string). This specification is used to generate and validate Codes.\n *\n * A CodeSpec defines the format of a Code for a certain type of Element in an IModel.\n * A CodeSpec can identify an external system that maintains and/or assigns Codes.\n * @public\n */\nexport class CodeSpec {\n  /** The iModel holding this CodeSpec. */\n  public iModel: IModel;\n  /** The id of this CodeSpec. */\n  public id: Id64String;\n  /** The name of this CodeSpec. */\n  public name: string;\n  /** The JSON properties for this CodeSpec.\n   * @note Use the getters and setters instead of accessing this directly.\n   * @internal\n   */\n  public properties: CodeSpecProperties;\n\n  private constructor(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties) {\n    this.iModel = iModel;\n    this.id = id;\n    this.name = name;\n    this.properties = properties ?? { scopeSpec: { type: CodeScopeSpec.Type.Repository } };\n  }\n\n  /** Create a new CodeSpec from the specified parameters\n   * > Note: CodeSpec.id will not be valid until inserted\n   * @see [CodeSpecs.insert]($backend)\n   */\n  public static create(iModel: IModel, name: string, scopeType: CodeScopeSpec.Type, scopeReq?: CodeScopeSpec.ScopeRequirement): CodeSpec {\n    const props: CodeSpecProperties = { scopeSpec: { type: scopeType } };\n    if (scopeReq)\n      props.scopeSpec.fGuidRequired = scopeReq === CodeScopeSpec.ScopeRequirement.FederationGuid;\n\n    return new CodeSpec(iModel, Id64.invalid, name, props);\n  }\n\n  /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.\n   * @internal\n   */\n  public static createFromJson(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties): CodeSpec {\n    return new CodeSpec(iModel, id, name, properties);\n  }\n\n  /** Will be true if the id of this CodeSpec is valid. */\n  public get isValid(): boolean { return Id64.isValid(this.id); }\n\n  /** The scope type of this CodeSpec. */\n  public get scopeType(): CodeScopeSpec.Type { return this.properties.scopeSpec.type; }\n  public set scopeType(scopeType: CodeScopeSpec.Type) { this.properties.scopeSpec.type = scopeType; }\n\n  /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or\n   * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).\n   */\n  public get scopeReq(): CodeScopeSpec.ScopeRequirement {\n    return this.properties.scopeSpec.fGuidRequired ? CodeScopeSpec.ScopeRequirement.FederationGuid : CodeScopeSpec.ScopeRequirement.ElementId;\n  }\n  public set scopeReq(req: CodeScopeSpec.ScopeRequirement) {\n    if (CodeScopeSpec.ScopeRequirement.FederationGuid === req)\n      this.properties.scopeSpec.fGuidRequired = true;\n    else\n      this.properties.scopeSpec.fGuidRequired = undefined;\n  }\n\n  /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.\n   * @deprecated in 3.6 Use scopeReq instead.\n   */\n  public get isManagedWithIModel(): boolean {\n    return this.properties.spec?.isManagedWithDgnDb ?? true;\n  }\n  public set isManagedWithIModel(value: boolean) {\n    if (!this.properties.spec)\n      this.properties.spec = {};\n\n    this.properties.spec.isManagedWithDgnDb = value;\n  }\n}\n"]}
+{"version":3,"file":"Code.js","sourceRoot":"","sources":["../../src/Code.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAwB9E;;;GAGG;AACH,MAAM,OAAO,IAAI;IAYf,YAAY,SAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAXD;;OAEG;IACH,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC;IAChD,IAAW,KAAK,CAAC,GAAW,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAS5D,gEAAgE;IACzD,MAAM,CAAC,WAAW;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAU,IAAU,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACxF,MAAM,KAAgB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACzF,MAAM,CAAC,KAAW,IAAa,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5E,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAC,EAAa,EAAE,EAAa;QACnD,OAAO,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,CAAC;IAC/E,CAAC;IACD,4CAA4C;IACrC,MAAM,CAAC,OAAO,CAAC,CAAY,IAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjF,0GAA0G;IACnG,MAAM,CAAC,OAAO,CAAC,CAAY,IAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;CACtH;AAED;;;;;GAKG;AACH,MAAM,CAAN,IAAY,WA6HX;AA7HD,WAAY,WAAW;IACrB;;OAEG;IACH,gDAAiC,CAAA;IACjC,gBAAgB;IAChB,gEAAiD,CAAA;IACjD,gBAAgB;IAChB,kEAAmD,CAAA;IACnD,gBAAgB;IAChB,8DAA+C,CAAA;IAC/C;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,kEAAmD,CAAA;IACnD;;OAEG;IACH,wDAAyC,CAAA;IACzC,gBAAgB;IAChB,0CAA2B,CAAA;IAC3B;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,sCAAuB,CAAA;IACvB;;OAEG;IACH,sDAAuC,CAAA;IACvC;;;OAGG;IACH,oDAAqC,CAAA;IACrC;;;OAGG;IACH,wEAAyD,CAAA;IACzD;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,sDAAuC,CAAA;IACvC;;OAEG;IACH,0CAA2B,CAAA;IAC3B;;OAEG;IACH,8CAA+B,CAAA;IAC/B;;OAEG;IACH,kDAAmC,CAAA;IACnC;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,8EAA+D,CAAA;IAC/D;;OAEG;IACH,oDAAqC,CAAA;IACrC;;OAEG;IACH,kCAAmB,CAAA;IACnB;;OAEG;IACH,sDAAuC,CAAA;IACvC;;OAEG;IACH,8DAA+C,CAAA;IAC/C;;OAEG;IACH,8CAA+B,CAAA;IAC/B;;OAEG;IACH,sCAAuB,CAAA;IACvB;;OAEG;IACH,wDAAyC,CAAA;IACzC;;OAEG;IACH,wDAAyC,CAAA;IACzC,gBAAgB;IAChB,4DAA6C,CAAA;IAC7C;;OAEG;IACH,sCAAuB,CAAA;IACvB;;OAEG;IACH,oDAAqC,CAAA;AACvC,CAAC,EA7HW,WAAW,KAAX,WAAW,QA6HtB;AAED;;GAEG;AACH,MAAM,KAAW,aAAa,CAyB7B;AAzBD,WAAiB,aAAa;IAC5B;;OAEG;IACH,IAAY,IASX;IATD,WAAY,IAAI;QACd,4EAA4E;QAC5E,2CAAc,CAAA;QACd,kEAAkE;QAClE,iCAAS,CAAA;QACT,oFAAoF;QACpF,iDAAiB,CAAA;QACjB,yFAAyF;QACzF,mDAAkB,CAAA;IACpB,CAAC,EATW,IAAI,GAAJ,kBAAI,KAAJ,kBAAI,QASf;IAED;;;OAGG;IACH,IAAY,gBAKX;IALD,WAAY,gBAAgB;QAC1B,2HAA2H;QAC3H,iEAAa,CAAA;QACb,iHAAiH;QACjH,2EAAkB,CAAA;IACpB,CAAC,EALW,gBAAgB,GAAhB,8BAAgB,KAAhB,8BAAgB,QAK3B;AACH,CAAC,EAzBgB,aAAa,KAAb,aAAa,QAyB7B;AAuBD;;;;;;GAMG;AACH,MAAM,OAAO,QAAQ;IAanB,YAAoB,MAAc,EAAE,EAAc,EAAE,IAAY,EAAE,UAA+B;QAC/F,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;IACzF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,MAAc,EAAE,IAAY,EAAE,SAA6B,EAAE,QAAyC;QACzH,MAAM,KAAK,GAAuB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;QACrE,IAAI,QAAQ;YACV,KAAK,CAAC,SAAS,CAAC,aAAa,GAAG,QAAQ,KAAK,aAAa,CAAC,gBAAgB,CAAC,cAAc,CAAC;QAE7F,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,MAAc,EAAE,EAAc,EAAE,IAAY,EAAE,UAA+B;QACxG,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,wDAAwD;IACxD,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/D,uCAAuC;IACvC,IAAW,SAAS,KAAyB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACrF,IAAW,SAAS,CAAC,SAA6B,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;IAEnG;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC;IAC5I,CAAC;IACD,IAAW,QAAQ,CAAC,GAAmC;QACrD,IAAI,aAAa,CAAC,gBAAgB,CAAC,cAAc,KAAK,GAAG;YACvD,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC;;YAE/C,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,kBAAkB,IAAI,IAAI,CAAC;IAC1D,CAAC;IACD,IAAW,mBAAmB,CAAC,KAAc;QAC3C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI;YACvB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC;QAE5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Codes\r\n */\r\n\r\nimport { GuidString, Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { IModel } from \"./IModel\";\r\n\r\n/**\r\n * The ElementId of the element that defines the scope for a Code value.\r\n * @note For insert or update, you may supply the FederationGuid of the scope element and it will be converted to the ElementId of that element.\r\n * @public\r\n * @extensions\r\n */\r\nexport type CodeScopeProps = Id64String | GuidString;\r\n\r\n/** The parameters that define a Code\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CodeProps {\r\n  /** Either the stringified 64-bit Id of the CodeSpec for this code, or the name of the CodeSpec. */\r\n  spec: Id64String | string;\r\n  /** Either the ElementId or the FederationGuid of the element that provides the scope for this code. */\r\n  scope: CodeScopeProps;\r\n  /** the value of this code. May be undefined. */\r\n  value?: string;\r\n}\r\n\r\n/**\r\n * A three-part structure containing information about the [Code]($docs/bis/guide/fundamentals/codes) of an Element\r\n * @public\r\n */\r\nexport class Code implements CodeProps {\r\n  /** The id of the [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec) of the Element */\r\n  public spec: Id64String;\r\n  /** The [CodeScope]($docs/bis/guide/fundamentals/codes.md#codescope-property) of the Element */\r\n  public scope: Id64String;\r\n  /** The [CodeValue]($docs/bis/guide/fundamentals/codes.md#codevalue-property) of the Element\r\n   * @note Leading and trailing whitespace is invalid so is automatically trimmed.\r\n   */\r\n  public get value() { return this._value ?? \"\"; }\r\n  public set value(val: string) { this._value = val?.trim(); }\r\n  private _value?: string;\r\n\r\n  constructor(codeProps: CodeProps) {\r\n    this.spec = Id64.fromJSON(codeProps.spec);\r\n    this.scope = JsonUtils.asString(codeProps.scope);\r\n    this.value = JsonUtils.asString(codeProps.value);\r\n  }\r\n\r\n  /** Create an empty, non-unique code with no special meaning. */\r\n  public static createEmpty(): Code {\r\n    const id = Id64.fromLocalAndBriefcaseIds(1, 0);\r\n    return new Code({ spec: id, scope: id });\r\n  }\r\n\r\n  public static fromJSON(json?: any): Code { return json ? new Code(json) : Code.createEmpty(); }\r\n  public toJSON(): CodeProps { return { spec: this.spec, scope: this.scope, value: this.value }; }\r\n  public equals(other: Code): boolean { return Code.equalCodes(this, other); }\r\n  /** @internal */\r\n  public static equalCodes(c1: CodeProps, c2: CodeProps): boolean {\r\n    return c1.spec === c2.spec && c1.scope === c2.scope && c1.value === c2.value;\r\n  }\r\n  /** Determine whether this Code is valid. */\r\n  public static isValid(c: CodeProps): boolean { return Id64.isValidId64(c.spec); }\r\n  /** Determine if this code is valid but not otherwise meaningful (and therefore not necessarily unique) */\r\n  public static isEmpty(c: CodeProps): boolean { return this.isValid(c) && (c.value === undefined || c.value === \"\"); }\r\n}\r\n\r\n/** Names of the internal BIS CodeSpecs. These names match those specified by the native library.\r\n * For other domains, the best practice is to include the domain name or alias as part of the CodeSpec name to ensure global uniqueness.\r\n * @public\r\n* @extensions\r\n* @see [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec)\r\n */\r\nexport enum BisCodeSpec {\r\n  /** The name of the standard [[CodeSpec]] used when creating *empty* codes.\r\n   * @see [[Code.createEmpty]]\r\n   */\r\n  nullCodeSpec = \"bis:NullCodeSpec\",\r\n  /** @internal */\r\n  annotationFrameStyle = \"bis:AnnotationFrameStyle\",\r\n  /** @internal */\r\n  annotationLeaderStyle = \"bis:AnnotationLeaderStyle\",\r\n  /** @internal */\r\n  annotationTextStyle = \"bis:AnnotationTextStyle\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem2d]($backend) elements.\r\n   * @see [AuxCoordSystem2d.createCode]($backend)\r\n   */\r\n  auxCoordSystem2d = \"bis:AuxCoordSystem2d\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem3d]($backend) elements.\r\n   * @see [AuxCoordSystem3d.createCode]($backend)\r\n   */\r\n  auxCoordSystem3d = \"bis:AuxCoordSystem3d\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystemSpatial]($backend) elements.\r\n   * @see [AuxCoordSystemSpatial.createCode]($backend)\r\n   */\r\n  auxCoordSystemSpatial = \"bis:AuxCoordSystemSpatial\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [CategorySelector]($backend) elements.\r\n   * @see [CategorySelector.createCode]($backend)\r\n   */\r\n  categorySelector = \"bis:CategorySelector\",\r\n  /** @internal */\r\n  colorBook = \"bis:ColorBook\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [DisplayStyle]($backend) elements.\r\n   * @see [DisplayStyle.createCode]($backend)\r\n   */\r\n  displayStyle = \"bis:DisplayStyle\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Drawing]($backend) elements.\r\n   * @see [Drawing.createCode]($backend)\r\n   */\r\n  drawing = \"bis:Drawing\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [DrawingCategory]($backend) elements.\r\n   * @see [DrawingCategory.createCode]($backend)\r\n   */\r\n  drawingCategory = \"bis:DrawingCategory\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSource]($backend) elements.\r\n   * @note This CodeSpec is not automatically created, so use [ExternalSource.ensureCodeSpec]($backend) to make sure that it exists.\r\n   * @see [ExternalSource.createCode]($backend)\r\n   */\r\n  externalSource = \"bis:ExternalSource\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ExternalSourceAttachment]($backend) elements.\r\n   * @note This CodeSpec is not automatically created, so use [ExternalSourceAttachment.ensureCodeSpec]($backend) to make sure that it exists.\r\n   * @see [ExternalSource.createCode]($backend)\r\n   */\r\n  externalSourceAttachment = \"bis:ExternalSourceAttachment\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [GeometryPart]($backend) elements.\r\n   * @see [GeometryPart.createCode]($backend)\r\n   */\r\n  geometryPart = \"bis:GeometryPart\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [GraphicalType2d]($backend) elements.\r\n   * @see [GraphicalType2d.createCode]($backend)\r\n   */\r\n  graphicalType2d = \"bis:GraphicalType2d\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [LineStyle]($backend) elements.\r\n   * @see [LineStyle.createCode]($backend)\r\n   */\r\n  lineStyle = \"bis:LineStyle\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [LinkElement]($backend) elements.\r\n   * @see [LinkElement.createCode]($backend)\r\n   */\r\n  linkElement = \"bis:LinkElement\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ModelSelector]($backend) elements.\r\n   * @see [ModelSelector.createCode]($backend)\r\n   */\r\n  modelSelector = \"bis:ModelSelector\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalMaterial]($backend) elements.\r\n   * @see [PhysicalMaterial.createCode]($backend)\r\n   */\r\n  physicalMaterial = \"bis:PhysicalMaterial\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalType]($backend) elements.\r\n   * @see [PhysicalType.createCode]($backend)\r\n   */\r\n  physicalType = \"bis:PhysicalType\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [InformationPartitionElement]($backend) elements.\r\n   * @see [InformationPartitionElement.createCode]($backend)\r\n   */\r\n  informationPartitionElement = \"bis:InformationPartitionElement\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [RenderMaterialElement]($backend) elements.\r\n   * @see [RenderMaterialElement.createCode]($backend)\r\n   */\r\n  renderMaterial = \"bis:RenderMaterial\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Sheet]($backend) elements.\r\n   * @see [Sheet.createCode]($backend)\r\n   */\r\n  sheet = \"bis:Sheet\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialCategory]($backend) elements.\r\n   * @see [SpatialCategory.createCode]($backend)\r\n   */\r\n  spatialCategory = \"bis:SpatialCategory\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialLocationType]($backend) elements.\r\n   * @see [SpatialLocationType.createCode]($backend)\r\n   */\r\n  spatialLocationType = \"bis:SpatialLocationType\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [SubCategory]($backend) elements.\r\n   * @see [SubCategory.createCode]($backend)\r\n   */\r\n  subCategory = \"bis:SubCategory\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Subject]($backend) elements.\r\n   * @see [Subject.createCode]($backend)\r\n   */\r\n  subject = \"bis:Subject\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe2d]($backend) elements.\r\n   * @see [TemplateRecipe2d.createCode]($backend)\r\n   */\r\n  templateRecipe2d = \"bis:TemplateRecipe2d\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe3d]($backend) elements.\r\n   * @see [TemplateRecipe3d.createCode]($backend)\r\n   */\r\n  templateRecipe3d = \"bis:TemplateRecipe3d\",\r\n  /** @internal */\r\n  textAnnotationSeed = \"bis:TextAnnotationSeed\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [Texture]($backend) elements.\r\n   * @see [Texture.createCode]($backend)\r\n   */\r\n  texture = \"bis:Texture\",\r\n  /** The name of the standard [[CodeSpec]] used when creating codes for [ViewDefinition]($backend) elements.\r\n   * @see [ViewDefinition.createCode]($backend)\r\n   */\r\n  viewDefinition = \"bis:ViewDefinition\",\r\n}\r\n\r\n/** The scope of the Code.\r\n * @public\r\n */\r\nexport namespace CodeScopeSpec {\r\n  /** The standard ways the CodeScope can be specified.\r\n   * @public\r\n   */\r\n  export enum Type {\r\n    /** The Code value must be unique within (at least) the iModel repository */\r\n    Repository = 1,\r\n    /** The Code value must be unique within the scope of the Model */\r\n    Model = 2,\r\n    /** The Code value must be unique among other children of the same parent element */\r\n    ParentElement = 3,\r\n    /** The Code value must be unique among other elements also scoped by the same element */\r\n    RelatedElement = 4,\r\n  }\r\n\r\n  /**\r\n   * Requirements for how the CodeScope Element is identified.\r\n   * @public\r\n   */\r\n  export enum ScopeRequirement {\r\n    /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */\r\n    ElementId = 1,\r\n    /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */\r\n    FederationGuid = 2,\r\n  }\r\n}\r\n\r\n/**\r\n * The JSON properties of a CodeSpec\r\n * @public\r\n */\r\nexport interface CodeSpecProperties {\r\n  scopeSpec: {\r\n    /** the type of CodeSpec */\r\n    type: CodeScopeSpec.Type;\r\n    /** If true, the federationGuid of the scope element identifies the scope, for Codes that are globally unique.\r\n     * Otherwise, the ElementId of the scopeElement is used, for Codes that are scoped only within a single iModel.\r\n     */\r\n    fGuidRequired?: boolean;\r\n    /** The relationship className (in the form \"schema:class\"), when `type` is `CodeScopeSpec.Type.RelatedElement` */\r\n    relationship?: string;\r\n  };\r\n  spec?: {\r\n    isManagedWithDgnDb?: boolean;\r\n  };\r\n  version?: string;\r\n}\r\n\r\n/** A [Code Specification]($docs/bis/guide/references/glossary#codespec) captures the rules for encoding and decoding significant business information into\r\n * and from a Code (string). This specification is used to generate and validate Codes.\r\n *\r\n * A CodeSpec defines the format of a Code for a certain type of Element in an IModel.\r\n * A CodeSpec can identify an external system that maintains and/or assigns Codes.\r\n * @public\r\n */\r\nexport class CodeSpec {\r\n  /** The iModel holding this CodeSpec. */\r\n  public iModel: IModel;\r\n  /** The id of this CodeSpec. */\r\n  public id: Id64String;\r\n  /** The name of this CodeSpec. */\r\n  public name: string;\r\n  /** The JSON properties for this CodeSpec.\r\n   * @note Use the getters and setters instead of accessing this directly.\r\n   * @internal\r\n   */\r\n  public properties: CodeSpecProperties;\r\n\r\n  private constructor(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties) {\r\n    this.iModel = iModel;\r\n    this.id = id;\r\n    this.name = name;\r\n    this.properties = properties ?? { scopeSpec: { type: CodeScopeSpec.Type.Repository } };\r\n  }\r\n\r\n  /** Create a new CodeSpec from the specified parameters\r\n   * > Note: CodeSpec.id will not be valid until inserted\r\n   * @see [CodeSpecs.insert]($backend)\r\n   */\r\n  public static create(iModel: IModel, name: string, scopeType: CodeScopeSpec.Type, scopeReq?: CodeScopeSpec.ScopeRequirement): CodeSpec {\r\n    const props: CodeSpecProperties = { scopeSpec: { type: scopeType } };\r\n    if (scopeReq)\r\n      props.scopeSpec.fGuidRequired = scopeReq === CodeScopeSpec.ScopeRequirement.FederationGuid;\r\n\r\n    return new CodeSpec(iModel, Id64.invalid, name, props);\r\n  }\r\n\r\n  /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.\r\n   * @internal\r\n   */\r\n  public static createFromJson(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties): CodeSpec {\r\n    return new CodeSpec(iModel, id, name, properties);\r\n  }\r\n\r\n  /** Will be true if the id of this CodeSpec is valid. */\r\n  public get isValid(): boolean { return Id64.isValid(this.id); }\r\n\r\n  /** The scope type of this CodeSpec. */\r\n  public get scopeType(): CodeScopeSpec.Type { return this.properties.scopeSpec.type; }\r\n  public set scopeType(scopeType: CodeScopeSpec.Type) { this.properties.scopeSpec.type = scopeType; }\r\n\r\n  /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or\r\n   * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).\r\n   */\r\n  public get scopeReq(): CodeScopeSpec.ScopeRequirement {\r\n    return this.properties.scopeSpec.fGuidRequired ? CodeScopeSpec.ScopeRequirement.FederationGuid : CodeScopeSpec.ScopeRequirement.ElementId;\r\n  }\r\n  public set scopeReq(req: CodeScopeSpec.ScopeRequirement) {\r\n    if (CodeScopeSpec.ScopeRequirement.FederationGuid === req)\r\n      this.properties.scopeSpec.fGuidRequired = true;\r\n    else\r\n      this.properties.scopeSpec.fGuidRequired = undefined;\r\n  }\r\n\r\n  /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.\r\n   * @deprecated in 3.6 Use scopeReq instead.\r\n   */\r\n  public get isManagedWithIModel(): boolean {\r\n    return this.properties.spec?.isManagedWithDgnDb ?? true;\r\n  }\r\n  public set isManagedWithIModel(value: boolean) {\r\n    if (!this.properties.spec)\r\n      this.properties.spec = {};\r\n\r\n    this.properties.spec.isManagedWithDgnDb = value;\r\n  }\r\n}\r\n"]}