@itwin/presentation-common 4.0.0-dev.17 → 4.0.0-dev.18

package/lib/cjs/presentation-common/Error.js

@@ -1,63 +1,63 @@
-"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 Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PresentationError = exports.PresentationStatus = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/**
- * Status codes used by Presentation APIs.
- * @public
- */
-var PresentationStatus;
-(function (PresentationStatus) {
-    /** Success result. */
-    PresentationStatus[PresentationStatus["Success"] = 0] = "Success";
-    /** Request was cancelled. */
-    PresentationStatus[PresentationStatus["Canceled"] = 1] = "Canceled";
-    /** Error: Unknown */
-    PresentationStatus[PresentationStatus["Error"] = 65536] = "Error";
-    /** Error: Backend is not initialized. */
-    PresentationStatus[PresentationStatus["NotInitialized"] = 65537] = "NotInitialized";
-    /** Error: Argument is invalid. */
-    PresentationStatus[PresentationStatus["InvalidArgument"] = 65539] = "InvalidArgument";
-    /**
-     * Timeout for the request was reached which prevented it from being fulfilled. Frontend may
-     * repeat the request.
-     */
-    PresentationStatus[PresentationStatus["BackendTimeout"] = 65543] = "BackendTimeout";
-})(PresentationStatus = exports.PresentationStatus || (exports.PresentationStatus = {}));
-/**
- * An error type thrown by Presentation APIs.
- * @public
- */
-class PresentationError extends core_bentley_1.BentleyError {
-    /**
-     * Creates an instance of Error.
-     * @param errorNumber Error code
-     * @param message Optional brief description of the error. The `message` property combined with the `name`
-     * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.
-     * @param log Optional log function which logs the error.
-     * @param getMetaData Optional function that returns meta-data related to an error.
-     */
-    constructor(errorNumber, message, getMetaData) {
-        super(errorNumber, message, getMetaData);
-    }
-    /**
-     * Returns the name of each error status. The name is used by the `Error.prototype.toString()`
-     * method to create a string representation of the error.
-     */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    _initName() {
-        let value = PresentationStatus[this.errorNumber];
-        if (!value)
-            value = `Unknown Error (${this.errorNumber})`;
-        return value;
-    }
-}
-exports.PresentationError = PresentationError;
+"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 Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PresentationError = exports.PresentationStatus = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * Status codes used by Presentation APIs.
+ * @public
+ */
+var PresentationStatus;
+(function (PresentationStatus) {
+    /** Success result. */
+    PresentationStatus[PresentationStatus["Success"] = 0] = "Success";
+    /** Request was cancelled. */
+    PresentationStatus[PresentationStatus["Canceled"] = 1] = "Canceled";
+    /** Error: Unknown */
+    PresentationStatus[PresentationStatus["Error"] = 65536] = "Error";
+    /** Error: Backend is not initialized. */
+    PresentationStatus[PresentationStatus["NotInitialized"] = 65537] = "NotInitialized";
+    /** Error: Argument is invalid. */
+    PresentationStatus[PresentationStatus["InvalidArgument"] = 65539] = "InvalidArgument";
+    /**
+     * Timeout for the request was reached which prevented it from being fulfilled. Frontend may
+     * repeat the request.
+     */
+    PresentationStatus[PresentationStatus["BackendTimeout"] = 65543] = "BackendTimeout";
+})(PresentationStatus = exports.PresentationStatus || (exports.PresentationStatus = {}));
+/**
+ * An error type thrown by Presentation APIs.
+ * @public
+ */
+class PresentationError extends core_bentley_1.BentleyError {
+    /**
+     * Creates an instance of Error.
+     * @param errorNumber Error code
+     * @param message Optional brief description of the error. The `message` property combined with the `name`
+     * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.
+     * @param log Optional log function which logs the error.
+     * @param getMetaData Optional function that returns meta-data related to an error.
+     */
+    constructor(errorNumber, message, getMetaData) {
+        super(errorNumber, message, getMetaData);
+    }
+    /**
+     * Returns the name of each error status. The name is used by the `Error.prototype.toString()`
+     * method to create a string representation of the error.
+     */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    _initName() {
+        let value = PresentationStatus[this.errorNumber];
+        if (!value)
+            value = `Unknown Error (${this.errorNumber})`;
+        return value;
+    }
+}
+exports.PresentationError = PresentationError;
 //# sourceMappingURL=Error.js.map

package/lib/cjs/presentation-common/Error.js.map

