npm - @itwin/core-common - Versions diffs - 5.1.0-dev.27 → 5.1.0-dev.29 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

package/lib/cjs/ElementProps.d.ts +42 -42
package/lib/cjs/ElementProps.js +6 -6
package/lib/cjs/ElementProps.js.map +1 -1
package/lib/cjs/EntityProps.d.ts +4 -4
package/lib/cjs/EntityProps.js.map +1 -1
package/lib/cjs/ITwinCoreErrors.d.ts +1 -1
package/lib/cjs/ITwinCoreErrors.d.ts.map +1 -1
package/lib/cjs/ITwinCoreErrors.js.map +1 -1
package/lib/esm/ElementProps.d.ts +42 -42
package/lib/esm/ElementProps.js +6 -6
package/lib/esm/ElementProps.js.map +1 -1
package/lib/esm/EntityProps.d.ts +4 -4
package/lib/esm/EntityProps.js.map +1 -1
package/lib/esm/ITwinCoreErrors.d.ts +1 -1
package/lib/esm/ITwinCoreErrors.d.ts.map +1 -1
package/lib/esm/ITwinCoreErrors.js.map +1 -1
package/package.json +6 -6

package/lib/cjs/ElementProps.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ import { GeometryStreamProps } from "./geometry/GeometryStream";
 import { SubCategoryAppearance } from "./SubCategoryAppearance";
 import { TextAnnotationProps } from "./annotation/TextAnnotation";
 /** Properties of a NavigationProperty.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface RelatedElementProps {
@@ -20,7 +20,7 @@ export interface RelatedElementProps {
     relClassName?: string;
 }
 /** Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ElementProps extends EntityProps {
@@ -41,7 +41,7 @@ export interface ElementProps extends EntityProps {
     jsonProperties?: any;
 }
 /** The Id and relationship class of an Element that is somehow related to another Element
- * @public
+ * @public @preview
  */
 export declare class RelatedElement implements RelatedElementProps {
     /** The Id of the element to which this element is related. */
@@ -57,12 +57,12 @@ export declare class RelatedElement implements RelatedElementProps {
     toJSON(): RelatedElementProps;
 }
 /** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.
- * @public
+ * @public @preview
  */
 export declare class TypeDefinition extends RelatedElement {
 }
 /** Properties of a [GeometricElement]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface GeometricElementProps extends ElementProps {
@@ -78,7 +78,7 @@ export interface GeometricElementProps extends ElementProps {
     placement?: PlacementProps;
 }
 /** Properties of a [[Placement3d]]
- * @public
+ * @public @preview
  * @extensions
  */
 export interface Placement3dProps {
@@ -87,7 +87,7 @@ export interface Placement3dProps {
     bbox?: LowAndHighXYZProps;
 }
 /** Properties of a [[Placement2d]]
- * @public
+ * @public @preview
  * @extensions
  */
 export interface Placement2dProps {
@@ -96,20 +96,20 @@ export interface Placement2dProps {
     bbox?: LowAndHighXYProps;
 }
 /**
- * @public
+ * @public @preview
  * @extensions
  */
 export type PlacementProps = Placement2dProps | Placement3dProps;
 /** determine if this is Placement2dProps
- * @public
+ * @public @preview
  */
 export declare function isPlacement2dProps(props: PlacementProps): props is Placement2dProps;
 /** determine if this is Placement3dProps
- * @public
+ * @public @preview
  */
 export declare function isPlacement3dProps(props: PlacementProps): props is Placement3dProps;
 /** Properties that define a [GeometricElement3d]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface GeometricElement3dProps extends GeometricElementProps {
@@ -117,7 +117,7 @@ export interface GeometricElement3dProps extends GeometricElementProps {
     typeDefinition?: RelatedElementProps;
 }
 /** JSON representation of a [TextAnnotation3d]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface TextAnnotation3dProps extends GeometricElement3dProps {
@@ -128,14 +128,14 @@ export interface TextAnnotation3dProps extends GeometricElement3dProps {
     };
 }
 /** Properties that define a [PhysicalElement]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface PhysicalElementProps extends GeometricElement3dProps {
     physicalMaterial?: RelatedElementProps;
 }
 /** An enumeration of the different types of [SectionDrawing]($backend)s.
- * @public
+ * @public @preview
  * @extensions
  */
 export declare enum SectionType {
@@ -145,7 +145,7 @@ export declare enum SectionType {
     Plan = 6
 }
 /** Properties that define a [Drawing]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface DrawingProps extends ElementProps {
@@ -153,12 +153,12 @@ export interface DrawingProps extends ElementProps {
      * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).
      * Default: 1.
      * @note The scale factor **must** be greater than zero.
-     * @public
+     * @public @preview
      */
     scaleFactor?: number;
 }
 /** Properties that define a [SectionDrawing]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SectionDrawingProps extends DrawingProps {
@@ -181,7 +181,7 @@ export interface SectionDrawingProps extends DrawingProps {
     };
 }
 /** Properties that define a [SectionDrawingLocation]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SectionDrawingLocationProps extends GeometricElement3dProps {
@@ -189,7 +189,7 @@ export interface SectionDrawingLocationProps extends GeometricElement3dProps {
     sectionView?: RelatedElementProps;
 }
 /** Properties that define a [GeometricElement2d]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface GeometricElement2dProps extends GeometricElementProps {
@@ -197,7 +197,7 @@ export interface GeometricElement2dProps extends GeometricElementProps {
     typeDefinition?: RelatedElementProps;
 }
 /** JSON representation of a [TextAnnotation2d]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface TextAnnotation2dProps extends GeometricElement2dProps {
@@ -208,7 +208,7 @@ export interface TextAnnotation2dProps extends GeometricElement2dProps {
     };
 }
 /** Properties of a [GeometryPart]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface GeometryPartProps extends ElementProps {
@@ -220,7 +220,7 @@ export interface GeometryPartProps extends ElementProps {
     bbox?: LowAndHighXYZProps;
 }
 /** Properties for a [ViewAttachment]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ViewAttachmentProps extends GeometricElement2dProps {
@@ -242,7 +242,7 @@ export interface ViewAttachmentProps extends GeometricElement2dProps {
     };
 }
 /** Properties of a [Subject]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SubjectProps extends ElementProps {
@@ -264,7 +264,7 @@ export interface SheetTemplateProps extends ElementProps {
     border?: Id64String;
 }
 /** Properties of a [Sheet]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SheetProps extends ElementProps {
@@ -275,21 +275,21 @@ export interface SheetProps extends ElementProps {
     attachments?: Id64String[];
 }
 /** Properties of a [DefinitionElement]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface DefinitionElementProps extends ElementProps {
     isPrivate?: boolean;
 }
 /** Properties of a [TypeDefinitionElement]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface TypeDefinitionElementProps extends DefinitionElementProps {
     recipe?: RelatedElementProps;
 }
 /** Properties of a [PhysicalType]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface PhysicalTypeProps extends TypeDefinitionElementProps {
@@ -297,7 +297,7 @@ export interface PhysicalTypeProps extends TypeDefinitionElementProps {
     physicalMaterial?: RelatedElementProps;
 }
 /** Properties of a [InformationPartitionElement]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface InformationPartitionElementProps extends ElementProps {
@@ -305,7 +305,7 @@ export interface InformationPartitionElementProps extends ElementProps {
 }
 /** Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].
  * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].
- * @public
+ * @public @preview
  * @extensions
  */
 export interface DisplayStyleLoadProps {
@@ -320,7 +320,7 @@ export interface DisplayStyleLoadProps {
 }
 /** Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].
  * @see [[ElementLoadOptions.renderTimeline]].
- * @public
+ * @public @preview
  * @extensions
  */
 export interface RenderTimelineLoadProps {
@@ -331,7 +331,7 @@ export interface RenderTimelineLoadProps {
 }
 /** Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like
  * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ElementLoadOptions {
@@ -352,7 +352,7 @@ export interface ElementLoadOptions {
     renderTimeline?: RenderTimelineLoadProps;
 }
 /** Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ElementLoadProps extends ElementLoadOptions {
@@ -365,14 +365,14 @@ export interface ElementLoadProps extends ElementLoadOptions {
     federationGuid?: GuidString;
 }
 /** Properties of an [ElementAspect]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ElementAspectProps extends EntityProps {
     element: RelatedElementProps;
 }
 /** Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ExternalSourceAspectProps extends ElementAspectProps {
@@ -431,7 +431,7 @@ export interface ExternalSourceAttachmentProps extends ElementProps {
     scale?: XYZProps;
 }
 /** Properties of an [ChannelRootAspect]($backend) that identifies an Element as the root of a *channel* which is a subset of the overall iModel hierarchy that is independently maintained.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface ChannelRootAspectProps extends ElementAspectProps {
@@ -439,7 +439,7 @@ export interface ChannelRootAspectProps extends ElementAspectProps {
     owner: string;
 }
 /** Properties of a [LineStyle]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface LineStyleProps extends DefinitionElementProps {
@@ -454,7 +454,7 @@ export interface LightLocationProps extends GeometricElement3dProps {
     enabled?: boolean;
 }
 /** The *rank* for a Category
- * @public
+ * @public @preview
  * @extensions
  */
 export declare enum Rank {
@@ -468,7 +468,7 @@ export declare enum Rank {
     User = 3
 }
 /** Parameters of a [Category]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface CategoryProps extends DefinitionElementProps {
@@ -476,7 +476,7 @@ export interface CategoryProps extends DefinitionElementProps {
     description?: string;
 }
 /** Parameters of a [SubCategory]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SubCategoryProps extends DefinitionElementProps {
@@ -484,7 +484,7 @@ export interface SubCategoryProps extends DefinitionElementProps {
     description?: string;
 }
 /** Parameters of a [UrlLink]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface UrlLinkProps extends ElementProps {
@@ -492,7 +492,7 @@ export interface UrlLinkProps extends ElementProps {
     url?: string;
 }
 /** Parameters of a [RepositoryLink]($backend)
- * @public
+ * @public @preview
  * @extensions
  */
 export interface RepositoryLinkProps extends UrlLinkProps {
@@ -506,7 +506,7 @@ export interface SynchronizationConfigLinkProps extends UrlLinkProps {
     lastSuccessfulRun?: string;
 }
 /** Wire format describing a [RenderTimeline]($backend).
- * @public
+ * @public @preview
  * @extensions
  */
 export interface RenderTimelineProps extends ElementProps {

package/lib/cjs/ElementProps.js CHANGED Viewed

@@ -13,7 +13,7 @@ exports.isPlacement3dProps = isPlacement3dProps;
 const core_bentley_1 = require("@itwin/core-bentley");
 const IModelError_1 = require("./IModelError");
 /** The Id and relationship class of an Element that is somehow related to another Element
- * @public
+ * @public @preview
  */
 class RelatedElement {
     /** The Id of the element to which this element is related. */
@@ -48,25 +48,25 @@ class RelatedElement {
 }
 exports.RelatedElement = RelatedElement;
 /** A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.
- * @public
+ * @public @preview
  */
 class TypeDefinition extends RelatedElement {
 }
 exports.TypeDefinition = TypeDefinition;
 /** determine if this is Placement2dProps
- * @public
+ * @public @preview
  */
 function isPlacement2dProps(props) {
     return props.angle !== undefined;
 }
 /** determine if this is Placement3dProps
- * @public
+ * @public @preview
  */
 function isPlacement3dProps(props) {
     return !isPlacement2dProps(props);
 }
 /** An enumeration of the different types of [SectionDrawing]($backend)s.
- * @public
+ * @public @preview
  * @extensions
  */
 var SectionType;
@@ -87,7 +87,7 @@ var ExternalSourceAttachmentRole;
     ExternalSourceAttachmentRole[ExternalSourceAttachmentRole["SpecifyPart"] = 1] = "SpecifyPart";
 })(ExternalSourceAttachmentRole || (exports.ExternalSourceAttachmentRole = ExternalSourceAttachmentRole = {}));
 /** The *rank* for a Category
- * @public
+ * @public @preview
  * @extensions
  */
 var Rank;

package/lib/cjs/ElementProps.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"ElementProps.js","sourceRoot":"","sources":["../../src/ElementProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA4IH,gDAEC;AAKD,gDAEC;AAnJD,sDAAiF;AAQjF,+CAA4C;AAqC5C;;GAEG;AACH,MAAa,cAAc;IACzB,8DAA8D;IAC9C,EAAE,CAAa;IAE/B,oDAAoD;IACpC,YAAY,CAAU;IAEtC,YAAY,KAA0B;QACpC,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAU,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,mBAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAEvE,mJAAmJ;IAC5I,MAAM,CAAC,UAAU,CAAC,IAAS;QAChC,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,SAAS;gBACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;YAC/E,OAAO,CAAC,CAAC,EAAE,CAAC;QACd,CAAC;QACD,OAAO,mBAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAEM,MAAM;QACX,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;;AAnCH,wCAoCC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,cAAc;CACjD;AADD,wCACC;AA6CD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAqB;IACtD,OAAQ,KAA0B,CAAC,KAAK,KAAK,SAAS,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAqB;IACtD,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AA+BD;;;GAGG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,iDAAU,CAAA;IACV,uDAAa,CAAA;IACb,6CAAQ,CAAA;AACV,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAiSD;;GAEG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,gEAAgE;IAChE,mGAAkB,CAAA;IAClB,0EAA0E;IAC1E,6FAAe,CAAA;AACjB,CAAC,EALW,4BAA4B,4CAA5B,4BAA4B,QAKvC;AAyCD;;;GAGG;AACH,IAAY,IASX;AATD,WAAY,IAAI;IACd,gDAAgD;IAChD,mCAAU,CAAA;IACV,4GAA4G;IAC5G,mCAAU,CAAA;IACV,6HAA6H;IAC7H,6CAAe,CAAA;IACf,mIAAmI;IACnI,+BAAQ,CAAA;AACV,CAAC,EATW,IAAI,oBAAJ,IAAI,QASf","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 Entities\n /\n\nimport { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport {\n AngleProps, ClipVectorProps, LowAndHighXYProps, LowAndHighXYZProps, TransformProps, XYProps, XYZProps, YawPitchRollProps,\n} from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { EntityProps } from \"./EntityProps\";\nimport { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from \"./geometry/ElementGeometry\";\nimport { GeometryStreamProps } from \"./geometry/GeometryStream\";\nimport { IModelError } from \"./IModelError\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\nimport { TextAnnotationProps } from \"./annotation/TextAnnotation\";\n\n/* Properties of a NavigationProperty.\n * @public\n * @extensions\n /\nexport interface RelatedElementProps {\n /* The Id of the element to which this element is related. /\n id: Id64String;\n /* The full className of the relationship class. /\n relClassName?: string;\n}\n\n/* Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)\n * @public\n * @extensions\n /\nexport interface ElementProps extends EntityProps {\n /* The Id of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element /\n model: Id64String;\n /* The [Code]($docs/bis/guide/fundamentals/codes.md) for this element /\n code: CodeProps;\n /* The Parent of this element, if defined. /\n parent?: RelatedElementProps;\n /* A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element.\n * @note On insert, if this is a valid Guid, the value is preserved. If it is `undefined`, a new Guid is created. If it is an invalid Guid (e.g. Guid.empty), the\n * resultant element will have a `null` federationGuid. For update, `undefined` means \"don't change.\"\n /\n federationGuid?: GuidString;\n /* A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. /\n userLabel?: string;\n /* Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. /\n jsonProperties?: any;\n}\n\n/* The Id and relationship class of an Element that is somehow related to another Element\n * @public\n /\nexport class RelatedElement implements RelatedElementProps {\n /* The Id of the element to which this element is related. /\n public readonly id: Id64String;\n\n /* The full className of the relationship class. /\n public readonly relClassName?: string;\n\n constructor(props: RelatedElementProps) {\n this.id = Id64.fromJSON(props.id);\n this.relClassName = props.relClassName;\n }\n\n public static fromJSON(json?: RelatedElementProps): RelatedElement \| undefined {\n return json ? new RelatedElement(json) : undefined;\n }\n\n /* Used to null out an existing navigation relationship. /\n public static readonly none = new RelatedElement({ id: Id64.invalid });\n\n /* Accept the value of a navigation property that might be in the shortened format of just an id or might be in the full RelatedElement format. /\n public static idFromJson(json: any): Id64String {\n if ((typeof json === \"object\") && (\"id\" in json)) {\n const r = RelatedElement.fromJSON(json);\n if (r === undefined)\n throw new IModelError(IModelStatus.BadArg, \"Problem parsing Id64 from json\");\n return r.id;\n }\n return Id64.fromJSON(json);\n }\n\n public toJSON(): RelatedElementProps {\n return {\n id: this.id,\n relClassName: this.relClassName,\n };\n }\n}\n\n/* A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.\n * @public\n /\nexport class TypeDefinition extends RelatedElement {\n}\n\n/* Properties of a [GeometricElement]($backend)\n * @public\n * @extensions\n /\nexport interface GeometricElementProps extends ElementProps {\n /* The id of the category for this geometric element. /\n category: Id64String;\n /* The geometry stream properties /\n geom?: GeometryStreamProps;\n /* Describes how to build the element's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent element.\n /\n elementGeometryBuilderParams?: ElementGeometryBuilderParams;\n /* The placement properties /\n placement?: PlacementProps;\n}\n\n/* Properties of a [[Placement3d]]\n * @public\n * @extensions\n /\nexport interface Placement3dProps {\n origin: XYZProps;\n angles: YawPitchRollProps;\n bbox?: LowAndHighXYZProps;\n}\n\n/* Properties of a [[Placement2d]]\n * @public\n * @extensions\n /\nexport interface Placement2dProps {\n origin: XYProps;\n angle: AngleProps;\n bbox?: LowAndHighXYProps;\n}\n\n/\n @public\n * @extensions\n /\nexport type PlacementProps = Placement2dProps \| Placement3dProps;\n\n/* determine if this is Placement2dProps\n * @public\n /\nexport function isPlacement2dProps(props: PlacementProps): props is Placement2dProps {\n return (props as Placement2dProps).angle !== undefined;\n}\n\n/* determine if this is Placement3dProps\n * @public\n /\nexport function isPlacement3dProps(props: PlacementProps): props is Placement3dProps {\n return !isPlacement2dProps(props);\n}\n\n/* Properties that define a [GeometricElement3d]($backend)\n * @public\n * @extensions\n /\nexport interface GeometricElement3dProps extends GeometricElementProps {\n placement?: Placement3dProps;\n typeDefinition?: RelatedElementProps;\n}\n\n/* JSON representation of a [TextAnnotation3d]($backend).\n * @public\n * @extensions\n /\nexport interface TextAnnotation3dProps extends GeometricElement3dProps {\n jsonProperties?: {\n [key: string]: any;\n /* @beta /\n annotation?: TextAnnotationProps;\n };\n}\n\n/* Properties that define a [PhysicalElement]($backend)\n * @public\n * @extensions\n /\nexport interface PhysicalElementProps extends GeometricElement3dProps {\n physicalMaterial?: RelatedElementProps;\n}\n\n/* An enumeration of the different types of [SectionDrawing]($backend)s.\n * @public\n * @extensions\n /\nexport enum SectionType {\n Section = 3,\n Detail = 4,\n Elevation = 5,\n Plan = 6,\n}\n\n/* Properties that define a [Drawing]($backend).\n * @public\n * @extensions\n /\nexport interface DrawingProps extends ElementProps {\n /* A factor used by tools to adjust the size of text in [GeometricElement2d]($backend)s in the associated [DrawingModel]($backend) and to compute the\n * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).\n * Default: 1.\n * @note The scale factor must be greater than zero.\n * @public\n /\n scaleFactor?: number;\n}\n\n/* Properties that define a [SectionDrawing]($backend).\n * @public\n * @extensions\n /\nexport interface SectionDrawingProps extends DrawingProps {\n /* The type of section used to generate the drawing. Default: Section. /\n sectionType?: SectionType;\n /* The spatial view from which the section was generated. /\n spatialView?: RelatedElementProps;\n jsonProperties?: {\n /* A transform from the section drawing model's coordinates to spatial coordinates. /\n drawingToSpatialTransform?: TransformProps;\n /* If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), a transform from the sheet's coordinates to spatial coordinates. /\n sheetToSpatialTransform?: TransformProps;\n /* If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), JSON representation of a [ClipVector]($geometry) to apply to\n * the sheet graphics when drawn in the context of the spatial view.\n * The ClipVector is in spatial coordinates.\n /\n drawingBoundaryClip?: ClipVectorProps;\n /* If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. /\n displaySpatialView?: true;\n };\n}\n\n/* Properties that define a [SectionDrawingLocation]($backend)\n * @public\n * @extensions\n /\nexport interface SectionDrawingLocationProps extends GeometricElement3dProps {\n /* The [ViewDefinition]($backend) to which this location refers. /\n sectionView?: RelatedElementProps;\n}\n\n/* Properties that define a [GeometricElement2d]($backend)\n * @public\n * @extensions\n /\nexport interface GeometricElement2dProps extends GeometricElementProps {\n placement?: Placement2dProps;\n typeDefinition?: RelatedElementProps;\n}\n\n/* JSON representation of a [TextAnnotation2d]($backend).\n * @public\n * @extensions\n /\nexport interface TextAnnotation2dProps extends GeometricElement2dProps {\n jsonProperties?: {\n [key: string]: any;\n /* @beta /\n annotation?: TextAnnotationProps;\n };\n}\n\n/* Properties of a [GeometryPart]($backend)\n * @public\n * @extensions\n /\nexport interface GeometryPartProps extends ElementProps {\n geom?: GeometryStreamProps;\n /* Describes how to build the part's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent part.\n /\n elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;\n bbox?: LowAndHighXYZProps;\n}\n\n/* Properties for a [ViewAttachment]($backend)\n * @public\n * @extensions\n /\nexport interface ViewAttachmentProps extends GeometricElement2dProps {\n view: RelatedElementProps;\n jsonProperties?: {\n /* Integer priority in [-500,500]. Where two attachments overlap, the one with the higher priority draws in front of the other. Default: 0. /\n displayPriority?: number;\n /* JSON representation of a [ClipVector]($core-geometry] in sheet coordinate space, used to clip the attachment's graphics on the sheet. /\n clip?: ClipVectorProps;\n /* Options for customizing how the view attachment is displayed on the sheet. /\n displayOptions?: {\n /* If true, the view attachment is always drawn as a raster image. By default, only 3d perspective views are drawn this way (they always must be). Default: false. /\n drawAsRaster?: boolean;\n /* If true, and the view attachment is drawn as a raster image, the background color of the view will be preserved. By default the background color of the\n * sheet is used and any background pixels become transparent, allowing the contents of the sheet to show through. Default: false.\n /\n preserveBackground?: boolean;\n };\n };\n}\n\n/* Properties of a [Subject]($backend)\n * @public\n * @extensions\n /\nexport interface SubjectProps extends ElementProps {\n description?: string;\n}\n\n/* Properties of a [SheetBorderTemplate]($backend)\n * @beta\n /\nexport interface SheetBorderTemplateProps extends ElementProps {\n height?: number;\n width?: number;\n}\n\n/* Properties of a [SheetTemplate]($backend)\n * @beta\n /\nexport interface SheetTemplateProps extends ElementProps {\n height?: number;\n width?: number;\n border?: Id64String;\n}\n\n/* Properties of a [Sheet]($backend).\n * @public\n * @extensions\n /\nexport interface SheetProps extends ElementProps {\n width?: number;\n height?: number;\n scale?: number;\n sheetTemplate?: Id64String;\n attachments?: Id64String[];\n}\n\n/* Properties of a [DefinitionElement]($backend)\n * @public\n * @extensions\n /\nexport interface DefinitionElementProps extends ElementProps {\n isPrivate?: boolean;\n}\n\n/* Properties of a [TypeDefinitionElement]($backend)\n * @public\n * @extensions\n /\nexport interface TypeDefinitionElementProps extends DefinitionElementProps {\n recipe?: RelatedElementProps;\n}\n\n/* Properties of a [PhysicalType]($backend)\n * @public\n * @extensions\n /\nexport interface PhysicalTypeProps extends TypeDefinitionElementProps {\n /* The [PhysicalMaterial]($backend) that makes up this physical type. /\n physicalMaterial?: RelatedElementProps;\n}\n\n/* Properties of a [InformationPartitionElement]($backend)\n * @public\n * @extensions\n /\nexport interface InformationPartitionElementProps extends ElementProps {\n description?: string;\n}\n\n/* Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].\n * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].\n * @public\n * @extensions\n /\nexport interface DisplayStyleLoadProps {\n /* If true, the lists of element Ids in the display style's schedule script will be empty.\n * The element Ids are not required on the frontend for display and can be quite large.\n /\n omitScheduleScriptElementIds?: boolean;\n /* If true, [[DisplayStyleSettingsProps.excludedElements]] will be compressed into a single compact string; otherwise they will be expanded into an array of strings.\n * The number of Ids may be quite large, so the compressed format is preferred, especially when communicating between the backend and frontend.\n /\n compressExcludedElementIds?: boolean;\n}\n\n/* Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].\n * @see [[ElementLoadOptions.renderTimeline]].\n * @public\n * @extensions\n /\nexport interface RenderTimelineLoadProps {\n /* If true, the lists of element Ids in the schedule script will be empty.\n * The element Ids can be extremely numerous and are not required on the frontend for display, so they are omitted by default by [DisplayStyleState.load]($frontend).\n /\n omitScriptElementIds?: boolean;\n}\n\n/* Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like\n * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).\n * @public\n * @extensions\n /\nexport interface ElementLoadOptions {\n /* if true, only load the members of [[ElementProps]], and no members from subclasses /\n onlyBaseProperties?: boolean;\n /* If true, include the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n * Geometry streams can consist of many megabytes worth of JSON, so they are omitted by default.\n /\n wantGeometry?: boolean;\n /* When including a geometry stream containing brep entries, whether to return the raw brep data or proxy geometry, false when undefined /\n /* If true, include [[BRepEntity.DataProps.data]] in the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n * The data is a potentially large base-64-encoded opaque binary blob that cannot be directly inspected or manipulated on the frontend, so it is omitted by default.\n /\n wantBRepData?: boolean;\n /* Options controlling which properties of [[DisplayStyleProps]] to include or exclude. /\n displayStyle?: DisplayStyleLoadProps;\n /* Options controlling which properties of [[RenderTimelineProps]] to include or exclude. /\n renderTimeline?: RenderTimelineLoadProps;\n}\n\n/* Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).\n * @public\n * @extensions\n /\nexport interface ElementLoadProps extends ElementLoadOptions {\n id?: Id64String;\n /* The properties of the Code of the element to load.\n * @note the Value member is required even though it is not declared so here. If no value is supplied, no element will ever be loaded.\n * TODO: change to Required<CodeProps> in Version 4.0\n /\n code?: CodeProps;\n federationGuid?: GuidString;\n}\n\n/* Properties of an [ElementAspect]($backend)\n * @public\n * @extensions\n /\nexport interface ElementAspectProps extends EntityProps {\n element: RelatedElementProps;\n}\n\n/* Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.\n * @public\n * @extensions\n /\nexport interface ExternalSourceAspectProps extends ElementAspectProps {\n /* An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\n * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\n * all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\n /\n scope: RelatedElementProps;\n /* The identifier of the object in the source repository. /\n identifier: string;\n /* The kind of object within the source repository. /\n kind: string;\n /* An optional value that is typically a version number or a pseudo version number like last modified time.\n * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.\n * If present, this value must be guaranteed to change when any of the source object's content changes.\n /\n version?: string;\n /* The optional cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. /\n checksum?: string;\n /* A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\n * @note Warning: if defined, jsonProperties must be a string, specifically a valid JSON string.\n * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.\n * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\n /\n jsonProperties?: any;\n /* The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). /\n source?: RelatedElementProps;\n}\n\n/* Properties of an [ExternalSource]($backend)\n * @beta\n /\nexport interface ExternalSourceProps extends ElementProps {\n repository?: RelatedElementProps;\n connectorName?: string;\n connectorVersion?: string;\n}\n\n/* The role that an attached [ExternalSource]($backend) plays.\n * @beta\n /\nexport enum ExternalSourceAttachmentRole {\n /* The attached [ExternalSource]($backend) provides context. /\n SpecifyContext = 0,\n /* The attached [ExternalSource]($backend) models a part of the whole. /\n SpecifyPart = 1,\n}\n\n/* Properties of an [ExternalSourceAttachment]($backend)\n * @beta\n /\nexport interface ExternalSourceAttachmentProps extends ElementProps {\n attaches?: RelatedElementProps;\n role?: ExternalSourceAttachmentRole;\n translation?: XYZProps;\n yaw?: number;\n pitch?: number;\n roll?: number;\n scale?: XYZProps;\n}\n\n/* Properties of an [ChannelRootAspect]($backend) that identifies an Element as the root of a channel which is a subset of the overall iModel hierarchy that is independently maintained.\n * @public\n * @extensions\n /\nexport interface ChannelRootAspectProps extends ElementAspectProps {\n /* The owner of the channel /\n owner: string;\n}\n\n/* Properties of a [LineStyle]($backend)\n * @public\n * @extensions\n /\nexport interface LineStyleProps extends DefinitionElementProps {\n description?: string;\n /* The JSON string line style definition element data [LineStyleDefinition.StyleProps]($backend) /\n data: string;\n}\n\n/* Properties of a [LightLocation]($backend)\n * @internal\n /\nexport interface LightLocationProps extends GeometricElement3dProps {\n enabled?: boolean;\n}\n\n/* The rank for a Category\n * @public\n * @extensions\n /\nexport enum Rank {\n /* This category is predefined by the system /\n System = 0,\n /* This category is defined by a schema. Elements in this category are not recognized by system classes. /\n Domain = 1,\n /* This category is defined by an application. Elements in this category are not recognized by system and schema classes. /\n Application = 2,\n /* This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. /\n User = 3,\n}\n\n/* Parameters of a [Category]($backend)\n * @public\n * @extensions\n /\nexport interface CategoryProps extends DefinitionElementProps {\n rank?: Rank;\n description?: string;\n}\n\n/* Parameters of a [SubCategory]($backend)\n * @public\n * @extensions\n /\nexport interface SubCategoryProps extends DefinitionElementProps {\n appearance?: SubCategoryAppearance.Props;\n description?: string;\n}\n\n/* Parameters of a [UrlLink]($backend)\n * @public\n * @extensions\n /\nexport interface UrlLinkProps extends ElementProps {\n description?: string;\n url?: string;\n}\n\n/* Parameters of a [RepositoryLink]($backend)\n * @public\n * @extensions\n /\nexport interface RepositoryLinkProps extends UrlLinkProps {\n repositoryGuid?: GuidString;\n format?: string;\n}\n\n/* The properties of a [SynchronizationConfigLink]($backend)\n * @beta\n /\nexport interface SynchronizationConfigLinkProps extends UrlLinkProps {\n lastSuccessfulRun?: string;\n}\n\n/* Wire format describing a [RenderTimeline]($backend).\n * @public\n * @extensions\n /\nexport interface RenderTimelineProps extends ElementProps {\n /* An optional human-readable description of the timeline. /\n description?: string;\n /* The stringified JSON representation of the instructions for visualizing change over time.\n * @see [[RenderSchedule.ScriptProps]] for the JSON interface.\n /\n script: string;\n}\n\n/* Properties of a [SheetIndexEntry]($backend).\n * @beta\n/\nexport interface SheetIndexEntryProps extends ElementProps {\n /* Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. /\n entryPriority: number;\n}\n\n/* Properties of a [SheetIndexFolder]($backend)\n * @beta\n /\nexport type SheetIndexFolderProps = SheetIndexEntryProps;\n\n/* Properties of a [SheetIndexReference]($backend)\n * @beta\n /\nexport interface SheetIndexReferenceProps extends SheetIndexEntryProps {\n /* The bis:SheetIndex that this bis:SheetIndexReference is pointing to. /\n sheetIndex?: RelatedElementProps;\n}\n\n/* Properties of a [SheetReference]($backend)\n * @beta\n /\nexport interface SheetReferenceProps extends SheetIndexEntryProps {\n /* The bis:Sheet that this bis:SheetReference is pointing to. */\n sheet?: RelatedElementProps;\n}\n"]}
1	+ {"version":3,"file":"ElementProps.js","sourceRoot":"","sources":["../../src/ElementProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA4IH,gDAEC;AAKD,gDAEC;AAnJD,sDAAiF;AAQjF,+CAA4C;AAqC5C;;GAEG;AACH,MAAa,cAAc;IACzB,8DAA8D;IAC9C,EAAE,CAAa;IAE/B,oDAAoD;IACpC,YAAY,CAAU;IAEtC,YAAY,KAA0B;QACpC,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAU,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,mBAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAEvE,mJAAmJ;IAC5I,MAAM,CAAC,UAAU,CAAC,IAAS;QAChC,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,SAAS;gBACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;YAC/E,OAAO,CAAC,CAAC,EAAE,CAAC;QACd,CAAC;QACD,OAAO,mBAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAEM,MAAM;QACX,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;;AAnCH,wCAoCC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,cAAc;CACjD;AADD,wCACC;AA6CD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAqB;IACtD,OAAQ,KAA0B,CAAC,KAAK,KAAK,SAAS,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAqB;IACtD,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AA+BD;;;GAGG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,iDAAU,CAAA;IACV,uDAAa,CAAA;IACb,6CAAQ,CAAA;AACV,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAiSD;;GAEG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,gEAAgE;IAChE,mGAAkB,CAAA;IAClB,0EAA0E;IAC1E,6FAAe,CAAA;AACjB,CAAC,EALW,4BAA4B,4CAA5B,4BAA4B,QAKvC;AAyCD;;;GAGG;AACH,IAAY,IASX;AATD,WAAY,IAAI;IACd,gDAAgD;IAChD,mCAAU,CAAA;IACV,4GAA4G;IAC5G,mCAAU,CAAA;IACV,6HAA6H;IAC7H,6CAAe,CAAA;IACf,mIAAmI;IACnI,+BAAQ,CAAA;AACV,CAAC,EATW,IAAI,oBAAJ,IAAI,QASf","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 Entities\n /\n\nimport { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport {\n AngleProps, ClipVectorProps, LowAndHighXYProps, LowAndHighXYZProps, TransformProps, XYProps, XYZProps, YawPitchRollProps,\n} from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { EntityProps } from \"./EntityProps\";\nimport { ElementGeometryBuilderParams, ElementGeometryBuilderParamsForPart } from \"./geometry/ElementGeometry\";\nimport { GeometryStreamProps } from \"./geometry/GeometryStream\";\nimport { IModelError } from \"./IModelError\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\nimport { TextAnnotationProps } from \"./annotation/TextAnnotation\";\n\n/* Properties of a NavigationProperty.\n * @public @preview\n * @extensions\n /\nexport interface RelatedElementProps {\n /* The Id of the element to which this element is related. /\n id: Id64String;\n /* The full className of the relationship class. /\n relClassName?: string;\n}\n\n/* Properties of an [Element]($docs/bis/guide/fundamentals/element-fundamentals)\n * @public @preview\n * @extensions\n /\nexport interface ElementProps extends EntityProps {\n /* The Id of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element /\n model: Id64String;\n /* The [Code]($docs/bis/guide/fundamentals/codes.md) for this element /\n code: CodeProps;\n /* The Parent of this element, if defined. /\n parent?: RelatedElementProps;\n /* A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element.\n * @note On insert, if this is a valid Guid, the value is preserved. If it is `undefined`, a new Guid is created. If it is an invalid Guid (e.g. Guid.empty), the\n * resultant element will have a `null` federationGuid. For update, `undefined` means \"don't change.\"\n /\n federationGuid?: GuidString;\n /* A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. /\n userLabel?: string;\n /* Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. /\n jsonProperties?: any;\n}\n\n/* The Id and relationship class of an Element that is somehow related to another Element\n * @public @preview\n /\nexport class RelatedElement implements RelatedElementProps {\n /* The Id of the element to which this element is related. /\n public readonly id: Id64String;\n\n /* The full className of the relationship class. /\n public readonly relClassName?: string;\n\n constructor(props: RelatedElementProps) {\n this.id = Id64.fromJSON(props.id);\n this.relClassName = props.relClassName;\n }\n\n public static fromJSON(json?: RelatedElementProps): RelatedElement \| undefined {\n return json ? new RelatedElement(json) : undefined;\n }\n\n /* Used to null out an existing navigation relationship. /\n public static readonly none = new RelatedElement({ id: Id64.invalid });\n\n /* Accept the value of a navigation property that might be in the shortened format of just an id or might be in the full RelatedElement format. /\n public static idFromJson(json: any): Id64String {\n if ((typeof json === \"object\") && (\"id\" in json)) {\n const r = RelatedElement.fromJSON(json);\n if (r === undefined)\n throw new IModelError(IModelStatus.BadArg, \"Problem parsing Id64 from json\");\n return r.id;\n }\n return Id64.fromJSON(json);\n }\n\n public toJSON(): RelatedElementProps {\n return {\n id: this.id,\n relClassName: this.relClassName,\n };\n }\n}\n\n/* A [RelatedElement]($common) relationship that describes the [TypeDefinitionElement]($backend) of an element.\n * @public @preview\n /\nexport class TypeDefinition extends RelatedElement {\n}\n\n/* Properties of a [GeometricElement]($backend)\n * @public @preview\n * @extensions\n /\nexport interface GeometricElementProps extends ElementProps {\n /* The id of the category for this geometric element. /\n category: Id64String;\n /* The geometry stream properties /\n geom?: GeometryStreamProps;\n /* Describes how to build the element's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent element.\n /\n elementGeometryBuilderParams?: ElementGeometryBuilderParams;\n /* The placement properties /\n placement?: PlacementProps;\n}\n\n/* Properties of a [[Placement3d]]\n * @public @preview\n * @extensions\n /\nexport interface Placement3dProps {\n origin: XYZProps;\n angles: YawPitchRollProps;\n bbox?: LowAndHighXYZProps;\n}\n\n/* Properties of a [[Placement2d]]\n * @public @preview\n * @extensions\n /\nexport interface Placement2dProps {\n origin: XYProps;\n angle: AngleProps;\n bbox?: LowAndHighXYProps;\n}\n\n/\n @public @preview\n * @extensions\n /\nexport type PlacementProps = Placement2dProps \| Placement3dProps;\n\n/* determine if this is Placement2dProps\n * @public @preview\n /\nexport function isPlacement2dProps(props: PlacementProps): props is Placement2dProps {\n return (props as Placement2dProps).angle !== undefined;\n}\n\n/* determine if this is Placement3dProps\n * @public @preview\n /\nexport function isPlacement3dProps(props: PlacementProps): props is Placement3dProps {\n return !isPlacement2dProps(props);\n}\n\n/* Properties that define a [GeometricElement3d]($backend)\n * @public @preview\n * @extensions\n /\nexport interface GeometricElement3dProps extends GeometricElementProps {\n placement?: Placement3dProps;\n typeDefinition?: RelatedElementProps;\n}\n\n/* JSON representation of a [TextAnnotation3d]($backend).\n * @public @preview\n * @extensions\n /\nexport interface TextAnnotation3dProps extends GeometricElement3dProps {\n jsonProperties?: {\n [key: string]: any;\n /* @beta /\n annotation?: TextAnnotationProps;\n };\n}\n\n/* Properties that define a [PhysicalElement]($backend)\n * @public @preview\n * @extensions\n /\nexport interface PhysicalElementProps extends GeometricElement3dProps {\n physicalMaterial?: RelatedElementProps;\n}\n\n/* An enumeration of the different types of [SectionDrawing]($backend)s.\n * @public @preview\n * @extensions\n /\nexport enum SectionType {\n Section = 3,\n Detail = 4,\n Elevation = 5,\n Plan = 6,\n}\n\n/* Properties that define a [Drawing]($backend).\n * @public @preview\n * @extensions\n /\nexport interface DrawingProps extends ElementProps {\n /* A factor used by tools to adjust the size of text in [GeometricElement2d]($backend)s in the associated [DrawingModel]($backend) and to compute the\n * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).\n * Default: 1.\n * @note The scale factor must be greater than zero.\n * @public @preview\n /\n scaleFactor?: number;\n}\n\n/* Properties that define a [SectionDrawing]($backend).\n * @public @preview\n * @extensions\n /\nexport interface SectionDrawingProps extends DrawingProps {\n /* The type of section used to generate the drawing. Default: Section. /\n sectionType?: SectionType;\n /* The spatial view from which the section was generated. /\n spatialView?: RelatedElementProps;\n jsonProperties?: {\n /* A transform from the section drawing model's coordinates to spatial coordinates. /\n drawingToSpatialTransform?: TransformProps;\n /* If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), a transform from the sheet's coordinates to spatial coordinates. /\n sheetToSpatialTransform?: TransformProps;\n /* If the section drawing is placed onto a [Sheet]($backend) via a [ViewAttachment]($backend), JSON representation of a [ClipVector]($geometry) to apply to\n * the sheet graphics when drawn in the context of the spatial view.\n * The ClipVector is in spatial coordinates.\n /\n drawingBoundaryClip?: ClipVectorProps;\n /* If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. /\n displaySpatialView?: true;\n };\n}\n\n/* Properties that define a [SectionDrawingLocation]($backend)\n * @public @preview\n * @extensions\n /\nexport interface SectionDrawingLocationProps extends GeometricElement3dProps {\n /* The [ViewDefinition]($backend) to which this location refers. /\n sectionView?: RelatedElementProps;\n}\n\n/* Properties that define a [GeometricElement2d]($backend)\n * @public @preview\n * @extensions\n /\nexport interface GeometricElement2dProps extends GeometricElementProps {\n placement?: Placement2dProps;\n typeDefinition?: RelatedElementProps;\n}\n\n/* JSON representation of a [TextAnnotation2d]($backend).\n * @public @preview\n * @extensions\n /\nexport interface TextAnnotation2dProps extends GeometricElement2dProps {\n jsonProperties?: {\n [key: string]: any;\n /* @beta /\n annotation?: TextAnnotationProps;\n };\n}\n\n/* Properties of a [GeometryPart]($backend)\n * @public @preview\n * @extensions\n /\nexport interface GeometryPartProps extends ElementProps {\n geom?: GeometryStreamProps;\n /* Describes how to build the part's GeometryStream, as an alternative to [[geom]]. This is used for insert and update operations only.\n * It is not a persistent property - it will always be undefined in the properties returned by functions that read a persistent part.\n /\n elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;\n bbox?: LowAndHighXYZProps;\n}\n\n/* Properties for a [ViewAttachment]($backend)\n * @public @preview\n * @extensions\n /\nexport interface ViewAttachmentProps extends GeometricElement2dProps {\n view: RelatedElementProps;\n jsonProperties?: {\n /* Integer priority in [-500,500]. Where two attachments overlap, the one with the higher priority draws in front of the other. Default: 0. /\n displayPriority?: number;\n /* JSON representation of a [ClipVector]($core-geometry] in sheet coordinate space, used to clip the attachment's graphics on the sheet. /\n clip?: ClipVectorProps;\n /* Options for customizing how the view attachment is displayed on the sheet. /\n displayOptions?: {\n /* If true, the view attachment is always drawn as a raster image. By default, only 3d perspective views are drawn this way (they always must be). Default: false. /\n drawAsRaster?: boolean;\n /* If true, and the view attachment is drawn as a raster image, the background color of the view will be preserved. By default the background color of the\n * sheet is used and any background pixels become transparent, allowing the contents of the sheet to show through. Default: false.\n /\n preserveBackground?: boolean;\n };\n };\n}\n\n/* Properties of a [Subject]($backend)\n * @public @preview\n * @extensions\n /\nexport interface SubjectProps extends ElementProps {\n description?: string;\n}\n\n/* Properties of a [SheetBorderTemplate]($backend)\n * @beta\n /\nexport interface SheetBorderTemplateProps extends ElementProps {\n height?: number;\n width?: number;\n}\n\n/* Properties of a [SheetTemplate]($backend)\n * @beta\n /\nexport interface SheetTemplateProps extends ElementProps {\n height?: number;\n width?: number;\n border?: Id64String;\n}\n\n/* Properties of a [Sheet]($backend).\n * @public @preview\n * @extensions\n /\nexport interface SheetProps extends ElementProps {\n width?: number;\n height?: number;\n scale?: number;\n sheetTemplate?: Id64String;\n attachments?: Id64String[];\n}\n\n/* Properties of a [DefinitionElement]($backend)\n * @public @preview\n * @extensions\n /\nexport interface DefinitionElementProps extends ElementProps {\n isPrivate?: boolean;\n}\n\n/* Properties of a [TypeDefinitionElement]($backend)\n * @public @preview\n * @extensions\n /\nexport interface TypeDefinitionElementProps extends DefinitionElementProps {\n recipe?: RelatedElementProps;\n}\n\n/* Properties of a [PhysicalType]($backend)\n * @public @preview\n * @extensions\n /\nexport interface PhysicalTypeProps extends TypeDefinitionElementProps {\n /* The [PhysicalMaterial]($backend) that makes up this physical type. /\n physicalMaterial?: RelatedElementProps;\n}\n\n/* Properties of a [InformationPartitionElement]($backend)\n * @public @preview\n * @extensions\n /\nexport interface InformationPartitionElementProps extends ElementProps {\n description?: string;\n}\n\n/* Options controlling which properties are included or excluded when querying [[DisplayStyleProps]].\n * @see [[ViewStateLoadProps]] and [[ElementLoadOptions]].\n * @public @preview\n * @extensions\n /\nexport interface DisplayStyleLoadProps {\n /* If true, the lists of element Ids in the display style's schedule script will be empty.\n * The element Ids are not required on the frontend for display and can be quite large.\n /\n omitScheduleScriptElementIds?: boolean;\n /* If true, [[DisplayStyleSettingsProps.excludedElements]] will be compressed into a single compact string; otherwise they will be expanded into an array of strings.\n * The number of Ids may be quite large, so the compressed format is preferred, especially when communicating between the backend and frontend.\n /\n compressExcludedElementIds?: boolean;\n}\n\n/* Options controlling which properties are included or excluded when querying [[RenderTimelineProps]].\n * @see [[ElementLoadOptions.renderTimeline]].\n * @public @preview\n * @extensions\n /\nexport interface RenderTimelineLoadProps {\n /* If true, the lists of element Ids in the schedule script will be empty.\n * The element Ids can be extremely numerous and are not required on the frontend for display, so they are omitted by default by [DisplayStyleState.load]($frontend).\n /\n omitScriptElementIds?: boolean;\n}\n\n/* Options used to specify properties to include or exclude when querying [[ElementProps]] with functions like\n * [IModelDb.Elements.getElementProps]($backend) and [IModelConnection.Elements.loadProps]($frontend).\n * @public @preview\n * @extensions\n /\nexport interface ElementLoadOptions {\n /* if true, only load the members of [[ElementProps]], and no members from subclasses /\n onlyBaseProperties?: boolean;\n /* If true, include the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n * Geometry streams can consist of many megabytes worth of JSON, so they are omitted by default.\n /\n wantGeometry?: boolean;\n /* When including a geometry stream containing brep entries, whether to return the raw brep data or proxy geometry, false when undefined /\n /* If true, include [[BRepEntity.DataProps.data]] in the [[GeometryStreamProps]] for [[GeometricElementProps]] and [[GeometryPartProps]].\n * The data is a potentially large base-64-encoded opaque binary blob that cannot be directly inspected or manipulated on the frontend, so it is omitted by default.\n /\n wantBRepData?: boolean;\n /* Options controlling which properties of [[DisplayStyleProps]] to include or exclude. /\n displayStyle?: DisplayStyleLoadProps;\n /* Options controlling which properties of [[RenderTimelineProps]] to include or exclude. /\n renderTimeline?: RenderTimelineLoadProps;\n}\n\n/* Parameters to specify what element to load for functions like [IModelDb.Elements.getElementProps]($backend).\n * @public @preview\n * @extensions\n /\nexport interface ElementLoadProps extends ElementLoadOptions {\n id?: Id64String;\n /* The properties of the Code of the element to load.\n * @note the Value member is required even though it is not declared so here. If no value is supplied, no element will ever be loaded.\n * TODO: change to Required<CodeProps> in Version 4.0\n /\n code?: CodeProps;\n federationGuid?: GuidString;\n}\n\n/* Properties of an [ElementAspect]($backend)\n * @public @preview\n * @extensions\n /\nexport interface ElementAspectProps extends EntityProps {\n element: RelatedElementProps;\n}\n\n/* Properties of an [ExternalSourceAspect]($backend) that stores synchronization information for an element originating from an external source.\n * @public @preview\n * @extensions\n /\nexport interface ExternalSourceAspectProps extends ElementAspectProps {\n /* An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.\n * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.\n * all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.\n /\n scope: RelatedElementProps;\n /* The identifier of the object in the source repository. /\n identifier: string;\n /* The kind of object within the source repository. /\n kind: string;\n /* An optional value that is typically a version number or a pseudo version number like last modified time.\n * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.\n * If present, this value must be guaranteed to change when any of the source object's content changes.\n /\n version?: string;\n /* The optional cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. /\n checksum?: string;\n /* A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process.\n * @note Warning: if defined, jsonProperties must be a string, specifically a valid JSON string.\n * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.\n * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.\n /\n jsonProperties?: any;\n /* The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). /\n source?: RelatedElementProps;\n}\n\n/* Properties of an [ExternalSource]($backend)\n * @beta\n /\nexport interface ExternalSourceProps extends ElementProps {\n repository?: RelatedElementProps;\n connectorName?: string;\n connectorVersion?: string;\n}\n\n/* The role that an attached [ExternalSource]($backend) plays.\n * @beta\n /\nexport enum ExternalSourceAttachmentRole {\n /* The attached [ExternalSource]($backend) provides context. /\n SpecifyContext = 0,\n /* The attached [ExternalSource]($backend) models a part of the whole. /\n SpecifyPart = 1,\n}\n\n/* Properties of an [ExternalSourceAttachment]($backend)\n * @beta\n /\nexport interface ExternalSourceAttachmentProps extends ElementProps {\n attaches?: RelatedElementProps;\n role?: ExternalSourceAttachmentRole;\n translation?: XYZProps;\n yaw?: number;\n pitch?: number;\n roll?: number;\n scale?: XYZProps;\n}\n\n/* Properties of an [ChannelRootAspect]($backend) that identifies an Element as the root of a channel which is a subset of the overall iModel hierarchy that is independently maintained.\n * @public @preview\n * @extensions\n /\nexport interface ChannelRootAspectProps extends ElementAspectProps {\n /* The owner of the channel /\n owner: string;\n}\n\n/* Properties of a [LineStyle]($backend)\n * @public @preview\n * @extensions\n /\nexport interface LineStyleProps extends DefinitionElementProps {\n description?: string;\n /* The JSON string line style definition element data [LineStyleDefinition.StyleProps]($backend) /\n data: string;\n}\n\n/* Properties of a [LightLocation]($backend)\n * @internal\n /\nexport interface LightLocationProps extends GeometricElement3dProps {\n enabled?: boolean;\n}\n\n/* The rank for a Category\n * @public @preview\n * @extensions\n /\nexport enum Rank {\n /* This category is predefined by the system /\n System = 0,\n /* This category is defined by a schema. Elements in this category are not recognized by system classes. /\n Domain = 1,\n /* This category is defined by an application. Elements in this category are not recognized by system and schema classes. /\n Application = 2,\n /* This category is defined by a user. Elements in this category are not recognized by system, schema, and application classes. /\n User = 3,\n}\n\n/* Parameters of a [Category]($backend)\n * @public @preview\n * @extensions\n /\nexport interface CategoryProps extends DefinitionElementProps {\n rank?: Rank;\n description?: string;\n}\n\n/* Parameters of a [SubCategory]($backend)\n * @public @preview\n * @extensions\n /\nexport interface SubCategoryProps extends DefinitionElementProps {\n appearance?: SubCategoryAppearance.Props;\n description?: string;\n}\n\n/* Parameters of a [UrlLink]($backend)\n * @public @preview\n * @extensions\n /\nexport interface UrlLinkProps extends ElementProps {\n description?: string;\n url?: string;\n}\n\n/* Parameters of a [RepositoryLink]($backend)\n * @public @preview\n * @extensions\n /\nexport interface RepositoryLinkProps extends UrlLinkProps {\n repositoryGuid?: GuidString;\n format?: string;\n}\n\n/* The properties of a [SynchronizationConfigLink]($backend)\n * @beta\n /\nexport interface SynchronizationConfigLinkProps extends UrlLinkProps {\n lastSuccessfulRun?: string;\n}\n\n/* Wire format describing a [RenderTimeline]($backend).\n * @public @preview\n * @extensions\n /\nexport interface RenderTimelineProps extends ElementProps {\n /* An optional human-readable description of the timeline. /\n description?: string;\n /* The stringified JSON representation of the instructions for visualizing change over time.\n * @see [[RenderSchedule.ScriptProps]] for the JSON interface.\n /\n script: string;\n}\n\n/* Properties of a [SheetIndexEntry]($backend).\n * @beta\n/\nexport interface SheetIndexEntryProps extends ElementProps {\n /* Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. /\n entryPriority: number;\n}\n\n/* Properties of a [SheetIndexFolder]($backend)\n * @beta\n /\nexport type SheetIndexFolderProps = SheetIndexEntryProps;\n\n/* Properties of a [SheetIndexReference]($backend)\n * @beta\n /\nexport interface SheetIndexReferenceProps extends SheetIndexEntryProps {\n /* The bis:SheetIndex that this bis:SheetIndexReference is pointing to. /\n sheetIndex?: RelatedElementProps;\n}\n\n/* Properties of a [SheetReference]($backend)\n * @beta\n /\nexport interface SheetReferenceProps extends SheetIndexEntryProps {\n /* The bis:Sheet that this bis:SheetReference is pointing to. */\n sheet?: RelatedElementProps;\n}\n"]}

package/lib/cjs/EntityProps.d.ts CHANGED Viewed

@@ -6,7 +6,7 @@ import { Id64String } from "@itwin/core-bentley";
  * between the backend and frontend.
  * EntityProps and all of its sub-types like [[ElementProps]] are "plain old Javascript objects" - that is, objects containing
  * no methods and no properties of `class` type.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface EntityProps {
@@ -24,7 +24,7 @@ export interface EntityProps {
     };
 }
 /** Specifies the source and target elements of a [[Relationship]] instance.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface SourceAndTarget {
@@ -32,13 +32,13 @@ export interface SourceAndTarget {
     targetId: Id64String;
 }
 /** Properties that are common to all types of link table ECRelationships
- * @public
+ * @public @preview
  * @extensions
  */
 export interface RelationshipProps extends EntityProps, SourceAndTarget {
 }
 /** Parameters for performing a query on [Entity]($backend) classes.
- * @public
+ * @public @preview
  * @extensions
  */
 export interface EntityQueryParams {

package/lib/cjs/EntityProps.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,wDAAwD;AACxD,iDAAgD;AA6DhD;;GAEG;AACH,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,iCAAjB,iBAAiB,QAY5B;AA4DD;;;GAGG;AACH,MAAa,gBAAgB;IACpB,aAAa,CAAqB;IAClC,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,WAAW,CAAU;IACrB,YAAY,CAAU;IACtB,YAAY,CAAO;IACnB,YAAY,CAAO;IACnB,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,QAAQ,CAAW;IACnB,cAAc,CAAU;IACxB,eAAe,CAAW;IAC1B,qBAAqB,CAAW;IAChC,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,iBAAiB,CAAU;IAClC,4DAA4D;IACrD,gBAAgB,CAAqB;IAE5C,4DAA4D;IAC5D,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBAE1E,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,6BAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAzFD,4CAyFC;AAsBD;;;GAGG;AACH,MAAa,cAAc;IACzB,oFAAoF;IACpE,OAAO,CAAa;IACpC,sBAAsB;IACN,OAAO,CAAS;IAChB,WAAW,CAAU;IACrB,QAAQ,CAAU;IAClB,YAAY,CAAU;IACtC,uIAAuI;IACvH,WAAW,CAAW;IACtC,2CAA2C;IAC3C,4DAA4D;IAC5C,gBAAgB,CAAqB;IACrD,qFAAqF;IACrF,4DAA4D;IAC5C,UAAU,CAA2C;IAErE,4DAA4D;IAC5D,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,mCAAmC;YAC9E,4DAA4D;YAC5D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF;AAjCD,wCAiCC","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 Entities\n /\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\nimport { RelatedElement } from \"./ElementProps\";\n\n/* The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\n * between the backend and frontend.\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\n * no methods and no properties of `class` type.\n * @public\n * @extensions\n /\nexport interface EntityProps {\n /* A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\n * @see [Entity.isInstanceOfEntity]($backend).\n /\n readonly isInstanceOfEntity?: never;\n /* The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" /\n classFullName: string;\n /* The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. /\n id?: Id64String;\n /* Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. /\n jsonProperties?: { [key: string]: any };\n}\n\n/* Specifies the source and target elements of a [[Relationship]] instance.\n * @public\n * @extensions\n /\nexport interface SourceAndTarget {\n sourceId: Id64String;\n targetId: Id64String;\n}\n\n/* Properties that are common to all types of link table ECRelationships\n * @public\n * @extensions\n /\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\n}\n\n/* Parameters for performing a query on [Entity]($backend) classes.\n * @public\n * @extensions\n /\nexport interface EntityQueryParams {\n /* The sql className, in the form \"Schema.ClassName\", of the class to search. /\n from?: string;\n /* Set to true to limit results to not include sub-classes of \"from\" class /\n only?: boolean;\n /* Optional \"WHERE\" clause to filter entities. Note: do not include the \"WHERE\" keyword. /\n where?: string;\n /* Optional \"ORDERBY\" clause to sort results. Note: do not include the \"ORDERBY\" keyword. /\n orderBy?: string;\n /* Optional \"LIMIT\" clause to limit the number of rows returned. /\n limit?: number;\n /* Optional \"OFFSET\" clause. Only valid if Limit is also present. /\n offset?: number;\n /* Bindings for parameterized values.\n * @see [[ECSqlStatement.bindValues]]\n /\n bindings?: any[] \| object;\n}\n\n/* The primitive types of an Entity property.\n * @beta\n /\nexport enum PrimitiveTypeCode {\n Uninitialized = 0x00,\n Binary = 0x101,\n Boolean = 0x201,\n DateTime = 0x301,\n Double = 0x401,\n Integer = 0x501,\n Long = 0x601,\n Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\n Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\n String = 0x901,\n IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\n}\n\n/* A callback function to process properties of an Entity\n * @beta\n * @deprecated in 5.0. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.\n \n @example\n * ```typescript\n * // Current usage:\n * const callback: PropertyCallback = (name: string, propMetaData: PropertyMetaData) => {\n * console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n * };\n \n // Replacement:\n * const callback: PropertyHandler = (propName: string, property: Property) => {\n * console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);\n * };\n * ```\n /\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/* A custom attribute instance\n * @beta\n * @deprecated in 5.0. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.\n /\nexport interface CustomAttribute {\n /* The class of the CustomAttribute /\n ecclass: string;\n /* An object whose properties correspond by name to the properties of this custom attribute instance. /\n properties: { [propName: string]: any };\n}\n\ntype FactoryFunc = (jsonObj: any) => any;\n\n/\n @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n /\nexport interface PropertyMetaDataProps {\n primitiveType?: number;\n structName?: string;\n extendedType?: string;\n description?: string;\n displayLabel?: string;\n minimumValue?: any;\n maximumValue?: any;\n minimumLength?: number;\n maximumLength?: number;\n readOnly?: boolean;\n kindOfQuantity?: string;\n isCustomHandled?: boolean;\n isCustomHandledOrphan?: boolean;\n minOccurs?: number;\n maxOccurs?: number;\n direction?: string;\n relationshipClass?: string;\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n customAttributes?: CustomAttribute[];\n}\n\n/* Metadata for a property.\n * @beta\n * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.\n /\nexport class PropertyMetaData implements PropertyMetaDataProps {\n public primitiveType?: PrimitiveTypeCode;\n public structName?: string;\n public extendedType?: string;\n public description?: string;\n public displayLabel?: string;\n public minimumValue?: any;\n public maximumValue?: any;\n public minimumLength?: number;\n public maximumLength?: number;\n public readOnly?: boolean;\n public kindOfQuantity?: string;\n public isCustomHandled?: boolean;\n public isCustomHandledOrphan?: boolean;\n public minOccurs?: number;\n public maxOccurs?: number;\n public direction?: string;\n public relationshipClass?: string;\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public customAttributes?: CustomAttribute[];\n\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public constructor(jsonObj: PropertyMetaDataProps) {\n this.primitiveType = jsonObj.primitiveType;\n if (jsonObj.structName)\n this.structName = jsonObj.structName;\n this.extendedType = jsonObj.extendedType;\n this.description = jsonObj.description;\n this.displayLabel = jsonObj.displayLabel;\n if (undefined !== jsonObj.minimumValue)\n this.minimumValue = jsonObj.minimumValue;\n if (undefined !== jsonObj.maximumValue)\n this.maximumValue = jsonObj.maximumValue;\n if (undefined !== jsonObj.minimumLength)\n this.minimumLength = jsonObj.minimumLength;\n if (undefined !== jsonObj.maximumLength)\n this.maximumLength = jsonObj.maximumLength;\n this.readOnly = jsonObj.readOnly;\n this.kindOfQuantity = jsonObj.kindOfQuantity;\n this.isCustomHandled = jsonObj.isCustomHandled;\n if (undefined !== jsonObj.minOccurs)\n this.minOccurs = jsonObj.minOccurs;\n if (undefined !== jsonObj.maxOccurs)\n this.maxOccurs = jsonObj.maxOccurs;\n this.direction = jsonObj.direction;\n this.relationshipClass = jsonObj.relationshipClass;\n this.customAttributes = jsonObj.customAttributes;\n }\n\n /* Create a typed value, or array of values, from a factory and an input object /\n private createValueOrArray(func: FactoryFunc, jsonObj: any) {\n if (undefined === this.minOccurs)\n return func(jsonObj); // not an array\n\n const val: any = [];\n jsonObj.forEach((element: any) => val.push(func(element)));\n return val;\n }\n\n /* construct a single property from an input object according to this metadata /\n public createProperty(jsonObj: any): any {\n if (jsonObj === undefined)\n return undefined;\n\n if (undefined !== this.primitiveType) {\n switch (this.primitiveType) {\n case PrimitiveTypeCode.Boolean:\n case PrimitiveTypeCode.Double:\n case PrimitiveTypeCode.Integer:\n case PrimitiveTypeCode.String:\n return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\n\n case PrimitiveTypeCode.Point2d:\n return this.createValueOrArray((obj) => Point2d.fromJSON(obj), jsonObj);\n\n case PrimitiveTypeCode.Point3d:\n return this.createValueOrArray((obj) => Point3d.fromJSON(obj), jsonObj);\n }\n }\n if (this.isNavigation)\n return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\n\n return jsonObj;\n }\n\n /* Return `true` if this property is a NavigationProperty. /\n public get isNavigation(): boolean {\n return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\n }\n}\n\n/\n @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n /\nexport interface EntityMetaDataProps {\n classId: Id64String;\n ecclass: string;\n description?: string;\n modifier?: string;\n displayLabel?: string;\n /* The base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). /\n baseClasses: string[];\n /* The Custom Attributes for this class /\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n customAttributes?: CustomAttribute[];\n /* An object whose properties correspond by name to the properties of this class. /\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n properties: { [propName: string]: PropertyMetaData };\n}\n\n/* Metadata for an Entity.\n * @beta\n * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.\n /\nexport class EntityMetaData implements EntityMetaDataProps {\n /* The Id of the class in the [[IModelDb]] from which the metadata was obtained. /\n public readonly classId: Id64String;\n /* The Entity name /\n public readonly ecclass: string;\n public readonly description?: string;\n public readonly modifier?: string;\n public readonly displayLabel?: string;\n /* The base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. /\n public readonly baseClasses: string[];\n /* The Custom Attributes for this class /\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public readonly customAttributes?: CustomAttribute[];\n /* An object whose properties correspond by name to the properties of this class. */\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public readonly properties: { [propName: string]: PropertyMetaData };\n\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public constructor(jsonObj: EntityMetaDataProps) {\n this.classId = jsonObj.classId;\n this.ecclass = jsonObj.ecclass;\n this.description = jsonObj.description;\n this.modifier = jsonObj.modifier;\n this.displayLabel = jsonObj.displayLabel;\n this.baseClasses = jsonObj.baseClasses;\n this.customAttributes = jsonObj.customAttributes;\n this.properties = {};\n\n for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n }\n }\n}\n"]}
1	+ {"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,wDAAwD;AACxD,iDAAgD;AA6DhD;;GAEG;AACH,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,iCAAjB,iBAAiB,QAY5B;AA4DD;;;GAGG;AACH,MAAa,gBAAgB;IACpB,aAAa,CAAqB;IAClC,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,WAAW,CAAU;IACrB,YAAY,CAAU;IACtB,YAAY,CAAO;IACnB,YAAY,CAAO;IACnB,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,QAAQ,CAAW;IACnB,cAAc,CAAU;IACxB,eAAe,CAAW;IAC1B,qBAAqB,CAAW;IAChC,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,SAAS,CAAU;IACnB,iBAAiB,CAAU;IAClC,4DAA4D;IACrD,gBAAgB,CAAqB;IAE5C,4DAA4D;IAC5D,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC3B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBAE1E,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,uBAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,6BAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAzFD,4CAyFC;AAsBD;;;GAGG;AACH,MAAa,cAAc;IACzB,oFAAoF;IACpE,OAAO,CAAa;IACpC,sBAAsB;IACN,OAAO,CAAS;IAChB,WAAW,CAAU;IACrB,QAAQ,CAAU;IAClB,YAAY,CAAU;IACtC,uIAAuI;IACvH,WAAW,CAAW;IACtC,2CAA2C;IAC3C,4DAA4D;IAC5C,gBAAgB,CAAqB;IACrD,qFAAqF;IACrF,4DAA4D;IAC5C,UAAU,CAA2C;IAErE,4DAA4D;IAC5D,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,mCAAmC;YAC9E,4DAA4D;YAC5D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;CACF;AAjCD,wCAiCC","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 Entities\n /\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\nimport { RelatedElement } from \"./ElementProps\";\n\n/* The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\n * between the backend and frontend.\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\n * no methods and no properties of `class` type.\n * @public @preview\n * @extensions\n /\nexport interface EntityProps {\n /* A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\n * @see [Entity.isInstanceOfEntity]($backend).\n /\n readonly isInstanceOfEntity?: never;\n /* The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" /\n classFullName: string;\n /* The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. /\n id?: Id64String;\n /* Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. /\n jsonProperties?: { [key: string]: any };\n}\n\n/* Specifies the source and target elements of a [[Relationship]] instance.\n * @public @preview\n * @extensions\n /\nexport interface SourceAndTarget {\n sourceId: Id64String;\n targetId: Id64String;\n}\n\n/* Properties that are common to all types of link table ECRelationships\n * @public @preview\n * @extensions\n /\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\n}\n\n/* Parameters for performing a query on [Entity]($backend) classes.\n * @public @preview\n * @extensions\n /\nexport interface EntityQueryParams {\n /* The sql className, in the form \"Schema.ClassName\", of the class to search. /\n from?: string;\n /* Set to true to limit results to not include sub-classes of \"from\" class /\n only?: boolean;\n /* Optional \"WHERE\" clause to filter entities. Note: do not include the \"WHERE\" keyword. /\n where?: string;\n /* Optional \"ORDERBY\" clause to sort results. Note: do not include the \"ORDERBY\" keyword. /\n orderBy?: string;\n /* Optional \"LIMIT\" clause to limit the number of rows returned. /\n limit?: number;\n /* Optional \"OFFSET\" clause. Only valid if Limit is also present. /\n offset?: number;\n /* Bindings for parameterized values.\n * @see [[ECSqlStatement.bindValues]]\n /\n bindings?: any[] \| object;\n}\n\n/* The primitive types of an Entity property.\n * @beta\n /\nexport enum PrimitiveTypeCode {\n Uninitialized = 0x00,\n Binary = 0x101,\n Boolean = 0x201,\n DateTime = 0x301,\n Double = 0x401,\n Integer = 0x501,\n Long = 0x601,\n Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\n Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\n String = 0x901,\n IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\n}\n\n/* A callback function to process properties of an Entity\n * @beta\n * @deprecated in 5.0. Use `PropertyHandler` from `@itwin/ecschema-metadata` instead.\n \n @example\n * ```typescript\n * // Current usage:\n * const callback: PropertyCallback = (name: string, propMetaData: PropertyMetaData) => {\n * console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n * };\n \n // Replacement:\n * const callback: PropertyHandler = (propName: string, property: Property) => {\n * console.log(`Property name: ${propName}, Property type: ${property.propertyType}`);\n * };\n * ```\n /\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/* A custom attribute instance\n * @beta\n * @deprecated in 5.0. Use `CustomAttribute` interface from `@itwin/ecschema-metadata` instead.\n /\nexport interface CustomAttribute {\n /* The class of the CustomAttribute /\n ecclass: string;\n /* An object whose properties correspond by name to the properties of this custom attribute instance. /\n properties: { [propName: string]: any };\n}\n\ntype FactoryFunc = (jsonObj: any) => any;\n\n/\n @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n /\nexport interface PropertyMetaDataProps {\n primitiveType?: number;\n structName?: string;\n extendedType?: string;\n description?: string;\n displayLabel?: string;\n minimumValue?: any;\n maximumValue?: any;\n minimumLength?: number;\n maximumLength?: number;\n readOnly?: boolean;\n kindOfQuantity?: string;\n isCustomHandled?: boolean;\n isCustomHandledOrphan?: boolean;\n minOccurs?: number;\n maxOccurs?: number;\n direction?: string;\n relationshipClass?: string;\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n customAttributes?: CustomAttribute[];\n}\n\n/* Metadata for a property.\n * @beta\n * @deprecated in 5.0. Use the `Property` class from @itwin/ecschema-metadata` instead.\n /\nexport class PropertyMetaData implements PropertyMetaDataProps {\n public primitiveType?: PrimitiveTypeCode;\n public structName?: string;\n public extendedType?: string;\n public description?: string;\n public displayLabel?: string;\n public minimumValue?: any;\n public maximumValue?: any;\n public minimumLength?: number;\n public maximumLength?: number;\n public readOnly?: boolean;\n public kindOfQuantity?: string;\n public isCustomHandled?: boolean;\n public isCustomHandledOrphan?: boolean;\n public minOccurs?: number;\n public maxOccurs?: number;\n public direction?: string;\n public relationshipClass?: string;\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public customAttributes?: CustomAttribute[];\n\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public constructor(jsonObj: PropertyMetaDataProps) {\n this.primitiveType = jsonObj.primitiveType;\n if (jsonObj.structName)\n this.structName = jsonObj.structName;\n this.extendedType = jsonObj.extendedType;\n this.description = jsonObj.description;\n this.displayLabel = jsonObj.displayLabel;\n if (undefined !== jsonObj.minimumValue)\n this.minimumValue = jsonObj.minimumValue;\n if (undefined !== jsonObj.maximumValue)\n this.maximumValue = jsonObj.maximumValue;\n if (undefined !== jsonObj.minimumLength)\n this.minimumLength = jsonObj.minimumLength;\n if (undefined !== jsonObj.maximumLength)\n this.maximumLength = jsonObj.maximumLength;\n this.readOnly = jsonObj.readOnly;\n this.kindOfQuantity = jsonObj.kindOfQuantity;\n this.isCustomHandled = jsonObj.isCustomHandled;\n if (undefined !== jsonObj.minOccurs)\n this.minOccurs = jsonObj.minOccurs;\n if (undefined !== jsonObj.maxOccurs)\n this.maxOccurs = jsonObj.maxOccurs;\n this.direction = jsonObj.direction;\n this.relationshipClass = jsonObj.relationshipClass;\n this.customAttributes = jsonObj.customAttributes;\n }\n\n /* Create a typed value, or array of values, from a factory and an input object /\n private createValueOrArray(func: FactoryFunc, jsonObj: any) {\n if (undefined === this.minOccurs)\n return func(jsonObj); // not an array\n\n const val: any = [];\n jsonObj.forEach((element: any) => val.push(func(element)));\n return val;\n }\n\n /* construct a single property from an input object according to this metadata /\n public createProperty(jsonObj: any): any {\n if (jsonObj === undefined)\n return undefined;\n\n if (undefined !== this.primitiveType) {\n switch (this.primitiveType) {\n case PrimitiveTypeCode.Boolean:\n case PrimitiveTypeCode.Double:\n case PrimitiveTypeCode.Integer:\n case PrimitiveTypeCode.String:\n return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\n\n case PrimitiveTypeCode.Point2d:\n return this.createValueOrArray((obj) => Point2d.fromJSON(obj), jsonObj);\n\n case PrimitiveTypeCode.Point3d:\n return this.createValueOrArray((obj) => Point3d.fromJSON(obj), jsonObj);\n }\n }\n if (this.isNavigation)\n return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\n\n return jsonObj;\n }\n\n /* Return `true` if this property is a NavigationProperty. /\n public get isNavigation(): boolean {\n return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\n }\n}\n\n/\n @beta\n * @deprecated in 5.0. Use `@itwin/ecschema-metadata` instead.\n /\nexport interface EntityMetaDataProps {\n classId: Id64String;\n ecclass: string;\n description?: string;\n modifier?: string;\n displayLabel?: string;\n /* The base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). /\n baseClasses: string[];\n /* The Custom Attributes for this class /\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n customAttributes?: CustomAttribute[];\n /* An object whose properties correspond by name to the properties of this class. /\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n properties: { [propName: string]: PropertyMetaData };\n}\n\n/* Metadata for an Entity.\n * @beta\n * @deprecated in 5.0. Use `EntityClass` class from `@itwin/ecschema-metadata` instead.\n /\nexport class EntityMetaData implements EntityMetaDataProps {\n /* The Id of the class in the [[IModelDb]] from which the metadata was obtained. /\n public readonly classId: Id64String;\n /* The Entity name /\n public readonly ecclass: string;\n public readonly description?: string;\n public readonly modifier?: string;\n public readonly displayLabel?: string;\n /* The base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. /\n public readonly baseClasses: string[];\n /* The Custom Attributes for this class /\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public readonly customAttributes?: CustomAttribute[];\n /* An object whose properties correspond by name to the properties of this class. */\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public readonly properties: { [propName: string]: PropertyMetaData };\n\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n public constructor(jsonObj: EntityMetaDataProps) {\n this.classId = jsonObj.classId;\n this.ecclass = jsonObj.ecclass;\n this.description = jsonObj.description;\n this.modifier = jsonObj.modifier;\n this.displayLabel = jsonObj.displayLabel;\n this.baseClasses = jsonObj.baseClasses;\n this.customAttributes = jsonObj.customAttributes;\n this.properties = {};\n\n for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n }\n }\n}\n"]}

package/lib/cjs/ITwinCoreErrors.d.ts CHANGED Viewed

@@ -63,7 +63,7 @@ export interface ViewStoreError extends ITwinError {
 /** @beta */
 export declare namespace ViewStoreError {
     const scope = "itwin-ViewStore";
-    type Key = "invalid-value" | "invalid-member" | "no-owner" | "not-found" | "not-unique" | "group-error";
+    type Key = "invalid-value" | "invalid-member" | "no-owner" | "not-found" | "not-unique" | "no-viewstore" | "group-error";
     /** Determine whether an error object is a ViewStoreError */
     function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T;
     /** Instantiate and throw a ViewStoreError */