@itwin/core-backend 3.4.0-dev.9 → 3.5.0-dev.5

package/lib/cjs/PromiseMemoizer.js

@@ -18,9 +18,13 @@ class QueryablePromise {
         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; });
+        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; }
@@ -63,7 +67,9 @@ class PromiseMemoizer {
                 this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));
                 return v;
             };
-            const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => { throw removeCachedPromise(e); });
+            const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {
+                throw removeCachedPromise(e);
+            });
             qp = new QueryablePromise(p);
             this._cachedPromises.set(key, qp);
             return qp;

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;aACT,IAAI,CAAC,CAAC,GAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;aAChE,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAPD,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;CAM5D;AAfD,4CAeC;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;QAsBtF,iCAAiC;QAC1B,YAAO,GAAG,CAAC,GAAG,IAAW,EAAuB,EAAE;YACvD,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;YACjD,IAAI,EAAE,GAAoC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACxE,IAAI,EAAE;gBACJ,OAAO,EAAE,CAAC;YAEZ,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;gBACnD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;oBACxB,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,eAAe,EAAE,uDAAuD,CAAC,CAAC;gBAClH,IAAI,CAAC,UAAU,EAAE,CAAC;aACnB;YAED,MAAM,mBAAmB,GAAG,CAAC,CAAI,EAAE,EAAE;gBACnC,MAAM,OAAO,GAAG,GAAG,EAAE;oBACnB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC3B,CAAC,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC/D,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;YAEF,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,EAAE,GAAG,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACvG,EAAE,GAAG,IAAI,gBAAgB,CAAI,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAClC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QAEF,mCAAmC;QAC5B,mBAAc,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;YACzC,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;YACjD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,KAAK;gBACP,YAAY,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC;QAEF,8CAA8C;QACvC,eAAU,GAAG,GAAG,EAAE;YACvB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC/B,CAAC,CAAC;QAEK,YAAO,GAAG,GAAG,EAAE;YACpB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACvC,YAAY,CAAC,KAAK,CAAC,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC,CAAC;QArDA,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;CAkDF;AAxED,0CAwEC","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\r\n      .then((res: T) => { this.result = res; this._fulfilled = true; })\r\n      .catch((err: any) => { this.error = err; this._rejected = true; });\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) => { throw removeCachedPromise(e); });\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    this._timers.clear();\r\n    this.clearCache();\r\n  };\r\n}\r\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;QAsBtF,iCAAiC;QAC1B,YAAO,GAAG,CAAC,GAAG,IAAW,EAAuB,EAAE;YACvD,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;YACjD,IAAI,EAAE,GAAoC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACxE,IAAI,EAAE;gBACJ,OAAO,EAAE,CAAC;YAEZ,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;gBACnD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;oBACxB,qBAAM,CAAC,QAAQ,CAAC,6CAAqB,CAAC,eAAe,EAAE,uDAAuD,CAAC,CAAC;gBAClH,IAAI,CAAC,UAAU,EAAE,CAAC;aACnB;YAED,MAAM,mBAAmB,GAAG,CAAC,CAAI,EAAE,EAAE;gBACnC,MAAM,OAAO,GAAG,GAAG,EAAE;oBACnB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC3B,CAAC,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC/D,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;YAEF,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,EAAE;gBACjE,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YAEH,EAAE,GAAG,IAAI,gBAAgB,CAAI,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAClC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QAEF,mCAAmC;QAC5B,mBAAc,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;YACzC,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;YACjD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,KAAK;gBACP,YAAY,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC;QAEF,8CAA8C;QACvC,eAAU,GAAG,GAAG,EAAE;YACvB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC/B,CAAC,CAAC;QAEK,YAAO,GAAG,GAAG,EAAE;YACpB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACvC,YAAY,CAAC,KAAK,CAAC,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC,CAAC;QAxDA,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;CAqDF;AA3ED,0CA2EC","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    this._timers.clear();\r\n    this.clearCache();\r\n  };\r\n}\r\n"]}

