@itwin/presentation-backend 3.5.0-dev.11 → 3.5.0-dev.13

package/lib/cjs/presentation-backend/ElementPropertiesHelper.d.ts

@@ -1,12 +1,12 @@
-/** @packageDocumentation
- * @module Core
- */
-import { IModelDb } from "@itwin/core-backend";
-import { Content, ElementProperties } from "@itwin/presentation-common";
-/** @internal */
-export declare const buildElementsProperties: (content: Content | undefined) => ElementProperties[];
-/** @internal */
-export declare function getElementsCount(db: IModelDb, classNames?: string[]): number;
-/** @internal */
-export declare function iterateElementIds(db: IModelDb, classNames?: string[], limit?: number): Generator<Map<string, string[]>, void, unknown>;
+/** @packageDocumentation
+ * @module Core
+ */
+import { IModelDb } from "@itwin/core-backend";
+import { Content, ElementProperties } from "@itwin/presentation-common";
+/** @internal */
+export declare const buildElementsProperties: (content: Content | undefined) => ElementProperties[];
+/** @internal */
+export declare function getElementsCount(db: IModelDb, classNames?: string[]): number;
+/** @internal */
+export declare function iterateElementIds(db: IModelDb, classNames?: string[], limit?: number): Generator<Map<string, string[]>, void, unknown>;
 //# sourceMappingURL=ElementPropertiesHelper.d.ts.map

package/lib/cjs/presentation-backend/ElementPropertiesHelper.js

