@itwin/core-backend 3.5.0-dev.8 → 3.6.0-dev.3

package/lib/cjs/ClassRegistry.d.ts

@@ -18,6 +18,14 @@ 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;
+    /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
+     * Then, gets its metadata and returns that.
+     * @param iModel - iModel containing the metadata for this type
+     * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
+     * @returns the qualified full name of an ECEntityClass
+     * @internal public for testing only
+     */
+    static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string;
     /** 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;AAM3C;;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;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM;IAe9E;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAyGrC;;;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,28 @@ class ClassRegistry {
         Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
         return schemaClass;
     }
+    /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
+     * Then, gets its metadata and returns that.
+     * @param iModel - iModel containing the metadata for this type
+     * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
+     * @returns the qualified full name of an ECEntityClass
+     * @internal public for testing only
+     */
+    static getRootEntity(iModel, ecTypeQualifier) {
+        var _a;
+        const [classSchema, className] = ecTypeQualifier.split(".");
+        const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);
+        if (schemaItemJson.error)
+            throw new core_common_1.IModelError(schemaItemJson.error, `failed to get schema item '${ecTypeQualifier}'`);
+        const schemaItem = JSON.parse(schemaItemJson.result);
+        if (!("appliesTo" in schemaItem) && schemaItem.baseClass === undefined) {
+            return ecTypeQualifier;
+        }
+        // typescript doesn't understand that the inverse of the above condition is
+        // ("appliesTo" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)
+        const parentItemQualifier = (_a = schemaItem.appliesTo) !== null && _a !== void 0 ? _a : schemaItem.baseClass;
+        return this.getRootEntity(iModel, parentItemQualifier);
+    }
     /** Generate a JavaScript class from Entity metadata.
      * @param entityMetaData The Entity metadata that defines the class
      */
