@itwin/core-backend 3.7.5 → 3.7.6

package/lib/cjs/PromiseMemoizer.js

@@ -1,102 +1,102 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utils
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromiseMemoizer = exports.QueryablePromise = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
-/** Wrapper around a promise that allows synchronous queries of it's state
- * @internal
- */
-class QueryablePromise {
-    constructor(promise) {
-        this.promise = promise;
-        this._fulfilled = false;
-        this._rejected = false;
-        this.promise.then((res) => {
-            this.result = res;
-            this._fulfilled = true;
-        }).catch((err) => {
-            this.error = err;
-            this._rejected = true;
-        });
-    }
-    get isPending() { return !this.isFulfilled && !this.isRejected; }
-    get isFulfilled() { return this._fulfilled; }
-    get isRejected() { return this._rejected; }
-}
-exports.QueryablePromise = QueryablePromise;
-/** Utility to cache and retrieve results of long running asynchronous functions.
- * The cache is keyed on the input arguments passed to these functions
- * @internal
- */
-class PromiseMemoizer {
-    /**
-     * Constructor
-     * @param memoizeFn Function to memoize
-     * @param generateKeyFn Function to generate the key for the memoized function
-     * @param maxCacheSize Maximum size of the memoizer cache.
-     * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these
-     * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize
-     * threshold, the entire cache is then cleared.
-     */
-    constructor(memoizeFn, generateKeyFn, maxCacheSize = 500, cacheTimeout = 30000) {
-        this._cachedPromises = new Map();
-        this._timers = new Map();
-        this._memoizeFn = memoizeFn;
-        this._generateKeyFn = generateKeyFn;
-        this._maxCacheSize = maxCacheSize;
-        this._cacheTimeout = cacheTimeout;
-    }
-    /** Call the memoized function */
-    memoize(...args) {
-        const key = this._generateKeyFn(...args);
-        let qp = this._cachedPromises.get(key);
-        if (qp)
-            return qp;
-        if (this._cachedPromises.size >= this._maxCacheSize) {
-            if (this._maxCacheSize > 1)
-                core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.PromiseMemoizer, "Cleared too many unresolved entries in memoizer cache");
-            this.clearCache();
-        }
-        const removeCachedPromise = (v) => {
-            const cleanUp = () => {
-                this._cachedPromises.delete(key);
-                this._timers.delete(key);
-            };
-            this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));
-            return v;
-        };
-        const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {
-            throw removeCachedPromise(e);
-        });
-        qp = new QueryablePromise(p);
-        this._cachedPromises.set(key, qp);
-        return qp;
-    }
-    /** Delete the memoized function */
-    deleteMemoized(...args) {
-        const key = this._generateKeyFn(...args);
-        this._cachedPromises.delete(key);
-        const timer = this._timers.get(key);
-        if (timer)
-            clearTimeout(timer);
-    }
-    /** Clear all entries in the memoizer cache */
-    clearCache() {
-        this._cachedPromises.clear();
-    }
-    dispose() {
-        for (const timer of this._timers.values())
-            clearTimeout(timer);
-        this._timers.clear();
-        this.clearCache();
-    }
-}
-exports.PromiseMemoizer = PromiseMemoizer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utils
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromiseMemoizer = exports.QueryablePromise = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
+/** Wrapper around a promise that allows synchronous queries of it's state
+ * @internal
+ */
+class QueryablePromise {
+    constructor(promise) {
+        this.promise = promise;
+        this._fulfilled = false;
+        this._rejected = false;
+        this.promise.then((res) => {
+            this.result = res;
+            this._fulfilled = true;
+        }).catch((err) => {
+            this.error = err;
+            this._rejected = true;
+        });
+    }
+    get isPending() { return !this.isFulfilled && !this.isRejected; }
+    get isFulfilled() { return this._fulfilled; }
+    get isRejected() { return this._rejected; }
+}
+exports.QueryablePromise = QueryablePromise;
+/** Utility to cache and retrieve results of long running asynchronous functions.
+ * The cache is keyed on the input arguments passed to these functions
+ * @internal
+ */
+class PromiseMemoizer {
+    /**
+     * Constructor
+     * @param memoizeFn Function to memoize
+     * @param generateKeyFn Function to generate the key for the memoized function
+     * @param maxCacheSize Maximum size of the memoizer cache.
+     * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these
+     * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize
+     * threshold, the entire cache is then cleared.
+     */
+    constructor(memoizeFn, generateKeyFn, maxCacheSize = 500, cacheTimeout = 30000) {
+        this._cachedPromises = new Map();
+        this._timers = new Map();
+        this._memoizeFn = memoizeFn;
+        this._generateKeyFn = generateKeyFn;
+        this._maxCacheSize = maxCacheSize;
+        this._cacheTimeout = cacheTimeout;
+    }
+    /** Call the memoized function */
+    memoize(...args) {
+        const key = this._generateKeyFn(...args);
+        let qp = this._cachedPromises.get(key);
+        if (qp)
+            return qp;
+        if (this._cachedPromises.size >= this._maxCacheSize) {
+            if (this._maxCacheSize > 1)
+                core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.PromiseMemoizer, "Cleared too many unresolved entries in memoizer cache");
+            this.clearCache();
+        }
+        const removeCachedPromise = (v) => {
+            const cleanUp = () => {
+                this._cachedPromises.delete(key);
+                this._timers.delete(key);
+            };
+            this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));
+            return v;
+        };
+        const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {
+            throw removeCachedPromise(e);
+        });
+        qp = new QueryablePromise(p);
+        this._cachedPromises.set(key, qp);
+        return qp;
+    }
+    /** Delete the memoized function */
+    deleteMemoized(...args) {
+        const key = this._generateKeyFn(...args);
+        this._cachedPromises.delete(key);
+        const timer = this._timers.get(key);
+        if (timer)
+            clearTimeout(timer);
+    }
+    /** Clear all entries in the memoizer cache */
+    clearCache() {
+        this._cachedPromises.clear();
+    }
+    dispose() {
+        for (const timer of this._timers.values())
+            clearTimeout(timer);
+        this._timers.clear();
+        this.clearCache();
+    }
+}
+exports.PromiseMemoizer = PromiseMemoizer;
 //# sourceMappingURL=PromiseMemoizer.js.map