package/lib/cjs/PropertyStore.d.ts

@@ -0,0 +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;
+    }
+}
+//# sourceMappingURL=PropertyStore.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyStore.d.ts","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;;;YAOY;AACZ,MAAM,WAAW,aAAa;IAE5B,sGAAsG;IACtG,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;IAEtC,mFAAmF;IACnF,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,gBAAgB,CAAC;IAElD;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;;;OAOG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,IAAI,WAAW,CAAC,aAAa,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,YAAY,EAAE,KAAK,EAAE,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjG;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1E;AAED,aAAa;AACb,yBAAiB,aAAa,CAAC;IAC7B,gBAAgB;IACT,IAAI,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,oBAAoB,KAAK,aAAa,CAAC,GAAG,SAAS,CAAC;IAEvG,gEAAgE;IAChE,KAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,CAAC;IAClF,uHAAuH;IACvH,KAAY,YAAY,GAAG,MAAM,CAAC;IAClC,mFAAmF;IACnF,KAAY,aAAa,GAAG;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,EAAE,CAAC;IAC1E,sGAAsG;IACtG,KAAY,eAAe,GAAG,IAAI,GAAG,MAAM,CAAC;IAC5C,+GAA+G;IAC/G,KAAY,iBAAiB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,eAAe,CAAC;IAElE,8EAA8E;IAC9E,UAAiB,cAAc;QAC7B,6EAA6E;QAC7E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QACxB,0DAA0D;QAC1D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;QACpF,kGAAkG;QAClG,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QAClC,8JAA8J;QAC9J,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;KACjC;IAED;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,CAAC;QAC1D;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;QAClD;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;QAC5D;;UAEE;QACF,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,CAAC;QACpD;;UAEE;QACF,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;QAC/D;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;QAClD;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;QAC5D;;UAEE;QACF,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS,CAAC;QACpD;;UAEE;QACF,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,GAAG,UAAU,CAAC;QAClE;;UAEE;QACF,SAAS,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,YAAY,GAAG,CAAC,GAAG,SAAS,CAAC;QACtE;;UAEE;QACF,SAAS,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3E,iFAAiF;QACjF,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;KAC1E;CACF"}

package/lib/cjs/PropertyStore.js

@@ -0,0 +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 = {}));
+//# sourceMappingURL=PropertyStore.js.map

package/lib/cjs/PropertyStore.js.map

@@ -0,0 +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":["/*---------------------------------------------------------------------------------------------\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"]}

package/lib/cjs/SQLiteDb.d.ts

@@ -1,9 +1,10 @@
 /** @packageDocumentation
  * @module SQLiteDb
  */
-import { CloudSqlite, IModelJsNative } from "@bentley/imodeljs-native";
+import { IModelJsNative } from "@bentley/imodeljs-native";
 import { DbResult, IDisposable, OpenMode } from "@itwin/core-bentley";
 import { LocalFileName } from "@itwin/core-common";
+import { CloudSqlite } from "./CloudSqlite";
 import { SqliteStatement } from "./SqliteStatement";
 /** A SQLiteDb file
  * @public
@@ -13,78 +14,63 @@ export declare class SQLiteDb implements IDisposable {
     readonly nativeDb: IModelJsNative.SQLiteDb;
     private _sqliteStatementCache;
     /** @internal */
-    static createCloudContainer(args: CloudSqlite.ContainerAccessProps): SQLiteDb.CloudContainer;
-    /** @internal */
-    static createCloudCache(args: CloudSqlite.CacheProps): SQLiteDb.CloudCache;
-    /** @internal */
-    static startCloudPrefetch(container: SQLiteDb.CloudContainer, dbName: string, args?: CloudSqlite.PrefetchProps): SQLiteDb.CloudPrefetch;
-    /** @internal */
     static createBlobIO(): SQLiteDb.BlobIO;
     /** alias for closeDb. */
     dispose(): void;
     /** Create a SQLiteDb
      * @param dbName The path to the SQLiteDb file to create.
      */