@@ -1 +1 @@
-{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../src/presentation-common/Error.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwE;AAExE;;;GAGG;AACH,IAAY,kBAqBX;AArBD,WAAY,kBAAkB;IAC5B,sBAAsB;IACtB,iEAAW,CAAA;IAEX,6BAA6B;IAC7B,mEAAY,CAAA;IAEZ,qBAAqB;IACrB,iEAAe,CAAA;IAEf,yCAAyC;IACzC,mFAA0B,CAAA;IAE1B,kCAAkC;IAClC,qFAA2B,CAAA;IAE3B;;;OAGG;IACH,mFAA0B,CAAA;AAC5B,CAAC,EArBW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAqB7B;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,2BAAY;IAEjD;;;;;;;OAOG;IACH,YAAmB,WAA+B,EAAE,OAAgB,EAAE,WAAiC;QACrG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,gEAAgE;IAC7C,SAAS;QAC1B,IAAI,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK;YACR,KAAK,GAAG,kBAAkB,IAAI,CAAC,WAAW,GAAG,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzBD,8CAyBC","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 Core\n */\n\nimport { BentleyError, GetMetaDataFunction } from \"@itwin/core-bentley\";\n\n/**\n * Status codes used by Presentation APIs.\n * @public\n */\nexport enum PresentationStatus {\n  /** Success result. */\n  Success = 0,\n\n  /** Request was cancelled. */\n  Canceled = 1,\n\n  /** Error: Unknown */\n  Error = 0x10000,\n\n  /** Error: Backend is not initialized. */\n  NotInitialized = Error + 1,\n\n  /** Error: Argument is invalid. */\n  InvalidArgument = Error + 3,\n\n  /**\n   * Timeout for the request was reached which prevented it from being fulfilled. Frontend may\n   * repeat the request.\n   */\n  BackendTimeout = Error + 7,\n}\n\n/**\n * An error type thrown by Presentation APIs.\n * @public\n */\nexport class PresentationError extends BentleyError {\n\n  /**\n   * Creates an instance of Error.\n   * @param errorNumber Error code\n   * @param message Optional brief description of the error. The `message` property combined with the `name`\n   * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.\n   * @param log Optional log function which logs the error.\n   * @param getMetaData Optional function that returns meta-data related to an error.\n   */\n  public constructor(errorNumber: PresentationStatus, message?: string, getMetaData?: GetMetaDataFunction) {\n    super(errorNumber, message, getMetaData);\n  }\n\n  /**\n   * Returns the name of each error status. The name is used by the `Error.prototype.toString()`\n   * method to create a string representation of the error.\n   */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  protected override _initName(): string {\n    let value = PresentationStatus[this.errorNumber];\n    if (!value)\n      value = `Unknown Error (${this.errorNumber})`;\n    return value;\n  }\n}\n"]}
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../src/presentation-common/Error.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwE;AAExE;;;GAGG;AACH,IAAY,kBAqBX;AArBD,WAAY,kBAAkB;IAC5B,sBAAsB;IACtB,iEAAW,CAAA;IAEX,6BAA6B;IAC7B,mEAAY,CAAA;IAEZ,qBAAqB;IACrB,iEAAe,CAAA;IAEf,yCAAyC;IACzC,mFAA0B,CAAA;IAE1B,kCAAkC;IAClC,qFAA2B,CAAA;IAE3B;;;OAGG;IACH,mFAA0B,CAAA;AAC5B,CAAC,EArBW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAqB7B;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,2BAAY;IAEjD;;;;;;;OAOG;IACH,YAAmB,WAA+B,EAAE,OAAgB,EAAE,WAAiC;QACrG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,gEAAgE;IAC7C,SAAS;QAC1B,IAAI,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK;YACR,KAAK,GAAG,kBAAkB,IAAI,CAAC,WAAW,GAAG,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzBD,8CAyBC","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 Core\r\n */\r\n\r\nimport { BentleyError, GetMetaDataFunction } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Status codes used by Presentation APIs.\r\n * @public\r\n */\r\nexport enum PresentationStatus {\r\n  /** Success result. */\r\n  Success = 0,\r\n\r\n  /** Request was cancelled. */\r\n  Canceled = 1,\r\n\r\n  /** Error: Unknown */\r\n  Error = 0x10000,\r\n\r\n  /** Error: Backend is not initialized. */\r\n  NotInitialized = Error + 1,\r\n\r\n  /** Error: Argument is invalid. */\r\n  InvalidArgument = Error + 3,\r\n\r\n  /**\r\n   * Timeout for the request was reached which prevented it from being fulfilled. Frontend may\r\n   * repeat the request.\r\n   */\r\n  BackendTimeout = Error + 7,\r\n}\r\n\r\n/**\r\n * An error type thrown by Presentation APIs.\r\n * @public\r\n */\r\nexport class PresentationError extends BentleyError {\r\n\r\n  /**\r\n   * Creates an instance of Error.\r\n   * @param errorNumber Error code\r\n   * @param message Optional brief description of the error. The `message` property combined with the `name`\r\n   * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.\r\n   * @param log Optional log function which logs the error.\r\n   * @param getMetaData Optional function that returns meta-data related to an error.\r\n   */\r\n  public constructor(errorNumber: PresentationStatus, message?: string, getMetaData?: GetMetaDataFunction) {\r\n    super(errorNumber, message, getMetaData);\r\n  }\r\n\r\n  /**\r\n   * Returns the name of each error status. The name is used by the `Error.prototype.toString()`\r\n   * method to create a string representation of the error.\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  protected override _initName(): string {\r\n    let value = PresentationStatus[this.errorNumber];\r\n    if (!value)\r\n      value = `Unknown Error (${this.errorNumber})`;\r\n    return value;\r\n  }\r\n}\r\n"]}

package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts

@@ -1,94 +1,94 @@
-/** @packageDocumentation
- * @module Core
- */
-import { StrippedRelationshipPath } from "./EC";
-/**
- * Definition of an instance filter that can be used to filter content or hierarchy levels.
- *
- * Example:
- *
- * ```json
- * {
- *   selectClassName: "MySchema:MyClass",
- *   expression: "this.MyProperty = 1 AND other.OtherProperty = 2",
- *   relatedInstances: [{
- *     pathFromSelectToPropertyClass: [{
- *         sourceClassName: "MySchema:MyClass",
- *         relationshipName: "MySchema:RelationshipFromMyToOtherClass",
- *         isForwardRelationship: true,
- *         targetClassName: "MySchema:OtherClass",
- *     }],
- *     alias: "other",
- *   }],
- * }
- * ```
- *
- * @beta
- */
-export interface InstanceFilterDefinition {
-    /**
-     * Select class filter used to select only instances of specific class.
-     * The [[relatedInstances]] attribute, when used, should specify paths from this class.
-     * Also, the [[expression]] attribute's `this` symbol points to instances of this class.
-     *
-     * The format is full class name: `SchemaName:ClassName`.
-     */
-    selectClassName: string;
-    /**
-     * Specifies relationship paths pointing to related instances used in the [[expression]] attribute.
-     *
-     * Sometimes there's a need to filter on a related instance property. In that case, the relationship
-     * needs to be named by specifying the path and alias for the target (or the relationship). Then, the
-     * related instance's symbol context can be accessed through the root symbol named as specified in the
-     * [[alias]] (or [[relationshipAlias]]) attribute.
-     */
-    relatedInstances?: InstanceFilterRelatedInstanceDefinition[];
-    /**
-     * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.
-     */
-    expression: string;
-}
-/**
- * Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].
- * @beta
- */
-export declare type InstanceFilterRelatedInstanceDefinition = InstanceFilterRelatedInstancePath & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);
-/**
- * Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].
- * @beta
- */
-export interface InstanceFilterRelatedInstancePath {
-    /**
-     * A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)
-     * to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].
-     */
-    pathFromSelectToPropertyClass: StrippedRelationshipPath;
-    /**
-     * An optional flag indicating that the target instance must exist. Setting this allows to filter out all
-     * select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.
-     */
-    isRequired?: boolean;
-}
-/**
- * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.
- * @beta
- */
-export interface InstanceFilterRelatedInstanceTargetAlias {
-    /**
-     * An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to
-     * access related instance symbols context in the [[InstanceFilterDefinition.expression]].
-     */
-    alias: string;
-}
-/**
- * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.
- * @beta
- */
-export interface InstanceFilterRelatedInstanceRelationshipAlias {
-    /**
-     * An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be
-     * used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].
-     */
-    relationshipAlias: string;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { StrippedRelationshipPath } from "./EC";
+/**
+ * Definition of an instance filter that can be used to filter content or hierarchy levels.
+ *
+ * Example:
+ *
+ * ```json
+ * {
+ *   selectClassName: "MySchema:MyClass",
+ *   expression: "this.MyProperty = 1 AND other.OtherProperty = 2",
+ *   relatedInstances: [{
+ *     pathFromSelectToPropertyClass: [{
+ *         sourceClassName: "MySchema:MyClass",
+ *         relationshipName: "MySchema:RelationshipFromMyToOtherClass",
+ *         isForwardRelationship: true,
+ *         targetClassName: "MySchema:OtherClass",
+ *     }],
+ *     alias: "other",
+ *   }],
+ * }
+ * ```
+ *
+ * @beta
+ */
+export interface InstanceFilterDefinition {
+    /**
+     * Select class filter used to select only instances of specific class.
+     * The [[relatedInstances]] attribute, when used, should specify paths from this class.
+     * Also, the [[expression]] attribute's `this` symbol points to instances of this class.
+     *
+     * The format is full class name: `SchemaName:ClassName`.
+     */
+    selectClassName: string;
+    /**
+     * Specifies relationship paths pointing to related instances used in the [[expression]] attribute.
+     *
+     * Sometimes there's a need to filter on a related instance property. In that case, the relationship
+     * needs to be named by specifying the path and alias for the target (or the relationship). Then, the
+     * related instance's symbol context can be accessed through the root symbol named as specified in the
+     * [[alias]] (or [[relationshipAlias]]) attribute.
+     */
+    relatedInstances?: InstanceFilterRelatedInstanceDefinition[];
+    /**
+     * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.
+     */
+    expression: string;
+}
+/**
+ * Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].
+ * @beta
+ */
+export declare type InstanceFilterRelatedInstanceDefinition = InstanceFilterRelatedInstancePath & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);
+/**
+ * Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].
+ * @beta
+ */
+export interface InstanceFilterRelatedInstancePath {
+    /**
+     * A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)
+     * to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].
+     */
+    pathFromSelectToPropertyClass: StrippedRelationshipPath;
+    /**
+     * An optional flag indicating that the target instance must exist. Setting this allows to filter out all
+     * select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.
+     */
+    isRequired?: boolean;
+}
+/**
+ * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.
+ * @beta
+ */
+export interface InstanceFilterRelatedInstanceTargetAlias {
+    /**
+     * An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to
+     * access related instance symbols context in the [[InstanceFilterDefinition.expression]].
+     */
+    alias: string;
+}
+/**
+ * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.
+ * @beta
+ */
+export interface InstanceFilterRelatedInstanceRelationshipAlias {
+    /**
+     * An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be
+     * used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].
+     */
+    relationshipAlias: string;
+}
 //# sourceMappingURL=InstanceFilterDefinition.d.ts.map

