@itwin/core-common 3.5.0-dev.18 → 3.5.0-dev.20

package/lib/cjs/EntityProps.d.ts

@@ -1,177 +1,177 @@
-/** @packageDocumentation
- * @module Entities
- */
-import { Id64String } from "@itwin/core-bentley";
-/** The persistent format of an [Entity]($backend), also used as the "wire format" when transmitting information about entities
- * 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
- * @extensions
- */
-export interface EntityProps {
-    /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).
-     * @see [Entity.isInstanceOfEntity]($backend).
-     */
-    readonly isInstanceOfEntity?: never;
-    /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form "Schema:ClassName" */
-    classFullName: string;
-    /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */
-    id?: Id64String;
-    /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */
-    jsonProperties?: {
-        [key: string]: any;
-    };
-}
-/** Specifies the source and target elements of a [[Relationship]] instance.
- * @public
- * @extensions
- */
-export interface SourceAndTarget {
-    sourceId: Id64String;
-    targetId: Id64String;
-}
-/** Properties that are common to all types of link table ECRelationships
- * @public
- * @extensions
- */
-export interface RelationshipProps extends EntityProps, SourceAndTarget {
-}
-/** Parameters for performing a query on [Entity]($backend) classes.
- * @public
- * @extensions
- */
-export interface EntityQueryParams {
-    /** The sql className, in the form "Schema.ClassName", of the class to search. */
-    from?: string;
-    /** Set to true to limit results to *not* include sub-classes of "from" class */
-    only?: boolean;
-    /** Optional "WHERE" clause to filter entities. Note: do *not* include the "WHERE" keyword. */
-    where?: string;
-    /** Optional "ORDERBY" clause to sort results. Note: do *not* include the "ORDERBY" keyword. */
-    orderBy?: string;
-    /** Optional "LIMIT" clause to limit the number of rows returned. */
-    limit?: number;
-    /** Optional "OFFSET" clause. Only valid if Limit is also present. */
-    offset?: number;
-    /** Bindings for parameterized values.
-     * @see [[ECSqlStatement.bindValues]]
-     */
-    bindings?: any[] | object;
-}
-/** The primitive types of an Entity property.
- * @beta
- */
-export declare enum PrimitiveTypeCode {
-    Uninitialized = 0,
-    Binary = 257,
-    Boolean = 513,
-    DateTime = 769,
-    Double = 1025,
-    Integer = 1281,
-    Long = 1537,
-    Point2d = 1793,
-    Point3d = 2049,
-    String = 2305
-}
-/** A callback function to process properties of an Entity
- * @beta
- */
-export declare type PropertyCallback = (name: string, meta: PropertyMetaData) => void;
-/** A custom attribute instance
- * @beta
- */
-export interface CustomAttribute {
-    /** The class of the CustomAttribute */
-    ecclass: string;
-    /** An object whose properties correspond by name to the properties of this custom attribute instance. */
-    properties: {
-        [propName: string]: any;
-    };
-}
-/** @beta */
-export interface PropertyMetaDataProps {
-    primitiveType?: number;
-    structName?: string;
-    extendedType?: string;
-    description?: string;
-    displayLabel?: string;
-    minimumValue?: any;
-    maximumValue?: any;
-    minimumLength?: number;
-    maximumLength?: number;
-    readOnly?: boolean;
-    kindOfQuantity?: string;
-    isCustomHandled?: boolean;
-    isCustomHandledOrphan?: boolean;
-    minOccurs?: number;
-    maxOccurs?: number;
-    direction?: string;
-    relationshipClass?: string;
-    customAttributes?: CustomAttribute[];
-}
-/** Metadata for a property.
- * @beta
- */
-export declare class PropertyMetaData implements PropertyMetaDataProps {
-    primitiveType?: PrimitiveTypeCode;
-    structName?: string;
-    extendedType?: string;
-    description?: string;
-    displayLabel?: string;
-    minimumValue?: any;
-    maximumValue?: any;
-    minimumLength?: number;
-    maximumLength?: number;
-    readOnly?: boolean;
-    kindOfQuantity?: string;
-    isCustomHandled?: boolean;
-    isCustomHandledOrphan?: boolean;
-    minOccurs?: number;
-    maxOccurs?: number;
-    direction?: string;
-    relationshipClass?: string;
-    customAttributes?: CustomAttribute[];
-    constructor(jsonObj: PropertyMetaDataProps);
-    /** Create a typed value, or array of values, from a factory and an input object */
-    private createValueOrArray;
-    /** construct a single property from an input object according to this metadata */
-    createProperty(jsonObj: any): any;
-    /** Return `true` if this property is a NavigationProperty. */
-    get isNavigation(): boolean;
-}
-/** @beta */
-export interface EntityMetaDataProps {
-    ecclass: string;
-    description?: string;
-    modifier?: string;
-    displayLabel?: string;
-    /** 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). */
-    baseClasses: string[];
-    /** The Custom Attributes for this class */
-    customAttributes?: CustomAttribute[];
-    /** An object whose properties correspond by name to the properties of this class. */
-    properties: {
-        [propName: string]: PropertyMetaData;
-    };
-}
-/** Metadata for an Entity.
- * @beta
- */
-export declare class EntityMetaData implements EntityMetaDataProps {
-    /** The Entity name */
-    readonly ecclass: string;
-    readonly description?: string;
-    readonly modifier?: string;
-    readonly displayLabel?: string;
-    /** 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. */
-    readonly baseClasses: string[];
-    /** The Custom Attributes for this class */
-    readonly customAttributes?: CustomAttribute[];
-    /** An object whose properties correspond by name to the properties of this class. */
-    readonly properties: {
-        [propName: string]: PropertyMetaData;
-    };
-    constructor(jsonObj: EntityMetaDataProps);
-}
+/** @packageDocumentation
+ * @module Entities
+ */
+import { Id64String } from "@itwin/core-bentley";
+/** The persistent format of an [Entity]($backend), also used as the "wire format" when transmitting information about entities
+ * 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
+ * @extensions
+ */
+export interface EntityProps {
+    /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).
+     * @see [Entity.isInstanceOfEntity]($backend).
+     */
+    readonly isInstanceOfEntity?: never;
+    /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form "Schema:ClassName" */
+    classFullName: string;
+    /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */
+    id?: Id64String;
+    /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */
+    jsonProperties?: {
+        [key: string]: any;
+    };
+}
+/** Specifies the source and target elements of a [[Relationship]] instance.
+ * @public
+ * @extensions
+ */
+export interface SourceAndTarget {
+    sourceId: Id64String;
+    targetId: Id64String;
+}
+/** Properties that are common to all types of link table ECRelationships
+ * @public
+ * @extensions
+ */
+export interface RelationshipProps extends EntityProps, SourceAndTarget {
+}
+/** Parameters for performing a query on [Entity]($backend) classes.
+ * @public
+ * @extensions
+ */
+export interface EntityQueryParams {
+    /** The sql className, in the form "Schema.ClassName", of the class to search. */
+    from?: string;
+    /** Set to true to limit results to *not* include sub-classes of "from" class */
+    only?: boolean;
+    /** Optional "WHERE" clause to filter entities. Note: do *not* include the "WHERE" keyword. */
+    where?: string;
+    /** Optional "ORDERBY" clause to sort results. Note: do *not* include the "ORDERBY" keyword. */
+    orderBy?: string;
+    /** Optional "LIMIT" clause to limit the number of rows returned. */
+    limit?: number;
+    /** Optional "OFFSET" clause. Only valid if Limit is also present. */
+    offset?: number;
+    /** Bindings for parameterized values.
+     * @see [[ECSqlStatement.bindValues]]
+     */
+    bindings?: any[] | object;
+}
+/** The primitive types of an Entity property.
+ * @beta
+ */
+export declare enum PrimitiveTypeCode {
+    Uninitialized = 0,
+    Binary = 257,
+    Boolean = 513,
+    DateTime = 769,
+    Double = 1025,
+    Integer = 1281,
+    Long = 1537,
+    Point2d = 1793,
+    Point3d = 2049,
+    String = 2305
+}
+/** A callback function to process properties of an Entity
+ * @beta
+ */
+export declare type PropertyCallback = (name: string, meta: PropertyMetaData) => void;
+/** A custom attribute instance
+ * @beta
+ */
+export interface CustomAttribute {
+    /** The class of the CustomAttribute */
+    ecclass: string;
+    /** An object whose properties correspond by name to the properties of this custom attribute instance. */
+    properties: {
+        [propName: string]: any;
+    };
+}
+/** @beta */
+export interface PropertyMetaDataProps {
+    primitiveType?: number;
+    structName?: string;
+    extendedType?: string;
+    description?: string;
+    displayLabel?: string;
+    minimumValue?: any;
+    maximumValue?: any;
+    minimumLength?: number;
+    maximumLength?: number;
+    readOnly?: boolean;
+    kindOfQuantity?: string;
+    isCustomHandled?: boolean;
+    isCustomHandledOrphan?: boolean;
+    minOccurs?: number;
+    maxOccurs?: number;
+    direction?: string;
+    relationshipClass?: string;
+    customAttributes?: CustomAttribute[];
+}
+/** Metadata for a property.
+ * @beta
+ */
+export declare class PropertyMetaData implements PropertyMetaDataProps {
+    primitiveType?: PrimitiveTypeCode;
+    structName?: string;
+    extendedType?: string;
+    description?: string;
+    displayLabel?: string;
+    minimumValue?: any;
+    maximumValue?: any;
+    minimumLength?: number;
+    maximumLength?: number;
+    readOnly?: boolean;
+    kindOfQuantity?: string;
+    isCustomHandled?: boolean;
+    isCustomHandledOrphan?: boolean;
+    minOccurs?: number;
+    maxOccurs?: number;
+    direction?: string;
+    relationshipClass?: string;
+    customAttributes?: CustomAttribute[];
+    constructor(jsonObj: PropertyMetaDataProps);
+    /** Create a typed value, or array of values, from a factory and an input object */
+    private createValueOrArray;
+    /** construct a single property from an input object according to this metadata */
+    createProperty(jsonObj: any): any;
+    /** Return `true` if this property is a NavigationProperty. */
+    get isNavigation(): boolean;
+}
+/** @beta */
+export interface EntityMetaDataProps {
+    ecclass: string;
+    description?: string;
+    modifier?: string;
+    displayLabel?: string;
+    /** 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). */
+    baseClasses: string[];
+    /** The Custom Attributes for this class */
+    customAttributes?: CustomAttribute[];
+    /** An object whose properties correspond by name to the properties of this class. */
+    properties: {
+        [propName: string]: PropertyMetaData;
+    };
+}
+/** Metadata for an Entity.
+ * @beta
+ */
+export declare class EntityMetaData implements EntityMetaDataProps {
+    /** The Entity name */
+    readonly ecclass: string;
+    readonly description?: string;
+    readonly modifier?: string;
+    readonly displayLabel?: string;
+    /** 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. */
+    readonly baseClasses: string[];
+    /** The Custom Attributes for this class */
+    readonly customAttributes?: CustomAttribute[];
+    /** An object whose properties correspond by name to the properties of this class. */
+    readonly properties: {
+        [propName: string]: PropertyMetaData;
+    };
+    constructor(jsonObj: EntityMetaDataProps);
+}
 //# sourceMappingURL=EntityProps.d.ts.map