@@ -1,275 +1,275 @@
-"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.iterateElementIds = exports.getElementsCount = exports.buildElementsProperties = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const presentation_common_1 = require("@itwin/presentation-common");
-/** @internal */
-const buildElementsProperties = (content) => {
-    if (!content || content.contentSet.length === 0)
-        return [];
-    const builder = new ElementPropertiesBuilder();
-    (0, presentation_common_1.traverseContent)(builder, content);
-    return builder.items;
-};
-exports.buildElementsProperties = buildElementsProperties;
-/** @internal */
-function getElementsCount(db, classNames) {
-    const filter = createElementsFilter("e", classNames);
-    const query = `
-    SELECT COUNT(e.ECInstanceId)
-    FROM bis.Element e
-    ${filter ? `WHERE ${filter}` : ""}
-  `;
-    return db.withPreparedStatement(query, (stmt) => {
-        return stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW ? stmt.getValue(0).getInteger() : 0;
-    });
-}
-exports.getElementsCount = getElementsCount;
-/** @internal */
-function* iterateElementIds(db, classNames, limit) {
-    let lastElementId;
-    while (true) {
-        const result = queryElementIds(db, classNames, limit, lastElementId);
-        yield result.ids;
-        lastElementId = result.lastElementId;
-        if (!lastElementId)
-            break;
-    }
-}
-exports.iterateElementIds = iterateElementIds;
-function queryElementIds(db, classNames, limit, lastElementId) {
-    function createWhereClause() {
-        const classFilter = createElementsFilter("e", classNames);
-        const elementFilter = lastElementId ? `e.ECInstanceId > ?` : undefined;
-        if (!classFilter && !elementFilter)
-            return "";
-        if (classFilter && elementFilter)
-            return `WHERE ${classFilter} AND ${elementFilter}`;
-        return `WHERE ${classFilter !== null && classFilter !== void 0 ? classFilter : ""} ${elementFilter !== null && elementFilter !== void 0 ? elementFilter : ""}`;
-    }
-    const query = `
-    SELECT e.ECInstanceId elId, eSchemaDef.Name || ':' || eClassDef.Name elClassName
-    FROM bis.Element e
-    LEFT JOIN meta.ECClassDef eClassDef ON eClassDef.ECInstanceId = e.ECClassId
-    LEFT JOIN meta.ECSchemaDef eSchemaDef ON eSchemaDef.ECInstanceId = eClassDef.Schema.Id
-    ${createWhereClause()}
-    ORDER BY e.ECInstanceId ASC
-  `;
-    return db.withPreparedStatement(query, (stmt) => {
-        if (lastElementId)
-            stmt.bindId(1, lastElementId);
-        const ids = new Map();
-        let currentClassName = "";
-        let currentIds = [];
-        let loadedIds = 0;
-        while (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
-            const row = stmt.getRow();
-            if (!row.elId || !row.elClassName)
-                continue;
-            if (currentClassName !== row.elClassName) {
-                currentClassName = row.elClassName;
-                const existingIds = ids.get(row.elClassName);
-                if (!existingIds) {
-                    currentIds = [];
-                    ids.set(row.elClassName, currentIds);
-                }
-                else {
-                    currentIds = existingIds;
-                }
-            }
-            currentIds.push(row.elId);
-            loadedIds++;
-            if (limit && loadedIds >= limit)
-                return { ids, lastElementId: row.elId };
-        }
-        return { ids, lastElementId: undefined };
-    });
-}
-function createElementsFilter(elementAlias, classNames) {
-    if (classNames === undefined || classNames.length === 0)
-        return undefined;
-    // check if list contains only valid class names
-    const classNameRegExp = new RegExp(/^[\w]+[.:][\w]+$/);
-    const invalidName = classNames.find((name) => !name.match(classNameRegExp));
-    if (invalidName) {
-        throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.InvalidArgument, `Encountered invalid class name - ${invalidName}.
-      Valid class name formats: "<schema name or alias>.<class name>", "<schema name or alias>:<class name>"`);
-    }
-    return `${elementAlias}.ECClassId IS (${classNames.join(",")})`;
-}
-class ElementPropertiesAppender {
-    constructor(_item, _onItemFinished) {
-        this._item = _item;
-        this._onItemFinished = _onItemFinished;
-        this._propertyItems = {};
-        this._categoryItemAppenders = {};
-    }
-    append(label, item) {
-        this._propertyItems[label] = item;
-    }
-    finish() {
-        var _a, _b, _c, _d;
-        // eslint-disable-next-line guard-for-in
-        for (const categoryName in this._categoryItemAppenders) {
-            const appender = this._categoryItemAppenders[categoryName];
-            appender.finish();
-        }
-        this._onItemFinished({
-            class: (_b = (_a = this._item.classInfo) === null || _a === void 0 ? void 0 : _a.label) !== null && _b !== void 0 ? _b : "",
-            id: (_d = (_c = this._item.primaryKeys[0]) === null || _c === void 0 ? void 0 : _c.id) !== null && _d !== void 0 ? _d : core_bentley_1.Id64.invalid,
-            label: this._item.label.displayValue,
-            items: this._propertyItems,
-        });
-    }
-    getCategoryAppender(parentAppender, category) {
-        let appender = this._categoryItemAppenders[category.name];
-        if (!appender) {
-            appender = new CategoryItemAppender(parentAppender, category);
-            this._categoryItemAppenders[category.name] = appender;
-        }
-        return appender;
-    }
-}
-class CategoryItemAppender {
-    constructor(_parentAppender, _category) {
-        this._parentAppender = _parentAppender;
-        this._category = _category;
-        this._items = {};
-    }
-    append(label, item) {
-        this._items[label] = item;
-    }
-    finish() {
-        if (Object.keys(this._items).length === 0)
-            return;
-        this._parentAppender.append(this._category.label, {
-            type: "category",
-            items: this._items,
-        });
-    }
-}
-class ArrayItemAppender {
-    constructor(_parentAppender, _props) {
-        this._parentAppender = _parentAppender;
-        this._props = _props;
-        this._items = [];
-    }
-    append(_label, item) {
-        (0, core_bentley_1.assert)(item.type !== "category");
-        this._items.push(item);
-    }
-    finish() {
-        (0, core_bentley_1.assert)(this._props.valueType.valueFormat === presentation_common_1.PropertyValueFormat.Array);
-        if (this._props.valueType.memberType.valueFormat === presentation_common_1.PropertyValueFormat.Primitive)
-            this._parentAppender.append(this._props.hierarchy.field.label, this.createPrimitivesArray());
-        else
-            this._parentAppender.append(this._props.hierarchy.field.label, this.createStructsArray());
-    }
-    createPrimitivesArray() {
-        return {
-            type: "array",
-            valueType: "primitive",
-            values: this._items.map((item) => {
-                (0, core_bentley_1.assert)(item.type === "primitive");
-                return item.value;
-            }),
-        };
-    }
-    createStructsArray() {
-        return {
-            type: "array",
-            valueType: "struct",
-            values: this._items.map((item) => {
-                (0, core_bentley_1.assert)(item.type === "struct");
-                return item.members;
-            }),
-        };
-    }
-}
-class StructItemAppender {
-    constructor(_parentAppender, _props) {
-        this._parentAppender = _parentAppender;
-        this._props = _props;
-        this._members = {};
-    }
-    append(label, item) {
-        (0, core_bentley_1.assert)(item.type !== "category");
-        this._members[label] = item;
-    }
-    finish() {
-        (0, core_bentley_1.assert)(this._props.valueType.valueFormat === presentation_common_1.PropertyValueFormat.Struct);
-        this._parentAppender.append(this._props.hierarchy.field.label, {
-            type: "struct",
-            members: this._members,
-        });
-    }
-}
-class ElementPropertiesBuilder {
-    constructor() {
-        this._appendersStack = [];
-        this._items = [];
-    }
-    get items() {
-        return this._items;
-    }
-    get _currentAppender() {
-        const appender = this._appendersStack[this._appendersStack.length - 1];
-        (0, core_bentley_1.assert)(appender !== undefined);
-        return appender;
-    }
-    startContent(_props) { return true; }
-    finishContent() { }
-    processFieldHierarchies(_props) { }
-    startItem(props) {
-        this._elementPropertiesAppender = new ElementPropertiesAppender(props.item, (item) => this._items.push(item));
-        this._appendersStack.push(this._elementPropertiesAppender);
-        return true;
-    }
-    finishItem() {
-        this._appendersStack.pop();
-        (0, core_bentley_1.assert)(this._elementPropertiesAppender !== undefined);
-        this._elementPropertiesAppender.finish();
-        this._elementPropertiesAppender = undefined;
-    }
-    startCategory(props) {
-        (0, core_bentley_1.assert)(this._elementPropertiesAppender !== undefined);
-        this._appendersStack.push(this._elementPropertiesAppender.getCategoryAppender(this._currentAppender, props.category));
-        return true;
-    }
-    finishCategory() {
-        this._appendersStack.pop();
-    }
-    startField(_props) { return true; }
-    finishField() { }
-    startStruct(props) {
-        this._appendersStack.push(new StructItemAppender(this._currentAppender, props));
-        return true;
-    }
-    finishStruct() { this._appendersStack.pop().finish(); }
-    startArray(props) {
-        this._appendersStack.push(new ArrayItemAppender(this._currentAppender, props));
-        return true;
-    }
-    finishArray() { this._appendersStack.pop().finish(); }
-    processMergedValue(props) {
-        this._currentAppender.append(props.mergedField.label, {
-            type: "primitive",
-            value: "",
-        });
-    }
-    processPrimitiveValue(props) {
-        var _a, _b;
-        this._currentAppender.append(props.field.label, {
-            type: "primitive",
-            value: (_b = (_a = props.displayValue) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "",
-        });
-    }
-}
+"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.iterateElementIds = exports.getElementsCount = exports.buildElementsProperties = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const presentation_common_1 = require("@itwin/presentation-common");
+/** @internal */
+const buildElementsProperties = (content) => {
+    if (!content || content.contentSet.length === 0)
+        return [];
+    const builder = new ElementPropertiesBuilder();
+    (0, presentation_common_1.traverseContent)(builder, content);
+    return builder.items;
+};
+exports.buildElementsProperties = buildElementsProperties;
+/** @internal */
+function getElementsCount(db, classNames) {
+    const filter = createElementsFilter("e", classNames);
+    const query = `
+    SELECT COUNT(e.ECInstanceId)
+    FROM bis.Element e
+    ${filter ? `WHERE ${filter}` : ""}
+  `;
+    return db.withPreparedStatement(query, (stmt) => {
+        return stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW ? stmt.getValue(0).getInteger() : 0;
+    });
+}
+exports.getElementsCount = getElementsCount;
+/** @internal */
+function* iterateElementIds(db, classNames, limit) {
+    let lastElementId;
+    while (true) {
+        const result = queryElementIds(db, classNames, limit, lastElementId);
+        yield result.ids;
+        lastElementId = result.lastElementId;
+        if (!lastElementId)
+            break;
+    }
+}
+exports.iterateElementIds = iterateElementIds;
+function queryElementIds(db, classNames, limit, lastElementId) {
+    function createWhereClause() {
+        const classFilter = createElementsFilter("e", classNames);
+        const elementFilter = lastElementId ? `e.ECInstanceId > ?` : undefined;
+        if (!classFilter && !elementFilter)
+            return "";
+        if (classFilter && elementFilter)
+            return `WHERE ${classFilter} AND ${elementFilter}`;
+        return `WHERE ${classFilter !== null && classFilter !== void 0 ? classFilter : ""} ${elementFilter !== null && elementFilter !== void 0 ? elementFilter : ""}`;
+    }
+    const query = `
+    SELECT e.ECInstanceId elId, eSchemaDef.Name || ':' || eClassDef.Name elClassName
+    FROM bis.Element e
+    LEFT JOIN meta.ECClassDef eClassDef ON eClassDef.ECInstanceId = e.ECClassId
+    LEFT JOIN meta.ECSchemaDef eSchemaDef ON eSchemaDef.ECInstanceId = eClassDef.Schema.Id
+    ${createWhereClause()}
+    ORDER BY e.ECInstanceId ASC
+  `;
+    return db.withPreparedStatement(query, (stmt) => {
+        if (lastElementId)
+            stmt.bindId(1, lastElementId);
+        const ids = new Map();
+        let currentClassName = "";
+        let currentIds = [];
+        let loadedIds = 0;
+        while (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+            const row = stmt.getRow();
+            if (!row.elId || !row.elClassName)
+                continue;
+            if (currentClassName !== row.elClassName) {
+                currentClassName = row.elClassName;
+                const existingIds = ids.get(row.elClassName);
+                if (!existingIds) {
+                    currentIds = [];
+                    ids.set(row.elClassName, currentIds);
+                }
+                else {
+                    currentIds = existingIds;
+                }
+            }
+            currentIds.push(row.elId);
+            loadedIds++;
+            if (limit && loadedIds >= limit)
+                return { ids, lastElementId: row.elId };
+        }
+        return { ids, lastElementId: undefined };
+    });
+}
+function createElementsFilter(elementAlias, classNames) {
+    if (classNames === undefined || classNames.length === 0)
+        return undefined;
+    // check if list contains only valid class names
+    const classNameRegExp = new RegExp(/^[\w]+[.:][\w]+$/);
+    const invalidName = classNames.find((name) => !name.match(classNameRegExp));
+    if (invalidName) {
+        throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.InvalidArgument, `Encountered invalid class name - ${invalidName}.
+      Valid class name formats: "<schema name or alias>.<class name>", "<schema name or alias>:<class name>"`);
+    }
+    return `${elementAlias}.ECClassId IS (${classNames.join(",")})`;
+}
+class ElementPropertiesAppender {
+    constructor(_item, _onItemFinished) {
+        this._item = _item;
+        this._onItemFinished = _onItemFinished;
+        this._propertyItems = {};
+        this._categoryItemAppenders = {};
+    }
+    append(label, item) {
+        this._propertyItems[label] = item;
+    }
+    finish() {
+        var _a, _b, _c, _d;
+        // eslint-disable-next-line guard-for-in
+        for (const categoryName in this._categoryItemAppenders) {
+            const appender = this._categoryItemAppenders[categoryName];
+            appender.finish();
+        }
+        this._onItemFinished({
+            class: (_b = (_a = this._item.classInfo) === null || _a === void 0 ? void 0 : _a.label) !== null && _b !== void 0 ? _b : "",
+            id: (_d = (_c = this._item.primaryKeys[0]) === null || _c === void 0 ? void 0 : _c.id) !== null && _d !== void 0 ? _d : core_bentley_1.Id64.invalid,
+            label: this._item.label.displayValue,
+            items: this._propertyItems,
+        });
+    }
+    getCategoryAppender(parentAppender, category) {
+        let appender = this._categoryItemAppenders[category.name];
+        if (!appender) {
+            appender = new CategoryItemAppender(parentAppender, category);
+            this._categoryItemAppenders[category.name] = appender;
+        }
+        return appender;
+    }
+}
+class CategoryItemAppender {
+    constructor(_parentAppender, _category) {
+        this._parentAppender = _parentAppender;
+        this._category = _category;
+        this._items = {};
+    }
+    append(label, item) {
+        this._items[label] = item;
+    }
+    finish() {
+        if (Object.keys(this._items).length === 0)
+            return;
+        this._parentAppender.append(this._category.label, {
+            type: "category",
+            items: this._items,
+        });
+    }
+}
+class ArrayItemAppender {
+    constructor(_parentAppender, _props) {
+        this._parentAppender = _parentAppender;
+        this._props = _props;
+        this._items = [];
+    }
+    append(_label, item) {
+        (0, core_bentley_1.assert)(item.type !== "category");
+        this._items.push(item);
+    }
+    finish() {
+        (0, core_bentley_1.assert)(this._props.valueType.valueFormat === presentation_common_1.PropertyValueFormat.Array);
+        if (this._props.valueType.memberType.valueFormat === presentation_common_1.PropertyValueFormat.Primitive)
+            this._parentAppender.append(this._props.hierarchy.field.label, this.createPrimitivesArray());
+        else
+            this._parentAppender.append(this._props.hierarchy.field.label, this.createStructsArray());
+    }
+    createPrimitivesArray() {
+        return {
+            type: "array",
+            valueType: "primitive",
+            values: this._items.map((item) => {
+                (0, core_bentley_1.assert)(item.type === "primitive");
+                return item.value;
+            }),
+        };
+    }
+    createStructsArray() {
+        return {
+            type: "array",
+            valueType: "struct",
+            values: this._items.map((item) => {
+                (0, core_bentley_1.assert)(item.type === "struct");
+                return item.members;
+            }),
+        };
+    }
+}
+class StructItemAppender {
+    constructor(_parentAppender, _props) {
+        this._parentAppender = _parentAppender;
+        this._props = _props;
+        this._members = {};
+    }
+    append(label, item) {
+        (0, core_bentley_1.assert)(item.type !== "category");
+        this._members[label] = item;
+    }
+    finish() {
+        (0, core_bentley_1.assert)(this._props.valueType.valueFormat === presentation_common_1.PropertyValueFormat.Struct);
+        this._parentAppender.append(this._props.hierarchy.field.label, {
+            type: "struct",
+            members: this._members,
+        });
+    }
+}
+class ElementPropertiesBuilder {
+    constructor() {
+        this._appendersStack = [];
+        this._items = [];
+    }
+    get items() {
+        return this._items;
+    }
+    get _currentAppender() {
+        const appender = this._appendersStack[this._appendersStack.length - 1];
+        (0, core_bentley_1.assert)(appender !== undefined);
+        return appender;
+    }
+    startContent(_props) { return true; }
+    finishContent() { }
+    processFieldHierarchies(_props) { }
+    startItem(props) {
+        this._elementPropertiesAppender = new ElementPropertiesAppender(props.item, (item) => this._items.push(item));
+        this._appendersStack.push(this._elementPropertiesAppender);
+        return true;
+    }
+    finishItem() {
+        this._appendersStack.pop();
+        (0, core_bentley_1.assert)(this._elementPropertiesAppender !== undefined);
+        this._elementPropertiesAppender.finish();
+        this._elementPropertiesAppender = undefined;
+    }
+    startCategory(props) {
+        (0, core_bentley_1.assert)(this._elementPropertiesAppender !== undefined);
+        this._appendersStack.push(this._elementPropertiesAppender.getCategoryAppender(this._currentAppender, props.category));
+        return true;
+    }
+    finishCategory() {
+        this._appendersStack.pop();
+    }
+    startField(_props) { return true; }
+    finishField() { }
+    startStruct(props) {
+        this._appendersStack.push(new StructItemAppender(this._currentAppender, props));
+        return true;
+    }
+    finishStruct() { this._appendersStack.pop().finish(); }
+    startArray(props) {
+        this._appendersStack.push(new ArrayItemAppender(this._currentAppender, props));
+        return true;
+    }
+    finishArray() { this._appendersStack.pop().finish(); }
+    processMergedValue(props) {
+        this._currentAppender.append(props.mergedField.label, {
+            type: "primitive",
+            value: "",
+        });
+    }
+    processPrimitiveValue(props) {
+        var _a, _b;
+        this._currentAppender.append(props.field.label, {
+            type: "primitive",
+            value: (_b = (_a = props.displayValue) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "",
+        });
+    }
+}
 //# sourceMappingURL=ElementPropertiesHelper.js.map