package/lib/cjs/presentation-common/InstanceFilterDefinition.js

@@ -1,10 +1,10 @@
-"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 Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"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 Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=InstanceFilterDefinition.js.map

package/lib/cjs/presentation-common/InstanceFilterDefinition.js.map

@@ -1 +1 @@
-{"version":3,"file":"InstanceFilterDefinition.js","sourceRoot":"","sources":["../../../src/presentation-common/InstanceFilterDefinition.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Core\n */\n\nimport { StrippedRelationshipPath } from \"./EC\";\n\n/**\n * Definition of an instance filter that can be used to filter content or hierarchy levels.\n *\n * Example:\n *\n * ```json\n * {\n *   selectClassName: \"MySchema:MyClass\",\n *   expression: \"this.MyProperty = 1 AND other.OtherProperty = 2\",\n *   relatedInstances: [{\n *     pathFromSelectToPropertyClass: [{\n *         sourceClassName: \"MySchema:MyClass\",\n *         relationshipName: \"MySchema:RelationshipFromMyToOtherClass\",\n *         isForwardRelationship: true,\n *         targetClassName: \"MySchema:OtherClass\",\n *     }],\n *     alias: \"other\",\n *   }],\n * }\n * ```\n *\n * @beta\n */\nexport interface InstanceFilterDefinition {\n  /**\n   * Select class filter used to select only instances of specific class.\n   * The [[relatedInstances]] attribute, when used, should specify paths from this class.\n   * Also, the [[expression]] attribute's `this` symbol points to instances of this class.\n   *\n   * The format is full class name: `SchemaName:ClassName`.\n   */\n  selectClassName: string;\n\n  /**\n   * Specifies relationship paths pointing to related instances used in the [[expression]] attribute.\n   *\n   * Sometimes there's a need to filter on a related instance property. In that case, the relationship\n   * needs to be named by specifying the path and alias for the target (or the relationship). Then, the\n   * related instance's symbol context can be accessed through the root symbol named as specified in the\n   * [[alias]] (or [[relationshipAlias]]) attribute.\n   */\n  relatedInstances?: InstanceFilterRelatedInstanceDefinition[];\n\n  /**\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.\n   */\n  expression: string;\n}\n\n/**\n * Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].\n * @beta\n */\nexport type InstanceFilterRelatedInstanceDefinition =\n  InstanceFilterRelatedInstancePath\n  & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);\n\n/**\n * Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].\n * @beta\n */\nexport interface InstanceFilterRelatedInstancePath {\n  /**\n   * A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)\n   * to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].\n   */\n  pathFromSelectToPropertyClass: StrippedRelationshipPath;\n  /**\n   * An optional flag indicating that the target instance must exist. Setting this allows to filter out all\n   * select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.\n   */\n  isRequired?: boolean;\n}\n\n/**\n * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.\n * @beta\n */\nexport interface InstanceFilterRelatedInstanceTargetAlias {\n  /**\n   * An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to\n   * access related instance symbols context in the [[InstanceFilterDefinition.expression]].\n   */\n  alias: string;\n}\n\n/**\n * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.\n * @beta\n */\nexport interface InstanceFilterRelatedInstanceRelationshipAlias {\n  /**\n   * An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be\n   * used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].\n   */\n  relationshipAlias: string;\n}\n"]}
+{"version":3,"file":"InstanceFilterDefinition.js","sourceRoot":"","sources":["../../../src/presentation-common/InstanceFilterDefinition.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Core\r\n */\r\n\r\nimport { StrippedRelationshipPath } from \"./EC\";\r\n\r\n/**\r\n * Definition of an instance filter that can be used to filter content or hierarchy levels.\r\n *\r\n * Example:\r\n *\r\n * ```json\r\n * {\r\n *   selectClassName: \"MySchema:MyClass\",\r\n *   expression: \"this.MyProperty = 1 AND other.OtherProperty = 2\",\r\n *   relatedInstances: [{\r\n *     pathFromSelectToPropertyClass: [{\r\n *         sourceClassName: \"MySchema:MyClass\",\r\n *         relationshipName: \"MySchema:RelationshipFromMyToOtherClass\",\r\n *         isForwardRelationship: true,\r\n *         targetClassName: \"MySchema:OtherClass\",\r\n *     }],\r\n *     alias: \"other\",\r\n *   }],\r\n * }\r\n * ```\r\n *\r\n * @beta\r\n */\r\nexport interface InstanceFilterDefinition {\r\n  /**\r\n   * Select class filter used to select only instances of specific class.\r\n   * The [[relatedInstances]] attribute, when used, should specify paths from this class.\r\n   * Also, the [[expression]] attribute's `this` symbol points to instances of this class.\r\n   *\r\n   * The format is full class name: `SchemaName:ClassName`.\r\n   */\r\n  selectClassName: string;\r\n\r\n  /**\r\n   * Specifies relationship paths pointing to related instances used in the [[expression]] attribute.\r\n   *\r\n   * Sometimes there's a need to filter on a related instance property. In that case, the relationship\r\n   * needs to be named by specifying the path and alias for the target (or the relationship). Then, the\r\n   * related instance's symbol context can be accessed through the root symbol named as specified in the\r\n   * [[alias]] (or [[relationshipAlias]]) attribute.\r\n   */\r\n  relatedInstances?: InstanceFilterRelatedInstanceDefinition[];\r\n\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.\r\n   */\r\n  expression: string;\r\n}\r\n\r\n/**\r\n * Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].\r\n * @beta\r\n */\r\nexport type InstanceFilterRelatedInstanceDefinition =\r\n  InstanceFilterRelatedInstancePath\r\n  & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);\r\n\r\n/**\r\n * Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].\r\n * @beta\r\n */\r\nexport interface InstanceFilterRelatedInstancePath {\r\n  /**\r\n   * A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)\r\n   * to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].\r\n   */\r\n  pathFromSelectToPropertyClass: StrippedRelationshipPath;\r\n  /**\r\n   * An optional flag indicating that the target instance must exist. Setting this allows to filter out all\r\n   * select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n\r\n/**\r\n * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.\r\n * @beta\r\n */\r\nexport interface InstanceFilterRelatedInstanceTargetAlias {\r\n  /**\r\n   * An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to\r\n   * access related instance symbols context in the [[InstanceFilterDefinition.expression]].\r\n   */\r\n  alias: string;\r\n}\r\n\r\n/**\r\n * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.\r\n * @beta\r\n */\r\nexport interface InstanceFilterRelatedInstanceRelationshipAlias {\r\n  /**\r\n   * An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be\r\n   * used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].\r\n   */\r\n  relationshipAlias: string;\r\n}\r\n"]}