@@ -98,26 +121,37 @@ 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 rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);
+                // root class must be in BisCore so should be loaded since biscore classes will never get this
+                // generated implementation
+                const normalizeClassName = (clsName) => clsName.replace(".", ":");
+                const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));
+                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;AAEjC,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;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC7E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,yBAAW,CAAC,cAAc,CAAC,KAAK,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAChG,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAgB,CAAC,CAAC;QAC/D,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE;YACtE,OAAO,eAAe,CAAC;SACxB;QACD,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,MAAA,UAAU,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,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,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,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;;AA7OH,sCA8OC;AA7OyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AA+OvE;;;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\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  /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\r\n   * Then, gets its metadata and returns that.\r\n   * @param iModel - iModel containing the metadata for this type\r\n   * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\r\n   * @returns the qualified full name of an ECEntityClass\r\n   * @internal public for testing only\r\n   */\r\n  public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\r\n    const [classSchema, className] = ecTypeQualifier.split(\".\");\r\n    const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);\r\n    if (schemaItemJson.error)\r\n      throw new IModelError(schemaItemJson.error, `failed to get schema item '${ecTypeQualifier}'`);\r\n    const schemaItem = JSON.parse(schemaItemJson.result as string);\r\n    if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\r\n      return ecTypeQualifier;\r\n    }\r\n    // typescript doesn't understand that the inverse of the above condition is\r\n    // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\r\n    const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\r\n    return this.getRootEntity(iModel, parentItemQualifier);\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 = JSON.parse(maybeMetaData.result);\r\n          const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\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 normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\r\n          const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\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/CloudSqlite.d.ts

@@ -344,6 +344,7 @@ export declare namespace CloudSqlite {
       * @param container the CloudContainer for which the lock is to be acquired
       * @param operation an asynchronous operation performed with the write lock held.
       * @param busyHandler if present, function called when the write lock is currently held by another user.
+      * @returns a Promise with the result of `operation`
       */
     function withWriteLock<T>(user: string, container: CloudContainer, operation: () => T, busyHandler?: WriteLockBusyHandler): Promise<T>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"CloudSqlite.d.ts","sourceRoot":"","sources":["../../src/CloudSqlite.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;GAEG;AACH,yBAAiB,WAAW,CAAC;IAC3B,SAAgB,oBAAoB,CAAC,IAAI,EAAE,oBAAoB,GAAG,cAAc,CAE/E;IACD,SAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU,CAErF;IACD,SAAgB,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAErJ;IAED,0FAA0F;IAC1F,UAAiB,kBAAkB;QACjC,iGAAiG;QACjG,WAAW,EAAE,MAAM,CAAC;QACpB,4DAA4D;QAC5D,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,sCAAsC;IACtC,UAAiB,cAAc;QAC7B,iCAAiC;QACjC,WAAW,EAAE,MAAM,CAAC;QACpB,4DAA4D;QAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oIAAoI;QACpI,WAAW,EAAE,MAAM,CAAC;QACpB,+HAA+H;QAC/H,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,6GAA6G;QAC7G,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;IAED,4FAA4F;IAC5F,UAAiB,aAAa;QAC5B,iDAAiD;QACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,yFAAyF;QACzF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,iHAAiH;QACjH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,kIAAkI;QAClI,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;QAC/B,qGAAqG;QACrG,QAAQ,CAAC,KAAK,EAAE,EAAE,GAAG,QAAQ,GAAG,SAAS,CAAC;KAC3C;IAED,gDAAgD;IAChD,KAAY,oBAAoB,GAAG,kBAAkB,GAAG,cAAc,GAAG;QACvE,iIAAiI;QACjI,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IAEF,kEAAkE;IAClE,UAAiB,UAAU;QACzB;6GACqG;QACrG,MAAM,EAAE,MAAM,CAAC;KAChB;IAED,kEAAkE;IAClE,UAAiB,OAAQ,SAAQ,UAAU;QACzC,yDAAyD;QACzD,aAAa,EAAE,aAAa,CAAC;KAC9B;IAED,KAAY,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtD,UAAiB,gBAAgB;QAC/B,0HAA0H;QAC1H,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;KACxD;IAED,UAAiB,cAAc;QAC7B,+DAA+D;QAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,aAAc,SAAQ,cAAc;QACnD,iEAAiE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,iGAAiG;QACjG,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,KAAY,eAAe,GAAG,OAAO,GAAG,gBAAgB,GAAG,cAAc,CAAC;IAE1E,4CAA4C;IAC5C,UAAiB,UAAW,SAAQ,cAAc;QAChD,0JAA0J;QAC1J,OAAO,EAAE,MAAM,CAAC;QAChB,+FAA+F;QAC/F,IAAI,EAAE,MAAM,CAAC;QACb,oHAAoH;QACpH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,yDAAyD;QACzD,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,gIAAgI;QAChI,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB,8DAA8D;QAC9D,YAAY,EAAE,MAAM,CAAC;QACrB;;;WAGG;QACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;KAClC;IAED,gBAAgB;IAChB,UAAiB,eAAe;QAC9B,+DAA+D;QAC/D,IAAI,EAAE,MAAM,CAAC;QACb,oDAAoD;QACpD,MAAM,EAAE,MAAM,CAAC;QACf,kEAAkE;QAClE,SAAS,EAAE,cAAc,CAAC;QAC1B,yFAAyF;QACzF,WAAW,CAAC,EAAE,oBAAoB,CAAC;KACpC;IAED,qDAAqD;IACrD,KAAY,WAAW;QACrB,0CAA0C;QAC1C,IAAI,IAAO;QACX,sDAAsD;QACtD,WAAW,IAAO;QAClB,iDAAiD;QACjD,WAAW,IAAO;QAClB,uGAAuG;QACvG,eAAe,IAAO;QACtB,qCAAqC;QACrC,GAAG,MAAO;QACV,sBAAsB;QACtB,IAAI,IAAI;KACT;IAED;;;;;OAKG;IACH,UAAiB,UAAU;QACzB,iEAAiE;QACjE,IAAI,QAAQ,IAAI,OAAO,CAAC;QACxB,oCAAoC;QACpC,IAAI,IAAI,IAAI,MAAM,CAAC;QACnB,8DAA8D;QAC9D,IAAI,OAAO,IAAI,YAAY,CAAC;QAC5B,mEAAmE;QACnE,IAAI,IAAI,IAAI,UAAU,CAAC;QACvB;;;;;WAKG;QACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,2FAA2F;QAC3F,OAAO,IAAI,IAAI,CAAC;KACjB;IAED,qEAAqE;IACrE,UAAiB,cAAc;QAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;QAC5B,uBAAuB;QACvB,IAAI,WAAW,IAAI,MAAM,CAAC;QAC1B,iGAAiG;QACjG,IAAI,KAAK,IAAI,MAAM,CAAC;QACpB,mGAAmG;QACnG,IAAI,WAAW,IAAI,OAAO,CAAC;QAC3B,uHAAuH;QACvH,IAAI,WAAW,IAAI,OAAO,CAAC;QAC3B,iGAAiG;QACjG,IAAI,YAAY,IAAI,OAAO,CAAC;QAC5B,6GAA6G;QAC7G,IAAI,eAAe,IAAI,OAAO,CAAC;QAC/B,sEAAsE;QACtE,IAAI,WAAW,IAAI,MAAM,CAAC;QAC1B,IAAI,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE;QAC7B,6EAA6E;QAC7E,IAAI,aAAa,IAAI,MAAM,CAAC;QAC5B,8CAA8C;QAC9C,IAAI,SAAS,IAAI,MAAM,CAAC;QAExB;;;WAGG;QACH,mBAAmB,CAAC,IAAI,CAAC,EAAE;YAAE,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvF;;;;;;;;;;;;;;WAcG;QACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC;;;;WAIG;QACH,gBAAgB,IAAI,IAAI,CAAC;QAEzB;;;;WAIG;QACH,cAAc,IAAI,IAAI,CAAC;QAEvB;;;;WAIG;QACH,cAAc,IAAI,IAAI,CAAC;QAEvB;;;;;;WAMG;QACH,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;QAEjC;;;WAGG;QACH,UAAU,IAAI,IAAI,CAAC;QAEnB;;WAEG;QACH,MAAM,IAAI,IAAI,CAAC;QAEf;;;;WAIG;QACH,eAAe,IAAI,IAAI,CAAC;QAExB;;;;;WAKG;QACH,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAE/B;;;;;;;;WAQG;QACH,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAErD;;;;;WAKG;QACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7D;;WAEG;QACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE9C;;WAEG;QACH,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAE3C;;;WAGG;QACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,aAAa,GAAG,SAAS,CAAC;QAErE;;;;WAIG;QACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;KAC3C;IAED,gBAAgB;IAChB,UAAiB,aAAa;QAC5B,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;QACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAExB,qGAAqG;QACrG,MAAM,IAAI,IAAI,CAAC;QAEf;;;;;;WAMG;QACH,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KAC3B;IAED,gBAAgB;IAChB,SAAsB,UAAU,CAAC,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,iBA4B/G;IAED;;;;QAII;IACJ,SAAsB,QAAQ,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAG/F;IAED;;;;;;QAMI;IACJ,SAAsB,UAAU,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG;IAED;;;;QAII;IACJ,KAAY,oBAAoB,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;IAEjG;;;;;;;QAOI;IACJ,SAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,oBAAoB,iBAajH;IAED;;;;;;;;;;;;QAYI;IACJ,SAAsB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,EAAE,oBAAoB,cAcrI;CACF"}
+{"version":3,"file":"CloudSqlite.d.ts","sourceRoot":"","sources":["../../src/CloudSqlite.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;GAEG;AACH,yBAAiB,WAAW,CAAC;IAC3B,SAAgB,oBAAoB,CAAC,IAAI,EAAE,oBAAoB,GAAG,cAAc,CAE/E;IACD,SAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU,CAErF;IACD,SAAgB,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAErJ;IAED,0FAA0F;IAC1F,UAAiB,kBAAkB;QACjC,iGAAiG;QACjG,WAAW,EAAE,MAAM,CAAC;QACpB,4DAA4D;QAC5D,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,sCAAsC;IACtC,UAAiB,cAAc;QAC7B,iCAAiC;QACjC,WAAW,EAAE,MAAM,CAAC;QACpB,4DAA4D;QAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oIAAoI;QACpI,WAAW,EAAE,MAAM,CAAC;QACpB,+HAA+H;QAC/H,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,6GAA6G;QAC7G,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;IAED,4FAA4F;IAC5F,UAAiB,aAAa;QAC5B,iDAAiD;QACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,yFAAyF;QACzF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,iHAAiH;QACjH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,kIAAkI;QAClI,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;QAC/B,qGAAqG;QACrG,QAAQ,CAAC,KAAK,EAAE,EAAE,GAAG,QAAQ,GAAG,SAAS,CAAC;KAC3C;IAED,gDAAgD;IAChD,KAAY,oBAAoB,GAAG,kBAAkB,GAAG,cAAc,GAAG;QACvE,iIAAiI;QACjI,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IAEF,kEAAkE;IAClE,UAAiB,UAAU;QACzB;6GACqG;QACrG,MAAM,EAAE,MAAM,CAAC;KAChB;IAED,kEAAkE;IAClE,UAAiB,OAAQ,SAAQ,UAAU;QACzC,yDAAyD;QACzD,aAAa,EAAE,aAAa,CAAC;KAC9B;IAED,KAAY,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtD,UAAiB,gBAAgB;QAC/B,0HAA0H;QAC1H,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;KACxD;IAED,UAAiB,cAAc;QAC7B,+DAA+D;QAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,aAAc,SAAQ,cAAc;QACnD,iEAAiE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,iGAAiG;QACjG,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,KAAY,eAAe,GAAG,OAAO,GAAG,gBAAgB,GAAG,cAAc,CAAC;IAE1E,4CAA4C;IAC5C,UAAiB,UAAW,SAAQ,cAAc;QAChD,0JAA0J;QAC1J,OAAO,EAAE,MAAM,CAAC;QAChB,+FAA+F;QAC/F,IAAI,EAAE,MAAM,CAAC;QACb,oHAAoH;QACpH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,yDAAyD;QACzD,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,gIAAgI;QAChI,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB,8DAA8D;QAC9D,YAAY,EAAE,MAAM,CAAC;QACrB;;;WAGG;QACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;KAClC;IAED,gBAAgB;IAChB,UAAiB,eAAe;QAC9B,+DAA+D;QAC/D,IAAI,EAAE,MAAM,CAAC;QACb,oDAAoD;QACpD,MAAM,EAAE,MAAM,CAAC;QACf,kEAAkE;QAClE,SAAS,EAAE,cAAc,CAAC;QAC1B,yFAAyF;QACzF,WAAW,CAAC,EAAE,oBAAoB,CAAC;KACpC;IAED,qDAAqD;IACrD,KAAY,WAAW;QACrB,0CAA0C;QAC1C,IAAI,IAAO;QACX,sDAAsD;QACtD,WAAW,IAAO;QAClB,iDAAiD;QACjD,WAAW,IAAO;QAClB,uGAAuG;QACvG,eAAe,IAAO;QACtB,qCAAqC;QACrC,GAAG,MAAO;QACV,sBAAsB;QACtB,IAAI,IAAI;KACT;IAED;;;;;OAKG;IACH,UAAiB,UAAU;QACzB,iEAAiE;QACjE,IAAI,QAAQ,IAAI,OAAO,CAAC;QACxB,oCAAoC;QACpC,IAAI,IAAI,IAAI,MAAM,CAAC;QACnB,8DAA8D;QAC9D,IAAI,OAAO,IAAI,YAAY,CAAC;QAC5B,mEAAmE;QACnE,IAAI,IAAI,IAAI,UAAU,CAAC;QACvB;;;;;WAKG;QACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,2FAA2F;QAC3F,OAAO,IAAI,IAAI,CAAC;KACjB;IAED,qEAAqE;IACrE,UAAiB,cAAc;QAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;QAC5B,uBAAuB;QACvB,IAAI,WAAW,IAAI,MAAM,CAAC;QAC1B,iGAAiG;QACjG,IAAI,KAAK,IAAI,MAAM,CAAC;QACpB,mGAAmG;QACnG,IAAI,WAAW,IAAI,OAAO,CAAC;QAC3B,uHAAuH;QACvH,IAAI,WAAW,IAAI,OAAO,CAAC;QAC3B,iGAAiG;QACjG,IAAI,YAAY,IAAI,OAAO,CAAC;QAC5B,6GAA6G;QAC7G,IAAI,eAAe,IAAI,OAAO,CAAC;QAC/B,sEAAsE;QACtE,IAAI,WAAW,IAAI,MAAM,CAAC;QAC1B,IAAI,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE;QAC7B,6EAA6E;QAC7E,IAAI,aAAa,IAAI,MAAM,CAAC;QAC5B,8CAA8C;QAC9C,IAAI,SAAS,IAAI,MAAM,CAAC;QAExB;;;WAGG;QACH,mBAAmB,CAAC,IAAI,CAAC,EAAE;YAAE,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvF;;;;;;;;;;;;;;WAcG;QACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC;;;;WAIG;QACH,gBAAgB,IAAI,IAAI,CAAC;QAEzB;;;;WAIG;QACH,cAAc,IAAI,IAAI,CAAC;QAEvB;;;;WAIG;QACH,cAAc,IAAI,IAAI,CAAC;QAEvB;;;;;;WAMG;QACH,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;QAEjC;;;WAGG;QACH,UAAU,IAAI,IAAI,CAAC;QAEnB;;WAEG;QACH,MAAM,IAAI,IAAI,CAAC;QAEf;;;;WAIG;QACH,eAAe,IAAI,IAAI,CAAC;QAExB;;;;;WAKG;QACH,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAE/B;;;;;;;;WAQG;QACH,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAErD;;;;;WAKG;QACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7D;;WAEG;QACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE9C;;WAEG;QACH,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAE3C;;;WAGG;QACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,aAAa,GAAG,SAAS,CAAC;QAErE;;;;WAIG;QACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;KAC3C;IAED,gBAAgB;IAChB,UAAiB,aAAa;QAC5B,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;QACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAExB,qGAAqG;QACrG,MAAM,IAAI,IAAI,CAAC;QAEf;;;;;;WAMG;QACH,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KAC3B;IAED,gBAAgB;IAChB,SAAsB,UAAU,CAAC,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,iBA4B/G;IAED;;;;QAII;IACJ,SAAsB,QAAQ,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAG/F;IAED;;;;;;QAMI;IACJ,SAAsB,UAAU,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG;IAED;;;;QAII;IACJ,KAAY,oBAAoB,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;IAEjG;;;;;;;QAOI;IACJ,SAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,oBAAoB,iBAajH;IAED;;;;;;;;;;;;;QAaI;IACJ,SAAsB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,EAAE,oBAAoB,cAcrI;CACF"}

package/lib/cjs/CloudSqlite.js

@@ -131,6 +131,7 @@ var CloudSqlite;
       * @param container the CloudContainer for which the lock is to be acquired
       * @param operation an asynchronous operation performed with the write lock held.
       * @param busyHandler if present, function called when the write lock is currently held by another user.
+      * @returns a Promise with the result of `operation`
       */
     async function withWriteLock(user, container, operation, busyHandler) {
         if (container.hasWriteLock)

package/lib/cjs/CloudSqlite.js.map

@@ -1 +1 @@
-{"version":3,"file":"CloudSqlite.js","sourceRoot":"","sources":["../../src/CloudSqlite.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,2BAA+B;AAC/B,+BAA+B;AAC/B,8DAAyD;AAIzD;;GAEG;AACH,IAAiB,WAAW,CA4b3B;AA5bD,WAAiB,WAAW;IAC1B,SAAgB,oBAAoB,CAAC,IAA0B;QAC7D,OAAO,IAAI,+BAAa,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,gCAAoB,uBAEnC,CAAA;IACD,SAAgB,gBAAgB,CAAC,IAA4B;QAC3D,OAAO,IAAI,+BAAa,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAFe,4BAAgB,mBAE/B,CAAA;IACD,SAAgB,kBAAkB,CAAC,SAAqC,EAAE,MAAc,EAAE,IAAgC;QACxH,OAAO,IAAI,+BAAa,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;IAFe,8BAAkB,qBAEjC,CAAA;IAwHD,qDAAqD;IACrD,IAAY,WAaX;IAbD,WAAY,WAAW;QACrB,0CAA0C;QAC1C,6CAAW,CAAA;QACX,sDAAsD;QACtD,2DAAkB,CAAA;QAClB,iDAAiD;QACjD,2DAAkB,CAAA;QAClB,uGAAuG;QACvG,mEAAsB,CAAA;QACtB,qCAAqC;QACrC,6CAAU,CAAA;QACV,sBAAsB;QACtB,6CAAQ,CAAA;IACV,CAAC,EAbW,WAAW,GAAX,uBAAW,KAAX,uBAAW,QAatB;IA+LD,gBAAgB;IACT,KAAK,UAAU,UAAU,CAAC,SAA4B,EAAE,SAAyB,EAAE,KAAsB;QAC9G,IAAI,SAAS,KAAK,UAAU;YAC1B,IAAA,cAAS,EAAC,IAAA,cAAO,EAAC,KAAK,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,0DAA0D;QAE1H,IAAI,KAAiC,CAAC;QACtC,IAAI;YACF,MAAM,QAAQ,GAAG,IAAI,+BAAa,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAC1F,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;YACpC,IAAI,UAAU,EAAE;gBACd,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;oBAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;oBACxC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;oBACvB,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC;wBAC7C,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC9B,CAAC,EAAE,GAAG,CAAC,CAAC;aACT;YACD,MAAM,QAAQ,CAAC,OAAO,CAAC;YACvB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAG,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,wEAAwE;SACrG;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,OAAO,KAAK,WAAW;gBAC7B,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,CAAC,oCAAoC;YAEhE,MAAM,GAAG,CAAC;SACX;gBAAS;YACR,IAAI,KAAK;gBACP,aAAa,CAAC,KAAK,CAAC,CAAC;SACxB;IACH,CAAC;IA5BqB,sBAAU,aA4B/B,CAAA;IAED;;;;QAII;IACG,KAAK,UAAU,QAAQ,CAAC,SAAyB,EAAE,KAAsB;QAC9E,MAAM,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC7C,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,6DAA6D;IAC5F,CAAC;IAHqB,oBAAQ,WAG7B,CAAA;IAED;;;;;;QAMI;IACG,KAAK,UAAU,UAAU,CAAC,SAAyB,EAAE,KAAsB;QAChF,MAAM,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAFqB,sBAAU,aAE/B,CAAA;IASD;;;;;;;QAOI;IACG,KAAK,UAAU,gBAAgB,CAAC,IAAY,EAAE,SAAyB,EAAE,WAAkC;QAChH,IAAI,SAAS,CAAC,YAAY;YACxB,OAAO;QAET,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;aACzC;YAAC,OAAO,CAAM,EAAE;gBACf,IAAI,CAAC,CAAC,WAAW,KAAK,CAAC,IAAI,WAAW,IAAI,MAAM,KAAK,MAAM,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,uBAAuB;oBACpH,SAAS,CAAC,kCAAkC;gBAC9C,MAAM,CAAC,CAAC;aACT;SACF;IACH,CAAC;IAbqB,4BAAgB,mBAarC,CAAA;IAED;;;;;;;;;;;;QAYI;IACG,KAAK,UAAU,aAAa,CAAI,IAAY,EAAE,SAAyB,EAAE,SAAkB,EAAE,WAAkC;QACpI,IAAI,SAAS,CAAC,YAAY;YACxB,OAAO,SAAS,EAAE,CAAC;QAErB,MAAM,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QACrD,IAAI;YACF,6DAA6D;YAC7D,MAAM,GAAG,GAAG,MAAM,SAAS,EAAE,CAAC,CAAC,kCAAkC;YACjE,SAAS,CAAC,gBAAgB,EAAE,CAAC;YAC7B,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,CAAC,EAAE;YACV,SAAS,CAAC,cAAc,EAAE,CAAC,CAAE,0CAA0C;YACvE,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAdqB,yBAAa,gBAclC,CAAA;AACH,CAAC,EA5bgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA4b3B","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 SQLiteDb\r\n */\r\n\r\nimport { mkdirSync } from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport { NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\n\r\n/** Types for using SQLite files stored in cloud containers.\r\n * @beta\r\n */\r\nexport namespace CloudSqlite {\r\n  export function createCloudContainer(args: ContainerAccessProps): CloudContainer {\r\n    return new NativeLibrary.nativeLib.CloudContainer(args);\r\n  }\r\n  export function createCloudCache(args: CloudSqlite.CacheProps): CloudSqlite.CloudCache {\r\n    return new NativeLibrary.nativeLib.CloudCache(args);\r\n  }\r\n  export function startCloudPrefetch(container: CloudSqlite.CloudContainer, dbName: string, args?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch {\r\n    return new NativeLibrary.nativeLib.CloudPrefetch(container, dbName, args);\r\n  }\r\n\r\n  /** Properties that specify how to access the account for a cloud blob-store container. */\r\n  export interface AccountAccessProps {\r\n    /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n    storageType: string;\r\n    /** blob store account name, or a URI for custom domains. */\r\n    accessName: string;\r\n  }\r\n\r\n  /** Properties of a CloudContainer. */\r\n  export interface ContainerProps {\r\n    /** the name of the container. */\r\n    containerId: string;\r\n    /** an alias for the container. Defaults to `containerId` */\r\n    alias?: string;\r\n    /** token that grants access to the container. For sas=1 `storageType`s, this is the sasToken. For sas=0, this is the account key */\r\n    accessToken: string;\r\n    /** if true, container is attached with write permissions, and accessToken must provide write access to the cloud container. */\r\n    writeable?: boolean;\r\n    /** if true, container is attached in \"secure\" mode (blocks are encrypted). Only supported in daemon mode. */\r\n    secure?: boolean;\r\n  }\r\n\r\n  /** Returned from `CloudContainer.queryDatabase` describing one database in the container */\r\n  export interface CachedDbProps {\r\n    /** The total of (4Mb) blocks in the database. */\r\n    readonly totalBlocks: number;\r\n    /** the number of blocks of the database that have been downloaded into the CloudCache */\r\n    readonly localBlocks: number;\r\n    /** the number of blocks from this database that have been modified in the CloudCache and need to be uploaded. */\r\n    readonly dirtyBlocks: number;\r\n    /** If true, the database currently has transactions in the WAL file and may not be uploaded until they have been checkPointed. */\r\n    readonly transactions: boolean;\r\n    /** the state of this database. Indicates whether the database is new or deleted since last upload */\r\n    readonly state: \"\" | \"copied\" | \"deleted\";\r\n  }\r\n\r\n  /** Properties for accessing a CloudContainer */\r\n  export type ContainerAccessProps = AccountAccessProps & ContainerProps & {\r\n    /** Duration for holding write lock, in seconds. After this time the write lock expires if not refreshed. Default is one hour. */\r\n    durationSeconds?: number;\r\n  };\r\n\r\n  /** The name of a CloudSqlite database within a CloudContainer. */\r\n  export interface DbNameProp {\r\n    /** the name of the database within the CloudContainer.\r\n     * @note names of databases within a CloudContainer are always **case sensitive** on all platforms.*/\r\n    dbName: string;\r\n  }\r\n\r\n  /** Properties for accessing a database within a CloudContainer */\r\n  export interface DbProps extends DbNameProp {\r\n    /** the name of the local file to access the database. */\r\n    localFileName: LocalFileName;\r\n  }\r\n\r\n  export type TransferDirection = \"upload\" | \"download\";\r\n  export interface TransferProgress {\r\n    /** a user-supplied progress function called during the transfer operation. Return a non-0 value to abort the transfer. */\r\n    onProgress?: (loaded: number, total: number) => number;\r\n  }\r\n\r\n  export interface CloudHttpProps {\r\n    /** The number of simultaneous HTTP requests.  Default is 6. */\r\n    nRequests?: number;\r\n  }\r\n\r\n  export interface PrefetchProps extends CloudHttpProps {\r\n    /** timeout between requests, in milliseconds. Default is 100. */\r\n    timeout?: number;\r\n    /** The number of prefetch requests to issue while there is foreground activity. Default is 3. */\r\n    minRequests?: number;\r\n  }\r\n\r\n  export type TransferDbProps = DbProps & TransferProgress & CloudHttpProps;\r\n\r\n  /** Properties for creating a CloudCache. */\r\n  export interface CacheProps extends CloudHttpProps {\r\n    /** full path of directory for cache to store its files. Must be on a (preferably fast) local drive, and must be empty when the cache is first created. */\r\n    rootDir: string;\r\n    /** name of this cache. It is possible to have more than one CloudCache in the same session. */\r\n    name: string;\r\n    /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */\r\n    cacheSize?: string;\r\n    /** turn on diagnostics for `curl` (outputs to stderr) */\r\n    curlDiagnostics?: boolean;\r\n  }\r\n\r\n  /** Parameters used to obtain the write lock on a cloud container\r\n   * @internal\r\n   */\r\n  export interface ObtainLockParams {\r\n    /** The name of the user attempting to acquire the write lock. This name will be shown to other users while the lock is held. */\r\n    user?: string;\r\n    /** number of times to retry in the event the lock currently held by someone else.\r\n     * After this number of attempts, `onFailure` is called. Default is 20.\r\n     */\r\n    nRetries: number;\r\n    /** Delay between retries, in milliseconds. Default is 100. */\r\n    retryDelayMs: number;\r\n    /** function called if lock cannot be obtained after all retries. It is called with the name of the user currently holding the lock and\r\n     * generally is expected that the user will be consulted whether to wait further.\r\n     * If this function returns \"stop\", an exception will be thrown. Otherwise the retry cycle is restarted.\r\n     */\r\n    onFailure?: WriteLockBusyHandler;\r\n  }\r\n\r\n  /** @internal */\r\n  export interface LockAndOpenArgs {\r\n    /** the name to be displayed in the event of lock collisions */\r\n    user: string;\r\n    /** the name of the database within the container */\r\n    dbName: string;\r\n    /** the CloudContainer on which the operation will be performed */\r\n    container: CloudContainer;\r\n    /** if present, function called when the write lock is currently held by another user. */\r\n    busyHandler?: WriteLockBusyHandler;\r\n  }\r\n\r\n  /** Logging categories for `CloudCache.setLogMask` */\r\n  export enum LoggingMask {\r\n    /** log all HTTP requests and responses */\r\n    HTTP = 0x01,\r\n    /** log as blocks become dirty and must be uploaded */\r\n    DirtyBlocks = 0x02,\r\n    /** log as blocks are added to the delete list */\r\n    AddToDelete = 0x04,\r\n    /** log container lifecycle events (e.g. authorization requests, disconnects, and state transitions) */\r\n    LifecycleEvents = 0x08,\r\n    /** Turn on all logging categories */\r\n    All = 0xff,\r\n    /** Disable logging */\r\n    None = 0,\r\n  }\r\n\r\n  /**\r\n   * A cache for storing data from CloudSqlite databases. This object refers to a directory on a local filesystem\r\n   * and is used to **connect** CloudContainers so they may be accessed. The contents of the cache directory are entirely\r\n   * controlled by CloudSqlite and should be empty when the cache is first created and never modified directly. It maintains\r\n   * the state of the local data across sessions.\r\n   */\r\n  export interface CloudCache {\r\n    /** `true` if this CloudCache is connected to a daemon process */\r\n    get isDaemon(): boolean;\r\n    /** The name for this CloudCache. */\r\n    get name(): string;\r\n    /** The root directory of this CloudCache on a local drive. */\r\n    get rootDir(): LocalDirName;\r\n    /** The guid for this CloudCache. Used for acquiring write lock. */\r\n    get guid(): GuidString;\r\n    /** Configure logging for this CloudCache.\r\n     * @param mask A bitmask of `LoggingMask` values\r\n     * @note this method does nothing if [[isDaemon]] is true. Daemon logging is configured when the daemon is started.\r\n     * @note HTTP logging can be happen on multiple threads and may be buffered. To see buffered log messages, periodically call\r\n     * `IModelHost.flushLog`\r\n     */\r\n    setLogMask(mask: number): void;\r\n    /** destroy this CloudCache. All CloudContainers should be detached before calling this. */\r\n    destroy(): void;\r\n  }\r\n\r\n  /** A CloudSqlite container that may be connected to a CloudCache. */\r\n  export interface CloudContainer {\r\n    readonly cache?: CloudCache;\r\n    /** The ContainerId. */\r\n    get containerId(): string;\r\n    /** The *alias* to identify this CloudContainer in a CloudCache. Usually just the ContainerId. */\r\n    get alias(): string;\r\n    /** true if this CloudContainer is currently connected to a CloudCache via the `connect` method. */\r\n    get isConnected(): boolean;\r\n    /** true if this CloudContainer was created with the `writeable` flag (and its `accessToken` supplies write access). */\r\n    get isWriteable(): boolean;\r\n    /** true if this CloudContainer currently holds the write lock for its container in the cloud. */\r\n    get hasWriteLock(): boolean;\r\n    /** true if this CloudContainer has local changes that have not be uploaded to its container in the cloud. */\r\n    get hasLocalChanges(): boolean;\r\n    /** The current accessToken providing access to the cloud container */\r\n    get accessToken(): string;\r\n    set accessToken(val: string);\r\n    /** Get the number of garbage blocks in this container that can be purged. */\r\n    get garbageBlocks(): number;\r\n    /** The block size for this CloudContainer. */\r\n    get blockSize(): number;\r\n\r\n    /**\r\n     * initialize a cloud blob-store container to be used as a new Sqlite CloudContainer. This creates the manifest, and should be\r\n     * performed on an empty container. If an existing manifest is present, it is destroyed and a new one is created (essentially emptying the container.)\r\n     */\r\n    initializeContainer(opts?: { checksumBlockNames?: boolean, blockSize?: number }): void;\r\n\r\n    /**\r\n     * Attempt to acquire the write lock for this CloudContainer. For this to succeed:\r\n     * 1. it must be connected to a `CloudCache`\r\n     * 2. this CloudContainer must have been constructed with `writeable: true`\r\n     * 3. the `accessToken` must authorize write access\r\n     * 4. no other process may be holding an unexpired write lock\r\n     * @throws exception if any of the above conditions fail\r\n     * @note Write locks *expire* after the duration specified in the `durationSeconds` property of the constructor argument, in case a process\r\n     * crashes or otherwise fails to release the lock. Calling `acquireWriteLock` with the lock already held resets the lock duration from the current time,\r\n     * so long running processes should call this method periodically to ensure their lock doesn't expire (they should also make sure their accessToken is refreshed\r\n     * before it expires.)\r\n     * @note on success, the manifest is polled before the promise resolves.\r\n     * @param user  An identifier of the process/user locking the CloudContainer. In the event of a write lock\r\n     * collision, this string will be included in the exception string of the *other* process attempting to obtain a write lock.\r\n     */\r\n    acquireWriteLock(user: string): void;\r\n\r\n    /**\r\n     * Release the write lock if it is currently held.\r\n     * @note if there are local changes that have not been uploaded, they are automatically uploaded before the write lock is released.\r\n     * @note if the write lock is not held, this method does nothing.\r\n     */\r\n    releaseWriteLock(): void;\r\n\r\n    /**\r\n     * Destroy any currently valid write lock from this or any other process. This is obviously very dangerous and defeats the purpose of write locking.\r\n     * This method exists only for administrator tools to clear a failed process without waiting for the expiration period. It can also be useful for tests.\r\n     * For this to succeed, all of the conditions of `acquireWriteLock` must be true other than #4.\r\n     */\r\n    clearWriteLock(): void;\r\n\r\n    /**\r\n     * Abandon any local changes in this container. If the write lock is currently held, it is released.\r\n     * This function fails with BE_SQLITE_BUSY if one or more clients have open read or write transactions\r\n     * on any database in the container.\r\n     */\r\n    abandonChanges(): void;\r\n\r\n    /**\r\n     * Connect this CloudContainer to a CloudCache for reading or writing its manifest, write lock, and databases.\r\n     * @note A CloudCache is a local directory holding copies of information from the cloud. Its content is persistent across sessions,\r\n     * but this method must be called each session to (re)establish the connection to the cache. If the CloudCache was previously populated,\r\n     * this method may be called and will succeed *even when offline* or without a valid `accessToken`.\r\n     * @note all operations that access the contents of databases or the manifest require this method be called (`isConnected === true`).\r\n     */\r\n    connect(cache: CloudCache): void;\r\n\r\n    /**\r\n     * Disconnect this CloudContainer from its CloudCache. There must be no open databases from this container. Leaves the container attached to the\r\n     * CloudCache so it is available for future sessions.\r\n     */\r\n    disconnect(): void;\r\n\r\n    /**\r\n     * Permanently Detach and Disconnect this CloudContainer from its CloudCache. There must be no open databases from this container.\r\n     */\r\n    detach(): void;\r\n\r\n    /**\r\n     * Poll cloud storage for changes from other processes. *No changes* made by other processes are visible to\r\n     * this CloudContainer unless/until this method is called.\r\n     * @note this is automatically called whenever the write lock is obtained to ensure all changes are against the latest version.\r\n     */\r\n    checkForChanges(): void;\r\n\r\n    /**\r\n     * Upload any changed blocks from all databases in this CloudContainer.\r\n     * @note this is called automatically from `releaseWriteLock` before the write lock is released. It is only necessary to call this directly if you\r\n     * wish to upload changes while the write lock is still held.\r\n     * @see hasLocalChanges\r\n     */\r\n    uploadChanges(): Promise<void>;\r\n\r\n    /**\r\n     * Clean any unused deleted blocks from cloud storage. When a database is written, a subset of its blocks are replaced\r\n     * by new versions, sometimes leaving the originals unused. In this case, they are not deleted immediately.\r\n     * Instead, they are scheduled for deletion at some later time. Calling this method deletes all blocks in the cloud container\r\n     * for which the scheduled deletion time has passed.\r\n     * @param nSeconds Any block that was marked as unused before this number of seconds ago will be deleted. Specifying a non-zero\r\n     * value gives a period of time for other clients to refresh their manifests and stop using the now-garbage blocks. Otherwise they may get\r\n     * a 404 error. Default is 1 hour.\r\n     */\r\n    cleanDeletedBlocks(nSeconds?: number): Promise<void>;\r\n\r\n    /**\r\n     * Create a copy of an existing database within this CloudContainer with a new name.\r\n     * @note CloudSqlite uses copy-on-write semantics for this operation. That is, this method merely makes a\r\n     * new entry in the manifest with the new name that *shares* all of its blocks with the original database.\r\n     * If either database subsequently changes, the only modified blocks are not shared.\r\n     */\r\n    copyDatabase(dbName: string, toAlias: string): Promise<void>;\r\n\r\n    /** Remove a database from this CloudContainer.\r\n     * @see cleanDeletedBlocks\r\n     */\r\n    deleteDatabase(dbName: string): Promise<void>;\r\n\r\n    /** Get the list of database names in this CloudContainer.\r\n     * @param globArg if present, filter the results with SQLite [GLOB](https://www.sqlite.org/lang_expr.html#glob) operator.\r\n     */\r\n    queryDatabases(globArg?: string): string[];\r\n\r\n    /**\r\n     * Get the status of a specific database in this CloudContainer.\r\n     * @param dbName the name of the database of interest\r\n     */\r\n    queryDatabase(dbName: string): CloudSqlite.CachedDbProps | undefined;\r\n\r\n    /**\r\n     * Get the SHA1 hash of the content of a database.\r\n     * @param dbName the name of the database of interest\r\n     * @note the hash will be empty if the database does not exist\r\n     */\r\n    queryDatabaseHash(dbName: string): string;\r\n  }\r\n\r\n  /** @internal */\r\n  export interface CloudPrefetch {\r\n    readonly cloudContainer: CloudContainer;\r\n    readonly dbName: string;\r\n\r\n    /** Cancel a currently pending prefetch. The promise will be resolved immediately after this call. */\r\n    cancel(): void;\r\n\r\n    /**\r\n     * Promise that is resolved when the prefetch completes or is cancelled. Await this promise to ensure that the\r\n     * database has been fully downloaded before going offline, for example.\r\n     * @returns a Promise that resolves to `true` if the prefetch completed and the entire database is local, or `false` if it was aborted or failed.\r\n     * @note the promise is *not* rejected on `cancel`. Some progress may (or may not) have been made by the request.\r\n     * @note To monitor the progress being made during prefetch, call `CloudContainer.queryDatabase` periodically.\r\n     */\r\n    promise: Promise<boolean>;\r\n  }\r\n\r\n  /** @internal */\r\n  export async function transferDb(direction: TransferDirection, container: CloudContainer, props: TransferDbProps) {\r\n    if (direction === \"download\")\r\n      mkdirSync(dirname(props.localFileName), { recursive: true }); // make sure the directory exists before starting download\r\n\r\n    let timer: NodeJS.Timeout | undefined;\r\n    try {\r\n      const transfer = new NativeLibrary.nativeLib.CloudDbTransfer(direction, container, props);\r\n      let total = 0;\r\n      const onProgress = props.onProgress;\r\n      if (onProgress) {\r\n        timer = setInterval(async () => { // set an interval timer to show progress every 250ms\r\n          const progress = transfer.getProgress();\r\n          total = progress.total;\r\n          if (onProgress(progress.loaded, progress.total))\r\n            transfer.cancelTransfer();\r\n        }, 250);\r\n      }\r\n      await transfer.promise;\r\n      onProgress?.(total, total); // make sure we call progress func one last time when download completes\r\n    } catch (err: any) {\r\n      if (err.message === \"cancelled\")\r\n        err.errorNumber = 131079; // BriefcaseStatus.DownloadCancelled\r\n\r\n      throw err;\r\n    } finally {\r\n      if (timer)\r\n        clearInterval(timer);\r\n    }\r\n  }\r\n\r\n  /** Upload a database into a CloudContainer\r\n    * @param container the CloudContainer holding the database. Must be connected.\r\n    * @param props the properties that describe the database to be downloaded, plus optionally an `onProgress` function.\r\n    * @note this function requires that the write lock be held on the container\r\n    */\r\n  export async function uploadDb(container: CloudContainer, props: TransferDbProps): Promise<void> {\r\n    await transferDb(\"upload\", container, props);\r\n    container.checkForChanges(); // re-read the manifest so the database is available locally.\r\n  }\r\n\r\n  /** Download a database from a CloudContainer\r\n    * @param container the CloudContainer holding the database. Must be connected.\r\n    * @param props the properties that describe the database to be downloaded, plus optionally an `onProgress` function.\r\n    * @returns a Promise that is resolved when the download completes.\r\n    * @note the download is \"restartable.\" If the transfer is aborted and then re-requested, it will continue from where\r\n    * it left off rather than re-downloading the entire file.\r\n    */\r\n  export async function downloadDb(container: CloudContainer, props: TransferDbProps): Promise<void> {\r\n    await transferDb(\"download\", container, props);\r\n  }\r\n\r\n  /** Optional method to be called when an attempt to acquire the write lock fails because another user currently holds it.\r\n    * @param lockedBy The identifier supplied by the application/user that currently holds the lock.\r\n    * @param expires a stringified Date (in local time) indicating when the lock will expire.\r\n    * @return \"stop\" to give up and stop retrying. Generally, it's a good idea to wait for some time before returning.\r\n    */\r\n  export type WriteLockBusyHandler = (lockedBy: string, expires: string) => Promise<void | \"stop\">;\r\n\r\n  /**\r\n    * Attempt to acquire the write lock for a container, with retries.\r\n    * If write lock is held by another user, call busyHandler if supplied. If no busyHandler, or handler returns \"stop\", throw. Otherwise try again.\r\n    * @note if write lock is already held, this function does nothing.\r\n    * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us\r\n    * @param container the CloudContainer for which the lock is to be acquired\r\n    * @param busyHandler if present, function called when the write lock is currently held by another user.\r\n    */\r\n  export async function acquireWriteLock(user: string, container: CloudContainer, busyHandler?: WriteLockBusyHandler) {\r\n    if (container.hasWriteLock)\r\n      return;\r\n\r\n    while (true) {\r\n      try {\r\n        return container.acquireWriteLock(user);\r\n      } catch (e: any) {\r\n        if (e.errorNumber === 5 && busyHandler && \"stop\" !== await busyHandler(e.lockedBy, e.expires)) // 5 === BE_SQLITE_BUSY\r\n          continue; // busy handler wants to try again\r\n        throw e;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n    * Perform an asynchronous write operation on a CloudContainer with the write lock held.\r\n    * 1. if write lock is already held, call operation and return.\r\n    * 2. attempt to acquire the write lock, with retries. Throw if unable to obtain write lock.\r\n    * 3. perform the operation\r\n    * 3.a if the operation throws, abandon all changes and re-throw\r\n    * 4. release the write lock.\r\n    * 5. return value from operation\r\n    * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us\r\n    * @param container the CloudContainer for which the lock is to be acquired\r\n    * @param operation an asynchronous operation performed with the write lock held.\r\n    * @param busyHandler if present, function called when the write lock is currently held by another user.\r\n    */\r\n  export async function withWriteLock<T>(user: string, container: CloudContainer, operation: () => T, busyHandler?: WriteLockBusyHandler) {\r\n    if (container.hasWriteLock)\r\n      return operation();\r\n\r\n    await acquireWriteLock(user, container, busyHandler);\r\n    try {\r\n      // eslint-disable-next-line @typescript-eslint/await-thenable\r\n      const val = await operation(); // wait for work to finish or fail\r\n      container.releaseWriteLock();\r\n      return val;\r\n    } catch (e) {\r\n      container.abandonChanges();  // if operation threw, abandon all changes\r\n      throw e;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"CloudSqlite.js","sourceRoot":"","sources":["../../src/CloudSqlite.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,2BAA+B;AAC/B,+BAA+B;AAC/B,8DAAyD;AAIzD;;GAEG;AACH,IAAiB,WAAW,CA6b3B;AA7bD,WAAiB,WAAW;IAC1B,SAAgB,oBAAoB,CAAC,IAA0B;QAC7D,OAAO,IAAI,+BAAa,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,gCAAoB,uBAEnC,CAAA;IACD,SAAgB,gBAAgB,CAAC,IAA4B;QAC3D,OAAO,IAAI,+BAAa,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAFe,4BAAgB,mBAE/B,CAAA;IACD,SAAgB,kBAAkB,CAAC,SAAqC,EAAE,MAAc,EAAE,IAAgC;QACxH,OAAO,IAAI,+BAAa,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;IAFe,8BAAkB,qBAEjC,CAAA;IAwHD,qDAAqD;IACrD,IAAY,WAaX;IAbD,WAAY,WAAW;QACrB,0CAA0C;QAC1C,6CAAW,CAAA;QACX,sDAAsD;QACtD,2DAAkB,CAAA;QAClB,iDAAiD;QACjD,2DAAkB,CAAA;QAClB,uGAAuG;QACvG,mEAAsB,CAAA;QACtB,qCAAqC;QACrC,6CAAU,CAAA;QACV,sBAAsB;QACtB,6CAAQ,CAAA;IACV,CAAC,EAbW,WAAW,GAAX,uBAAW,KAAX,uBAAW,QAatB;IA+LD,gBAAgB;IACT,KAAK,UAAU,UAAU,CAAC,SAA4B,EAAE,SAAyB,EAAE,KAAsB;QAC9G,IAAI,SAAS,KAAK,UAAU;YAC1B,IAAA,cAAS,EAAC,IAAA,cAAO,EAAC,KAAK,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,0DAA0D;QAE1H,IAAI,KAAiC,CAAC;QACtC,IAAI;YACF,MAAM,QAAQ,GAAG,IAAI,+BAAa,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAC1F,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;YACpC,IAAI,UAAU,EAAE;gBACd,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;oBAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;oBACxC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;oBACvB,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC;wBAC7C,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC9B,CAAC,EAAE,GAAG,CAAC,CAAC;aACT;YACD,MAAM,QAAQ,CAAC,OAAO,CAAC;YACvB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAG,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,wEAAwE;SACrG;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,OAAO,KAAK,WAAW;gBAC7B,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,CAAC,oCAAoC;YAEhE,MAAM,GAAG,CAAC;SACX;gBAAS;YACR,IAAI,KAAK;gBACP,aAAa,CAAC,KAAK,CAAC,CAAC;SACxB;IACH,CAAC;IA5BqB,sBAAU,aA4B/B,CAAA;IAED;;;;QAII;IACG,KAAK,UAAU,QAAQ,CAAC,SAAyB,EAAE,KAAsB;QAC9E,MAAM,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC7C,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,6DAA6D;IAC5F,CAAC;IAHqB,oBAAQ,WAG7B,CAAA;IAED;;;;;;QAMI;IACG,KAAK,UAAU,UAAU,CAAC,SAAyB,EAAE,KAAsB;QAChF,MAAM,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAFqB,sBAAU,aAE/B,CAAA;IASD;;;;;;;QAOI;IACG,KAAK,UAAU,gBAAgB,CAAC,IAAY,EAAE,SAAyB,EAAE,WAAkC;QAChH,IAAI,SAAS,CAAC,YAAY;YACxB,OAAO;QAET,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;aACzC;YAAC,OAAO,CAAM,EAAE;gBACf,IAAI,CAAC,CAAC,WAAW,KAAK,CAAC,IAAI,WAAW,IAAI,MAAM,KAAK,MAAM,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,uBAAuB;oBACpH,SAAS,CAAC,kCAAkC;gBAC9C,MAAM,CAAC,CAAC;aACT;SACF;IACH,CAAC;IAbqB,4BAAgB,mBAarC,CAAA;IAED;;;;;;;;;;;;;QAaI;IACG,KAAK,UAAU,aAAa,CAAI,IAAY,EAAE,SAAyB,EAAE,SAAkB,EAAE,WAAkC;QACpI,IAAI,SAAS,CAAC,YAAY;YACxB,OAAO,SAAS,EAAE,CAAC;QAErB,MAAM,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QACrD,IAAI;YACF,6DAA6D;YAC7D,MAAM,GAAG,GAAG,MAAM,SAAS,EAAE,CAAC,CAAC,kCAAkC;YACjE,SAAS,CAAC,gBAAgB,EAAE,CAAC;YAC7B,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,CAAC,EAAE;YACV,SAAS,CAAC,cAAc,EAAE,CAAC,CAAE,0CAA0C;YACvE,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAdqB,yBAAa,gBAclC,CAAA;AACH,CAAC,EA7bgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA6b3B","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 SQLiteDb\r\n */\r\n\r\nimport { mkdirSync } from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport { NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\n\r\n/** Types for using SQLite files stored in cloud containers.\r\n * @beta\r\n */\r\nexport namespace CloudSqlite {\r\n  export function createCloudContainer(args: ContainerAccessProps): CloudContainer {\r\n    return new NativeLibrary.nativeLib.CloudContainer(args);\r\n  }\r\n  export function createCloudCache(args: CloudSqlite.CacheProps): CloudSqlite.CloudCache {\r\n    return new NativeLibrary.nativeLib.CloudCache(args);\r\n  }\r\n  export function startCloudPrefetch(container: CloudSqlite.CloudContainer, dbName: string, args?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch {\r\n    return new NativeLibrary.nativeLib.CloudPrefetch(container, dbName, args);\r\n  }\r\n\r\n  /** Properties that specify how to access the account for a cloud blob-store container. */\r\n  export interface AccountAccessProps {\r\n    /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n    storageType: string;\r\n    /** blob store account name, or a URI for custom domains. */\r\n    accessName: string;\r\n  }\r\n\r\n  /** Properties of a CloudContainer. */\r\n  export interface ContainerProps {\r\n    /** the name of the container. */\r\n    containerId: string;\r\n    /** an alias for the container. Defaults to `containerId` */\r\n    alias?: string;\r\n    /** token that grants access to the container. For sas=1 `storageType`s, this is the sasToken. For sas=0, this is the account key */\r\n    accessToken: string;\r\n    /** if true, container is attached with write permissions, and accessToken must provide write access to the cloud container. */\r\n    writeable?: boolean;\r\n    /** if true, container is attached in \"secure\" mode (blocks are encrypted). Only supported in daemon mode. */\r\n    secure?: boolean;\r\n  }\r\n\r\n  /** Returned from `CloudContainer.queryDatabase` describing one database in the container */\r\n  export interface CachedDbProps {\r\n    /** The total of (4Mb) blocks in the database. */\r\n    readonly totalBlocks: number;\r\n    /** the number of blocks of the database that have been downloaded into the CloudCache */\r\n    readonly localBlocks: number;\r\n    /** the number of blocks from this database that have been modified in the CloudCache and need to be uploaded. */\r\n    readonly dirtyBlocks: number;\r\n    /** If true, the database currently has transactions in the WAL file and may not be uploaded until they have been checkPointed. */\r\n    readonly transactions: boolean;\r\n    /** the state of this database. Indicates whether the database is new or deleted since last upload */\r\n    readonly state: \"\" | \"copied\" | \"deleted\";\r\n  }\r\n\r\n  /** Properties for accessing a CloudContainer */\r\n  export type ContainerAccessProps = AccountAccessProps & ContainerProps & {\r\n    /** Duration for holding write lock, in seconds. After this time the write lock expires if not refreshed. Default is one hour. */\r\n    durationSeconds?: number;\r\n  };\r\n\r\n  /** The name of a CloudSqlite database within a CloudContainer. */\r\n  export interface DbNameProp {\r\n    /** the name of the database within the CloudContainer.\r\n     * @note names of databases within a CloudContainer are always **case sensitive** on all platforms.*/\r\n    dbName: string;\r\n  }\r\n\r\n  /** Properties for accessing a database within a CloudContainer */\r\n  export interface DbProps extends DbNameProp {\r\n    /** the name of the local file to access the database. */\r\n    localFileName: LocalFileName;\r\n  }\r\n\r\n  export type TransferDirection = \"upload\" | \"download\";\r\n  export interface TransferProgress {\r\n    /** a user-supplied progress function called during the transfer operation. Return a non-0 value to abort the transfer. */\r\n    onProgress?: (loaded: number, total: number) => number;\r\n  }\r\n\r\n  export interface CloudHttpProps {\r\n    /** The number of simultaneous HTTP requests.  Default is 6. */\r\n    nRequests?: number;\r\n  }\r\n\r\n  export interface PrefetchProps extends CloudHttpProps {\r\n    /** timeout between requests, in milliseconds. Default is 100. */\r\n    timeout?: number;\r\n    /** The number of prefetch requests to issue while there is foreground activity. Default is 3. */\r\n    minRequests?: number;\r\n  }\r\n\r\n  export type TransferDbProps = DbProps & TransferProgress & CloudHttpProps;\r\n\r\n  /** Properties for creating a CloudCache. */\r\n  export interface CacheProps extends CloudHttpProps {\r\n    /** full path of directory for cache to store its files. Must be on a (preferably fast) local drive, and must be empty when the cache is first created. */\r\n    rootDir: string;\r\n    /** name of this cache. It is possible to have more than one CloudCache in the same session. */\r\n    name: string;\r\n    /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */\r\n    cacheSize?: string;\r\n    /** turn on diagnostics for `curl` (outputs to stderr) */\r\n    curlDiagnostics?: boolean;\r\n  }\r\n\r\n  /** Parameters used to obtain the write lock on a cloud container\r\n   * @internal\r\n   */\r\n  export interface ObtainLockParams {\r\n    /** The name of the user attempting to acquire the write lock. This name will be shown to other users while the lock is held. */\r\n    user?: string;\r\n    /** number of times to retry in the event the lock currently held by someone else.\r\n     * After this number of attempts, `onFailure` is called. Default is 20.\r\n     */\r\n    nRetries: number;\r\n    /** Delay between retries, in milliseconds. Default is 100. */\r\n    retryDelayMs: number;\r\n    /** function called if lock cannot be obtained after all retries. It is called with the name of the user currently holding the lock and\r\n     * generally is expected that the user will be consulted whether to wait further.\r\n     * If this function returns \"stop\", an exception will be thrown. Otherwise the retry cycle is restarted.\r\n     */\r\n    onFailure?: WriteLockBusyHandler;\r\n  }\r\n\r\n  /** @internal */\r\n  export interface LockAndOpenArgs {\r\n    /** the name to be displayed in the event of lock collisions */\r\n    user: string;\r\n    /** the name of the database within the container */\r\n    dbName: string;\r\n    /** the CloudContainer on which the operation will be performed */\r\n    container: CloudContainer;\r\n    /** if present, function called when the write lock is currently held by another user. */\r\n    busyHandler?: WriteLockBusyHandler;\r\n  }\r\n\r\n  /** Logging categories for `CloudCache.setLogMask` */\r\n  export enum LoggingMask {\r\n    /** log all HTTP requests and responses */\r\n    HTTP = 0x01,\r\n    /** log as blocks become dirty and must be uploaded */\r\n    DirtyBlocks = 0x02,\r\n    /** log as blocks are added to the delete list */\r\n    AddToDelete = 0x04,\r\n    /** log container lifecycle events (e.g. authorization requests, disconnects, and state transitions) */\r\n    LifecycleEvents = 0x08,\r\n    /** Turn on all logging categories */\r\n    All = 0xff,\r\n    /** Disable logging */\r\n    None = 0,\r\n  }\r\n\r\n  /**\r\n   * A cache for storing data from CloudSqlite databases. This object refers to a directory on a local filesystem\r\n   * and is used to **connect** CloudContainers so they may be accessed. The contents of the cache directory are entirely\r\n   * controlled by CloudSqlite and should be empty when the cache is first created and never modified directly. It maintains\r\n   * the state of the local data across sessions.\r\n   */\r\n  export interface CloudCache {\r\n    /** `true` if this CloudCache is connected to a daemon process */\r\n    get isDaemon(): boolean;\r\n    /** The name for this CloudCache. */\r\n    get name(): string;\r\n    /** The root directory of this CloudCache on a local drive. */\r\n    get rootDir(): LocalDirName;\r\n    /** The guid for this CloudCache. Used for acquiring write lock. */\r\n    get guid(): GuidString;\r\n    /** Configure logging for this CloudCache.\r\n     * @param mask A bitmask of `LoggingMask` values\r\n     * @note this method does nothing if [[isDaemon]] is true. Daemon logging is configured when the daemon is started.\r\n     * @note HTTP logging can be happen on multiple threads and may be buffered. To see buffered log messages, periodically call\r\n     * `IModelHost.flushLog`\r\n     */\r\n    setLogMask(mask: number): void;\r\n    /** destroy this CloudCache. All CloudContainers should be detached before calling this. */\r\n    destroy(): void;\r\n  }\r\n\r\n  /** A CloudSqlite container that may be connected to a CloudCache. */\r\n  export interface CloudContainer {\r\n    readonly cache?: CloudCache;\r\n    /** The ContainerId. */\r\n    get containerId(): string;\r\n    /** The *alias* to identify this CloudContainer in a CloudCache. Usually just the ContainerId. */\r\n    get alias(): string;\r\n    /** true if this CloudContainer is currently connected to a CloudCache via the `connect` method. */\r\n    get isConnected(): boolean;\r\n    /** true if this CloudContainer was created with the `writeable` flag (and its `accessToken` supplies write access). */\r\n    get isWriteable(): boolean;\r\n    /** true if this CloudContainer currently holds the write lock for its container in the cloud. */\r\n    get hasWriteLock(): boolean;\r\n    /** true if this CloudContainer has local changes that have not be uploaded to its container in the cloud. */\r\n    get hasLocalChanges(): boolean;\r\n    /** The current accessToken providing access to the cloud container */\r\n    get accessToken(): string;\r\n    set accessToken(val: string);\r\n    /** Get the number of garbage blocks in this container that can be purged. */\r\n    get garbageBlocks(): number;\r\n    /** The block size for this CloudContainer. */\r\n    get blockSize(): number;\r\n\r\n    /**\r\n     * initialize a cloud blob-store container to be used as a new Sqlite CloudContainer. This creates the manifest, and should be\r\n     * performed on an empty container. If an existing manifest is present, it is destroyed and a new one is created (essentially emptying the container.)\r\n     */\r\n    initializeContainer(opts?: { checksumBlockNames?: boolean, blockSize?: number }): void;\r\n\r\n    /**\r\n     * Attempt to acquire the write lock for this CloudContainer. For this to succeed:\r\n     * 1. it must be connected to a `CloudCache`\r\n     * 2. this CloudContainer must have been constructed with `writeable: true`\r\n     * 3. the `accessToken` must authorize write access\r\n     * 4. no other process may be holding an unexpired write lock\r\n     * @throws exception if any of the above conditions fail\r\n     * @note Write locks *expire* after the duration specified in the `durationSeconds` property of the constructor argument, in case a process\r\n     * crashes or otherwise fails to release the lock. Calling `acquireWriteLock` with the lock already held resets the lock duration from the current time,\r\n     * so long running processes should call this method periodically to ensure their lock doesn't expire (they should also make sure their accessToken is refreshed\r\n     * before it expires.)\r\n     * @note on success, the manifest is polled before the promise resolves.\r\n     * @param user  An identifier of the process/user locking the CloudContainer. In the event of a write lock\r\n     * collision, this string will be included in the exception string of the *other* process attempting to obtain a write lock.\r\n     */\r\n    acquireWriteLock(user: string): void;\r\n\r\n    /**\r\n     * Release the write lock if it is currently held.\r\n     * @note if there are local changes that have not been uploaded, they are automatically uploaded before the write lock is released.\r\n     * @note if the write lock is not held, this method does nothing.\r\n     */\r\n    releaseWriteLock(): void;\r\n\r\n    /**\r\n     * Destroy any currently valid write lock from this or any other process. This is obviously very dangerous and defeats the purpose of write locking.\r\n     * This method exists only for administrator tools to clear a failed process without waiting for the expiration period. It can also be useful for tests.\r\n     * For this to succeed, all of the conditions of `acquireWriteLock` must be true other than #4.\r\n     */\r\n    clearWriteLock(): void;\r\n\r\n    /**\r\n     * Abandon any local changes in this container. If the write lock is currently held, it is released.\r\n     * This function fails with BE_SQLITE_BUSY if one or more clients have open read or write transactions\r\n     * on any database in the container.\r\n     */\r\n    abandonChanges(): void;\r\n\r\n    /**\r\n     * Connect this CloudContainer to a CloudCache for reading or writing its manifest, write lock, and databases.\r\n     * @note A CloudCache is a local directory holding copies of information from the cloud. Its content is persistent across sessions,\r\n     * but this method must be called each session to (re)establish the connection to the cache. If the CloudCache was previously populated,\r\n     * this method may be called and will succeed *even when offline* or without a valid `accessToken`.\r\n     * @note all operations that access the contents of databases or the manifest require this method be called (`isConnected === true`).\r\n     */\r\n    connect(cache: CloudCache): void;\r\n\r\n    /**\r\n     * Disconnect this CloudContainer from its CloudCache. There must be no open databases from this container. Leaves the container attached to the\r\n     * CloudCache so it is available for future sessions.\r\n     */\r\n    disconnect(): void;\r\n\r\n    /**\r\n     * Permanently Detach and Disconnect this CloudContainer from its CloudCache. There must be no open databases from this container.\r\n     */\r\n    detach(): void;\r\n\r\n    /**\r\n     * Poll cloud storage for changes from other processes. *No changes* made by other processes are visible to\r\n     * this CloudContainer unless/until this method is called.\r\n     * @note this is automatically called whenever the write lock is obtained to ensure all changes are against the latest version.\r\n     */\r\n    checkForChanges(): void;\r\n\r\n    /**\r\n     * Upload any changed blocks from all databases in this CloudContainer.\r\n     * @note this is called automatically from `releaseWriteLock` before the write lock is released. It is only necessary to call this directly if you\r\n     * wish to upload changes while the write lock is still held.\r\n     * @see hasLocalChanges\r\n     */\r\n    uploadChanges(): Promise<void>;\r\n\r\n    /**\r\n     * Clean any unused deleted blocks from cloud storage. When a database is written, a subset of its blocks are replaced\r\n     * by new versions, sometimes leaving the originals unused. In this case, they are not deleted immediately.\r\n     * Instead, they are scheduled for deletion at some later time. Calling this method deletes all blocks in the cloud container\r\n     * for which the scheduled deletion time has passed.\r\n     * @param nSeconds Any block that was marked as unused before this number of seconds ago will be deleted. Specifying a non-zero\r\n     * value gives a period of time for other clients to refresh their manifests and stop using the now-garbage blocks. Otherwise they may get\r\n     * a 404 error. Default is 1 hour.\r\n     */\r\n    cleanDeletedBlocks(nSeconds?: number): Promise<void>;\r\n\r\n    /**\r\n     * Create a copy of an existing database within this CloudContainer with a new name.\r\n     * @note CloudSqlite uses copy-on-write semantics for this operation. That is, this method merely makes a\r\n     * new entry in the manifest with the new name that *shares* all of its blocks with the original database.\r\n     * If either database subsequently changes, the only modified blocks are not shared.\r\n     */\r\n    copyDatabase(dbName: string, toAlias: string): Promise<void>;\r\n\r\n    /** Remove a database from this CloudContainer.\r\n     * @see cleanDeletedBlocks\r\n     */\r\n    deleteDatabase(dbName: string): Promise<void>;\r\n\r\n    /** Get the list of database names in this CloudContainer.\r\n     * @param globArg if present, filter the results with SQLite [GLOB](https://www.sqlite.org/lang_expr.html#glob) operator.\r\n     */\r\n    queryDatabases(globArg?: string): string[];\r\n\r\n    /**\r\n     * Get the status of a specific database in this CloudContainer.\r\n     * @param dbName the name of the database of interest\r\n     */\r\n    queryDatabase(dbName: string): CloudSqlite.CachedDbProps | undefined;\r\n\r\n    /**\r\n     * Get the SHA1 hash of the content of a database.\r\n     * @param dbName the name of the database of interest\r\n     * @note the hash will be empty if the database does not exist\r\n     */\r\n    queryDatabaseHash(dbName: string): string;\r\n  }\r\n\r\n  /** @internal */\r\n  export interface CloudPrefetch {\r\n    readonly cloudContainer: CloudContainer;\r\n    readonly dbName: string;\r\n\r\n    /** Cancel a currently pending prefetch. The promise will be resolved immediately after this call. */\r\n    cancel(): void;\r\n\r\n    /**\r\n     * Promise that is resolved when the prefetch completes or is cancelled. Await this promise to ensure that the\r\n     * database has been fully downloaded before going offline, for example.\r\n     * @returns a Promise that resolves to `true` if the prefetch completed and the entire database is local, or `false` if it was aborted or failed.\r\n     * @note the promise is *not* rejected on `cancel`. Some progress may (or may not) have been made by the request.\r\n     * @note To monitor the progress being made during prefetch, call `CloudContainer.queryDatabase` periodically.\r\n     */\r\n    promise: Promise<boolean>;\r\n  }\r\n\r\n  /** @internal */\r\n  export async function transferDb(direction: TransferDirection, container: CloudContainer, props: TransferDbProps) {\r\n    if (direction === \"download\")\r\n      mkdirSync(dirname(props.localFileName), { recursive: true }); // make sure the directory exists before starting download\r\n\r\n    let timer: NodeJS.Timeout | undefined;\r\n    try {\r\n      const transfer = new NativeLibrary.nativeLib.CloudDbTransfer(direction, container, props);\r\n      let total = 0;\r\n      const onProgress = props.onProgress;\r\n      if (onProgress) {\r\n        timer = setInterval(async () => { // set an interval timer to show progress every 250ms\r\n          const progress = transfer.getProgress();\r\n          total = progress.total;\r\n          if (onProgress(progress.loaded, progress.total))\r\n            transfer.cancelTransfer();\r\n        }, 250);\r\n      }\r\n      await transfer.promise;\r\n      onProgress?.(total, total); // make sure we call progress func one last time when download completes\r\n    } catch (err: any) {\r\n      if (err.message === \"cancelled\")\r\n        err.errorNumber = 131079; // BriefcaseStatus.DownloadCancelled\r\n\r\n      throw err;\r\n    } finally {\r\n      if (timer)\r\n        clearInterval(timer);\r\n    }\r\n  }\r\n\r\n  /** Upload a database into a CloudContainer\r\n    * @param container the CloudContainer holding the database. Must be connected.\r\n    * @param props the properties that describe the database to be downloaded, plus optionally an `onProgress` function.\r\n    * @note this function requires that the write lock be held on the container\r\n    */\r\n  export async function uploadDb(container: CloudContainer, props: TransferDbProps): Promise<void> {\r\n    await transferDb(\"upload\", container, props);\r\n    container.checkForChanges(); // re-read the manifest so the database is available locally.\r\n  }\r\n\r\n  /** Download a database from a CloudContainer\r\n    * @param container the CloudContainer holding the database. Must be connected.\r\n    * @param props the properties that describe the database to be downloaded, plus optionally an `onProgress` function.\r\n    * @returns a Promise that is resolved when the download completes.\r\n    * @note the download is \"restartable.\" If the transfer is aborted and then re-requested, it will continue from where\r\n    * it left off rather than re-downloading the entire file.\r\n    */\r\n  export async function downloadDb(container: CloudContainer, props: TransferDbProps): Promise<void> {\r\n    await transferDb(\"download\", container, props);\r\n  }\r\n\r\n  /** Optional method to be called when an attempt to acquire the write lock fails because another user currently holds it.\r\n    * @param lockedBy The identifier supplied by the application/user that currently holds the lock.\r\n    * @param expires a stringified Date (in local time) indicating when the lock will expire.\r\n    * @return \"stop\" to give up and stop retrying. Generally, it's a good idea to wait for some time before returning.\r\n    */\r\n  export type WriteLockBusyHandler = (lockedBy: string, expires: string) => Promise<void | \"stop\">;\r\n\r\n  /**\r\n    * Attempt to acquire the write lock for a container, with retries.\r\n    * If write lock is held by another user, call busyHandler if supplied. If no busyHandler, or handler returns \"stop\", throw. Otherwise try again.\r\n    * @note if write lock is already held, this function does nothing.\r\n    * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us\r\n    * @param container the CloudContainer for which the lock is to be acquired\r\n    * @param busyHandler if present, function called when the write lock is currently held by another user.\r\n    */\r\n  export async function acquireWriteLock(user: string, container: CloudContainer, busyHandler?: WriteLockBusyHandler) {\r\n    if (container.hasWriteLock)\r\n      return;\r\n\r\n    while (true) {\r\n      try {\r\n        return container.acquireWriteLock(user);\r\n      } catch (e: any) {\r\n        if (e.errorNumber === 5 && busyHandler && \"stop\" !== await busyHandler(e.lockedBy, e.expires)) // 5 === BE_SQLITE_BUSY\r\n          continue; // busy handler wants to try again\r\n        throw e;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n    * Perform an asynchronous write operation on a CloudContainer with the write lock held.\r\n    * 1. if write lock is already held, call operation and return.\r\n    * 2. attempt to acquire the write lock, with retries. Throw if unable to obtain write lock.\r\n    * 3. perform the operation\r\n    * 3.a if the operation throws, abandon all changes and re-throw\r\n    * 4. release the write lock.\r\n    * 5. return value from operation\r\n    * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us\r\n    * @param container the CloudContainer for which the lock is to be acquired\r\n    * @param operation an asynchronous operation performed with the write lock held.\r\n    * @param busyHandler if present, function called when the write lock is currently held by another user.\r\n    * @returns a Promise with the result of `operation`\r\n    */\r\n  export async function withWriteLock<T>(user: string, container: CloudContainer, operation: () => T, busyHandler?: WriteLockBusyHandler) {\r\n    if (container.hasWriteLock)\r\n      return operation();\r\n\r\n    await acquireWriteLock(user, container, busyHandler);\r\n    try {\r\n      // eslint-disable-next-line @typescript-eslint/await-thenable\r\n      const val = await operation(); // wait for work to finish or fail\r\n      container.releaseWriteLock();\r\n      return val;\r\n    } catch (e) {\r\n      container.abandonChanges();  // if operation threw, abandon all changes\r\n      throw e;\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/ConcurrentQuery.d.ts

@@ -1,5 +1,5 @@
 import { IModelJsNative } from "@bentley/imodeljs-native";
-import { DbBlobRequest, DbBlobResponse, DbQueryRequest, DbQueryResponse } from "@itwin/core-common";
+import { DbBlobRequest, DbBlobResponse, DbQueryConfig, DbQueryRequest, DbQueryResponse } from "@itwin/core-common";
 /** @internal */
 export declare type OnResponse = (response: Response) => void;
 /** @internal */
@@ -8,5 +8,7 @@ export declare class ConcurrentQuery {
     static executeQueryRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbQueryRequest): Promise<DbQueryResponse>;
     /** @internal */
     static executeBlobRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbBlobRequest): Promise<DbBlobResponse>;
+    static resetConfig(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, config?: DbQueryConfig): DbQueryConfig;
+    static shutdown(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb): void;
 }
 //# sourceMappingURL=ConcurrentQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAK1D,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,eAAe,EAAiB,MAAM,oBAAoB,CAAC;AAEnH,gBAAgB;AAChB,oBAAY,UAAU,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEtD,gBAAgB;AAChB,qBAAa,eAAe;IAC1B,gBAAgB;WACI,mBAAmB,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ5I,gBAAgB;WACI,kBAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;CAQ1I"}
+{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAK1D,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAiB,MAAM,oBAAoB,CAAC;AAElI,gBAAgB;AAChB,oBAAY,UAAU,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEtD,gBAAgB;AAChB,qBAAa,eAAe;IAC1B,gBAAgB;WACI,mBAAmB,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ5I,gBAAgB;WACI,kBAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;WAQ3H,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa;WAGpG,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK;CAGxE"}

package/lib/cjs/ConcurrentQuery.js

@@ -26,6 +26,12 @@ class ConcurrentQuery {
             });
         });
     }
+    static resetConfig(conn, config) {
+        return conn.concurrentQueryResetConfig(config);
+    }
+    static shutdown(conn) {
+        conn.concurrentQueryShutdown();
+    }
 }
 exports.ConcurrentQuery = ConcurrentQuery;
 //# sourceMappingURL=ConcurrentQuery.js.map

package/lib/cjs/ConcurrentQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":";;;AACA;;;+FAG+F;AAC/F,oDAAmH;AAKnH,gBAAgB;AAChB,MAAa,eAAe;IAC1B,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAgD,EAAE,OAAuB;QAC/G,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,EAAE;YAC9C,OAAO,CAAC,IAAI,GAAG,2BAAa,CAAC,KAAK,CAAC;YACnC,IAAI,CAAC,sBAAsB,CAAC,OAAc,EAAE,CAAC,QAAa,EAAE,EAAE;gBAC5D,OAAO,CAAC,QAA2B,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAgD,EAAE,OAAsB;QAC7G,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,EAAE;YAC7C,OAAO,CAAC,IAAI,GAAG,2BAAa,CAAC,MAAM,CAAC;YACpC,IAAI,CAAC,sBAAsB,CAAC,OAAc,EAAE,CAAC,QAAa,EAAE,EAAE;gBAC5D,OAAO,CAAC,QAA0B,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,0CAmBC","sourcesContent":["import { IModelJsNative } from \"@bentley/imodeljs-native\";\r\n/*---------------------------------------------------------------------------------------------\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\nimport { DbBlobRequest, DbBlobResponse, DbQueryRequest, DbQueryResponse, DbRequestKind } from \"@itwin/core-common\";\r\n\r\n/** @internal */\r\nexport type OnResponse = (response: Response) => void;\r\n\r\n/** @internal */\r\nexport class ConcurrentQuery {\r\n  /** @internal */\r\n  public static async executeQueryRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbQueryRequest): Promise<DbQueryResponse> {\r\n    return new Promise<DbQueryResponse>((resolve) => {\r\n      request.kind = DbRequestKind.ECSql;\r\n      conn.concurrentQueryExecute(request as any, (response: any) => {\r\n        resolve(response as DbQueryResponse);\r\n      });\r\n    });\r\n  }\r\n  /** @internal */\r\n  public static async executeBlobRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbBlobRequest): Promise<DbBlobResponse> {\r\n    return new Promise<DbBlobResponse>((resolve) => {\r\n      request.kind = DbRequestKind.BlobIO;\r\n      conn.concurrentQueryExecute(request as any, (response: any) => {\r\n        resolve(response as DbBlobResponse);\r\n      });\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":";;;AACA;;;+FAG+F;AAC/F,oDAAkI;AAKlI,gBAAgB;AAChB,MAAa,eAAe;IAC1B,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAgD,EAAE,OAAuB;QAC/G,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,EAAE;YAC9C,OAAO,CAAC,IAAI,GAAG,2BAAa,CAAC,KAAK,CAAC;YACnC,IAAI,CAAC,sBAAsB,CAAC,OAAc,EAAE,CAAC,QAAa,EAAE,EAAE;gBAC5D,OAAO,CAAC,QAA2B,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAgD,EAAE,OAAsB;QAC7G,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,EAAE;YAC7C,OAAO,CAAC,IAAI,GAAG,2BAAa,CAAC,MAAM,CAAC;YACpC,IAAI,CAAC,sBAAsB,CAAC,OAAc,EAAE,CAAC,QAAa,EAAE,EAAE;gBAC5D,OAAO,CAAC,QAA0B,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IACM,MAAM,CAAC,WAAW,CAAC,IAAgD,EAAE,MAAsB;QAChG,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IACM,MAAM,CAAC,QAAQ,CAAC,IAAgD;QACrE,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;CACF;AAzBD,0CAyBC","sourcesContent":["import { IModelJsNative } from \"@bentley/imodeljs-native\";\r\n/*---------------------------------------------------------------------------------------------\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\nimport { DbBlobRequest, DbBlobResponse, DbQueryConfig, DbQueryRequest, DbQueryResponse, DbRequestKind } from \"@itwin/core-common\";\r\n\r\n/** @internal */\r\nexport type OnResponse = (response: Response) => void;\r\n\r\n/** @internal */\r\nexport class ConcurrentQuery {\r\n  /** @internal */\r\n  public static async executeQueryRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbQueryRequest): Promise<DbQueryResponse> {\r\n    return new Promise<DbQueryResponse>((resolve) => {\r\n      request.kind = DbRequestKind.ECSql;\r\n      conn.concurrentQueryExecute(request as any, (response: any) => {\r\n        resolve(response as DbQueryResponse);\r\n      });\r\n    });\r\n  }\r\n  /** @internal */\r\n  public static async executeBlobRequest(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, request: DbBlobRequest): Promise<DbBlobResponse> {\r\n    return new Promise<DbBlobResponse>((resolve) => {\r\n      request.kind = DbRequestKind.BlobIO;\r\n      conn.concurrentQueryExecute(request as any, (response: any) => {\r\n        resolve(response as DbBlobResponse);\r\n      });\r\n    });\r\n  }\r\n  public static resetConfig(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb, config?: DbQueryConfig): DbQueryConfig {\r\n    return conn.concurrentQueryResetConfig(config);\r\n  }\r\n  public static shutdown(conn: IModelJsNative.ECDb | IModelJsNative.DgnDb) {\r\n    conn.concurrentQueryShutdown();\r\n  }\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.