-    createDb(dbName: string, container?: SQLiteDb.CloudContainer, params?: SQLiteDb.CreateParams): void;
+    createDb(dbName: string): void;
+    /** @beta */
+    createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;
     /** Open a SQLiteDb.
      * @param dbName The path to the SQLiteDb file to open
      */
     openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;
     /**
      * @param container optional CloudContainer holding database
-     * @internal
+     * @beta
      */
-    openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: SQLiteDb.CloudContainer): void;
+    openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;
     /** Close SQLiteDb.
-     * @param saveChanges if true, call `saveChanges` before closing db.
+     * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.
      */
     closeDb(saveChanges?: boolean): void;
-    /** Returns true if the SQLiteDb is open */
+    /** Returns true if this SQLiteDb is open */
     get isOpen(): boolean;
+    /** Returns true if this SQLiteDb is open readonly */
+    get isReadonly(): boolean;
     /**
-     * 1. open a database
-     * 2. call a function supplying the open SQliteDb as argument. If it is async, await its return.
-     * 3. close the database (even if exceptions are thrown)
+     * Open a database, perform an operation, then close the database.
+     *
+     * Details:
+     * - if database is open, throw an error
+     * - open a database
+     * - call a function with the database opened. If it is async, await its return.
+     * - if function throws, abandon all changes, close database, and rethrow
+     * - save all changes
+     * - close the database
+     * @return value from operation
      */
-    static withOpenDb<T>(args: {
-        /** The name of the database to open */
-        dbName: string;
-        /** either an object with the open parameters or just OpenMode value. */
-        openMode?: OpenMode | SQLiteDb.OpenParams;
-        /** @internal */
-        container?: SQLiteDb.CloudContainer;
-    }, operation: (db: SQLiteDb) => T): T;
+    withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T;
     /**
-     * 1. acquire the write lock on a CloudContainer
-     * 2. open a ReadWrite database in the container
-     * 3. call a function with the opened database as an argument
-     * 4. close the database
-     * 5. release the write lock and upload changes.
+     * Perform an operation on a database in a CloudContainer with the write lock held.
+     *
+     * Details:
+     * - acquire the write lock on a CloudContainer
+     * - call `withOpenDb` with openMode `ReadWrite`
+     * - upload changes
+     * - release the write lock
+     * @param args arguments to lock the container and open the database
+     * @param operation an operation performed on the database with the write lock held.
+     * @return value from operation
      * @internal
      */
-    static withLockedContainer(args: {
-        /** the name to be displayed in the event of lock collisions */
-        user: string;
-        /** the name of the database within the container */
-        dbName: string;
-        /** the CloudContainer on which the operation will be performed */
-        container: SQLiteDb.CloudContainer;
-        /** if present, function called when the write lock is currently held by another user. */
-        busyHandler?: CloudSqlite.WriteLockBusyHandler;
-    }, 
-    /** an asynchronous operation performed on the database with the write lock held. */
-    operation: (db: SQLiteDb) => Promise<void>): Promise<void>;
+    withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => T): Promise<T>;
     /** vacuum this database
      * @see https://www.sqlite.org/lang_vacuum.html
      */
-    vacuum(args?: {
-        /** new page size
-         * @see https://www.sqlite.org/pragma.html#pragma_page_size
-         */
-        pageSize?: number;
-        /** if present, name of new file to vacuum into */
-        into?: LocalFileName;
-    }): void;
+    vacuum(args?: SQLiteDb.VacuumDbArgs): void;
     /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */
     saveChanges(): void;
     /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */
@@ -109,6 +95,12 @@ export declare class SQLiteDb implements IDisposable {
      * @returns the value returned by `callback`.
      */
     withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T;
+    /**
+     * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the
+     * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back
+     * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.
+     */
+    withSavePoint(savePointName: string, operation: () => void): void;
     /** Prepare an SQL statement.
        * @param sql The SQLite SQL statement to prepare
        * @param logErrors Determine if errors are logged or not
@@ -120,21 +112,59 @@ export declare class SQLiteDb implements IDisposable {
 }
 /** @public */
 export declare namespace SQLiteDb {
-    /** A CloudSqlite container that may be connected to a CloudCache.
-     * @internal
-     */
-    type CloudContainer = IModelJsNative.CloudContainer;
-    /** @internal */
-    type CloudCache = IModelJsNative.CloudCache;
-    /** @internal */
-    type CloudPrefetch = IModelJsNative.CloudPrefetch;
-    /** Incremental IO for blobs
+    /** interface for reading and writing to a blob in a SQLiteDb
      * @internal
      */
-    type BlobIO = IModelJsNative.BlobIO;
+    interface BlobIO {
+        /** Close this BlobIO if it is opened.
+           * @note this BlobIO *may* be reused after this call by calling `open` again.
+          */
+        close(): void;
+        /** get the total number of bytes in the blob */
+        getNumBytes(): number;
+        /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */
+        isValid(): boolean;
+        /** Open this BlobIO against a table/row/column in a Db */
+        open(
+        /** The database for the blob */
+        db: IModelJsNative.AnyDb, args: {
+            /** the name of the table for the blob*/
+            tableName: string;
+            /** the name of the column for the blob */
+            columnName: string;
+            /** The rowId of the blob */
+            row: number;
+            /** If true, open this BlobIO for write access */
+            writeable?: boolean;
+        }): void;
+        /** Read from a blob
+           * @returns the contents of the requested byte range
+           */
+        read(args: {
+            /** The number of bytes to read */
+            numBytes: number;
+            /** starting offset within the blob to read */
+            offset: number;
+            /** If present and of sufficient size, use this ArrayBuffer for the value. */
+            blob?: ArrayBuffer;
+        }): Uint8Array;
+        /** Reposition this BlobIO to a new rowId
+           * @note this BlobIO must be valid when this methods is called.
+           */
+        changeRow(row: number): void;
+        /** Write to a blob */
+        write(args: {
+            /** The number of bytes to write  */
+            numBytes: number;
+            /** starting offset within the blob to write */
+            offset: number;
+            /** the value to write */
+            blob: ArrayBuffer;
+        }): void;
+    }
     /** Default transaction mode for SQLiteDbs.
-       * @see https://www.sqlite.org/lang_transaction.html
-      */
+     * @see https://www.sqlite.org/lang_transaction.html
+     */
     enum DefaultTxnMode {
         /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */
         None = 0,
@@ -154,8 +184,8 @@ export declare namespace SQLiteDb {
         /** Do not attempt to verify that the file is a valid sQLite file before opening. */
         skipFileCheck?: boolean;
         /** the default transaction mode
-         * @see [[SQLiteDb.DefaultTxnMode]]
-        */
+       * @see [[SQLiteDb.DefaultTxnMode]]
+      */
         defaultTxn?: 0 | 1 | 2 | 3;
         /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */
         queryParam?: string;
@@ -165,10 +195,26 @@ export declare namespace SQLiteDb {
         /** use OpenMode.ReadWrite to open the file with write access */
         openMode: OpenMode;
     }
-    /** Parameters for creating a new SQLiteDb */
-    interface CreateParams extends OpenOrCreateParams {
+    /** Size of a SQLiteDb page in bytes */
+    interface PageSize {
         /** see https://www.sqlite.org/pragma.html#pragma_page_size */
         pageSize?: number;
     }
+    /** Parameters for creating a new SQLiteDb */
+    type CreateParams = OpenOrCreateParams & PageSize;
+    /** Arguments for `SqliteDb.withOpenDb` */
+    interface WithOpenDbArgs {
+        /** The name of the database to open */
+        dbName: string;
+        /** either an object with the open parameters or just OpenMode value. */
+        openMode?: OpenMode | SQLiteDb.OpenParams;
+        /** @internal */
+        container?: CloudSqlite.CloudContainer;
+    }
+    /** Arguments for `SQLiteDb.vacuum` */
+    interface VacuumDbArgs extends PageSize {
+        /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */
+        into?: LocalFileName;
+    }
 }
 //# sourceMappingURL=SQLiteDb.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AAIpE;;GAEG;AACH,qBAAa,QAAS,YAAW,WAAW;IAC1C,gBAAgB;IAChB,SAAgB,QAAQ,0BAAsC;IAC9D,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,oBAAoB,CAAC,IAAI,EAAE,WAAW,CAAC,oBAAoB,GAAG,QAAQ,CAAC,cAAc;IAGnG,gBAAgB;WACF,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU;IAGjF,gBAAgB;WACF,kBAAkB,CAAC,SAAS,EAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,QAAQ,CAAC,aAAa;IAG9I,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C,yBAAyB;IAClB,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI;IAI1G;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,GAAG,IAAI;IAC7E;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,QAAQ,CAAC,cAAc,GAAG,IAAI;IAOlH;;OAEG;IACI,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAO3C,2CAA2C;IAC3C,IAAW,MAAM,IAAI,OAAO,CAAmC;IAE/D;;;;OAIG;WACW,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE;QAChC,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC1C,gBAAgB;QAChB,SAAS,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;KACrC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,CAAC,GAAG,CAAC;IAmBrC;;;;;;;OAOG;WACiB,mBAAmB,CACrC,IAAI,EAAE;QACJ,+DAA+D;QAC/D,IAAI,EAAE,MAAM,CAAC;QACb,oDAAoD;QACpD,MAAM,EAAE,MAAM,CAAC;QACf,kEAAkE;QAClE,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC;QACnC,yFAAyF;QACzF,WAAW,CAAC,EAAE,WAAW,CAAC,oBAAoB,CAAC;KAChD;IACD,oFAAoF;IACpF,SAAS,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC;IAK5C;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE;QACnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,kDAAkD;QAClD,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;IAID,oGAAoG;IAC7F,WAAW,IAAI,IAAI;IAI1B,yHAAyH;IAClH,cAAc,IAAI,IAAI;IAI7B;;;;;;;;;OASG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAiB7F;;;;;;;OAOG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAiBrF;;;;SAIK;IACE,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,+BAA+B;IACxB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAQzC;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,KAAY,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;IAC3D,gBAAgB;IAChB,KAAY,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;IACnD,gBAAgB;IAChB,KAAY,aAAa,GAAG,cAAc,CAAC,aAAa,CAAC;IACzD;;OAEG;IACH,KAAY,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;IAE3C;;QAEI;IACJ,KAAY,cAAc;QACxB,4GAA4G;QAC5G,IAAI,IAAI;QACR,4FAA4F;QAC5F,QAAQ,IAAI;QACZ,yEAAyE;QACzE,SAAS,IAAI;QACb,yEAAyE;QACzE,SAAS,IAAI;KACd;IAED,8DAA8D;IAC9D,UAAiB,kBAAkB;QACjC,6DAA6D;QAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,sEAAsE;QACtE,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,oFAAoF;QACpF,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;UAEE;QACF,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,2FAA2F;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,kDAAkD;IAClD,UAAiB,UAAW,SAAQ,kBAAkB;QACpD,gEAAgE;QAChE,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,6CAA6C;IAC7C,UAAiB,YAAa,SAAQ,kBAAkB;QACtD,8DAA8D;QAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CAEF"}
+{"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AAKpE;;GAEG;AACH,qBAAa,QAAS,YAAW,WAAW;IAC1C,gBAAgB;IAChB,SAAgB,QAAQ,0BAAsC;IAC9D,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C,yBAAyB;IAClB,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IACrC,YAAY;IACL,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI;IAM7G;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,GAAG,IAAI;IAC7E;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI;IAOrH;;OAEG;IACI,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAO3C,4CAA4C;IAC5C,IAAW,MAAM,IAAI,OAAO,CAAmC;IAE/D,qDAAqD;IACrD,IAAW,UAAU,IAAI,OAAO,CAAuC;IAEvE;;;;;;;;;;;OAWG;IACI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC;IAgB1E;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,CAAC;IAIzF;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY;IAI1C,oGAAoG;IAC7F,WAAW,IAAI,IAAI;IAI1B,yHAAyH;IAClH,cAAc,IAAI,IAAI;IAI7B;;;;;;;;;OASG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAa7F;;;;;;;OAOG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAarF;;;;OAIG;IACI,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI;IAcjE;;;;SAIK;IACE,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,+BAA+B;IACxB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAQzC;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,UAAiB,MAAM;QACrB;;YAEI;QACJ,KAAK,IAAI,IAAI,CAAC;QACd,gDAAgD;QAChD,WAAW,IAAI,MAAM,CAAC;QACtB,mGAAmG;QACnG,OAAO,IAAI,OAAO,CAAC;QACnB,0DAA0D;QAC1D,IAAI;QACF,gCAAgC;QAChC,EAAE,EAAE,cAAc,CAAC,KAAK,EACxB,IAAI,EAAE;YACJ,wCAAwC;YACxC,SAAS,EAAE,MAAM,CAAC;YAClB,0CAA0C;YAC1C,UAAU,EAAE,MAAM,CAAC;YACnB,4BAA4B;YAC5B,GAAG,EAAE,MAAM,CAAC;YACZ,iDAAiD;YACjD,SAAS,CAAC,EAAE,OAAO,CAAC;SACrB,GAAG,IAAI,CAAC;QACX;;aAEK;QACL,IAAI,CAAC,IAAI,EAAE;YACT,kCAAkC;YAClC,QAAQ,EAAE,MAAM,CAAC;YACjB,8CAA8C;YAC9C,MAAM,EAAE,MAAM,CAAC;YACf,6EAA6E;YAC7E,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB,GAAG,UAAU,CAAC;QACf;;aAEK;QACL,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,sBAAsB;QACtB,KAAK,CAAC,IAAI,EAAE;YACV,oCAAoC;YACpC,QAAQ,EAAE,MAAM,CAAC;YACjB,+CAA+C;YAC/C,MAAM,EAAE,MAAM,CAAC;YACf,yBAAyB;YACzB,IAAI,EAAE,WAAW,CAAC;SACnB,GAAG,IAAI,CAAC;KACV;IAED;;OAEG;IACH,KAAY,cAAc;QACxB,4GAA4G;QAC5G,IAAI,IAAI;QACR,4FAA4F;QAC5F,QAAQ,IAAI;QACZ,yEAAyE;QACzE,SAAS,IAAI;QACb,yEAAyE;QACzE,SAAS,IAAI;KACd;IAED,8DAA8D;IAC9D,UAAiB,kBAAkB;QACjC,6DAA6D;QAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,sEAAsE;QACtE,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,oFAAoF;QACpF,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;QAEA;QACA,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,2FAA2F;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,kDAAkD;IAClD,UAAiB,UAAW,SAAQ,kBAAkB;QACpD,gEAAgE;QAChE,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,8DAA8D;QAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,6CAA6C;IAC7C,KAAY,YAAY,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAEzD,0CAA0C;IAC1C,UAAiB,cAAc;QAC7B,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC1C,gBAAgB;QAChB,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACxC;IAED,sCAAsC;IACtC,UAAiB,YAAa,SAAQ,QAAQ;QAC5C,6FAA6F;QAC7F,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;CACF"}