package/lib/cjs/EntityProps.js

@@ -1,113 +1,113 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Entities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityMetaData = exports.PropertyMetaData = exports.PrimitiveTypeCode = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_geometry_1 = require("@itwin/core-geometry");
-const ElementProps_1 = require("./ElementProps");
-/** The primitive types of an Entity property.
- * @beta
- */
-var PrimitiveTypeCode;
-(function (PrimitiveTypeCode) {
-    PrimitiveTypeCode[PrimitiveTypeCode["Uninitialized"] = 0] = "Uninitialized";
-    PrimitiveTypeCode[PrimitiveTypeCode["Binary"] = 257] = "Binary";
-    PrimitiveTypeCode[PrimitiveTypeCode["Boolean"] = 513] = "Boolean";
-    PrimitiveTypeCode[PrimitiveTypeCode["DateTime"] = 769] = "DateTime";
-    PrimitiveTypeCode[PrimitiveTypeCode["Double"] = 1025] = "Double";
-    PrimitiveTypeCode[PrimitiveTypeCode["Integer"] = 1281] = "Integer";
-    PrimitiveTypeCode[PrimitiveTypeCode["Long"] = 1537] = "Long";
-    PrimitiveTypeCode[PrimitiveTypeCode["Point2d"] = 1793] = "Point2d";
-    PrimitiveTypeCode[PrimitiveTypeCode["Point3d"] = 2049] = "Point3d";
-    PrimitiveTypeCode[PrimitiveTypeCode["String"] = 2305] = "String";
-})(PrimitiveTypeCode = exports.PrimitiveTypeCode || (exports.PrimitiveTypeCode = {}));
-/** Metadata for a property.
- * @beta
- */
-class PropertyMetaData {
-    constructor(jsonObj) {
-        this.primitiveType = jsonObj.primitiveType;
-        if (jsonObj.structName)
-            this.structName = jsonObj.structName;
-        this.extendedType = jsonObj.extendedType;
-        this.description = jsonObj.description;
-        this.displayLabel = jsonObj.displayLabel;
-        if (undefined !== jsonObj.minimumValue)
-            this.minimumValue = jsonObj.minimumValue;
-        if (undefined !== jsonObj.maximumValue)
-            this.maximumValue = jsonObj.maximumValue;
-        if (undefined !== jsonObj.minimumLength)
-            this.minimumLength = jsonObj.minimumLength;
-        if (undefined !== jsonObj.maximumLength)
-            this.maximumLength = jsonObj.maximumLength;
-        this.readOnly = jsonObj.readOnly;
-        this.kindOfQuantity = jsonObj.kindOfQuantity;
-        this.isCustomHandled = jsonObj.isCustomHandled;
-        if (undefined !== jsonObj.minOccurs)
-            this.minOccurs = jsonObj.minOccurs;
-        if (undefined !== jsonObj.maxOccurs)
-            this.maxOccurs = jsonObj.maxOccurs;
-        this.direction = jsonObj.direction;
-        this.relationshipClass = jsonObj.relationshipClass;
-        this.customAttributes = jsonObj.customAttributes;
-    }
-    /** Create a typed value, or array of values, from a factory and an input object */
-    createValueOrArray(func, jsonObj) {
-        if (undefined === this.minOccurs)
-            return func(jsonObj); // not an array
-        const val = [];
-        jsonObj.forEach((element) => val.push(func(element)));
-        return val;
-    }
-    /** construct a single property from an input object according to this metadata */
-    createProperty(jsonObj) {
-        if (jsonObj === undefined)
-            return undefined;
-        if (undefined !== this.primitiveType) {
-            switch (this.primitiveType) {
-                case PrimitiveTypeCode.Boolean:
-                case PrimitiveTypeCode.Double:
-                case PrimitiveTypeCode.Integer:
-                case PrimitiveTypeCode.String:
-                    return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type
-                case PrimitiveTypeCode.Point2d:
-                    return this.createValueOrArray(core_geometry_1.Point2d.fromJSON, jsonObj);
-                case PrimitiveTypeCode.Point3d:
-                    return this.createValueOrArray(core_geometry_1.Point3d.fromJSON, jsonObj);
-            }
-        }
-        if (this.isNavigation)
-            return jsonObj.id !== undefined ? new ElementProps_1.RelatedElement(jsonObj) : core_bentley_1.Id64.fromJSON(jsonObj);
-        return jsonObj;
-    }
-    /** Return `true` if this property is a NavigationProperty. */
-    get isNavigation() {
-        return (this.direction !== undefined); // the presence of `direction` means it is a navigation property
-    }
-}
-exports.PropertyMetaData = PropertyMetaData;
-/** Metadata for an Entity.
- * @beta
- */
-class EntityMetaData {
-    constructor(jsonObj) {
-        this.ecclass = jsonObj.ecclass;
-        this.description = jsonObj.description;
-        this.modifier = jsonObj.modifier;
-        this.displayLabel = jsonObj.displayLabel;
-        this.baseClasses = jsonObj.baseClasses;
-        this.customAttributes = jsonObj.customAttributes;
-        this.properties = {};
-        for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in
-            this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);
-        }
-    }
-}
-exports.EntityMetaData = EntityMetaData;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Entities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityMetaData = exports.PropertyMetaData = exports.PrimitiveTypeCode = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_geometry_1 = require("@itwin/core-geometry");
+const ElementProps_1 = require("./ElementProps");
+/** The primitive types of an Entity property.
+ * @beta
+ */
+var PrimitiveTypeCode;
+(function (PrimitiveTypeCode) {
+    PrimitiveTypeCode[PrimitiveTypeCode["Uninitialized"] = 0] = "Uninitialized";
+    PrimitiveTypeCode[PrimitiveTypeCode["Binary"] = 257] = "Binary";
+    PrimitiveTypeCode[PrimitiveTypeCode["Boolean"] = 513] = "Boolean";
+    PrimitiveTypeCode[PrimitiveTypeCode["DateTime"] = 769] = "DateTime";
+    PrimitiveTypeCode[PrimitiveTypeCode["Double"] = 1025] = "Double";
+    PrimitiveTypeCode[PrimitiveTypeCode["Integer"] = 1281] = "Integer";
+    PrimitiveTypeCode[PrimitiveTypeCode["Long"] = 1537] = "Long";
+    PrimitiveTypeCode[PrimitiveTypeCode["Point2d"] = 1793] = "Point2d";
+    PrimitiveTypeCode[PrimitiveTypeCode["Point3d"] = 2049] = "Point3d";
+    PrimitiveTypeCode[PrimitiveTypeCode["String"] = 2305] = "String";
+})(PrimitiveTypeCode = exports.PrimitiveTypeCode || (exports.PrimitiveTypeCode = {}));
+/** Metadata for a property.
+ * @beta
+ */
+class PropertyMetaData {
+    constructor(jsonObj) {
+        this.primitiveType = jsonObj.primitiveType;
+        if (jsonObj.structName)
+            this.structName = jsonObj.structName;
+        this.extendedType = jsonObj.extendedType;
+        this.description = jsonObj.description;
+        this.displayLabel = jsonObj.displayLabel;
+        if (undefined !== jsonObj.minimumValue)
+            this.minimumValue = jsonObj.minimumValue;
+        if (undefined !== jsonObj.maximumValue)
+            this.maximumValue = jsonObj.maximumValue;
+        if (undefined !== jsonObj.minimumLength)
+            this.minimumLength = jsonObj.minimumLength;
+        if (undefined !== jsonObj.maximumLength)
+            this.maximumLength = jsonObj.maximumLength;
+        this.readOnly = jsonObj.readOnly;
+        this.kindOfQuantity = jsonObj.kindOfQuantity;
+        this.isCustomHandled = jsonObj.isCustomHandled;
+        if (undefined !== jsonObj.minOccurs)
+            this.minOccurs = jsonObj.minOccurs;
+        if (undefined !== jsonObj.maxOccurs)
+            this.maxOccurs = jsonObj.maxOccurs;
+        this.direction = jsonObj.direction;
+        this.relationshipClass = jsonObj.relationshipClass;
+        this.customAttributes = jsonObj.customAttributes;
+    }
+    /** Create a typed value, or array of values, from a factory and an input object */
+    createValueOrArray(func, jsonObj) {
+        if (undefined === this.minOccurs)
+            return func(jsonObj); // not an array
+        const val = [];
+        jsonObj.forEach((element) => val.push(func(element)));
+        return val;
+    }
+    /** construct a single property from an input object according to this metadata */
+    createProperty(jsonObj) {
+        if (jsonObj === undefined)
+            return undefined;
+        if (undefined !== this.primitiveType) {
+            switch (this.primitiveType) {
+                case PrimitiveTypeCode.Boolean:
+                case PrimitiveTypeCode.Double:
+                case PrimitiveTypeCode.Integer:
+                case PrimitiveTypeCode.String:
+                    return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type
+                case PrimitiveTypeCode.Point2d:
+                    return this.createValueOrArray(core_geometry_1.Point2d.fromJSON, jsonObj);
+                case PrimitiveTypeCode.Point3d:
+                    return this.createValueOrArray(core_geometry_1.Point3d.fromJSON, jsonObj);
+            }
+        }
+        if (this.isNavigation)
+            return jsonObj.id !== undefined ? new ElementProps_1.RelatedElement(jsonObj) : core_bentley_1.Id64.fromJSON(jsonObj);
+        return jsonObj;
+    }
+    /** Return `true` if this property is a NavigationProperty. */
+    get isNavigation() {
+        return (this.direction !== undefined); // the presence of `direction` means it is a navigation property
+    }
+}
+exports.PropertyMetaData = PropertyMetaData;
+/** Metadata for an Entity.
+ * @beta
+ */
+class EntityMetaData {
+    constructor(jsonObj) {
+        this.ecclass = jsonObj.ecclass;
+        this.description = jsonObj.description;
+        this.modifier = jsonObj.modifier;
+        this.displayLabel = jsonObj.displayLabel;
+        this.baseClasses = jsonObj.baseClasses;
+        this.customAttributes = jsonObj.customAttributes;
+        this.properties = {};
+        for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in
+            this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);
+        }
+    }
+}
+exports.EntityMetaData = EntityMetaData;
 //# sourceMappingURL=EntityProps.js.map

