@itwin/presentation-hierarchies 0.1.0

package/lib/esm/hierarchies/Logging.js

@@ -0,0 +1,23 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { NOOP_LOGGER } from "@itwin/presentation-shared";
+// eslint-disable-next-line @typescript-eslint/naming-convention
+let g_logger = NOOP_LOGGER;
+/**
+ * Set logger to use by this package. By default the package uses a no-op logger.
+ * @beta
+ */
+export function setLogger(logger) {
+    g_logger = logger ?? /* istanbul ignore next */ NOOP_LOGGER;
+}
+/**
+ * Get logger used by this package.
+ * @see `setLogger`
+ * @beta
+ */
+export function getLogger() {
+    return g_logger;
+}
+//# sourceMappingURL=Logging.js.map

package/lib/esm/hierarchies/Logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.js","sourceRoot":"","sources":["../../../src/hierarchies/Logging.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAW,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAElE,gEAAgE;AAChE,IAAI,QAAQ,GAAY,WAAW,CAAC;AAEpC;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,MAA2B;IACnD,QAAQ,GAAG,MAAM,IAAI,0BAA0B,CAAC,WAAW,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,QAAQ,CAAC;AAClB,CAAC","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\nimport { ILogger, NOOP_LOGGER } from \"@itwin/presentation-shared\";\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nlet g_logger: ILogger = NOOP_LOGGER;\n\n/**\n * Set logger to use by this package. By default the package uses a no-op logger.\n * @beta\n */\nexport function setLogger(logger: ILogger | undefined) {\n  g_logger = logger ?? /* istanbul ignore next */ NOOP_LOGGER;\n}\n\n/**\n * Get logger used by this package.\n * @see `setLogger`\n * @beta\n */\nexport function getLogger(): ILogger {\n  return g_logger;\n}\n"]}

package/lib/esm/hierarchies/NodeSelectQueryFactory.d.ts