package/lib/cjs/PromiseMemoizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"PromiseMemoizer.js","sourceRoot":"","sources":["../../src/PromiseMemoizer.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0D;AAC1D,mEAAgE;AAEhE;;GAEG;AACH,MAAa,gBAAgB;IAU3B,YAAmC,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;QAN9C,eAAU,GAAY,KAAK,CAAC;QAC5B,cAAS,GAAY,KAAK,CAAC;QAMjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAM,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;YACjB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAXD,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACjF,IAAW,WAAW,KAAc,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7D,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;CAU5D;AAnBD,4CAmBC;AAOD;;;GAGG;AACH,MAAa,eAAe;IAQ1B;;;;;;;;OAQG;IACH,YAAmB,SAA2B,EAAE,aAAgC,EAAE,eAAuB,GAAG,EAAE,eAAuB,KAAK;QAhBzH,oBAAe,GAAqC,IAAI,GAAG,EAA+B,CAAC;QAC3F,YAAO,GAA8B,IAAI,GAAG,EAAwB,CAAC;QAgBpF,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED,iCAAiC;IAC1B,OAAO,CAAC,GAAG,IAAW;QAC3B,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,EAAE,GAAoC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxE,IAAI,EAAE;YACJ,OAAO,EAAE,CAAC;QAEZ,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACnD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;gBACxB,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,eAAe,EAAE,uDAAuD,CAAC,CAAC;YAClH,IAAI,CAAC,UAAU,EAAE,CAAC;SACnB;QAED,MAAM,mBAAmB,GAAG,CAAC,CAAI,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YAC/D,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QAEF,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,EAAE;YACjE,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,GAAG,IAAI,gBAAgB,CAAI,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAClC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,mCAAmC;IAC5B,cAAc,CAAC,GAAG,IAAW;QAClC,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK;YACP,YAAY,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,8CAA8C;IACvC,UAAU;QACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAEM,OAAO;QACZ,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACvC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEtB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;CACF;AA5ED,0CA4EC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utils\n */\n\nimport { IDisposable, Logger } from \"@itwin/core-bentley\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\n\n/** Wrapper around a promise that allows synchronous queries of it's state\n * @internal\n */\nexport class QueryablePromise<T> {\n  public result?: T;\n  public error?: any;\n\n  private _fulfilled: boolean = false;\n  private _rejected: boolean = false;\n\n  public get isPending(): boolean { return !this.isFulfilled && !this.isRejected; }\n  public get isFulfilled(): boolean { return this._fulfilled; }\n  public get isRejected(): boolean { return this._rejected; }\n  public constructor(public readonly promise: Promise<T>) {\n    this.promise.then((res: T) => {\n      this.result = res;\n      this._fulfilled = true;\n    }).catch((err: any) => {\n      this.error = err;\n      this._rejected = true;\n    });\n  }\n}\n\n/** @internal */\nexport type MemoizeFnType<T> = (...args: any[]) => Promise<T>;\n/** @internal */\nexport type GenerateKeyFnType = (...args: any[]) => string;\n\n/** Utility to cache and retrieve results of long running asynchronous functions.\n * The cache is keyed on the input arguments passed to these functions\n * @internal\n */\nexport class PromiseMemoizer<T> implements IDisposable {\n  private readonly _cachedPromises: Map<string, QueryablePromise<T>> = new Map<string, QueryablePromise<T>>();\n  private readonly _timers: Map<string, NodeJS.Timer> = new Map<string, NodeJS.Timer>();\n  private readonly _memoizeFn: MemoizeFnType<T>;\n  private readonly _generateKeyFn: GenerateKeyFnType;\n  private readonly _maxCacheSize: number;\n  private readonly _cacheTimeout: number;\n\n  /**\n   * Constructor\n   * @param memoizeFn Function to memoize\n   * @param generateKeyFn Function to generate the key for the memoized function\n   * @param maxCacheSize Maximum size of the memoizer cache.\n   * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these\n   * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize\n   * threshold, the entire cache is then cleared.\n   */\n  public constructor(memoizeFn: MemoizeFnType<T>, generateKeyFn: GenerateKeyFnType, maxCacheSize: number = 500, cacheTimeout: number = 30000) {\n    this._memoizeFn = memoizeFn;\n    this._generateKeyFn = generateKeyFn;\n    this._maxCacheSize = maxCacheSize;\n    this._cacheTimeout = cacheTimeout;\n  }\n\n  /** Call the memoized function */\n  public memoize(...args: any[]): QueryablePromise<T> {\n    const key: string = this._generateKeyFn(...args);\n    let qp: QueryablePromise<T> | undefined = this._cachedPromises.get(key);\n    if (qp)\n      return qp;\n\n    if (this._cachedPromises.size >= this._maxCacheSize) {\n      if (this._maxCacheSize > 1)\n        Logger.logError(BackendLoggerCategory.PromiseMemoizer, \"Cleared too many unresolved entries in memoizer cache\");\n      this.clearCache();\n    }\n\n    const removeCachedPromise = (v: T) => {\n      const cleanUp = () => {\n        this._cachedPromises.delete(key);\n        this._timers.delete(key);\n      };\n      this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));\n      return v;\n    };\n\n    const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {\n      throw removeCachedPromise(e);\n    });\n\n    qp = new QueryablePromise<T>(p);\n    this._cachedPromises.set(key, qp);\n    return qp;\n  }\n\n  /** Delete the memoized function */\n  public deleteMemoized(...args: any[]) {\n    const key: string = this._generateKeyFn(...args);\n    this._cachedPromises.delete(key);\n    const timer = this._timers.get(key);\n    if (timer)\n      clearTimeout(timer);\n  }\n\n  /** Clear all entries in the memoizer cache */\n  public clearCache() {\n    this._cachedPromises.clear();\n  }\n\n  public dispose() {\n    for (const timer of this._timers.values())\n      clearTimeout(timer);\n\n    this._timers.clear();\n    this.clearCache();\n  }\n}\n"]}
+{"version":3,"file":"PromiseMemoizer.js","sourceRoot":"","sources":["../../src/PromiseMemoizer.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0D;AAC1D,mEAAgE;AAEhE;;GAEG;AACH,MAAa,gBAAgB;IAU3B,YAAmC,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;QAN9C,eAAU,GAAY,KAAK,CAAC;QAC5B,cAAS,GAAY,KAAK,CAAC;QAMjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAM,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;YACjB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAXD,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACjF,IAAW,WAAW,KAAc,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7D,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;CAU5D;AAnBD,4CAmBC;AAOD;;;GAGG;AACH,MAAa,eAAe;IAQ1B;;;;;;;;OAQG;IACH,YAAmB,SAA2B,EAAE,aAAgC,EAAE,eAAuB,GAAG,EAAE,eAAuB,KAAK;QAhBzH,oBAAe,GAAqC,IAAI,GAAG,EAA+B,CAAC;QAC3F,YAAO,GAA8B,IAAI,GAAG,EAAwB,CAAC;QAgBpF,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED,iCAAiC;IAC1B,OAAO,CAAC,GAAG,IAAW;QAC3B,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,EAAE,GAAoC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxE,IAAI,EAAE;YACJ,OAAO,EAAE,CAAC;QAEZ,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACnD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;gBACxB,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,eAAe,EAAE,uDAAuD,CAAC,CAAC;YAClH,IAAI,CAAC,UAAU,EAAE,CAAC;SACnB;QAED,MAAM,mBAAmB,GAAG,CAAC,CAAI,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YAC/D,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QAEF,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,EAAE;YACjE,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,GAAG,IAAI,gBAAgB,CAAI,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAClC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,mCAAmC;IAC5B,cAAc,CAAC,GAAG,IAAW;QAClC,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK;YACP,YAAY,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,8CAA8C;IACvC,UAAU;QACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAEM,OAAO;QACZ,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACvC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEtB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;CACF;AA5ED,0CA4EC","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 Utils\r\n */\r\n\r\nimport { IDisposable, Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\n\r\n/** Wrapper around a promise that allows synchronous queries of it's state\r\n * @internal\r\n */\r\nexport class QueryablePromise<T> {\r\n  public result?: T;\r\n  public error?: any;\r\n\r\n  private _fulfilled: boolean = false;\r\n  private _rejected: boolean = false;\r\n\r\n  public get isPending(): boolean { return !this.isFulfilled && !this.isRejected; }\r\n  public get isFulfilled(): boolean { return this._fulfilled; }\r\n  public get isRejected(): boolean { return this._rejected; }\r\n  public constructor(public readonly promise: Promise<T>) {\r\n    this.promise.then((res: T) => {\r\n      this.result = res;\r\n      this._fulfilled = true;\r\n    }).catch((err: any) => {\r\n      this.error = err;\r\n      this._rejected = true;\r\n    });\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport type MemoizeFnType<T> = (...args: any[]) => Promise<T>;\r\n/** @internal */\r\nexport type GenerateKeyFnType = (...args: any[]) => string;\r\n\r\n/** Utility to cache and retrieve results of long running asynchronous functions.\r\n * The cache is keyed on the input arguments passed to these functions\r\n * @internal\r\n */\r\nexport class PromiseMemoizer<T> implements IDisposable {\r\n  private readonly _cachedPromises: Map<string, QueryablePromise<T>> = new Map<string, QueryablePromise<T>>();\r\n  private readonly _timers: Map<string, NodeJS.Timer> = new Map<string, NodeJS.Timer>();\r\n  private readonly _memoizeFn: MemoizeFnType<T>;\r\n  private readonly _generateKeyFn: GenerateKeyFnType;\r\n  private readonly _maxCacheSize: number;\r\n  private readonly _cacheTimeout: number;\r\n\r\n  /**\r\n   * Constructor\r\n   * @param memoizeFn Function to memoize\r\n   * @param generateKeyFn Function to generate the key for the memoized function\r\n   * @param maxCacheSize Maximum size of the memoizer cache.\r\n   * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these\r\n   * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize\r\n   * threshold, the entire cache is then cleared.\r\n   */\r\n  public constructor(memoizeFn: MemoizeFnType<T>, generateKeyFn: GenerateKeyFnType, maxCacheSize: number = 500, cacheTimeout: number = 30000) {\r\n    this._memoizeFn = memoizeFn;\r\n    this._generateKeyFn = generateKeyFn;\r\n    this._maxCacheSize = maxCacheSize;\r\n    this._cacheTimeout = cacheTimeout;\r\n  }\r\n\r\n  /** Call the memoized function */\r\n  public memoize(...args: any[]): QueryablePromise<T> {\r\n    const key: string = this._generateKeyFn(...args);\r\n    let qp: QueryablePromise<T> | undefined = this._cachedPromises.get(key);\r\n    if (qp)\r\n      return qp;\r\n\r\n    if (this._cachedPromises.size >= this._maxCacheSize) {\r\n      if (this._maxCacheSize > 1)\r\n        Logger.logError(BackendLoggerCategory.PromiseMemoizer, \"Cleared too many unresolved entries in memoizer cache\");\r\n      this.clearCache();\r\n    }\r\n\r\n    const removeCachedPromise = (v: T) => {\r\n      const cleanUp = () => {\r\n        this._cachedPromises.delete(key);\r\n        this._timers.delete(key);\r\n      };\r\n      this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));\r\n      return v;\r\n    };\r\n\r\n    const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {\r\n      throw removeCachedPromise(e);\r\n    });\r\n\r\n    qp = new QueryablePromise<T>(p);\r\n    this._cachedPromises.set(key, qp);\r\n    return qp;\r\n  }\r\n\r\n  /** Delete the memoized function */\r\n  public deleteMemoized(...args: any[]) {\r\n    const key: string = this._generateKeyFn(...args);\r\n    this._cachedPromises.delete(key);\r\n    const timer = this._timers.get(key);\r\n    if (timer)\r\n      clearTimeout(timer);\r\n  }\r\n\r\n  /** Clear all entries in the memoizer cache */\r\n  public clearCache() {\r\n    this._cachedPromises.clear();\r\n  }\r\n\r\n  public dispose() {\r\n    for (const timer of this._timers.values())\r\n      clearTimeout(timer);\r\n\r\n    this._timers.clear();\r\n    this.clearCache();\r\n  }\r\n}\r\n"]}