package/lib/cjs/EntityProps.js.map

@@ -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,iBAWX;AAXD,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;AAChB,CAAC,EAXW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAW5B;AAyCD;;GAEG;AACH,MAAa,gBAAgB;IAoB3B,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;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,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,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;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;AAvFD,4CAuFC;AAgBD;;GAEG;AACH,MAAa,cAAc;IAazB,YAAmB,OAA4B;QAC7C,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,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AA1BD,wCA0BC","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}\n\n/** A callback function to process properties of an Entity\n * @beta\n */\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\n\n/** A custom attribute instance\n * @beta\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/** @beta */\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  customAttributes?: CustomAttribute[];\n}\n\n/** Metadata for a property.\n * @beta\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  public customAttributes?: CustomAttribute[];\n\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(Point2d.fromJSON, jsonObj);\n\n        case PrimitiveTypeCode.Point3d:\n          return this.createValueOrArray(Point3d.fromJSON, 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/** @beta */\nexport interface EntityMetaDataProps {\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  customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  properties: { [propName: string]: PropertyMetaData };\n}\n\n/** Metadata for an Entity.\n * @beta\n */\nexport class EntityMetaData implements EntityMetaDataProps {\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  public readonly customAttributes?: CustomAttribute[];\n  /** An object whose properties correspond by name to the properties of this class. */\n  public readonly properties: { [propName: string]: PropertyMetaData };\n\n  public constructor(jsonObj: EntityMetaDataProps) {\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      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\n    }\n  }\n}\n"]}
+{"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,iBAWX;AAXD,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;AAChB,CAAC,EAXW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAW5B;AAyCD;;GAEG;AACH,MAAa,gBAAgB;IAoB3B,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;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,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,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;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;AAvFD,4CAuFC;AAgBD;;GAEG;AACH,MAAa,cAAc;IAazB,YAAmB,OAA4B;QAC7C,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,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AA1BD,wCA0BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Entities\r\n */\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\nimport { RelatedElement } from \"./ElementProps\";\r\n\r\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\r\n * between the backend and frontend.\r\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\r\n * no methods and no properties of `class` type.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityProps {\r\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\r\n   * @see [Entity.isInstanceOfEntity]($backend).\r\n   */\r\n  readonly isInstanceOfEntity?: never;\r\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\r\n  classFullName: string;\r\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\r\n  id?: Id64String;\r\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\r\n  jsonProperties?: { [key: string]: any };\r\n}\r\n\r\n/** Specifies the source and target elements of a [[Relationship]] instance.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SourceAndTarget {\r\n  sourceId: Id64String;\r\n  targetId: Id64String;\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\r\n}\r\n\r\n/** Parameters for performing a query on [Entity]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityQueryParams {\r\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\r\n  from?: string;\r\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\r\n  only?: boolean;\r\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\r\n  where?: string;\r\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\r\n  orderBy?: string;\r\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\r\n  limit?: number;\r\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\r\n  offset?: number;\r\n  /** Bindings for parameterized values.\r\n   * @see [[ECSqlStatement.bindValues]]\r\n   */\r\n  bindings?: any[] | object;\r\n}\r\n\r\n/** The primitive types of an Entity property.\r\n * @beta\r\n */\r\nexport enum PrimitiveTypeCode {\r\n  Uninitialized = 0x00,\r\n  Binary = 0x101,\r\n  Boolean = 0x201,\r\n  DateTime = 0x301,\r\n  Double = 0x401,\r\n  Integer = 0x501,\r\n  Long = 0x601,\r\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\r\n  String = 0x901,\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @beta\r\n */\r\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\r\n\r\n/** A custom attribute instance\r\n * @beta\r\n */\r\nexport interface CustomAttribute {\r\n  /** The class of the CustomAttribute */\r\n  ecclass: string;\r\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\r\n  properties: { [propName: string]: any };\r\n}\r\n\r\ntype FactoryFunc = (jsonObj: any) => any;\r\n\r\n/** @beta */\r\nexport interface PropertyMetaDataProps {\r\n  primitiveType?: number;\r\n  structName?: string;\r\n  extendedType?: string;\r\n  description?: string;\r\n  displayLabel?: string;\r\n  minimumValue?: any;\r\n  maximumValue?: any;\r\n  minimumLength?: number;\r\n  maximumLength?: number;\r\n  readOnly?: boolean;\r\n  kindOfQuantity?: string;\r\n  isCustomHandled?: boolean;\r\n  isCustomHandledOrphan?: boolean;\r\n  minOccurs?: number;\r\n  maxOccurs?: number;\r\n  direction?: string;\r\n  relationshipClass?: string;\r\n  customAttributes?: CustomAttribute[];\r\n}\r\n\r\n/** Metadata for a property.\r\n * @beta\r\n */\r\nexport class PropertyMetaData implements PropertyMetaDataProps {\r\n  public primitiveType?: PrimitiveTypeCode;\r\n  public structName?: string;\r\n  public extendedType?: string;\r\n  public description?: string;\r\n  public displayLabel?: string;\r\n  public minimumValue?: any;\r\n  public maximumValue?: any;\r\n  public minimumLength?: number;\r\n  public maximumLength?: number;\r\n  public readOnly?: boolean;\r\n  public kindOfQuantity?: string;\r\n  public isCustomHandled?: boolean;\r\n  public isCustomHandledOrphan?: boolean;\r\n  public minOccurs?: number;\r\n  public maxOccurs?: number;\r\n  public direction?: string;\r\n  public relationshipClass?: string;\r\n  public customAttributes?: CustomAttribute[];\r\n\r\n  public constructor(jsonObj: PropertyMetaDataProps) {\r\n    this.primitiveType = jsonObj.primitiveType;\r\n    if (jsonObj.structName)\r\n      this.structName = jsonObj.structName;\r\n    this.extendedType = jsonObj.extendedType;\r\n    this.description = jsonObj.description;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    if (undefined !== jsonObj.minimumValue)\r\n      this.minimumValue = jsonObj.minimumValue;\r\n    if (undefined !== jsonObj.maximumValue)\r\n      this.maximumValue = jsonObj.maximumValue;\r\n    if (undefined !== jsonObj.minimumLength)\r\n      this.minimumLength = jsonObj.minimumLength;\r\n    if (undefined !== jsonObj.maximumLength)\r\n      this.maximumLength = jsonObj.maximumLength;\r\n    this.readOnly = jsonObj.readOnly;\r\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\r\n    this.isCustomHandled = jsonObj.isCustomHandled;\r\n    if (undefined !== jsonObj.minOccurs)\r\n      this.minOccurs = jsonObj.minOccurs;\r\n    if (undefined !== jsonObj.maxOccurs)\r\n      this.maxOccurs = jsonObj.maxOccurs;\r\n    this.direction = jsonObj.direction;\r\n    this.relationshipClass = jsonObj.relationshipClass;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n  }\r\n\r\n  /** Create a typed value, or array of values, from a factory and an input object */\r\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\r\n    if (undefined === this.minOccurs)\r\n      return func(jsonObj); // not an array\r\n\r\n    const val: any = [];\r\n    jsonObj.forEach((element: any) => val.push(func(element)));\r\n    return val;\r\n  }\r\n\r\n  /** construct a single property from an input object according to this metadata */\r\n  public createProperty(jsonObj: any): any {\r\n    if (jsonObj === undefined)\r\n      return undefined;\r\n\r\n    if (undefined !== this.primitiveType) {\r\n      switch (this.primitiveType) {\r\n        case PrimitiveTypeCode.Boolean:\r\n        case PrimitiveTypeCode.Double:\r\n        case PrimitiveTypeCode.Integer:\r\n        case PrimitiveTypeCode.String:\r\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\r\n\r\n        case PrimitiveTypeCode.Point2d:\r\n          return this.createValueOrArray(Point2d.fromJSON, jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray(Point3d.fromJSON, jsonObj);\r\n      }\r\n    }\r\n    if (this.isNavigation)\r\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\r\n\r\n    return jsonObj;\r\n  }\r\n\r\n  /** Return `true` if this property is a NavigationProperty. */\r\n  public get isNavigation(): boolean {\r\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface EntityMetaDataProps {\r\n  ecclass: string;\r\n  description?: string;\r\n  modifier?: string;\r\n  displayLabel?: string;\r\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). */\r\n  baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  properties: { [propName: string]: PropertyMetaData };\r\n}\r\n\r\n/** Metadata for an Entity.\r\n * @beta\r\n */\r\nexport class EntityMetaData implements EntityMetaDataProps {\r\n  /** The Entity name */\r\n  public readonly ecclass: string;\r\n  public readonly description?: string;\r\n  public readonly modifier?: string;\r\n  public readonly displayLabel?: string;\r\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. */\r\n  public readonly baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  public readonly customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  public readonly properties: { [propName: string]: PropertyMetaData };\r\n\r\n  public constructor(jsonObj: EntityMetaDataProps) {\r\n    this.ecclass = jsonObj.ecclass;\r\n    this.description = jsonObj.description;\r\n    this.modifier = jsonObj.modifier;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    this.baseClasses = jsonObj.baseClasses;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n    this.properties = {};\r\n\r\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\r\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\r\n    }\r\n  }\r\n}\r\n"]}