@@ -0,0 +1,205 @@
+import { Id64String } from "@itwin/core-bentley";
+import { GenericInstanceFilter } from "@itwin/core-common";
+import { ECClassHierarchyInspector, ECSchemaProvider } from "@itwin/presentation-shared";
+/**
+ * Column names of the SELECT clause created by `NodeSelectClauseFactory`. Order of the names matches the order of columns
+ * created by the factory.
+ *
+ * @beta
+ */
+export declare enum NodeSelectClauseColumnNames {
+    /** Full class name of the instance the node represents. Type: `string` in format `{schema name}:{class name}`. */
+    FullClassName = "FullClassName",
+    /** ECInstance ID of the instance the node represents. Type: `Id64String`. */
+    ECInstanceId = "ECInstanceId",
+    /** Display label. Type: `string`. */
+    DisplayLabel = "DisplayLabel",
+    /**
+     * A flag indicating if the node has children. Type: `boolean`. Values:
+     * - `false` - node never has children.
+     * - `true` - node always has children.
+     * - NULL - unknown, needs to be determined by requesting children for the node.
+     */
+    HasChildren = "HasChildren",
+    /** A flag indicating that a node should be hidden if it has no children. Type: `boolean`. */
+    HideIfNoChildren = "HideIfNoChildren",
+    /** A flag indicating that a node should be hidden and its children should be displayed instead. Type: `boolean`. */
+    HideNodeInHierarchy = "HideNodeInHierarchy",
+    /** A serialized JSON object for providing grouping information. */
+    Grouping = "Grouping",
+    /** A serialized JSON object for associating a node with additional data. */
+    ExtendedData = "ExtendedData",
+    /** A flag indicating the node should be auto-expanded when it's loaded. */
+    AutoExpand = "AutoExpand",
+    /** A flag indicating the node supports child hierarchy level filtering. */
+    SupportsFiltering = "SupportsFiltering"
+}
+/**
+ * A data structure for defining an ECSQL value selector.
+ */
+interface ECSqlValueSelector {
+    selector: string;
+}
+/**
+ * Props for `NodeSelectClauseFactory.createSelectClause`.
+ */
+interface NodeSelectClauseProps {
+    ecClassId: Id64String | ECSqlValueSelector;
+    ecInstanceId: Id64String | ECSqlValueSelector;
+    nodeLabel: string | ECSqlValueSelector;
+    extendedData?: {
+        [key: string]: Id64String | string | number | boolean | ECSqlValueSelector;
+    };
+    autoExpand?: boolean | ECSqlValueSelector;
+    supportsFiltering?: boolean | ECSqlValueSelector;
+    hasChildren?: boolean | ECSqlValueSelector;
+    hideNodeInHierarchy?: boolean | ECSqlValueSelector;
+    hideIfNoChildren?: boolean | ECSqlValueSelector;
+    grouping?: ECSqlSelectClauseGroupingParams;
+}
+/**
+ * A data structure for defining nodes' grouping requirements.
+ */
+interface ECSqlSelectClauseGroupingParams {
+    byLabel?: ECSqlSelectClauseLabelGroupingParams;
+    byClass?: boolean | ECSqlSelectClauseGroupingParamsBase | ECSqlValueSelector;
+    byBaseClasses?: ECSqlSelectClauseBaseClassGroupingParams;
+    byProperties?: ECSqlSelectClausePropertiesGroupingParams;
+}
+/**
+ * A data structure for defining label grouping params.
+ */
+interface ECSqlSelectClauseLabelGroupingBaseParams {
+    /** Label grouping option that determines whether to group nodes or to merge them. Defaults to "group".*/
+    action?: "group" | "merge";
+    /** Id that needs to match for nodes to be grouped or merged.*/
+    groupId?: string | ECSqlValueSelector;
+}
+/**
+ * A data structure for defining label merging.
+ */
+interface ECSqlSelectClauseLabelGroupingMergeParams extends ECSqlSelectClauseLabelGroupingBaseParams {
+    action: "merge";
+}
+/**
+ * A data structure for defining label grouping.
+ */
+interface ECSqlSelectClauseLabelGroupingGroupParams extends ECSqlSelectClauseLabelGroupingBaseParams, ECSqlSelectClauseGroupingParamsBase {
+    action?: "group";
+}
+/**
+ * A data structure for defining possible label grouping types.
+ */
+type ECSqlSelectClauseLabelGroupingParams = boolean | ECSqlValueSelector | ECSqlSelectClauseLabelGroupingMergeParams | ECSqlSelectClauseLabelGroupingGroupParams;
+/**
+ * A data structure for defining base grouping parameters shared across all types of grouping.
+ */
+interface ECSqlSelectClauseGroupingParamsBase {
+    hideIfNoSiblings?: boolean | ECSqlValueSelector;
+    hideIfOneGroupedNode?: boolean | ECSqlValueSelector;
+    autoExpand?: string | ECSqlValueSelector;
+}
+/**
+ * A data structure for defining properties grouping.
+ */
+interface ECSqlSelectClausePropertiesGroupingParams extends ECSqlSelectClauseGroupingParamsBase {
+    /**
+     * Full name of a class whose properties are used to group the node. Only has effect if the node
+     * represents an instance of that class.
+     *
+     * Full class name format: `SchemaName.ClassName`.
+     */
+    propertiesClassName: string;
+    /**
+     * Property grouping option that determines whether to group nodes whose grouping value is not set or is set to an empty string.
+     *
+     * Label of the created grouping node will be `Not Specified`.
+     */
+    createGroupForUnspecifiedValues?: boolean | ECSqlValueSelector;
+    /**
+     * Property grouping option that determines whether to group nodes whose grouping value doesn't fit within any of the provided
+     * ranges, or is not a numeric value.
+     *
+     * Label of the created grouping node will be `Other`.
+     */
+    createGroupForOutOfRangeValues?: boolean | ECSqlValueSelector;
+    /**
+     * Properties of the specified class, by which the nodes should be grouped.
+     *
+     * Example usage:
+     * ```ts
+     * propertyGroups: [
+     *   {
+     *     propertyName: "type",
+     *     propertyClassAlias: "this"
+     *   },
+     *   {
+     *     propertyName: "length",
+     *     propertyClassAlias: "x",
+     *     ranges: [
+     *       { fromValue: 1, toValue: 10, rangeLabel: "Small" },
+     *       { fromValue: 11, toValue: 20, rangeLabel: "Medium" }
+     *     ]
+     *   },
+     * ]
+     * ```
+     */
+    propertyGroups: ECSqlSelectClausePropertyGroup[];
+}
+/**
+ * A data structure for defining specific properties' grouping params.
+ */
+interface ECSqlSelectClausePropertyGroup {
+    /** A string indicating the name of the property to group by. */
+    propertyName: string;
+    /** Alias to of the class containing the property. Used to select the property value. */
+    propertyClassAlias: string;
+    /** Ranges are used to group nodes by numeric properties which are within specified bounds. */
+    ranges?: ECSqlSelectClausePropertyValueRange[];
+}
+/**
+ * A data structure for defining boundaries for a value.
+ */
+interface ECSqlSelectClausePropertyValueRange {
+    /** Defines the lower bound of the range. */
+    fromValue: number | ECSqlValueSelector;
+    /** Defines the upper bound of the range. */
+    toValue: number | ECSqlValueSelector;
+    /** Defines the range label. Will be used as grouping node's display label. */
+    rangeLabel?: string | ECSqlValueSelector;
+}
+/**
+ * A data structure for defining base class grouping.
+ */
+interface ECSqlSelectClauseBaseClassGroupingParams extends ECSqlSelectClauseGroupingParamsBase {
+    fullClassNames: string[] | ECSqlValueSelector[];
+}
+/**
+ * An interface of a factory that knows how to create nodes' select ECSQL query.
+ * @beta
+ */
+export interface NodesQueryClauseFactory {
+    /** Create a SELECT clause in a format understood by nodes query parser used by `HierarchyProvider`. */
+    createSelectClause(props: NodeSelectClauseProps): Promise<string>;
+    /** Create FROM, JOIN and WHERE clauses whose combination results in an ECSQL filter defined by given `GenericInstanceFilter`. */
+    createFilterClauses(props: {
+        contentClass: {
+            fullName: string;
+            alias: string;
+        };
+        filter: GenericInstanceFilter | undefined;
+    }): Promise<{
+        from: string;
+        where: string;
+        joins: string;
+    }>;
+}
+/**
+ * Creates an instance of `NodeSelectQueryFactory` that .
+ * @beta
+ */
+export declare function createNodesQueryClauseFactory(props: {
+    imodelAccess: ECSchemaProvider & ECClassHierarchyInspector;
+}): NodesQueryClauseFactory;
+export {};
+//# sourceMappingURL=NodeSelectQueryFactory.d.ts.map

