@itwin/core-backend 3.4.0 → 3.4.2

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Thu, 13 Oct 2022 20:24:47 GMT and should not be manually modified.
+This log was last generated on Mon, 24 Oct 2022 13:23:45 GMT and should not be manually modified.
+
+## 3.4.2
+Mon, 24 Oct 2022 13:23:45 GMT
+
+### Updates
+
+- Add asynchronous functions to obtain the extents of geometric models.
+- Return a pending response from calls to IModelReadRpcInterface.getCustomViewState3dData if they take too long.
+
+## 3.4.1
+Mon, 17 Oct 2022 20:06:51 GMT
+
+### Updates
+
+- Add EntityReferences and associated utilities
 
 ## 3.4.0
 Thu, 13 Oct 2022 20:24:47 GMT

package/lib/cjs/ClassRegistry.d.ts

@@ -18,6 +18,7 @@ export declare class ClassRegistry {
     static register(entityClass: typeof Entity, schema: typeof Schema): void;
     /** Generate a proxy Schema for a domain that has not been registered. */
     private static generateProxySchema;
+    private static getRootMetaData;
     /** Generate a JavaScript class from Entity metadata.
      * @param entityMetaData The Entity metadata that defines the class
      */

package/lib/cjs/ClassRegistry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAI3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAgGrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}
+{"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAsB,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAO3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC,OAAO,CAAC,MAAM,CAAC,eAAe;IAe9B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IA0GrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}

package/lib/cjs/ClassRegistry.js

@@ -11,8 +11,9 @@ exports.MetaDataRegistry = exports.ClassRegistry = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const Entity_1 = require("./Entity");
-const Element_1 = require("./Element");
 const Schema_1 = require("./Schema");
+const EntityReferences_1 = require("./EntityReferences");
+const assert = require("assert");
 const isGeneratedClassTag = Symbol("isGeneratedClassTag");
 /** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
  * @public
@@ -52,6 +53,21 @@ class ClassRegistry {
         Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
         return schemaClass;
     }
+    static getRootMetaData(iModel, entityMetaData) {
+        var _a;
+        let rootClassMetaData = entityMetaData;
+        while (true) {
+            if (rootClassMetaData.baseClasses.length === 0)
+                break;
+            const firstBase = iModel.getMetaData(rootClassMetaData.baseClasses[0]);
+            const firstBaseIsMixin = (_a = firstBase.customAttributes) === null || _a === void 0 ? void 0 : _a.some((ca) => ca.ecclass === "IsMixin");
+            if (firstBaseIsMixin)
+                break;
+            else
+                rootClassMetaData = firstBase;
+        }
+        return rootClassMetaData;
+    }
     /** Generate a JavaScript class from Entity metadata.
      * @param entityMetaData The Entity metadata that defines the class
      */
@@ -98,26 +114,38 @@ class ClassRegistry {
             _b);
         // the above creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
         Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
-        const navigationProps = Object.entries(entityMetaData.properties)
-            .filter(([_propName, prop]) => prop.isNavigation)
-            .map(([propName, _prop]) => propName);
-        const isElement = (t) => t.is(Element_1.Element); // Entity.is check but with type information to avoid casts later
-        // a class only gets an automatic `collectReferenceIds` implementation if:
-        // - it derives from `BisCore:Element`
+        // a class only gets an automatic `collectReferenceConcreteIds` implementation if:
         // - it is not in the `BisCore` schema
         // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
-        if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {
-            Object.defineProperty(generatedClass.prototype, "collectReferenceIds", {
-                // first prototype of `this` is its class
+        if (!generatedClassHasNonGeneratedNonCoreAncestor) {
+            const navigationProps = Object.entries(entityMetaData.properties)
+                .filter(([_name, prop]) => prop.isNavigation)
+                // eslint-disable-next-line @typescript-eslint/no-shadow
+                .map(([name, prop]) => {
+                assert(prop.relationshipClass);
+                const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(":"));
+                assert(maybeMetaData.result !== undefined, "The nav props relationship metadata was not found");
+                const relMetaData = JSON.parse(maybeMetaData.result);
+                const normalizeClassName = (clsName) => clsName.replace(".", ":");
+                const ecClassMetaData = iModel.getMetaData(normalizeClassName(relMetaData.target.constraintClasses[0]));
+                const rootClassMetaData = ClassRegistry.getRootMetaData(iModel, ecClassMetaData);
+                // root class must be in BisCore so should be loaded since biscore classes will never get this
+                // generated implementation
+                const rootClass = ClassRegistry.findRegisteredClass(rootClassMetaData.ecclass);
+                assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);
+                return { name, concreteEntityType: EntityReferences_1.EntityReferences.typeFromClass(rootClass) };
+            });
+            Object.defineProperty(generatedClass.prototype, "collectReferenceConcreteIds", {
                 value(referenceIds) {
                     // eslint-disable-next-line @typescript-eslint/dot-notation
-                    const superImpl = superclass.prototype["collectReferenceIds"];
+                    const superImpl = superclass.prototype["collectReferenceConcreteIds"];
                     superImpl.call(this, referenceIds);
                     for (const navProp of navigationProps) {
-                        const relatedElem = this[navProp]; // cast to any since subclass can have any extensions
+                        const relatedElem = this[navProp.name]; // cast to any since subclass can have any extensions
                         if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
                             continue;
-                        referenceIds.add(relatedElem.id);
+                        const referenceId = EntityReferences_1.EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);
+                        referenceIds.add(referenceId);
                     }
                 },
                 // defaults for methods on a prototype (required for sinon to stub out methods on tests)

package/lib/cjs/ClassRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoF;AACpF,oDAAiF;AACjF,qCAAkC;AAClC,uCAAoC;AAEpC,qCAA2C;AAE3C,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;aAC9D,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;aAChD,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,SAAS,GAAG,CAAC,CAAgB,EAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAO,CAAC,CAAC,CAAC,iEAAiE;QAE7I,0EAA0E;QAC1E,sCAAsC;QACtC,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE;YAC1E,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,qBAAqB,EACrB;gBACE,yCAAyC;gBACzC,KAAK,CAA8B,YAAqB;oBACtD,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;oBAC9D,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,CAAC,CAAC,qDAAqD;wBAC7H,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBAEX,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;qBAClC;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AA9MH,sCA+MC;AA9MyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAgNvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","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 Schema\r\n */\r\n\r\nimport { DbResult, Id64, Id64Set, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { Element } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\")\r\n        break;\r\n\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    const navigationProps = Object.entries(entityMetaData.properties)\r\n      .filter(([_propName, prop]) => prop.isNavigation)\r\n      .map(([propName, _prop]) => propName);\r\n\r\n    const isElement = (t: typeof Entity): t is typeof Element => t.is(Element); // Entity.is check but with type information to avoid casts later\r\n\r\n    // a class only gets an automatic `collectReferenceIds` implementation if:\r\n    // - it derives from `BisCore:Element`\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectReferenceIds\",\r\n        {\r\n          // first prototype of `this` is its class\r\n          value(this: typeof generatedClass, referenceIds: Id64Set) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectReferenceIds\"];\r\n            superImpl.call(this, referenceIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id))\r\n                continue;\r\n\r\n              referenceIds.add(relatedElem.id);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => {\r\n        throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\r\n      };\r\n\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}
+{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2E;AAC3E,oDAAqG;AACrG,qCAAkC;AAElC,qCAA2C;AAC3C,yDAAsD;AACtD,iCAAiC;AAGjC,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,MAAgB,EAAE,cAA8B;;QAC7E,IAAI,iBAAiB,GAAG,cAAc,CAAC;QACvC,OAAO,IAAI,EAAE;YACX,IAAI,iBAAiB,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;gBAC5C,MAAM;YACR,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;YACvE,MAAM,gBAAgB,GAAG,MAAA,SAAS,CAAC,gBAAgB,0CAAE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;YAC5F,IAAI,gBAAgB;gBAClB,MAAM;;gBAEN,iBAAiB,GAAG,SAAS,CAAC;SACjC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,kFAAkF;QAClF,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE;YACjD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAC9G,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAA2B,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBAC7E,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxG,MAAM,iBAAiB,GAAG,aAAa,CAAC,eAAe,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;gBACjF,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAC/E,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,mCAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,6BAA6B,EAC7B;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;oBACtE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,mCAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;qBAC/B;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AAvOH,sCAwOC;AAvOyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAyOvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","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 Schema\r\n */\r\n\r\nimport { DbResult, Id64, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport { EntityReferences } from \"./EntityReferences\";\r\nimport * as assert from \"assert\";\r\nimport type { RelationshipClassProps } from \"@itwin/ecschema-metadata\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  private static getRootMetaData(iModel: IModelDb, entityMetaData: EntityMetaData): EntityMetaData {\r\n    let rootClassMetaData = entityMetaData;\r\n    while (true) {\r\n      if (rootClassMetaData.baseClasses.length === 0)\r\n        break;\r\n      const firstBase = iModel.getMetaData(rootClassMetaData.baseClasses[0]);\r\n      const firstBaseIsMixin = firstBase.customAttributes?.some((ca) => ca.ecclass === \"IsMixin\");\r\n      if (firstBaseIsMixin)\r\n        break;\r\n      else\r\n        rootClassMetaData = firstBase;\r\n    }\r\n    return rootClassMetaData;\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\")\r\n        break;\r\n\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    // a class only gets an automatic `collectReferenceConcreteIds` implementation if:\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor) {\r\n      const navigationProps = Object.entries(entityMetaData.properties)\r\n        .filter(([_name, prop]) => prop.isNavigation)\r\n        // eslint-disable-next-line @typescript-eslint/no-shadow\r\n        .map(([name, prop]) => {\r\n          assert(prop.relationshipClass);\r\n          const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\r\n          assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\r\n          const relMetaData: RelationshipClassProps = JSON.parse(maybeMetaData.result);\r\n          const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\r\n          const ecClassMetaData = iModel.getMetaData(normalizeClassName(relMetaData.target.constraintClasses[0]));\r\n          const rootClassMetaData = ClassRegistry.getRootMetaData(iModel, ecClassMetaData);\r\n          // root class must be in BisCore so should be loaded since biscore classes will never get this\r\n          // generated implementation\r\n          const rootClass = ClassRegistry.findRegisteredClass(rootClassMetaData.ecclass);\r\n          assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\r\n          return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\r\n        });\r\n\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectReferenceConcreteIds\",\r\n        {\r\n          value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectReferenceConcreteIds\"];\r\n            superImpl.call(this, referenceIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id))\r\n                continue;\r\n              const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\r\n              referenceIds.add(referenceId);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => {\r\n        throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\r\n      };\r\n\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}

package/lib/cjs/CustomViewState3dCreator.d.ts

@@ -7,27 +7,16 @@ import { IModelDb } from "./IModelDb";
 export declare class CustomViewState3dCreator {
     private _imodel;
     constructor(iModel: IModelDb);
-    /**
-     * Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.
+    /** Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.
      * @param [modelIds] Ids of models to display in the view.
      * @throws [IModelError]($common) If no 3d models are found in the iModel.
-     * @returns CustomViewState3dProps
      */
     getCustomViewState3dData(options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps>;
     private _getAllCategories;
-    /**
-     * Gets the union of the extents of each model id passed in. Can return null range if no ids are passed, or no geometry found for the models.
-     * @param modelIdsList array of modelIds to get extents for
-     * @returns Range3d, the union of the extents of each model id
-     */
+    /** Compute the union of the extents of all the specified models. */
     private _getModelExtents;
-    /**
-     * Get all PhysicalModel ids in the iModel
-     */
+    /** Get the Ids of all spatially-located, non-template 3d models in the iModel. */
     private _getAllModels;
-    /**
-     * Helper function to execute ECSql queries.
-     */
     private _executeQuery;
 }
 //# sourceMappingURL=CustomViewState3dCreator.d.ts.map

package/lib/cjs/CustomViewState3dCreator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomViewState3dCreator.d.ts","sourceRoot":"","sources":["../../src/CustomViewState3dCreator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,+BAA+B,EAAE,sBAAsB,EAA6C,MAAM,oBAAoB,CAAC;AAGxI,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,OAAO,CAAW;gBACP,MAAM,EAAE,QAAQ;IAGnC;;;;;OAKG;IACU,wBAAwB,CAAC,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC;YAclG,iBAAiB;IAS/B;;;;OAIG;YACW,gBAAgB;IA+B9B;;OAEG;YACW,aAAa;IAgB3B;;OAEG;IACH,OAAO,CAAC,aAAa,CAMnB;CACH"}
+{"version":3,"file":"CustomViewState3dCreator.d.ts","sourceRoot":"","sources":["../../src/CustomViewState3dCreator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,+BAA+B,EAAE,sBAAsB,EAAkB,MAAM,oBAAoB,CAAC;AAG7G,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,OAAO,CAAW;gBACP,MAAM,EAAE,QAAQ;IAGnC;;;OAGG;IACU,wBAAwB,CAAC,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC;YAelG,iBAAiB;IAS/B,oEAAoE;YACtD,gBAAgB;IAa9B,kFAAkF;YACpE,aAAa;IAmB3B,OAAO,CAAC,aAAa,CAMnB;CACH"}

package/lib/cjs/CustomViewState3dCreator.js

@@ -16,9 +16,6 @@ const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.CustomViewS
  */
 class CustomViewState3dCreator {
     constructor(iModel) {
-        /**
-         * Helper function to execute ECSql queries.
-         */
         this._executeQuery = async (query) => {
             const rows = [];
             for await (const row of this._imodel.query(query, undefined, { rowFormat: core_common_1.QueryRowFormat.UseJsPropertyNames }))
@@ -27,11 +24,9 @@ class CustomViewState3dCreator {
         };
         this._imodel = iModel;
     }
-    /**
-     * Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.
+    /** Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.
      * @param [modelIds] Ids of models to display in the view.
      * @throws [IModelError]($common) If no 3d models are found in the iModel.
-     * @returns CustomViewState3dProps
      */
     async getCustomViewState3dData(options) {
         let decompressedModelIds;
@@ -54,44 +49,17 @@ class CustomViewState3dCreator {
         core_bentley_1.Logger.logInfo(loggerCategory, "Finished getAllCategories query.");
         return categories;
     }
-    /**
-     * Gets the union of the extents of each model id passed in. Can return null range if no ids are passed, or no geometry found for the models.
-     * @param modelIdsList array of modelIds to get extents for
-     * @returns Range3d, the union of the extents of each model id
-     */
-    async _getModelExtents(modelIdsList) {
-        const modelExtents = new core_geometry_1.Range3d();
-        if (modelIdsList.length === 0)
-            return modelExtents;
-        const modelIds = new Set(modelIdsList);
-        for (const id of modelIds) {
-            const modelExtentsStopWatch = new core_bentley_1.StopWatch("getModelExtents query", false);
-            try {
-                await new Promise((resolve) => setImmediate(resolve)); // Free up main thread temporarily. Ideally we get queryModelExtents off the main thread and do not need to do this.
-                core_bentley_1.Logger.logInfo(loggerCategory, "Starting getModelExtents query.", { modelId: id });
-                modelExtentsStopWatch.start();
-                const props = this._imodel.nativeDb.queryModelExtents({ id }).modelExtents;
-                modelExtentsStopWatch.stop();
-                core_bentley_1.Logger.logInfo(loggerCategory, "Finished getModelExtents query.", { timeElapsedMs: modelExtentsStopWatch.elapsed, modelId: id });
-                modelExtents.union(core_geometry_1.Range3d.fromJSON(props), modelExtents);
-            }
-            catch (err) {
-                modelExtentsStopWatch.stop();
-                if (err.errorNumber === core_common_1.IModelStatus.NoGeometry) { // if there was no geometry, just return null range
-                    core_bentley_1.Logger.logInfo(loggerCategory, "Finished getModelExtents query with NoGeometry error.", { timeElapsedMs: modelExtentsStopWatch.elapsed, modelId: id });
-                    continue;
-                }
-                core_bentley_1.Logger.logInfo(loggerCategory, "Finished getModelExtents query with error.", { timeElapsedMs: modelExtentsStopWatch.elapsed, modelId: id, errorMessage: err === null || err === void 0 ? void 0 : err.message, errorNumber: err === null || err === void 0 ? void 0 : err.errorNumber });
-                if (modelIds.size === 1)
-                    throw err; // if they're asking for more than one model, don't throw on error.
-                continue;
-            }
-        }
-        return modelExtents;
+    /** Compute the union of the extents of all the specified models. */
+    async _getModelExtents(modelIds) {
+        if (modelIds.length === 0)
+            return new core_geometry_1.Range3d();
+        const timer = new core_bentley_1.StopWatch("getModelExtents query", true);
+        const range = await this._imodel.models.queryRange(modelIds);
+        timer.stop();
+        core_bentley_1.Logger.logInfo(loggerCategory, "Finished getModelExtents query.", { timeElapsedMs: timer.elapsed });
+        return range;
     }
-    /**
-     * Get all PhysicalModel ids in the iModel
-     */
+    /** Get the Ids of all spatially-located, non-template 3d models in the iModel. */
     async _getAllModels() {
         // Note: IsNotSpatiallyLocated was introduced in a later version of the BisCore ECSchema.
         // If the iModel has an earlier version, the statement will throw because the property does not exist.

package/lib/cjs/CustomViewState3dCreator.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomViewState3dCreator.js","sourceRoot":"","sources":["../../src/CustomViewState3dCreator.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAkG;AAClG,oDAAwI;AACxI,wDAA+C;AAC/C,mEAAgE;AAGhE,MAAM,cAAc,GAAG,6CAAqB,CAAC,wBAAwB,CAAC;AAEtE;;;GAGG;AACH,MAAa,wBAAwB;IAEnC,YAAmB,MAAgB;QAuFnC;;WAEG;QACK,kBAAa,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,kBAAkB,EAAE,CAAC;gBAC5G,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAEpB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QA/FA,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CAAC,OAAwC;QAC5E,IAAI,oBAAoB,CAAC;QACzB,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,SAAS;YACjC,oBAAoB,GAAG,gCAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7E,MAAM,MAAM,GAAc,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7E,MAAM,UAAU,GAAc,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7D,MAAM,YAAY,GAAY,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAClE,OAAO;YACL,QAAQ,EAAE,gCAAiB,CAAC,eAAe,CAAC,MAAM,CAAC;YACnD,WAAW,EAAE,gCAAiB,CAAC,eAAe,CAAC,UAAU,CAAC;YAC1D,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE;SACpC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,4CAA4C;QAC5C,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QACnE,MAAM,KAAK,GAAG,2IAA2I,CAAC;QAC1J,MAAM,UAAU,GAAc,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9D,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QACnE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAAC,YAA0B;QACvD,MAAM,YAAY,GAAG,IAAI,uBAAO,EAAE,CAAC;QACnC,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;YAC3B,OAAO,YAAY,CAAC;QACtB,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;QACvC,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE;YACzB,MAAM,qBAAqB,GAAG,IAAI,wBAAS,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC5E,IAAI;gBACF,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,oHAAoH;gBAC3K,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,iCAAiC,EAAE,EAAC,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;gBACjF,qBAAqB,CAAC,KAAK,EAAE,CAAC;gBAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC;gBAC3E,qBAAqB,CAAC,IAAI,EAAE,CAAC;gBAC7B,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,iCAAiC,EAAE,EAAC,aAAa,EAAE,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;gBAC/H,YAAY,CAAC,KAAK,CAAC,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC;aAC3D;YAAC,OAAO,GAAQ,EAAE;gBACjB,qBAAqB,CAAC,IAAI,EAAE,CAAC;gBAC7B,IAAK,GAAmB,CAAC,WAAW,KAAK,0BAAY,CAAC,UAAU,EAAE,EAAE,mDAAmD;oBACrH,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,uDAAuD,EAAE,EAAC,aAAa,EAAE,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;oBACrJ,SAAS;iBACV;gBACD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,4CAA4C,EAAE,EAAC,aAAa,EAAE,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EAAE,WAAW,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,EAAC,CAAC,CAAC;gBAErM,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;oBACrB,MAAM,GAAG,CAAC,CAAC,mEAAmE;gBAChF,SAAS;aACV;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,aAAa;QACzB,yFAAyF;QACzF,sGAAsG;QACtG,6JAA6J;QAC7J,MAAM,MAAM,GAAG,8FAA8F,CAAC;QAC9G,MAAM,gBAAgB,GAAG,sEAAsE,CAAC;QAChG,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC/D,IAAI;YACF,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,MAAM,IAAI,gBAAgB,EAAE,CAAC,CAAC;SACpE;QAAC,MAAM;YACN,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SAC3C;QACD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC;CAWF;AAnGD,4DAmGC","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\r\nimport { CompressedId64Set, Id64Array, Id64String, Logger, StopWatch } from \"@itwin/core-bentley\";\r\nimport { CustomViewState3dCreatorOptions, CustomViewState3dProps, IModelError, IModelStatus, QueryRowFormat } from \"@itwin/core-common\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.CustomViewState3dCreator;\r\n\r\n/**\r\n * Class which helps to generate a custom ViewState3d.\r\n * @internal\r\n */\r\nexport class CustomViewState3dCreator {\r\n  private _imodel: IModelDb;\r\n  public constructor(iModel: IModelDb) {\r\n    this._imodel = iModel;\r\n  }\r\n  /**\r\n   * Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.\r\n   * @param [modelIds] Ids of models to display in the view.\r\n   * @throws [IModelError]($common) If no 3d models are found in the iModel.\r\n   * @returns CustomViewState3dProps\r\n   */\r\n  public async getCustomViewState3dData(options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps> {\r\n    let decompressedModelIds;\r\n    if (options?.modelIds !== undefined)\r\n      decompressedModelIds = CompressedId64Set.decompressArray(options.modelIds);\r\n    const models: Id64Array = decompressedModelIds ?? await this._getAllModels();\r\n    const categories: Id64Array = await this._getAllCategories();\r\n    const modelExtents: Range3d = await this._getModelExtents(models);\r\n    return {\r\n      modelIds: CompressedId64Set.sortAndCompress(models),\r\n      categoryIds: CompressedId64Set.sortAndCompress(categories),\r\n      modelExtents: modelExtents.toJSON(),\r\n    };\r\n  }\r\n\r\n  private async _getAllCategories(): Promise<Id64Array> {\r\n    // Only use categories with elements in them\r\n    Logger.logInfo(loggerCategory, \"Starting getAllCategories query.\");\r\n    const query = `SELECT DISTINCT Category.Id AS id FROM BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId FROM BisCore.SpatialCategory)`;\r\n    const categories: Id64Array = await this._executeQuery(query);\r\n    Logger.logInfo(loggerCategory, \"Finished getAllCategories query.\");\r\n    return categories;\r\n  }\r\n\r\n  /**\r\n   * Gets the union of the extents of each model id passed in. Can return null range if no ids are passed, or no geometry found for the models.\r\n   * @param modelIdsList array of modelIds to get extents for\r\n   * @returns Range3d, the union of the extents of each model id\r\n   */\r\n  private async _getModelExtents(modelIdsList: Id64String[]): Promise<Range3d> {\r\n    const modelExtents = new Range3d();\r\n    if (modelIdsList.length === 0)\r\n      return modelExtents;\r\n    const modelIds = new Set(modelIdsList);\r\n    for (const id of modelIds) {\r\n      const modelExtentsStopWatch = new StopWatch(\"getModelExtents query\", false);\r\n      try {\r\n        await new Promise((resolve) => setImmediate(resolve)); // Free up main thread temporarily. Ideally we get queryModelExtents off the main thread and do not need to do this.\r\n        Logger.logInfo(loggerCategory, \"Starting getModelExtents query.\", {modelId: id});\r\n        modelExtentsStopWatch.start();\r\n        const props = this._imodel.nativeDb.queryModelExtents({ id }).modelExtents;\r\n        modelExtentsStopWatch.stop();\r\n        Logger.logInfo(loggerCategory, \"Finished getModelExtents query.\", {timeElapsedMs: modelExtentsStopWatch.elapsed, modelId: id});\r\n        modelExtents.union(Range3d.fromJSON(props), modelExtents);\r\n      } catch (err: any) {\r\n        modelExtentsStopWatch.stop();\r\n        if ((err as IModelError).errorNumber === IModelStatus.NoGeometry) { // if there was no geometry, just return null range\r\n          Logger.logInfo(loggerCategory, \"Finished getModelExtents query with NoGeometry error.\", {timeElapsedMs: modelExtentsStopWatch.elapsed, modelId: id});\r\n          continue;\r\n        }\r\n        Logger.logInfo(loggerCategory, \"Finished getModelExtents query with error.\", {timeElapsedMs: modelExtentsStopWatch.elapsed, modelId: id, errorMessage: err?.message, errorNumber: err?.errorNumber});\r\n\r\n        if (modelIds.size === 1)\r\n          throw err; // if they're asking for more than one model, don't throw on error.\r\n        continue;\r\n      }\r\n    }\r\n    return modelExtents;\r\n  }\r\n\r\n  /**\r\n   * Get all PhysicalModel ids in the iModel\r\n   */\r\n  private async _getAllModels(): Promise<Id64Array> {\r\n    // Note: IsNotSpatiallyLocated was introduced in a later version of the BisCore ECSchema.\r\n    // If the iModel has an earlier version, the statement will throw because the property does not exist.\r\n    // If the iModel was created from an earlier version and later upgraded to a newer version, the property may be NULL for models created prior to the upgrade.\r\n    const select = \"SELECT ECInstanceId FROM Bis.GeometricModel3D WHERE IsPrivate = false AND IsTemplate = false\";\r\n    const spatialCriterion = \"AND (IsNotSpatiallyLocated IS NULL OR IsNotSpatiallyLocated = false)\";\r\n    let models = [];\r\n    Logger.logInfo(loggerCategory, \"Starting getAllModels query.\");\r\n    try {\r\n      models = await this._executeQuery(`${select} ${spatialCriterion}`);\r\n    } catch {\r\n      models = await this._executeQuery(select);\r\n    }\r\n    Logger.logInfo(loggerCategory, \"Finished getAllModels query.\");\r\n    return models;\r\n  }\r\n  /**\r\n   * Helper function to execute ECSql queries.\r\n   */\r\n  private _executeQuery = async (query: string) => {\r\n    const rows = [];\r\n    for await (const row of this._imodel.query(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }))\r\n      rows.push(row.id);\r\n\r\n    return rows;\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"CustomViewState3dCreator.js","sourceRoot":"","sources":["../../src/CustomViewState3dCreator.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAkG;AAClG,oDAA6G;AAC7G,wDAA+C;AAC/C,mEAAgE;AAGhE,MAAM,cAAc,GAAG,6CAAqB,CAAC,wBAAwB,CAAC;AAEtE;;;GAGG;AACH,MAAa,wBAAwB;IAEnC,YAAmB,MAAgB;QAiE3B,kBAAa,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,kBAAkB,EAAE,CAAC;gBAC5G,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAEpB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAtEA,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IACD;;;OAGG;IACI,KAAK,CAAC,wBAAwB,CAAC,OAAwC;QAC5E,IAAI,oBAAoB,CAAC;QACzB,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,SAAS;YACjC,oBAAoB,GAAG,gCAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAc,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7E,MAAM,UAAU,GAAc,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7D,MAAM,YAAY,GAAY,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAClE,OAAO;YACL,QAAQ,EAAE,gCAAiB,CAAC,eAAe,CAAC,MAAM,CAAC;YACnD,WAAW,EAAE,gCAAiB,CAAC,eAAe,CAAC,UAAU,CAAC;YAC1D,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE;SACpC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,4CAA4C;QAC5C,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QACnE,MAAM,KAAK,GAAG,2IAA2I,CAAC;QAC1J,MAAM,UAAU,GAAc,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9D,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QACnE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,oEAAoE;IAC5D,KAAK,CAAC,gBAAgB,CAAC,QAAsB;QACnD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,OAAO,IAAI,uBAAO,EAAE,CAAC;QAEvB,MAAM,KAAK,GAAG,IAAI,wBAAS,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE7D,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,iCAAiC,EAAE,EAAC,aAAa,EAAE,KAAK,CAAC,OAAO,EAAC,CAAC,CAAC;QAElG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kFAAkF;IAC1E,KAAK,CAAC,aAAa;QACzB,yFAAyF;QACzF,sGAAsG;QACtG,6JAA6J;QAC7J,MAAM,MAAM,GAAG,8FAA8F,CAAC;QAC9G,MAAM,gBAAgB,GAAG,sEAAsE,CAAC;QAEhG,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC/D,IAAI;YACF,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,MAAM,IAAI,gBAAgB,EAAE,CAAC,CAAC;SACpE;QAAC,MAAM;YACN,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SAC3C;QAED,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC;CASF;AA1ED,4DA0EC","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\r\nimport { CompressedId64Set, Id64Array, Id64String, Logger, StopWatch } from \"@itwin/core-bentley\";\r\nimport { CustomViewState3dCreatorOptions, CustomViewState3dProps, QueryRowFormat } from \"@itwin/core-common\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.CustomViewState3dCreator;\r\n\r\n/**\r\n * Class which helps to generate a custom ViewState3d.\r\n * @internal\r\n */\r\nexport class CustomViewState3dCreator {\r\n  private _imodel: IModelDb;\r\n  public constructor(iModel: IModelDb) {\r\n    this._imodel = iModel;\r\n  }\r\n  /** Gets default view state data such as category Ids and modelextents. If no model ids are passed in, all 3D models in the iModel are used.\r\n   * @param [modelIds] Ids of models to display in the view.\r\n   * @throws [IModelError]($common) If no 3d models are found in the iModel.\r\n   */\r\n  public async getCustomViewState3dData(options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps> {\r\n    let decompressedModelIds;\r\n    if (options?.modelIds !== undefined)\r\n      decompressedModelIds = CompressedId64Set.decompressArray(options.modelIds);\r\n\r\n    const models: Id64Array = decompressedModelIds ?? await this._getAllModels();\r\n    const categories: Id64Array = await this._getAllCategories();\r\n    const modelExtents: Range3d = await this._getModelExtents(models);\r\n    return {\r\n      modelIds: CompressedId64Set.sortAndCompress(models),\r\n      categoryIds: CompressedId64Set.sortAndCompress(categories),\r\n      modelExtents: modelExtents.toJSON(),\r\n    };\r\n  }\r\n\r\n  private async _getAllCategories(): Promise<Id64Array> {\r\n    // Only use categories with elements in them\r\n    Logger.logInfo(loggerCategory, \"Starting getAllCategories query.\");\r\n    const query = `SELECT DISTINCT Category.Id AS id FROM BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId FROM BisCore.SpatialCategory)`;\r\n    const categories: Id64Array = await this._executeQuery(query);\r\n    Logger.logInfo(loggerCategory, \"Finished getAllCategories query.\");\r\n    return categories;\r\n  }\r\n\r\n  /** Compute the union of the extents of all the specified models. */\r\n  private async _getModelExtents(modelIds: Id64String[]): Promise<Range3d> {\r\n    if (modelIds.length === 0)\r\n      return new Range3d();\r\n\r\n    const timer = new StopWatch(\"getModelExtents query\", true);\r\n    const range = await this._imodel.models.queryRange(modelIds);\r\n\r\n    timer.stop();\r\n    Logger.logInfo(loggerCategory, \"Finished getModelExtents query.\", {timeElapsedMs: timer.elapsed});\r\n\r\n    return range;\r\n  }\r\n\r\n  /** Get the Ids of all spatially-located, non-template 3d models in the iModel. */\r\n  private async _getAllModels(): Promise<Id64Array> {\r\n    // Note: IsNotSpatiallyLocated was introduced in a later version of the BisCore ECSchema.\r\n    // If the iModel has an earlier version, the statement will throw because the property does not exist.\r\n    // If the iModel was created from an earlier version and later upgraded to a newer version, the property may be NULL for models created prior to the upgrade.\r\n    const select = \"SELECT ECInstanceId FROM Bis.GeometricModel3D WHERE IsPrivate = false AND IsTemplate = false\";\r\n    const spatialCriterion = \"AND (IsNotSpatiallyLocated IS NULL OR IsNotSpatiallyLocated = false)\";\r\n\r\n    let models = [];\r\n    Logger.logInfo(loggerCategory, \"Starting getAllModels query.\");\r\n    try {\r\n      models = await this._executeQuery(`${select} ${spatialCriterion}`);\r\n    } catch {\r\n      models = await this._executeQuery(select);\r\n    }\r\n\r\n    Logger.logInfo(loggerCategory, \"Finished getAllModels query.\");\r\n    return models;\r\n  }\r\n\r\n  private _executeQuery = async (query: string) => {\r\n    const rows = [];\r\n    for await (const row of this._imodel.query(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }))\r\n      rows.push(row.id);\r\n\r\n    return rows;\r\n  };\r\n}\r\n"]}

package/lib/cjs/DisplayStyle.d.ts

@@ -1,11 +1,11 @@
 /** @packageDocumentation
  * @module ViewDefinitions
  */
-import { Id64Set, Id64String } from "@itwin/core-bentley";
-import { Code, CodeScopeProps, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps, DisplayStyleProps, DisplayStyleSettings, RenderSchedule, ViewFlags } from "@itwin/core-common";
+import { Id64String } from "@itwin/core-bentley";
+import { Code, CodeScopeProps, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps, DisplayStyleProps, DisplayStyleSettings, EntityReferenceSet, RenderSchedule, ViewFlags } from "@itwin/core-common";
 import { DefinitionElement } from "./Element";
-import { IModelCloneContext } from "./IModelCloneContext";
 import { IModelDb } from "./IModelDb";
+import { IModelCloneContext } from "./IModelCloneContext";
 /** A DisplayStyle defines the parameters for 'styling' the contents of a view.
  * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
  * Many ViewDefinitions may share the same DisplayStyle.
@@ -23,8 +23,8 @@ export declare abstract class DisplayStyle extends DefinitionElement {
      * @param codeValue The DisplayStyle name
      */
     static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
-    /** @alpha */
-    protected collectReferenceIds(referenceIds: Id64Set): void;
+    /** @internal */
+    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
     /** @alpha */
     protected static onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void;
     loadScheduleScript(): RenderSchedule.ScriptReference | undefined;
@@ -82,8 +82,8 @@ export declare class DisplayStyle3d extends DisplayStyle {
     get settings(): DisplayStyle3dSettings;
     /** @internal */
     constructor(props: DisplayStyle3dProps, iModel: IModelDb);
-    /** @alpha */
-    protected collectReferenceIds(referenceIds: Id64Set): void;
+    /** @internal */
+    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
     /** @alpha */
     protected static onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void;
     /** Create a DisplayStyle3d for use by a ViewDefinition.

package/lib/cjs/DisplayStyle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyle.d.ts","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAsC,OAAO,EAAE,UAAU,EAAuB,MAAM,qBAAqB,CAAC;AACnH,OAAO,EACQ,IAAI,EAAE,cAAc,EAAY,QAAQ,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,2BAA2B,EAC/H,iBAAiB,EAAE,oBAAoB,EAA+B,cAAc,EAAoB,SAAS,EAClH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAIhE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,OAAO,GAAG,IAAI;IAkBnE,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,GAAG,IAAI;IAiD5I,kBAAkB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS;CAgBxE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,gBAAgB;gBACG,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAI7D;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAgBrG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAIlG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,IAAI,CAAC,2BAA2B,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;IAC1H;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;IAExE,gBAAgB;gBACG,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAK/D,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,OAAO,GAAG,IAAI;IAUnE,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IA+BvJ;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,cAAc;IAyB5I;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,UAAU;CAIzI"}
+{"version":3,"file":"DisplayStyle.d.ts","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAsC,UAAU,EAAuB,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EACQ,IAAI,EAAE,cAAc,EAAY,QAAQ,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,2BAA2B,EAC/H,iBAAiB,EAAE,oBAAoB,EAAE,kBAAkB,EAA+B,cAAc,EAAoB,SAAS,EACtI,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;GAIG;AACH,8BAAsB,YAAa,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,aAAoB,QAAQ,IAAI,oBAAoB,CAAC;IAErD,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAIhE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAkBtF,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,GAAG,IAAI;IAiD5I,kBAAkB,IAAI,cAAc,CAAC,eAAe,GAAG,SAAS;CAgBxE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IAEjD,IAAW,QAAQ,IAAI,oBAAoB,CAA2B;IAEtE,gBAAgB;gBACG,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAI7D;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAgBrG;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAIlG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,IAAI,CAAC,2BAA2B,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;IAC1H;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,IAAW,QAAQ,IAAI,sBAAsB,CAA2B;IAExE,gBAAgB;gBACG,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAK/D,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAUtF,aAAa;qBACa,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IA+BvJ;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,cAAc;IAyB5I;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,UAAU;CAIzI"}

package/lib/cjs/DisplayStyle.js

@@ -32,21 +32,21 @@ class DisplayStyle extends Element_1.DefinitionElement {
         const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.displayStyle);
         return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
     }
-    /** @alpha */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         for (const [id] of this.settings.subCategoryOverrides) {
-            referenceIds.add(id);
+            referenceIds.addElement(id);
         }
         for (const excludedElementId of this.settings.excludedElementIds)
-            referenceIds.add(excludedElementId);
+            referenceIds.addElement(excludedElementId);
         if (this.settings.renderTimeline) {
-            referenceIds.add(this.settings.renderTimeline);
+            referenceIds.addElement(this.settings.renderTimeline);
         }
         else {
             const script = this.loadScheduleScript();
             if (script)
-                script.script.discloseIds(referenceIds);
+                script.script.discloseIds(referenceIds); // eslint-disable-line deprecation/deprecation
         }
     }
     /** @alpha */
@@ -174,14 +174,14 @@ class DisplayStyle3d extends DisplayStyle {
     /** @internal */
     static get className() { return "DisplayStyle3d"; }
     get settings() { return this._settings; }
-    /** @alpha */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         for (const textureId of this.settings.environment.sky.textureIds)
-            referenceIds.add(textureId);
+            referenceIds.addElement(textureId);
         if (this.settings.planProjectionSettings)
             for (const planProjectionSetting of this.settings.planProjectionSettings)
-                referenceIds.add(planProjectionSetting[0]);
+                referenceIds.addElement(planProjectionSetting[0]);
     }
     /** @alpha */
     static onCloned(context, sourceElementProps, targetElementProps) {

package/lib/cjs/DisplayStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmH;AACnH,oDAG4B;AAC5B,uCAA8D;AAI9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,gBAAgB;IAChB,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAqB;QAC1D,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE;YACrD,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACtB;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;SAChD;aAAM;YACL,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAqC,EAAE,kBAAqC;;QAC1I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAA,MAAA,kBAAkB,CAAC,cAAc,0CAAE,MAAM,CAAA;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE;gBACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACvC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC9E,IAAI,mBAAI,CAAC,OAAO,KAAK,GAAG,CAAC,WAAW;oBAClC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAErC,CAAC,EAAE,CAAC;aACP;SACF;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE;YAC7B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE;gBAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ;oBAC3B,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAEtB,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;aAC5B;YAED,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM;gBACvB,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtG;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE;YAClC,MAAM,cAAc,GAAG,wBAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE;gBACZ,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;aACxB;SACF;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YAC5C,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;SACpB;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAzGD,oCAyGC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAAwB,EAAE,MAAgB;QAC3D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOtE;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA9CD,wCA8CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAA0B,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAQxE,aAAa;IACM,mBAAmB,CAAC,YAAqB;QAC1D,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAuC,EAAE,kBAAuC;;QAC9I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,MAAA,MAAA,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,WAAW,0CAAE,GAAG,0CAAE,KAAK,CAAC;YAC3H,IAAI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,KAAI,mBAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,EAAE;gBAC9B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACrF;YAED,IAAI,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,eAAe,EAAE;gBAC/D,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;oBAC5F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,mBAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE;wBACrC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;qBACrD;iBACF;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;aACpF;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;;QACzH,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AApGD,wCAoGC","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 ViewDefinitions\r\n */\r\n\r\nimport { CompressedId64Set, Id64, Id64Array, Id64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\r\n  DisplayStyleProps, DisplayStyleSettings, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\r\nimport { IModelCloneContext } from \"./IModelCloneContext\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\r\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\r\n * Many ViewDefinitions may share the same DisplayStyle.\r\n * @public\r\n */\r\nexport abstract class DisplayStyle extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle\"; }\r\n  public abstract get settings(): DisplayStyleSettings;\r\n\r\n  /** @internal */\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n\r\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\r\n   * @param codeValue The DisplayStyle name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: Id64Set): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const [id] of this.settings.subCategoryOverrides) {\r\n      referenceIds.add(id);\r\n    }\r\n\r\n    for (const excludedElementId of this.settings.excludedElementIds)\r\n      referenceIds.add(excludedElementId);\r\n\r\n    if (this.settings.renderTimeline) {\r\n      referenceIds.add(this.settings.renderTimeline);\r\n    } else {\r\n      const script = this.loadScheduleScript();\r\n      if (script)\r\n        script.script.discloseIds(referenceIds);\r\n    }\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n\r\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\r\n      return;\r\n\r\n    const settings = targetElementProps.jsonProperties.styles;\r\n    if (settings.subCategoryOvr) {\r\n      for (let i = 0; i < settings.subCategoryOvr.length; /* */) {\r\n        const ovr = settings.subCategoryOvr[i];\r\n        ovr.subCategory = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\r\n        if (Id64.invalid === ovr.subCategory)\r\n          settings.subCategoryOvr.splice(i, 1);\r\n        else\r\n          i++;\r\n      }\r\n    }\r\n\r\n    if (settings.excludedElements) {\r\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\r\n      for (let i = 0; i < excluded.length; /* */) {\r\n        const remapped = context.findTargetElementId(excluded[i]);\r\n        if (Id64.invalid === remapped)\r\n          excluded.splice(i, 1);\r\n        else\r\n          excluded[i++] = remapped;\r\n      }\r\n\r\n      if (0 === excluded.length)\r\n        delete settings.excludedElements;\r\n      else\r\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excluded));\r\n    }\r\n\r\n    if (settings.renderTimeline) {\r\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\r\n      if (Id64.isValid(renderTimeline))\r\n        settings.renderTimeline = renderTimeline;\r\n      else\r\n        delete settings.renderTimeline;\r\n    } else if (settings.scheduleScript) {\r\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\r\n      if (scheduleScript.length > 0)\r\n        settings.scheduleScript = scheduleScript;\r\n      else\r\n        delete settings.scheduleScript;\r\n    }\r\n  }\r\n\r\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\r\n    let script;\r\n    let sourceId;\r\n    if (this.settings.renderTimeline) {\r\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\r\n      if (timeline) {\r\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\r\n        sourceId = timeline.id;\r\n      }\r\n    } else if (this.settings.scheduleScriptProps) {\r\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\r\n      sourceId = this.id;\r\n    }\r\n\r\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\r\n  }\r\n}\r\n\r\n/** A DisplayStyle for 2d views.\r\n * @public\r\n */\r\nexport class DisplayStyle2d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle2d\"; }\r\n  private readonly _settings: DisplayStyleSettings;\r\n\r\n  public get settings(): DisplayStyleSettings { return this._settings; }\r\n\r\n  /** @internal */\r\n  public constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\r\n  }\r\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle2d\r\n   * @returns The newly constructed DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\r\n    const displayStyleProps: DisplayStyleProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n      jsonProperties: {\r\n        styles: {\r\n          backgroundColor: 0,\r\n          monochromeColor: ColorDef.white.toJSON(),\r\n          viewflags: ViewFlags.defaults,\r\n        },\r\n      },\r\n    };\r\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\r\n  }\r\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\r\n   * @param name The name of the DisplayStyle2d\r\n   * @returns The Id of the newly inserted DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n\r\n/** Describes initial settings for a new [[DisplayStyle3d]].\r\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\r\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\r\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\r\n * These idiosyncrasies will be addressed in a future version of core-backend.\r\n * @see [[DisplayStyle3d.create]].\r\n * @public\r\n */\r\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\r\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\r\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\r\n   */\r\n  viewFlags?: ViewFlags;\r\n  backgroundColor?: ColorDef | number;\r\n}\r\n\r\n/** A DisplayStyle for 3d views.\r\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\r\n * @public\r\n */\r\nexport class DisplayStyle3d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle3d\"; }\r\n  private readonly _settings: DisplayStyle3dSettings;\r\n\r\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\r\n\r\n  /** @internal */\r\n  public constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: Id64Set): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const textureId of this.settings.environment.sky.textureIds)\r\n      referenceIds.add(textureId);\r\n\r\n    if (this.settings.planProjectionSettings)\r\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\r\n        referenceIds.add(planProjectionSetting[0]);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n    if (context.isBetweenIModels) {\r\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\r\n\r\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\r\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\r\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\r\n\r\n      if (skyBoxImageProps?.textures) {\r\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\r\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\r\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\r\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\r\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\r\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\r\n      }\r\n\r\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\r\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\r\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\r\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\r\n          if (Id64.isValidId64(remappedModelId)) {\r\n            remappedPlanProjections[remappedModelId] = entry[1];\r\n          }\r\n        }\r\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle3d\r\n   * @returns The newly constructed DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\r\n    options = options ?? {};\r\n    let viewflags = options.viewFlags?.toJSON();\r\n    if (!viewflags)\r\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\r\n\r\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\r\n\r\n    const settings: DisplayStyle3dSettingsProps = {\r\n      ...options,\r\n      viewflags,\r\n      backgroundColor,\r\n    };\r\n\r\n    const displayStyleProps: DisplayStyle3dProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      jsonProperties: { styles: settings },\r\n      isPrivate: false,\r\n\r\n    };\r\n\r\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\r\n  }\r\n  /**\r\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\r\n   * @param name The name of the DisplayStyle3d\r\n   * @returns The Id of the newly inserted DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAG4B;AAC5B,uCAA8D;AAI9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,gBAAgB;IAChB,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,gBAAgB;IACG,2BAA2B,CAAC,YAAgC;QAC7E,KAAK,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAChD,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE;YACrD,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;SAC7B;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QAE7C,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;SACvD;aAAM;YACL,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,8CAA8C;SAC1F;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAqC,EAAE,kBAAqC;;QAC1I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAA,MAAA,kBAAkB,CAAC,cAAc,0CAAE,MAAM,CAAA;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE;gBACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACvC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC9E,IAAI,mBAAI,CAAC,OAAO,KAAK,GAAG,CAAC,WAAW;oBAClC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAErC,CAAC,EAAE,CAAC;aACP;SACF;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE;YAC7B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE;gBAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ;oBAC3B,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAEtB,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;aAC5B;YAED,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM;gBACvB,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtG;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE;YAClC,MAAM,cAAc,GAAG,wBAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE;gBACZ,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;aACxB;SACF;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YAC5C,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;SACpB;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAzGD,oCAyGC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAAwB,EAAE,MAAgB;QAC3D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOtE;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA9CD,wCA8CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAA0B,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAQxE,gBAAgB;IACG,2BAA2B,CAAC,YAAgC;QAC7E,KAAK,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAChD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAErC,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAuC,EAAE,kBAAuC;;QAC9I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,MAAA,MAAA,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,WAAW,0CAAE,GAAG,0CAAE,KAAK,CAAC;YAC3H,IAAI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,KAAI,mBAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,EAAE;gBAC9B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACrF;YAED,IAAI,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,eAAe,EAAE;gBAC/D,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;oBAC5F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,mBAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE;wBACrC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;qBACrD;iBACF;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;aACpF;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;;QACzH,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AApGD,wCAoGC","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 ViewDefinitions\r\n */\r\n\r\nimport { CompressedId64Set, Id64, Id64Array, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\r\n  DisplayStyleProps, DisplayStyleSettings, EntityReferenceSet, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { IModelCloneContext } from \"./IModelCloneContext\";\r\n\r\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\r\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\r\n * Many ViewDefinitions may share the same DisplayStyle.\r\n * @public\r\n */\r\nexport abstract class DisplayStyle extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle\"; }\r\n  public abstract get settings(): DisplayStyleSettings;\r\n\r\n  /** @internal */\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n\r\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\r\n   * @param codeValue The DisplayStyle name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** @internal */\r\n  protected override collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceConcreteIds(referenceIds);\r\n    for (const [id] of this.settings.subCategoryOverrides) {\r\n      referenceIds.addElement(id);\r\n    }\r\n\r\n    for (const excludedElementId of this.settings.excludedElementIds)\r\n      referenceIds.addElement(excludedElementId);\r\n\r\n    if (this.settings.renderTimeline) {\r\n      referenceIds.addElement(this.settings.renderTimeline);\r\n    } else {\r\n      const script = this.loadScheduleScript();\r\n      if (script)\r\n        script.script.discloseIds(referenceIds); // eslint-disable-line deprecation/deprecation\r\n    }\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n\r\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\r\n      return;\r\n\r\n    const settings = targetElementProps.jsonProperties.styles;\r\n    if (settings.subCategoryOvr) {\r\n      for (let i = 0; i < settings.subCategoryOvr.length; /* */) {\r\n        const ovr = settings.subCategoryOvr[i];\r\n        ovr.subCategory = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\r\n        if (Id64.invalid === ovr.subCategory)\r\n          settings.subCategoryOvr.splice(i, 1);\r\n        else\r\n          i++;\r\n      }\r\n    }\r\n\r\n    if (settings.excludedElements) {\r\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\r\n      for (let i = 0; i < excluded.length; /* */) {\r\n        const remapped = context.findTargetElementId(excluded[i]);\r\n        if (Id64.invalid === remapped)\r\n          excluded.splice(i, 1);\r\n        else\r\n          excluded[i++] = remapped;\r\n      }\r\n\r\n      if (0 === excluded.length)\r\n        delete settings.excludedElements;\r\n      else\r\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excluded));\r\n    }\r\n\r\n    if (settings.renderTimeline) {\r\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\r\n      if (Id64.isValid(renderTimeline))\r\n        settings.renderTimeline = renderTimeline;\r\n      else\r\n        delete settings.renderTimeline;\r\n    } else if (settings.scheduleScript) {\r\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\r\n      if (scheduleScript.length > 0)\r\n        settings.scheduleScript = scheduleScript;\r\n      else\r\n        delete settings.scheduleScript;\r\n    }\r\n  }\r\n\r\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\r\n    let script;\r\n    let sourceId;\r\n    if (this.settings.renderTimeline) {\r\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\r\n      if (timeline) {\r\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\r\n        sourceId = timeline.id;\r\n      }\r\n    } else if (this.settings.scheduleScriptProps) {\r\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\r\n      sourceId = this.id;\r\n    }\r\n\r\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\r\n  }\r\n}\r\n\r\n/** A DisplayStyle for 2d views.\r\n * @public\r\n */\r\nexport class DisplayStyle2d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle2d\"; }\r\n  private readonly _settings: DisplayStyleSettings;\r\n\r\n  public get settings(): DisplayStyleSettings { return this._settings; }\r\n\r\n  /** @internal */\r\n  public constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\r\n  }\r\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle2d\r\n   * @returns The newly constructed DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\r\n    const displayStyleProps: DisplayStyleProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n      jsonProperties: {\r\n        styles: {\r\n          backgroundColor: 0,\r\n          monochromeColor: ColorDef.white.toJSON(),\r\n          viewflags: ViewFlags.defaults,\r\n        },\r\n      },\r\n    };\r\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\r\n  }\r\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\r\n   * @param name The name of the DisplayStyle2d\r\n   * @returns The Id of the newly inserted DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n\r\n/** Describes initial settings for a new [[DisplayStyle3d]].\r\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\r\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\r\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\r\n * These idiosyncrasies will be addressed in a future version of core-backend.\r\n * @see [[DisplayStyle3d.create]].\r\n * @public\r\n */\r\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\r\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\r\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\r\n   */\r\n  viewFlags?: ViewFlags;\r\n  backgroundColor?: ColorDef | number;\r\n}\r\n\r\n/** A DisplayStyle for 3d views.\r\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\r\n * @public\r\n */\r\nexport class DisplayStyle3d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle3d\"; }\r\n  private readonly _settings: DisplayStyle3dSettings;\r\n\r\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\r\n\r\n  /** @internal */\r\n  public constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\r\n  }\r\n\r\n  /** @internal */\r\n  protected override collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceConcreteIds(referenceIds);\r\n    for (const textureId of this.settings.environment.sky.textureIds)\r\n      referenceIds.addElement(textureId);\r\n\r\n    if (this.settings.planProjectionSettings)\r\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\r\n        referenceIds.addElement(planProjectionSetting[0]);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n    if (context.isBetweenIModels) {\r\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\r\n\r\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\r\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\r\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\r\n\r\n      if (skyBoxImageProps?.textures) {\r\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\r\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\r\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\r\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\r\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\r\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\r\n      }\r\n\r\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\r\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\r\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\r\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\r\n          if (Id64.isValidId64(remappedModelId)) {\r\n            remappedPlanProjections[remappedModelId] = entry[1];\r\n          }\r\n        }\r\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle3d\r\n   * @returns The newly constructed DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\r\n    options = options ?? {};\r\n    let viewflags = options.viewFlags?.toJSON();\r\n    if (!viewflags)\r\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\r\n\r\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\r\n\r\n    const settings: DisplayStyle3dSettingsProps = {\r\n      ...options,\r\n      viewflags,\r\n      backgroundColor,\r\n    };\r\n\r\n    const displayStyleProps: DisplayStyle3dProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      jsonProperties: { styles: settings },\r\n      isPrivate: false,\r\n\r\n    };\r\n\r\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\r\n  }\r\n  /**\r\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\r\n   * @param name The name of the DisplayStyle3d\r\n   * @returns The Id of the newly inserted DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n"]}