@itwin/core-common 4.0.0-dev.10 → 4.0.0-dev.101

package/lib/cjs/Code.d.ts

@@ -1,278 +1,279 @@
-/** @packageDocumentation
- * @module Codes
- */
-import { GuidString, Id64String } from "@itwin/core-bentley";
-import { IModel } from "./IModel";
-/**
- * The identity of the element defining the scope for a Code value.
- * For query input, may either be an ElementId or a FederationGuid. When returned from a query, it will be an ElementId.
- * @public
- * @extensions
- */
-export declare type CodeScopeProps = Id64String | GuidString;
-/** The wire format for a Code
- * @public
- * @extensions
- */
-export interface CodeProps {
-    /** Either the stringified 64-bit Id of the CodeSpec for this code, or the name of the CodeSpec. */
-    spec: Id64String | string;
-    /** Either the ElementId or the FederationGuid of the element that provides the scope for this code. */
-    scope: CodeScopeProps;
-    /** the value of this code. May be undefined. */
-    value?: string;
-}
-/**
- * A three-part structure containing information about the [Code]($docs/bis/guide/fundamentals/codes) of an Element
- * @public
- */
-export declare class Code implements CodeProps {
-    /** The id of the [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec) of the Element */
-    spec: Id64String;
-    /** The [CodeScope]($docs/bis/guide/fundamentals/codes.md#codescope-property) of the Element */
-    scope: Id64String;
-    /** 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(): string;
-    set value(val: string);
-    private _value?;
-    constructor(codeProps: CodeProps);
-    /** Create an empty, non-unique code with no special meaning. */
-    static createEmpty(): Code;
-    static fromJSON(json?: any): Code;
-    toJSON(): CodeProps;
-    equals(other: Code): boolean;
-    /** @internal */
-    static equalCodes(c1: CodeProps, c2: CodeProps): boolean;
-    /** Determine whether this Code is valid. */
-    static isValid(c: CodeProps): boolean;
-    /** Determine if this code is valid but not otherwise meaningful (and therefore not necessarily unique) */
-    static isEmpty(c: CodeProps): boolean;
-}
-/** 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 declare enum BisCodeSpec {
-    /** The name of the standard [[CodeSpec]] used when creating *empty* codes.
-     * @see [[Code.createEmpty]]
-     */
-    nullCodeSpec = "bis:NullCodeSpec",
-    /** @internal */
-    annotationFrameStyle = "bis:AnnotationFrameStyle",
-    /** @internal */
-    annotationLeaderStyle = "bis:AnnotationLeaderStyle",
-    /** @internal */
-    annotationTextStyle = "bis:AnnotationTextStyle",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem2d]($backend) elements.
-     * @see [AuxCoordSystem2d.createCode]($backend)
-     */
-    auxCoordSystem2d = "bis:AuxCoordSystem2d",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem3d]($backend) elements.
-     * @see [AuxCoordSystem3d.createCode]($backend)
-     */
-    auxCoordSystem3d = "bis:AuxCoordSystem3d",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystemSpatial]($backend) elements.
-     * @see [AuxCoordSystemSpatial.createCode]($backend)
-     */
-    auxCoordSystemSpatial = "bis:AuxCoordSystemSpatial",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [CategorySelector]($backend) elements.
-     * @see [CategorySelector.createCode]($backend)
-     */
-    categorySelector = "bis:CategorySelector",
-    /** @internal */
-    colorBook = "bis:ColorBook",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [DisplayStyle]($backend) elements.
-     * @see [DisplayStyle.createCode]($backend)
-     */
-    displayStyle = "bis:DisplayStyle",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Drawing]($backend) elements.
-     * @see [Drawing.createCode]($backend)
-     */
-    drawing = "bis:Drawing",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [DrawingCategory]($backend) elements.
-     * @see [DrawingCategory.createCode]($backend)
-     */
-    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)
-     */
-    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)
-     */
-    externalSourceAttachment = "bis:ExternalSourceAttachment",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [GeometryPart]($backend) elements.
-     * @see [GeometryPart.createCode]($backend)
-     */
-    geometryPart = "bis:GeometryPart",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [GraphicalType2d]($backend) elements.
-     * @see [GraphicalType2d.createCode]($backend)
-     */
-    graphicalType2d = "bis:GraphicalType2d",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [LineStyle]($backend) elements.
-     * @see [LineStyle.createCode]($backend)
-     */
-    lineStyle = "bis:LineStyle",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [LinkElement]($backend) elements.
-     * @see [LinkElement.createCode]($backend)
-     */
-    linkElement = "bis:LinkElement",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [ModelSelector]($backend) elements.
-     * @see [ModelSelector.createCode]($backend)
-     */
-    modelSelector = "bis:ModelSelector",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalMaterial]($backend) elements.
-     * @see [PhysicalMaterial.createCode]($backend)
-     */
-    physicalMaterial = "bis:PhysicalMaterial",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalType]($backend) elements.
-     * @see [PhysicalType.createCode]($backend)
-     */
-    physicalType = "bis:PhysicalType",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [InformationPartitionElement]($backend) elements.
-     * @see [InformationPartitionElement.createCode]($backend)
-     */
-    informationPartitionElement = "bis:InformationPartitionElement",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [RenderMaterialElement]($backend) elements.
-     * @see [RenderMaterialElement.createCode]($backend)
-     */
-    renderMaterial = "bis:RenderMaterial",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Sheet]($backend) elements.
-     * @see [Sheet.createCode]($backend)
-     */
-    sheet = "bis:Sheet",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialCategory]($backend) elements.
-     * @see [SpatialCategory.createCode]($backend)
-     */
-    spatialCategory = "bis:SpatialCategory",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialLocationType]($backend) elements.
-     * @see [SpatialLocationType.createCode]($backend)
-     */
-    spatialLocationType = "bis:SpatialLocationType",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [SubCategory]($backend) elements.
-     * @see [SubCategory.createCode]($backend)
-     */
-    subCategory = "bis:SubCategory",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Subject]($backend) elements.
-     * @see [Subject.createCode]($backend)
-     */
-    subject = "bis:Subject",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe2d]($backend) elements.
-     * @see [TemplateRecipe2d.createCode]($backend)
-     */
-    templateRecipe2d = "bis:TemplateRecipe2d",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe3d]($backend) elements.
-     * @see [TemplateRecipe3d.createCode]($backend)
-     */
-    templateRecipe3d = "bis:TemplateRecipe3d",
-    /** @internal */
-    textAnnotationSeed = "bis:TextAnnotationSeed",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [Texture]($backend) elements.
-     * @see [Texture.createCode]($backend)
-     */
-    texture = "bis:Texture",
-    /** The name of the standard [[CodeSpec]] used when creating codes for [ViewDefinition]($backend) elements.
-     * @see [ViewDefinition.createCode]($backend)
-     */
-    viewDefinition = "bis:ViewDefinition"
-}
-/** The scope of the Code.
- * @public
- */
-export declare namespace CodeScopeSpec {
-    /** The standard ways the CodeScope can be specified.
-     * @public
-     */
-    enum Type {
-        /** The Code value must be unique within (at least) the iModel repository */
-        Repository = 1,
-        /** The Code value must be unique within the scope of the Model */
-        Model = 2,
-        /** The Code value must be unique among other children of the same parent element */
-        ParentElement = 3,
-        /** The Code value must be unique among other elements also scoped by the same element */
-        RelatedElement = 4
-    }
-    /**
-     * Requirements for how the CodeScope Element is identified.
-     * @public
-     */
-    enum ScopeRequirement {
-        /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */
-        ElementId = 1,
-        /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */
-        FederationGuid = 2
-    }
-}
-/**
- * The JSON properties of a CodeSpec
- * @public
- */
-export interface CodeSpecProperties {
-    scopeSpec: {
-        /** the type of CodeSpec */
-        type: CodeScopeSpec.Type;
-        /** If true, the federationGuid of the scope element identifies the scope, for Codes that are globally unique.
-         * Otherwise, the ElementId of the scopeElement is used, for Codes that are scoped only within a single iModel.
-         */
-        fGuidRequired?: boolean;
-        /** The relationship className (in the form "schema:class"), when `type` is `CodeScopeSpec.Type.RelatedElement` */
-        relationship?: string;
-    };
-    spec?: {
-        isManagedWithDgnDb?: boolean;
-    };
-    version?: string;
-}
-/** 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 declare class CodeSpec {
-    /** The iModel holding this CodeSpec. */
-    iModel: IModel;
-    /** The id of this CodeSpec. */
-    id: Id64String;
-    /** The name of this CodeSpec. */
-    name: string;
-    /** The JSON properties for this CodeSpec.
-     * @note Use the getters and setters instead of accessing this directly.
-     * @internal
-     */
-    properties: CodeSpecProperties;
-    private constructor();
-    /** Create a new CodeSpec from the specified parameters
-     * > Note: CodeSpec.id will not be valid until inserted
-     * @see [CodeSpecs.insert]($backend)
-     */
-    static create(iModel: IModel, name: string, scopeType: CodeScopeSpec.Type, scopeReq?: CodeScopeSpec.ScopeRequirement): CodeSpec;
-    /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.
-     * @internal
-     */
-    static createFromJson(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties): CodeSpec;
-    /** Will be true if the id of this CodeSpec is valid. */
-    get isValid(): boolean;
-    /** The scope type of this CodeSpec. */
-    get scopeType(): CodeScopeSpec.Type;
-    set scopeType(scopeType: CodeScopeSpec.Type);
-    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or
-     * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).
-     */
-    get scopeReq(): CodeScopeSpec.ScopeRequirement;
-    set scopeReq(req: CodeScopeSpec.ScopeRequirement);
-    /** 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(): boolean;
-    set isManagedWithIModel(value: boolean);
-}
+/** @packageDocumentation
+ * @module Codes
+ */
+import { GuidString, Id64String } from "@itwin/core-bentley";
+import { IModel } from "./IModel";
+/**
+ * The ElementId of the element that defines the scope for a Code value.
+ * @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.
+ * @public
+ * @extensions
+ */
+export type CodeScopeProps = Id64String | GuidString;
+/** The parameters that define a Code
+ * @public
+ * @extensions
+ */
+export interface CodeProps {
+    /** Either the stringified 64-bit Id of the CodeSpec for this code, or the name of the CodeSpec. */
+    spec: Id64String | string;
+    /** Either the ElementId or the FederationGuid of the element that provides the scope for this code. */
+    scope: CodeScopeProps;
+    /** the value of this code. May be undefined. */
+    value?: string;
+}
+/**
+ * A three-part structure containing information about the [Code]($docs/bis/guide/fundamentals/codes) of an Element
+ * @public
+ */
+export declare class Code implements CodeProps {
+    /** The id of the [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec) of the Element */
+    spec: Id64String;
+    /** The [CodeScope]($docs/bis/guide/fundamentals/codes.md#codescope-property) of the Element */
+    scope: Id64String;
+    /** 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(): string;
+    set value(val: string);
+    private _value?;
+    constructor(codeProps: CodeProps);
+    /** Create an empty, non-unique code with no special meaning. */
+    static createEmpty(): Code;
+    static fromJSON(json?: any): Code;
+    toJSON(): CodeProps;
+    equals(other: Code): boolean;
+    /** @internal */
+    static equalCodes(c1: CodeProps, c2: CodeProps): boolean;
+    /** Determine whether this Code is valid. */
+    static isValid(c: CodeProps): boolean;
+    /** Determine if this code is valid but not otherwise meaningful (and therefore not necessarily unique) */
+    static isEmpty(c: CodeProps): boolean;
+}
+/** 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 declare enum BisCodeSpec {
+    /** The name of the standard [[CodeSpec]] used when creating *empty* codes.
+     * @see [[Code.createEmpty]]
+     */
+    nullCodeSpec = "bis:NullCodeSpec",
+    /** @internal */
+    annotationFrameStyle = "bis:AnnotationFrameStyle",
+    /** @internal */
+    annotationLeaderStyle = "bis:AnnotationLeaderStyle",
+    /** @internal */
+    annotationTextStyle = "bis:AnnotationTextStyle",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem2d]($backend) elements.
+     * @see [AuxCoordSystem2d.createCode]($backend)
+     */
+    auxCoordSystem2d = "bis:AuxCoordSystem2d",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystem3d]($backend) elements.
+     * @see [AuxCoordSystem3d.createCode]($backend)
+     */
+    auxCoordSystem3d = "bis:AuxCoordSystem3d",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [AuxCoordSystemSpatial]($backend) elements.
+     * @see [AuxCoordSystemSpatial.createCode]($backend)
+     */
+    auxCoordSystemSpatial = "bis:AuxCoordSystemSpatial",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [CategorySelector]($backend) elements.
+     * @see [CategorySelector.createCode]($backend)
+     */
+    categorySelector = "bis:CategorySelector",
+    /** @internal */
+    colorBook = "bis:ColorBook",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [DisplayStyle]($backend) elements.
+     * @see [DisplayStyle.createCode]($backend)
+     */
+    displayStyle = "bis:DisplayStyle",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Drawing]($backend) elements.
+     * @see [Drawing.createCode]($backend)
+     */
+    drawing = "bis:Drawing",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [DrawingCategory]($backend) elements.
+     * @see [DrawingCategory.createCode]($backend)
+     */
+    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)
+     */
+    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)
+     */
+    externalSourceAttachment = "bis:ExternalSourceAttachment",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [GeometryPart]($backend) elements.
+     * @see [GeometryPart.createCode]($backend)
+     */
+    geometryPart = "bis:GeometryPart",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [GraphicalType2d]($backend) elements.
+     * @see [GraphicalType2d.createCode]($backend)
+     */
+    graphicalType2d = "bis:GraphicalType2d",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [LineStyle]($backend) elements.
+     * @see [LineStyle.createCode]($backend)
+     */
+    lineStyle = "bis:LineStyle",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [LinkElement]($backend) elements.
+     * @see [LinkElement.createCode]($backend)
+     */
+    linkElement = "bis:LinkElement",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [ModelSelector]($backend) elements.
+     * @see [ModelSelector.createCode]($backend)
+     */
+    modelSelector = "bis:ModelSelector",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalMaterial]($backend) elements.
+     * @see [PhysicalMaterial.createCode]($backend)
+     */
+    physicalMaterial = "bis:PhysicalMaterial",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [PhysicalType]($backend) elements.
+     * @see [PhysicalType.createCode]($backend)
+     */
+    physicalType = "bis:PhysicalType",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [InformationPartitionElement]($backend) elements.
+     * @see [InformationPartitionElement.createCode]($backend)
+     */
+    informationPartitionElement = "bis:InformationPartitionElement",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [RenderMaterialElement]($backend) elements.
+     * @see [RenderMaterialElement.createCode]($backend)
+     */
+    renderMaterial = "bis:RenderMaterial",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Sheet]($backend) elements.
+     * @see [Sheet.createCode]($backend)
+     */
+    sheet = "bis:Sheet",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialCategory]($backend) elements.
+     * @see [SpatialCategory.createCode]($backend)
+     */
+    spatialCategory = "bis:SpatialCategory",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [SpatialLocationType]($backend) elements.
+     * @see [SpatialLocationType.createCode]($backend)
+     */
+    spatialLocationType = "bis:SpatialLocationType",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [SubCategory]($backend) elements.
+     * @see [SubCategory.createCode]($backend)
+     */
+    subCategory = "bis:SubCategory",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Subject]($backend) elements.
+     * @see [Subject.createCode]($backend)
+     */
+    subject = "bis:Subject",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe2d]($backend) elements.
+     * @see [TemplateRecipe2d.createCode]($backend)
+     */
+    templateRecipe2d = "bis:TemplateRecipe2d",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [TemplateRecipe3d]($backend) elements.
+     * @see [TemplateRecipe3d.createCode]($backend)
+     */
+    templateRecipe3d = "bis:TemplateRecipe3d",
+    /** @internal */
+    textAnnotationSeed = "bis:TextAnnotationSeed",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [Texture]($backend) elements.
+     * @see [Texture.createCode]($backend)
+     */
+    texture = "bis:Texture",
+    /** The name of the standard [[CodeSpec]] used when creating codes for [ViewDefinition]($backend) elements.
+     * @see [ViewDefinition.createCode]($backend)
+     */
+    viewDefinition = "bis:ViewDefinition"
+}
+/** The scope of the Code.
+ * @public
+ */
+export declare namespace CodeScopeSpec {
+    /** The standard ways the CodeScope can be specified.
+     * @public
+     */
+    enum Type {
+        /** The Code value must be unique within (at least) the iModel repository */
+        Repository = 1,
+        /** The Code value must be unique within the scope of the Model */
+        Model = 2,
+        /** The Code value must be unique among other children of the same parent element */
+        ParentElement = 3,
+        /** The Code value must be unique among other elements also scoped by the same element */
+        RelatedElement = 4
+    }
+    /**
+     * Requirements for how the CodeScope Element is identified.
+     * @public
+     */
+    enum ScopeRequirement {
+        /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */
+        ElementId = 1,
+        /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */
+        FederationGuid = 2
+    }
+}
+/**
+ * The JSON properties of a CodeSpec
+ * @public
+ */
+export interface CodeSpecProperties {
+    scopeSpec: {
+        /** the type of CodeSpec */
+        type: CodeScopeSpec.Type;
+        /** If true, the federationGuid of the scope element identifies the scope, for Codes that are globally unique.
+         * Otherwise, the ElementId of the scopeElement is used, for Codes that are scoped only within a single iModel.
+         */
+        fGuidRequired?: boolean;
+        /** The relationship className (in the form "schema:class"), when `type` is `CodeScopeSpec.Type.RelatedElement` */
+        relationship?: string;
+    };
+    spec?: {
+        isManagedWithDgnDb?: boolean;
+    };
+    version?: string;
+}
+/** 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 declare class CodeSpec {
+    /** The iModel holding this CodeSpec. */
+    iModel: IModel;
+    /** The id of this CodeSpec. */
+    id: Id64String;
+    /** The name of this CodeSpec. */
+    name: string;
+    /** The JSON properties for this CodeSpec.
+     * @note Use the getters and setters instead of accessing this directly.
+     * @internal
+     */
+    properties: CodeSpecProperties;
+    private constructor();
+    /** Create a new CodeSpec from the specified parameters
+     * > Note: CodeSpec.id will not be valid until inserted
+     * @see [CodeSpecs.insert]($backend)
+     */
+    static create(iModel: IModel, name: string, scopeType: CodeScopeSpec.Type, scopeReq?: CodeScopeSpec.ScopeRequirement): CodeSpec;
+    /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.
+     * @internal
+     */
+    static createFromJson(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties): CodeSpec;
+    /** Will be true if the id of this CodeSpec is valid. */
+    get isValid(): boolean;
+    get isExternal(): boolean;
+    /** The scope type of this CodeSpec. */
+    get scopeType(): CodeScopeSpec.Type;
+    set scopeType(scopeType: CodeScopeSpec.Type);
+    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or
+     * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).
+     */
+    get scopeReq(): CodeScopeSpec.ScopeRequirement;
+    set scopeReq(req: CodeScopeSpec.ScopeRequirement);
+    /** 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(): boolean;
+    set isManagedWithIModel(value: boolean);
+}
 //# sourceMappingURL=Code.d.ts.map

package/lib/cjs/Code.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Code.d.ts","sourceRoot":"","sources":["../../src/Code.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;GAKG;AACH,oBAAY,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,mGAAmG;IACnG,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,uGAAuG;IACvG,KAAK,EAAE,cAAc,CAAC;IACtB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,IAAK,YAAW,SAAS;IACpC,8FAA8F;IACvF,IAAI,EAAE,UAAU,CAAC;IACxB,+FAA+F;IACxF,KAAK,EAAE,UAAU,CAAC;IACzB;;OAEG;IACH,IAAW,KAAK,IACM,MAAM,CADoB;IAChD,IAAW,KAAK,CAAC,GAAG,EAAE,MAAM,EAAgC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAS;gBAEZ,SAAS,EAAE,SAAS;IAMhC,gEAAgE;WAClD,WAAW,IAAI,IAAI;WAKnB,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IACjC,MAAM,IAAI,SAAS;IACnB,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IACnC,gBAAgB;WACF,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,GAAG,OAAO;IAG/D,4CAA4C;WAC9B,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;IAC5C,0GAA0G;WAC5F,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;CAC7C;AAED;;;;;GAKG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,YAAY,qBAAqB;IACjC,gBAAgB;IAChB,oBAAoB,6BAA6B;IACjD,gBAAgB;IAChB,qBAAqB,8BAA8B;IACnD,gBAAgB;IAChB,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,qBAAqB,8BAA8B;IACnD;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,SAAS,kBAAkB;IAC3B;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;;OAGG;IACH,cAAc,uBAAuB;IACrC;;;OAGG;IACH,wBAAwB,iCAAiC;IACzD;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,SAAS,kBAAkB;IAC3B;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,aAAa,sBAAsB;IACnC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,2BAA2B,oCAAoC;IAC/D;;OAEG;IACH,cAAc,uBAAuB;IACrC;;OAEG;IACH,KAAK,cAAc;IACnB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,kBAAkB,2BAA2B;IAC7C;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,cAAc,uBAAuB;CACtC;AAED;;GAEG;AACH,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,KAAY,IAAI;QACd,4EAA4E;QAC5E,UAAU,IAAI;QACd,kEAAkE;QAClE,KAAK,IAAI;QACT,oFAAoF;QACpF,aAAa,IAAI;QACjB,yFAAyF;QACzF,cAAc,IAAI;KACnB;IAED;;;OAGG;IACH,KAAY,gBAAgB;QAC1B,2HAA2H;QAC3H,SAAS,IAAI;QACb,iHAAiH;QACjH,cAAc,IAAI;KACnB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE;QACT,2BAA2B;QAC3B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,kHAAkH;QAClH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,IAAI,CAAC,EAAE;QACL,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,wCAAwC;IACjC,MAAM,EAAE,MAAM,CAAC;IACtB,+BAA+B;IACxB,EAAE,EAAE,UAAU,CAAC;IACtB,iCAAiC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACI,UAAU,EAAE,kBAAkB,CAAC;IAEtC,OAAO;IAOP;;;OAGG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,QAAQ;IAQtI;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,kBAAkB,GAAG,QAAQ;IAIrH,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAAkC;IAE/D,uCAAuC;IACvC,IAAW,SAAS,IAAI,aAAa,CAAC,IAAI,CAA2C;IACrF,IAAW,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAiD;IAEnG;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAAC,gBAAgB,CAEpD;IACD,IAAW,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,gBAAgB,EAKtD;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;IACD,IAAW,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAK5C;CACF"}
+{"version":3,"file":"Code.d.ts","sourceRoot":"","sources":["../../src/Code.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,mGAAmG;IACnG,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,uGAAuG;IACvG,KAAK,EAAE,cAAc,CAAC;IACtB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,IAAK,YAAW,SAAS;IACpC,8FAA8F;IACvF,IAAI,EAAE,UAAU,CAAC;IACxB,+FAA+F;IACxF,KAAK,EAAE,UAAU,CAAC;IACzB;;OAEG;IACH,IAAW,KAAK,IACM,MAAM,CADoB;IAChD,IAAW,KAAK,CAAC,GAAG,EAAE,MAAM,EAAgC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAS;gBAEZ,SAAS,EAAE,SAAS;IAMhC,gEAAgE;WAClD,WAAW,IAAI,IAAI;WAKnB,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IACjC,MAAM,IAAI,SAAS;IACnB,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IACnC,gBAAgB;WACF,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,GAAG,OAAO;IAG/D,4CAA4C;WAC9B,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;IAC5C,0GAA0G;WAC5F,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;CAC7C;AAED;;;;;GAKG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,YAAY,qBAAqB;IACjC,gBAAgB;IAChB,oBAAoB,6BAA6B;IACjD,gBAAgB;IAChB,qBAAqB,8BAA8B;IACnD,gBAAgB;IAChB,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,qBAAqB,8BAA8B;IACnD;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,SAAS,kBAAkB;IAC3B;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;;OAGG;IACH,cAAc,uBAAuB;IACrC;;;OAGG;IACH,wBAAwB,iCAAiC;IACzD;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,SAAS,kBAAkB;IAC3B;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,aAAa,sBAAsB;IACnC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,2BAA2B,oCAAoC;IAC/D;;OAEG;IACH,cAAc,uBAAuB;IACrC;;OAEG;IACH,KAAK,cAAc;IACnB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,kBAAkB,2BAA2B;IAC7C;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,cAAc,uBAAuB;CACtC;AAED;;GAEG;AACH,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,KAAY,IAAI;QACd,4EAA4E;QAC5E,UAAU,IAAI;QACd,kEAAkE;QAClE,KAAK,IAAI;QACT,oFAAoF;QACpF,aAAa,IAAI;QACjB,yFAAyF;QACzF,cAAc,IAAI;KACnB;IAED;;;OAGG;IACH,KAAY,gBAAgB;QAC1B,2HAA2H;QAC3H,SAAS,IAAI;QACb,iHAAiH;QACjH,cAAc,IAAI;KACnB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE;QACT,2BAA2B;QAC3B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,kHAAkH;QAClH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,IAAI,CAAC,EAAE;QACL,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,wCAAwC;IACjC,MAAM,EAAE,MAAM,CAAC;IACtB,+BAA+B;IACxB,EAAE,EAAE,UAAU,CAAC;IACtB,iCAAiC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACI,UAAU,EAAE,kBAAkB,CAAC;IAEtC,OAAO;IAOP;;;OAGG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,QAAQ;IAQtI;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,kBAAkB,GAAG,QAAQ;IAIrH,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAAkC;IAC/D,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,uCAAuC;IACvC,IAAW,SAAS,IAAI,aAAa,CAAC,IAAI,CAA2C;IACrF,IAAW,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAiD;IAEnG;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAAC,gBAAgB,CAEpD;IACD,IAAW,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,gBAAgB,EAKtD;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;IACD,IAAW,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAK5C;CACF"}