package/lib/cjs/PropertyStore.d.ts

@@ -1,133 +1,133 @@
-import { AccessToken } from "@itwin/core-bentley";
-import { CloudSqlite } from "./CloudSqlite";
-import { SettingObject } from "./workspace/Settings";
-/**
- * A persistent storage for a set of values of type `PropertyType`, each with a unique `PropertyName`.
- * `PropertyStore`s are stored in cloud containers, and require an access token that grants permission to read and/or write them.
- * All write operations will fail without an access token that grants write permission.
- * A `PropertyStore` is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.
- * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes
- * made by others, as appropriate (see [[synchronizeWithCloud]]).
- * @alpha */
-export interface PropertyStore {
-    /** The collection of property values in the PropertyStore as of the last time it was synchronized. */
-    readonly values: PropertyStore.Values;
-    /** Parameters for obtaining the write lock on the container for a PropertyStore.*/
-    readonly lockParams: CloudSqlite.ObtainLockParams;
-    /**
-     * The token that grants access to the cloud container for this PropertyStore. If it does not grant write permissions, all
-     * write operations will fail. It should be refreshed (via a timer) before it expires.
-     */
-    sasToken: AccessToken;
-    /**
-     * Synchronize the local values in this PropertyStore with any changes by made by others.
-     * @note This is called automatically whenever any write operation is performed on the PropertyStore. It is only necessary to
-     * call this directly if you have not changed the PropertyStore recently, but wish to perform a readonly operation and want to
-     * ensure it is up-to-date as of now.
-     * @note There is no guarantee that the Values are up-to-date even immediately after calling this method, since others
-     * may be modifying them at any time.
-     */
-    synchronizeWithCloud(): void;
-    /** initiate a prefetch operation on this PropertyStore
-     * @internal
-     */
-    startPrefetch(): CloudSqlite.CloudPrefetch;
-    /** Save a single property in this PropertyStore. If the property already exists, its value is overwritten.
-     * @note This will obtain the write lock, save the value, and then release the write lock.
-     */
-    saveProperty(name: PropertyStore.PropertyName, value: PropertyStore.PropertyType): Promise<void>;
-    /** Save an array of properties in this PropertyStore. If a property already exists, its value is overwritten.
-     * @note This will obtain the write lock, save the values, and then release the write lock.
-     */
-    saveProperties(props: PropertyStore.PropertyArray): Promise<void>;
-    /** Delete a single property from this PropertyStore. If the value does not exist, this method does nothing.
-     * @note This will obtain the write lock, delete the value, and then release the write lock.
-     */
-    deleteProperty(propName: PropertyStore.PropertyName): Promise<void>;
-    /** Delete an array of properties from this PropertyStore. Any value that does not exist is ignored.
-     * @note This will obtain the write lock, delete the values, and then release the write lock.
-     */
-    deleteProperties(propNames: PropertyStore.PropertyName[]): Promise<void>;
-}
-/** @alpha */
-export declare namespace PropertyStore {
-    /** @internal */
-    let openPropertyStore: ((props: CloudSqlite.ContainerAccessProps) => PropertyStore) | undefined;
-    /** The set of valid types for properties in a PropertyStore. */
-    type PropertyType = string | number | boolean | Uint8Array | SettingObject;
-    /** The name of a Property. May not have leading or trailing spaces, and must be between 3 and 2048 characters long. */
-    type PropertyName = string;
-    /** An array of PropertyName/PropertyType pairs to be stored in a PropertyStore. */
-    type PropertyArray = {
-        name: PropertyName;
-        value: PropertyType;
-    }[];
-    /** The return status of an iteration function. The value "stop" causes the iteration to terminate. */
-    type IterationReturn = void | "stop";
-    /** An iteration function over Properties in a PropertyStore. It is called with the name of a each Property. */
-    type PropertyIteration = (name: string) => IterationReturn;
-    /** A filter used to limit and/or sort the values returned by an iteration. */
-    interface PropertyFilter {
-        /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */
-        readonly value?: string;
-        /** The comparison operator for `value`. Default is `=` */
-        readonly valueCompare?: "GLOB" | "LIKE" | "NOT GLOB" | "NOT LIKE" | "=" | "<" | ">";
-        /** Order results ascending or descending. If not supplied, the results are unordered (random). */
-        readonly orderBy?: "ASC" | "DESC";
-        /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */
-        readonly sqlExpression?: string;
-    }
-    /**
-     * A readonly set of Property values in a PropertyStore.
-     * @alpha
-     */
-    interface Values {
-        /** get the value of a Property by name.
-         * @returns the property's value if it exists, `undefined` otherwise.
-         */
-        getProperty(name: PropertyName): PropertyType | undefined;
-        /** Get the value of a string property by name.
-        * @returns the property's value if it exists and is a string, `undefined` otherwise.
-        */
-        getString(name: PropertyName): string | undefined;
-        /** Get the value of a string property by name.
-        * @returns the property's value if it exists and is a string, otherwise the supplied default value.
-        */
-        getString(name: PropertyName, defaultValue: string): string;
-        /** Get the value of a boolean property by name.
-        * @returns the property's value if it exists and is a boolean, `undefined` otherwise.
-        */
-        getBoolean(name: PropertyName): boolean | undefined;
-        /** Get the value of a boolean property by name.
-        * @returns the property's value if it exists and is a boolean, otherwise the supplied default value.
-        */
-        getBoolean(name: PropertyName, defaultValue: boolean): boolean;
-        /** Get the value of a number property by name.
-        * @returns the property's value if it exists and is a number, `undefined` otherwise.
-        */
-        getNumber(name: PropertyName): number | undefined;
-        /** Get the value of a number property by name.
-        * @returns the property's value if it exists and is a number, otherwise the supplied default value.
-        */
-        getNumber(name: PropertyName, defaultValue: number): number;
-        /** Get the value of a blob property by name.
-        * @returns the property's value if it exists and is a blob, `undefined` otherwise.
-        */
-        getBlob(name: PropertyName): Uint8Array | undefined;
-        /** Get the value of a blob property by name.
-        * @returns the property's value if it exists and is a blob, otherwise the supplied default value.
-        */
-        getBlob(name: PropertyName, defaultValue: Uint8Array): Uint8Array;
-        /** Get the value of an object property by name.
-        * @returns the property's value if it exists and is an object, `undefined` otherwise.
-        */
-        getObject<T extends SettingObject>(name: PropertyName): T | undefined;
-        /** Get the value of an object property by name.
-        * @returns the property's value if it exists and is an object, otherwise the supplied default value.
-        */
-        getObject<T extends SettingObject>(name: PropertyName, defaultValue: T): T;
-        /** call an iteration function for each property, optionally applying a filter */
-        forAllProperties(iter: PropertyIteration, filter?: PropertyFilter): void;
-    }
-}
+import { AccessToken } from "@itwin/core-bentley";
+import { CloudSqlite } from "./CloudSqlite";
+import { SettingObject } from "./workspace/Settings";
+/**
+ * A persistent storage for a set of values of type `PropertyType`, each with a unique `PropertyName`.
+ * `PropertyStore`s are stored in cloud containers, and require an access token that grants permission to read and/or write them.
+ * All write operations will fail without an access token that grants write permission.
+ * A `PropertyStore` is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.
+ * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes
+ * made by others, as appropriate (see [[synchronizeWithCloud]]).
+ * @alpha */
+export interface PropertyStore {
+    /** The collection of property values in the PropertyStore as of the last time it was synchronized. */
+    readonly values: PropertyStore.Values;
+    /** Parameters for obtaining the write lock on the container for a PropertyStore.*/
+    readonly lockParams: CloudSqlite.ObtainLockParams;
+    /**
+     * The token that grants access to the cloud container for this PropertyStore. If it does not grant write permissions, all
+     * write operations will fail. It should be refreshed (via a timer) before it expires.
+     */
+    sasToken: AccessToken;
+    /**
+     * Synchronize the local values in this PropertyStore with any changes by made by others.
+     * @note This is called automatically whenever any write operation is performed on the PropertyStore. It is only necessary to
+     * call this directly if you have not changed the PropertyStore recently, but wish to perform a readonly operation and want to
+     * ensure it is up-to-date as of now.
+     * @note There is no guarantee that the Values are up-to-date even immediately after calling this method, since others
+     * may be modifying them at any time.
+     */
+    synchronizeWithCloud(): void;
+    /** initiate a prefetch operation on this PropertyStore
+     * @internal
+     */
+    startPrefetch(): CloudSqlite.CloudPrefetch;
+    /** Save a single property in this PropertyStore. If the property already exists, its value is overwritten.
+     * @note This will obtain the write lock, save the value, and then release the write lock.
+     */
+    saveProperty(name: PropertyStore.PropertyName, value: PropertyStore.PropertyType): Promise<void>;
+    /** Save an array of properties in this PropertyStore. If a property already exists, its value is overwritten.
+     * @note This will obtain the write lock, save the values, and then release the write lock.
+     */
+    saveProperties(props: PropertyStore.PropertyArray): Promise<void>;
+    /** Delete a single property from this PropertyStore. If the value does not exist, this method does nothing.
+     * @note This will obtain the write lock, delete the value, and then release the write lock.
+     */
+    deleteProperty(propName: PropertyStore.PropertyName): Promise<void>;
+    /** Delete an array of properties from this PropertyStore. Any value that does not exist is ignored.
+     * @note This will obtain the write lock, delete the values, and then release the write lock.
+     */
+    deleteProperties(propNames: PropertyStore.PropertyName[]): Promise<void>;
+}
+/** @alpha */
+export declare namespace PropertyStore {
+    /** @internal */
+    let openPropertyStore: ((props: CloudSqlite.ContainerAccessProps) => PropertyStore) | undefined;
+    /** The set of valid types for properties in a PropertyStore. */
+    type PropertyType = string | number | boolean | Uint8Array | SettingObject;
+    /** The name of a Property. May not have leading or trailing spaces, and must be between 3 and 2048 characters long. */
+    type PropertyName = string;
+    /** An array of PropertyName/PropertyType pairs to be stored in a PropertyStore. */
+    type PropertyArray = {
+        name: PropertyName;
+        value: PropertyType;
+    }[];
+    /** The return status of an iteration function. The value "stop" causes the iteration to terminate. */
+    type IterationReturn = void | "stop";
+    /** An iteration function over Properties in a PropertyStore. It is called with the name of a each Property. */
+    type PropertyIteration = (name: string) => IterationReturn;
+    /** A filter used to limit and/or sort the values returned by an iteration. */
+    interface PropertyFilter {
+        /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */
+        readonly value?: string;
+        /** The comparison operator for `value`. Default is `=` */
+        readonly valueCompare?: "GLOB" | "LIKE" | "NOT GLOB" | "NOT LIKE" | "=" | "<" | ">";
+        /** Order results ascending or descending. If not supplied, the results are unordered (random). */
+        readonly orderBy?: "ASC" | "DESC";
+        /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */
+        readonly sqlExpression?: string;
+    }
+    /**
+     * A readonly set of Property values in a PropertyStore.
+     * @alpha
+     */
+    interface Values {
+        /** get the value of a Property by name.
+         * @returns the property's value if it exists, `undefined` otherwise.
+         */
+        getProperty(name: PropertyName): PropertyType | undefined;
+        /** Get the value of a string property by name.
+        * @returns the property's value if it exists and is a string, `undefined` otherwise.
+        */
+        getString(name: PropertyName): string | undefined;
+        /** Get the value of a string property by name.
+        * @returns the property's value if it exists and is a string, otherwise the supplied default value.
+        */
+        getString(name: PropertyName, defaultValue: string): string;
+        /** Get the value of a boolean property by name.
+        * @returns the property's value if it exists and is a boolean, `undefined` otherwise.
+        */
+        getBoolean(name: PropertyName): boolean | undefined;
+        /** Get the value of a boolean property by name.
+        * @returns the property's value if it exists and is a boolean, otherwise the supplied default value.
+        */
+        getBoolean(name: PropertyName, defaultValue: boolean): boolean;
+        /** Get the value of a number property by name.
+        * @returns the property's value if it exists and is a number, `undefined` otherwise.
+        */
+        getNumber(name: PropertyName): number | undefined;
+        /** Get the value of a number property by name.
+        * @returns the property's value if it exists and is a number, otherwise the supplied default value.
+        */
+        getNumber(name: PropertyName, defaultValue: number): number;
+        /** Get the value of a blob property by name.
+        * @returns the property's value if it exists and is a blob, `undefined` otherwise.
+        */
+        getBlob(name: PropertyName): Uint8Array | undefined;
+        /** Get the value of a blob property by name.
+        * @returns the property's value if it exists and is a blob, otherwise the supplied default value.
+        */
+        getBlob(name: PropertyName, defaultValue: Uint8Array): Uint8Array;
+        /** Get the value of an object property by name.
+        * @returns the property's value if it exists and is an object, `undefined` otherwise.
+        */
+        getObject<T extends SettingObject>(name: PropertyName): T | undefined;
+        /** Get the value of an object property by name.
+        * @returns the property's value if it exists and is an object, otherwise the supplied default value.
+        */
+        getObject<T extends SettingObject>(name: PropertyName, defaultValue: T): T;
+        /** call an iteration function for each property, optionally applying a filter */
+        forAllProperties(iter: PropertyIteration, filter?: PropertyFilter): void;
+    }
+}
 //# sourceMappingURL=PropertyStore.d.ts.map