package/lib/esm/hierarchies/NodeSelectQueryFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeSelectQueryFactory.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/NodeSelectQueryFactory.ts"],"names":[],"mappings":"AAKA,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACL,qBAAqB,EAOtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAM,yBAAyB,EAAE,gBAAgB,EAAuD,MAAM,4BAA4B,CAAC;AAElJ;;;;;GAKG;AACH,oBAAY,2BAA2B;IACrC,kHAAkH;IAClH,aAAa,kBAAkB;IAC/B,6EAA6E;IAC7E,YAAY,iBAAiB;IAC7B,qCAAqC;IACrC,YAAY,iBAAiB;IAC7B;;;;;OAKG;IACH,WAAW,gBAAgB;IAC3B,6FAA6F;IAC7F,gBAAgB,qBAAqB;IACrC,oHAAoH;IACpH,mBAAmB,wBAAwB;IAC3C,mEAAmE;IACnE,QAAQ,aAAa;IACrB,4EAA4E;IAC5E,YAAY,iBAAiB;IAC7B,2EAA2E;IAC3E,UAAU,eAAe;IACzB,2EAA2E;IAC3E,iBAAiB,sBAAsB;CACxC;AAED;;GAEG;AACH,UAAU,kBAAkB;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,UAAU,qBAAqB;IAC7B,SAAS,EAAE,UAAU,GAAG,kBAAkB,CAAC;IAC3C,YAAY,EAAE,UAAU,GAAG,kBAAkB,CAAC;IAC9C,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACvC,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,kBAAkB,CAAC;KAC5E,CAAC;IACF,UAAU,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC1C,iBAAiB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACjD,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C,mBAAmB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACnD,gBAAgB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAChD,QAAQ,CAAC,EAAE,+BAA+B,CAAC;CAC5C;AAED;;GAEG;AACH,UAAU,+BAA+B;IACvC,OAAO,CAAC,EAAE,oCAAoC,CAAC;IAC/C,OAAO,CAAC,EAAE,OAAO,GAAG,mCAAmC,GAAG,kBAAkB,CAAC;IAC7E,aAAa,CAAC,EAAE,wCAAwC,CAAC;IACzD,YAAY,CAAC,EAAE,yCAAyC,CAAC;CAC1D;AAED;;GAEG;AACH,UAAU,wCAAwC;IAChD,yGAAyG;IACzG,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;CACvC;AAED;;GAEG;AACH,UAAU,yCAA0C,SAAQ,wCAAwC;IAClG,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,UAAU,yCAA0C,SAAQ,wCAAwC,EAAE,mCAAmC;IACvI,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,KAAK,oCAAoC,GACrC,OAAO,GACP,kBAAkB,GAClB,yCAAyC,GACzC,yCAAyC,CAAC;AAE9C;;GAEG;AACH,UAAU,mCAAmC;IAC3C,gBAAgB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAChD,oBAAoB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACpD,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;CAC1C;AAED;;GAEG;AACH,UAAU,yCAA0C,SAAQ,mCAAmC;IAC7F;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC/D;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC9D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;GAEG;AACH,UAAU,8BAA8B;IACtC,gEAAgE;IAChE,YAAY,EAAE,MAAM,CAAC;IACrB,wFAAwF;IACxF,kBAAkB,EAAE,MAAM,CAAC;IAC3B,8FAA8F;IAC9F,MAAM,CAAC,EAAE,mCAAmC,EAAE,CAAC;CAChD;AAED;;GAEG;AACH,UAAU,mCAAmC;IAC3C,4CAA4C;IAC5C,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACvC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACrC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;CAC1C;AAED;;GAEG;AACH,UAAU,wCAAyC,SAAQ,mCAAmC;IAC5F,cAAc,EAAE,MAAM,EAAE,GAAG,kBAAkB,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,uGAAuG;IACvG,kBAAkB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElE,iIAAiI;IACjI,mBAAmB,CAAC,KAAK,EAAE;QACzB,YAAY,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC;QAClD,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAAC;KAC3C,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE;IAAE,YAAY,EAAE,gBAAgB,GAAG,yBAAyB,CAAA;CAAE,GAAG,uBAAuB,CAE5I"}