package/lib/cjs/PropertyStore.js

@@ -1,12 +1,12 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyStore = void 0;
-/** @alpha */
-var PropertyStore;
-(function (PropertyStore) {
-})(PropertyStore = exports.PropertyStore || (exports.PropertyStore = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyStore = void 0;
+/** @alpha */
+var PropertyStore;
+(function (PropertyStore) {
+})(PropertyStore = exports.PropertyStore || (exports.PropertyStore = {}));
 //# sourceMappingURL=PropertyStore.js.map

package/lib/cjs/PropertyStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyStore.js","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AA6D/F,aAAa;AACb,IAAiB,aAAa,CA+E7B;AA/ED,WAAiB,aAAa;AA+E9B,CAAC,EA/EgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA+E7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { AccessToken } from \"@itwin/core-bentley\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { SettingObject } from \"./workspace/Settings\";\n\n/**\n * A persistent storage for a set of values of type `PropertyType`, each with a unique `PropertyName`.\n * `PropertyStore`s are stored in cloud containers, and require an access token that grants permission to read and/or write them.\n * All write operations will fail without an access token that grants write permission.\n * A `PropertyStore` is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.\n * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes\n * made by others, as appropriate (see [[synchronizeWithCloud]]).\n * @alpha */\nexport interface PropertyStore {\n\n  /** The collection of property values in the PropertyStore as of the last time it was synchronized. */\n  readonly values: PropertyStore.Values;\n\n  /** Parameters for obtaining the write lock on the container for a PropertyStore.*/\n  readonly lockParams: CloudSqlite.ObtainLockParams;\n\n  /**\n   * The token that grants access to the cloud container for this PropertyStore. If it does not grant write permissions, all\n   * write operations will fail. It should be refreshed (via a timer) before it expires.\n   */\n  sasToken: AccessToken;\n\n  /**\n   * Synchronize the local values in this PropertyStore with any changes by made by others.\n   * @note This is called automatically whenever any write operation is performed on the PropertyStore. It is only necessary to\n   * call this directly if you have not changed the PropertyStore recently, but wish to perform a readonly operation and want to\n   * ensure it is up-to-date as of now.\n   * @note There is no guarantee that the Values are up-to-date even immediately after calling this method, since others\n   * may be modifying them at any time.\n   */\n  synchronizeWithCloud(): void;\n\n  /** initiate a prefetch operation on this PropertyStore\n   * @internal\n   */\n  startPrefetch(): CloudSqlite.CloudPrefetch;\n\n  /** Save a single property in this PropertyStore. If the property already exists, its value is overwritten.\n   * @note This will obtain the write lock, save the value, and then release the write lock.\n   */\n  saveProperty(name: PropertyStore.PropertyName, value: PropertyStore.PropertyType): Promise<void>;\n  /** Save an array of properties in this PropertyStore. If a property already exists, its value is overwritten.\n   * @note This will obtain the write lock, save the values, and then release the write lock.\n   */\n  saveProperties(props: PropertyStore.PropertyArray): Promise<void>;\n  /** Delete a single property from this PropertyStore. If the value does not exist, this method does nothing.\n   * @note This will obtain the write lock, delete the value, and then release the write lock.\n   */\n  deleteProperty(propName: PropertyStore.PropertyName): Promise<void>;\n  /** Delete an array of properties from this PropertyStore. Any value that does not exist is ignored.\n   * @note This will obtain the write lock, delete the values, and then release the write lock.\n   */\n  deleteProperties(propNames: PropertyStore.PropertyName[]): Promise<void>;\n}\n\n/** @alpha */\nexport namespace PropertyStore {\n  /** @internal */\n  export let openPropertyStore: ((props: CloudSqlite.ContainerAccessProps) => PropertyStore) | undefined;\n\n  /** The set of valid types for properties in a PropertyStore. */\n  export type PropertyType = string | number | boolean | Uint8Array | SettingObject;\n  /** The name of a Property. May not have leading or trailing spaces, and must be between 3 and 2048 characters long. */\n  export type PropertyName = string;\n  /** An array of PropertyName/PropertyType pairs to be stored in a PropertyStore. */\n  export type PropertyArray = { name: PropertyName, value: PropertyType }[];\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\n  export type IterationReturn = void | \"stop\";\n  /** An iteration function over Properties in a PropertyStore. It is called with the name of a each Property. */\n  export type PropertyIteration = (name: string) => IterationReturn;\n\n  /** A filter used to limit and/or sort the values returned by an iteration. */\n  export interface PropertyFilter {\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\n    readonly value?: string;\n    /** The comparison operator for `value`. Default is `=` */\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"<\" | \">\";\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\n    readonly orderBy?: \"ASC\" | \"DESC\";\n    /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */\n    readonly sqlExpression?: string;\n  }\n\n  /**\n   * A readonly set of Property values in a PropertyStore.\n   * @alpha\n   */\n  export interface Values {\n    /** get the value of a Property by name.\n     * @returns the property's value if it exists, `undefined` otherwise.\n     */\n    getProperty(name: PropertyName): PropertyType | undefined;\n    /** Get the value of a string property by name.\n    * @returns the property's value if it exists and is a string, `undefined` otherwise.\n    */\n    getString(name: PropertyName): string | undefined;\n    /** Get the value of a string property by name.\n    * @returns the property's value if it exists and is a string, otherwise the supplied default value.\n    */\n    getString(name: PropertyName, defaultValue: string): string;\n    /** Get the value of a boolean property by name.\n    * @returns the property's value if it exists and is a boolean, `undefined` otherwise.\n    */\n    getBoolean(name: PropertyName): boolean | undefined;\n    /** Get the value of a boolean property by name.\n    * @returns the property's value if it exists and is a boolean, otherwise the supplied default value.\n    */\n    getBoolean(name: PropertyName, defaultValue: boolean): boolean;\n    /** Get the value of a number property by name.\n    * @returns the property's value if it exists and is a number, `undefined` otherwise.\n    */\n    getNumber(name: PropertyName): number | undefined;\n    /** Get the value of a number property by name.\n    * @returns the property's value if it exists and is a number, otherwise the supplied default value.\n    */\n    getNumber(name: PropertyName, defaultValue: number): number;\n    /** Get the value of a blob property by name.\n    * @returns the property's value if it exists and is a blob, `undefined` otherwise.\n    */\n    getBlob(name: PropertyName): Uint8Array | undefined;\n    /** Get the value of a blob property by name.\n    * @returns the property's value if it exists and is a blob, otherwise the supplied default value.\n    */\n    getBlob(name: PropertyName, defaultValue: Uint8Array): Uint8Array;\n    /** Get the value of an object property by name.\n    * @returns the property's value if it exists and is an object, `undefined` otherwise.\n    */\n    getObject<T extends SettingObject>(name: PropertyName): T | undefined;\n    /** Get the value of an object property by name.\n    * @returns the property's value if it exists and is an object, otherwise the supplied default value.\n    */\n    getObject<T extends SettingObject>(name: PropertyName, defaultValue: T): T;\n    /** call an iteration function for each property, optionally applying a filter */\n    forAllProperties(iter: PropertyIteration, filter?: PropertyFilter): void;\n  }\n}\n"]}
+{"version":3,"file":"PropertyStore.js","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AA6D/F,aAAa;AACb,IAAiB,aAAa,CA+E7B;AA/ED,WAAiB,aAAa;AA+E9B,CAAC,EA/EgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA+E7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { AccessToken } from \"@itwin/core-bentley\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\n\r\n/**\r\n * A persistent storage for a set of values of type `PropertyType`, each with a unique `PropertyName`.\r\n * `PropertyStore`s are stored in cloud containers, and require an access token that grants permission to read and/or write them.\r\n * All write operations will fail without an access token that grants write permission.\r\n * A `PropertyStore` is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.\r\n * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes\r\n * made by others, as appropriate (see [[synchronizeWithCloud]]).\r\n * @alpha */\r\nexport interface PropertyStore {\r\n\r\n  /** The collection of property values in the PropertyStore as of the last time it was synchronized. */\r\n  readonly values: PropertyStore.Values;\r\n\r\n  /** Parameters for obtaining the write lock on the container for a PropertyStore.*/\r\n  readonly lockParams: CloudSqlite.ObtainLockParams;\r\n\r\n  /**\r\n   * The token that grants access to the cloud container for this PropertyStore. If it does not grant write permissions, all\r\n   * write operations will fail. It should be refreshed (via a timer) before it expires.\r\n   */\r\n  sasToken: AccessToken;\r\n\r\n  /**\r\n   * Synchronize the local values in this PropertyStore with any changes by made by others.\r\n   * @note This is called automatically whenever any write operation is performed on the PropertyStore. It is only necessary to\r\n   * call this directly if you have not changed the PropertyStore recently, but wish to perform a readonly operation and want to\r\n   * ensure it is up-to-date as of now.\r\n   * @note There is no guarantee that the Values are up-to-date even immediately after calling this method, since others\r\n   * may be modifying them at any time.\r\n   */\r\n  synchronizeWithCloud(): void;\r\n\r\n  /** initiate a prefetch operation on this PropertyStore\r\n   * @internal\r\n   */\r\n  startPrefetch(): CloudSqlite.CloudPrefetch;\r\n\r\n  /** Save a single property in this PropertyStore. If the property already exists, its value is overwritten.\r\n   * @note This will obtain the write lock, save the value, and then release the write lock.\r\n   */\r\n  saveProperty(name: PropertyStore.PropertyName, value: PropertyStore.PropertyType): Promise<void>;\r\n  /** Save an array of properties in this PropertyStore. If a property already exists, its value is overwritten.\r\n   * @note This will obtain the write lock, save the values, and then release the write lock.\r\n   */\r\n  saveProperties(props: PropertyStore.PropertyArray): Promise<void>;\r\n  /** Delete a single property from this PropertyStore. If the value does not exist, this method does nothing.\r\n   * @note This will obtain the write lock, delete the value, and then release the write lock.\r\n   */\r\n  deleteProperty(propName: PropertyStore.PropertyName): Promise<void>;\r\n  /** Delete an array of properties from this PropertyStore. Any value that does not exist is ignored.\r\n   * @note This will obtain the write lock, delete the values, and then release the write lock.\r\n   */\r\n  deleteProperties(propNames: PropertyStore.PropertyName[]): Promise<void>;\r\n}\r\n\r\n/** @alpha */\r\nexport namespace PropertyStore {\r\n  /** @internal */\r\n  export let openPropertyStore: ((props: CloudSqlite.ContainerAccessProps) => PropertyStore) | undefined;\r\n\r\n  /** The set of valid types for properties in a PropertyStore. */\r\n  export type PropertyType = string | number | boolean | Uint8Array | SettingObject;\r\n  /** The name of a Property. May not have leading or trailing spaces, and must be between 3 and 2048 characters long. */\r\n  export type PropertyName = string;\r\n  /** An array of PropertyName/PropertyType pairs to be stored in a PropertyStore. */\r\n  export type PropertyArray = { name: PropertyName, value: PropertyType }[];\r\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\r\n  export type IterationReturn = void | \"stop\";\r\n  /** An iteration function over Properties in a PropertyStore. It is called with the name of a each Property. */\r\n  export type PropertyIteration = (name: string) => IterationReturn;\r\n\r\n  /** A filter used to limit and/or sort the values returned by an iteration. */\r\n  export interface PropertyFilter {\r\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\r\n    readonly value?: string;\r\n    /** The comparison operator for `value`. Default is `=` */\r\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"<\" | \">\";\r\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\r\n    readonly orderBy?: \"ASC\" | \"DESC\";\r\n    /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */\r\n    readonly sqlExpression?: string;\r\n  }\r\n\r\n  /**\r\n   * A readonly set of Property values in a PropertyStore.\r\n   * @alpha\r\n   */\r\n  export interface Values {\r\n    /** get the value of a Property by name.\r\n     * @returns the property's value if it exists, `undefined` otherwise.\r\n     */\r\n    getProperty(name: PropertyName): PropertyType | undefined;\r\n    /** Get the value of a string property by name.\r\n    * @returns the property's value if it exists and is a string, `undefined` otherwise.\r\n    */\r\n    getString(name: PropertyName): string | undefined;\r\n    /** Get the value of a string property by name.\r\n    * @returns the property's value if it exists and is a string, otherwise the supplied default value.\r\n    */\r\n    getString(name: PropertyName, defaultValue: string): string;\r\n    /** Get the value of a boolean property by name.\r\n    * @returns the property's value if it exists and is a boolean, `undefined` otherwise.\r\n    */\r\n    getBoolean(name: PropertyName): boolean | undefined;\r\n    /** Get the value of a boolean property by name.\r\n    * @returns the property's value if it exists and is a boolean, otherwise the supplied default value.\r\n    */\r\n    getBoolean(name: PropertyName, defaultValue: boolean): boolean;\r\n    /** Get the value of a number property by name.\r\n    * @returns the property's value if it exists and is a number, `undefined` otherwise.\r\n    */\r\n    getNumber(name: PropertyName): number | undefined;\r\n    /** Get the value of a number property by name.\r\n    * @returns the property's value if it exists and is a number, otherwise the supplied default value.\r\n    */\r\n    getNumber(name: PropertyName, defaultValue: number): number;\r\n    /** Get the value of a blob property by name.\r\n    * @returns the property's value if it exists and is a blob, `undefined` otherwise.\r\n    */\r\n    getBlob(name: PropertyName): Uint8Array | undefined;\r\n    /** Get the value of a blob property by name.\r\n    * @returns the property's value if it exists and is a blob, otherwise the supplied default value.\r\n    */\r\n    getBlob(name: PropertyName, defaultValue: Uint8Array): Uint8Array;\r\n    /** Get the value of an object property by name.\r\n    * @returns the property's value if it exists and is an object, `undefined` otherwise.\r\n    */\r\n    getObject<T extends SettingObject>(name: PropertyName): T | undefined;\r\n    /** Get the value of an object property by name.\r\n    * @returns the property's value if it exists and is an object, otherwise the supplied default value.\r\n    */\r\n    getObject<T extends SettingObject>(name: PropertyName, defaultValue: T): T;\r\n    /** call an iteration function for each property, optionally applying a filter */\r\n    forAllProperties(iter: PropertyIteration, filter?: PropertyFilter): void;\r\n  }\r\n}\r\n"]}