@itwin/core-backend 4.0.0-dev.94 → 4.0.0-dev.96

package/lib/cjs/SQLiteDb.d.ts

@@ -2,20 +2,23 @@
  * @module SQLiteDb
  */
 import { IModelJsNative } from "@bentley/imodeljs-native";
-import { DbResult, IDisposable, OpenMode } from "@itwin/core-bentley";
+import { DbResult, OpenMode } from "@itwin/core-bentley";
 import { LocalFileName } from "@itwin/core-common";
 import { CloudSqlite } from "./CloudSqlite";
 import { SqliteStatement } from "./SqliteStatement";
-/** A SQLiteDb file
+/**
+ * A "generic" SQLiteDb. This class may be used to access local files or databases in a cloud container.
  * @public
  */
-export declare class SQLiteDb implements IDisposable {
+export declare class SQLiteDb {
     /** @internal */
     readonly nativeDb: IModelJsNative.SQLiteDb;
     private _sqliteStatementCache;
     /** @internal */
     static createBlobIO(): SQLiteDb.BlobIO;
-    /** alias for closeDb. */
+    /** alias for closeDb.
+     * @deprecated in 4.0, use [[closeDb]]
+     */
     dispose(): void;
     /** Create a SQLiteDb
      * @param dbName The path to the SQLiteDb file to create.
@@ -40,6 +43,22 @@ export declare class SQLiteDb implements IDisposable {
     get isOpen(): boolean;
     /** Returns true if this SQLiteDb is open readonly */
     get isReadonly(): boolean;
+    /** Create a new table in this database. */
+    protected createTable(args: {
+        /** The name of the table to create. */
+        tableName: string;
+        /** all of the columns in the table. */
+        columns: string;
+        /** any unique or foreign key constraints */
+        constraints?: string;
+        /** if true, add a "lastMod" timestamp column and triggers to automatically update it. */
+        addTimestamp?: boolean;
+    }): void;
+    /**
+     * Get the last modified date for a row in a table of this database.
+     * @note the table must have been created with `addTimestamp: true`
+    */
+    readLastModTime(tableName: string, rowId: number): Date;
     /**
      * Open a database, perform an operation, then close the database.
      *
@@ -66,14 +85,14 @@ export declare class SQLiteDb implements IDisposable {
      * @return value from operation
      * @internal
      */
-    withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => T): Promise<T>;
+    withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => Promise<T>): Promise<T>;
     /** vacuum this database
      * @see https://www.sqlite.org/lang_vacuum.html
      */
     vacuum(args?: SQLiteDb.VacuumDbArgs): void;
-    /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */
+    /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */
     saveChanges(): void;
-    /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */
+    /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */
     abandonChanges(): void;
     /**
      * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist
@@ -87,7 +106,7 @@ export declare class SQLiteDb implements IDisposable {
      */
     withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T;
     /**
-     * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.
+     * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.
      * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.
      * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].
      * @param sql The SQLite SQL statement to execute
@@ -110,8 +129,87 @@ export declare class SQLiteDb implements IDisposable {
     /** execute an SQL statement */
     executeSQL(sql: string): DbResult;
 }
+/**
+ * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.
+ * This class provides version checking when the database is opened, to guarantee that a valid version of software is
+ * always used for access.
+ *
+ * Notes:
+ *  - This class may be used either to access a local file, or one stored in a cloud container.
+ *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its
+ * tables.
+ * @beta
+ */
+export declare abstract class VersionedSqliteDb extends SQLiteDb {
+    protected static _versionProps: {
+        readonly namespace: "SQLiteDb";
+        readonly name: "versions";
+    };
+    /** The current semver "persistence version" of this class.
+     * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.
+     * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if
+     * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated
+     * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their
+     * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version
+     * supported by it, the user will be informed that they need to upgrade their software.
+     * @note this identifier is independent of versions in `package.json` files.
+    */
+    abstract myVersion: string;
+    /**
+     * Change the "versions required to open this database" property stored in this database. After this call,
+     * versions of software that don't meet the supplied ranges will fail.
+     * @param versions the new versions required for reading and writing this database.
+     * @note the database must be opened for write access.
+     */
+    setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges): void;
+    /** Get the required version ranges necessary to open this VersionedSqliteDb. */
+    getRequiredVersions(): SQLiteDb.RequiredVersionRanges;
+    /**
+     * Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].
+     */
+    protected abstract createDDL(): void;
+    /**
+     * Create a new database file for the subclass of VersionedSqliteDb.
+     * @param fileName the name of a local
+     * @note The required versions are saved as [[myVersion]] or newer for both read and write.
+     */
+    static createNewDb(fileName: LocalFileName): void;
+    /**
+     * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.
+     * Throws otherwise.
+     */
+    protected verifyVersions(): void;
+    /**
+     * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.
+     * Throws otherwise.
+     * @see [[SqliteDb.openDb]] for argument types
+     */
+    openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;
+    upgradeSchema(arg: {
+        dbName: string;
+        lockContainer?: {
+            container: CloudSqlite.CloudContainer;
+            moniker: string;
+        };
+        upgradeFn: () => void;
+    }): Promise<void | (() => void)>;
+}
 /** @public */
 export declare namespace SQLiteDb {
+    /** A semver version range.
+     * @see https://docs.npmjs.com/cli/v6/using-npm/semver
+     */
+    type VersionRange = string;
+    /**
+     * A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].
+     * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.
+     */
+    interface RequiredVersionRanges {
+        /** a range of acceptable persistence versions for reading from a VersionedSqliteDb. */
+        readonly readVersion: VersionRange;
+        /** a range of acceptable persistence versions for writing to a VersionedSqliteDb. */
+        readonly writeVersion: VersionRange;
+    }
     /** interface for reading and writing to a blob in a SQLiteDb
      * @internal
      */

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,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"}
+{"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AAMpE;;;GAGG;AACH,qBAAa,QAAQ;IACnB,gBAAgB;IAChB,SAAgB,QAAQ,0BAAsC;IAC9D,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C;;OAEG;IACI,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;IAK7G;;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;IAKrH;;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,2CAA2C;IAC3C,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1B,uCAAuC;QACvC,SAAS,EAAE,MAAM,CAAC;QAClB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,4CAA4C;QAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,yFAAyF;QACzF,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAQD;;;MAGE;IACK,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAO9D;;;;;;;;;;;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,OAAO,CAAC,CAAC,CAAC;IAIlG;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY;IAI1C,4GAA4G;IACrG,WAAW,IAAI,IAAI;IAI1B,iIAAiI;IAC1H,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;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAkB,SAAQ,QAAQ;IACtD,SAAS,CAAC,MAAM,CAAC,aAAa;;;MAAwD;IAEtF;;;;;;;;MAQE;IACF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB;IAKnE,gFAAgF;IACzE,mBAAmB;IAa1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,IAAI;IAEpC;;;;OAIG;WACW,WAAW,CAAC,QAAQ,EAAE,aAAa;IAajD;;;OAGG;IACH,SAAS,CAAC,cAAc;IAaxB;;;;OAIG;IACa,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;IAK1G,aAAa,CAAC,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,CAAC,cAAc,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,SAAS,EAAE,MAAM,IAAI,CAAA;KAAE,yBAAN,IAAI;CAMpJ;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,UAAiB,qBAAqB;QACpC,uFAAuF;QACvF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;QACnC,qFAAqF;QACrF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;KACrC;IAED;;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"}

package/lib/cjs/SQLiteDb.js

@@ -7,14 +7,19 @@
  * @module SQLiteDb
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SQLiteDb = void 0;
+exports.VersionedSqliteDb = exports.SQLiteDb = void 0;
+const fs = require("fs");
+const path_1 = require("path");
+const semver = require("semver");
 const core_bentley_1 = require("@itwin/core-bentley");
 const CloudSqlite_1 = require("./CloudSqlite");
 const IModelHost_1 = require("./IModelHost");
+const IModelJsFs_1 = require("./IModelJsFs");
 const SqliteStatement_1 = require("./SqliteStatement");
-// cspell:ignore savepoint
+// cspell:ignore savepoint julianday rowid
 /* eslint-disable @typescript-eslint/unified-signatures */
-/** A SQLiteDb file
+/**
+ * A "generic" SQLiteDb. This class may be used to access local files or databases in a cloud container.
  * @public
  */
 class SQLiteDb {
@@ -27,15 +32,15 @@ class SQLiteDb {
     static createBlobIO() {
         return new IModelHost_1.IModelHost.platform.BlobIO();
     }
-    /** alias for closeDb. */
+    /** alias for closeDb.
+     * @deprecated in 4.0, use [[closeDb]]
+     */
     dispose() {
         this.closeDb();
     }
-    /** @internal */
     createDb(dbName, container, params) {
         this.nativeDb.createDb(dbName, container, params);
     }
-    /** @internal */
     openDb(dbName, openMode, container) {
         this.nativeDb.openDb(dbName, openMode, container);
     }
@@ -52,6 +57,24 @@ class SQLiteDb {
     get isOpen() { return this.nativeDb.isOpen(); }
     /** Returns true if this SQLiteDb is open readonly */
     get isReadonly() { return this.nativeDb.isReadonly(); }
+    /** Create a new table in this database. */
+    createTable(args) {
+        const timestampCol = args.addTimestamp ? ",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))" : "";
+        const constraints = args.constraints ? `,${args.constraints}` : "";
+        this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);
+        if (args.addTimestamp)
+            this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);
+    }
+    /**
+     * Get the last modified date for a row in a table of this database.
+     * @note the table must have been created with `addTimestamp: true`
+    */
+    readLastModTime(tableName, rowId) {
+        return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {
+            stmt.bindInteger(1, rowId);
+            return stmt.getValueDate(0);
+        });
+    }
     /**
      * Open a database, perform an operation, then close the database.
      *
@@ -93,7 +116,7 @@ class SQLiteDb {
      * @internal
      */
     async withLockedContainer(args, operation) {
-        return CloudSqlite_1.CloudSqlite.withWriteLock(args.user, args.container, () => this.withOpenDb({ ...args, openMode: core_bentley_1.OpenMode.ReadWrite }, operation), args.busyHandler);
+        return CloudSqlite_1.CloudSqlite.withWriteLock(args.moniker, args.container, async () => this.withOpenDb({ ...args, openMode: core_bentley_1.OpenMode.ReadWrite }, operation), args.busyHandler);
     }
     /** vacuum this database
      * @see https://www.sqlite.org/lang_vacuum.html
@@ -101,11 +124,11 @@ class SQLiteDb {
     vacuum(args) {
         this.nativeDb.vacuum(args);
     }
-    /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */
+    /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */
     saveChanges() {
         this.nativeDb.saveChanges();
     }
-    /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */
+    /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */
     abandonChanges() {
         this.nativeDb.abandonChanges();
     }
@@ -133,7 +156,7 @@ class SQLiteDb {
         }
     }
     /**
-     * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.
+     * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.
      * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.
      * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].
      * @param sql The SQLite SQL statement to execute
@@ -193,6 +216,89 @@ class SQLiteDb {
     }
 }
 exports.SQLiteDb = SQLiteDb;
+/**
+ * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.
+ * This class provides version checking when the database is opened, to guarantee that a valid version of software is
+ * always used for access.
+ *
+ * Notes:
+ *  - This class may be used either to access a local file, or one stored in a cloud container.
+ *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its
+ * tables.
+ * @beta
+ */
+class VersionedSqliteDb extends SQLiteDb {
+    /**
+     * Change the "versions required to open this database" property stored in this database. After this call,
+     * versions of software that don't meet the supplied ranges will fail.
+     * @param versions the new versions required for reading and writing this database.
+     * @note the database must be opened for write access.
+     */
+    setRequiredVersions(versions) {
+        // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.
+        this.nativeDb.saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));
+    }
+    /** Get the required version ranges necessary to open this VersionedSqliteDb. */
+    getRequiredVersions() {
+        const checkIsString = (value) => {
+            if (typeof value !== "string")
+                throw new Error(`CloudDb ${this.nativeDb.getFilePath()} has invalid "versions" property`);
+            return value;
+        };
+        const versionJson = checkIsString(this.nativeDb.queryFileProperty(VersionedSqliteDb._versionProps, true));
+        const versionRanges = JSON.parse(versionJson);
+        checkIsString(versionRanges.readVersion);
+        checkIsString(versionRanges.writeVersion);
+        return versionRanges;
+    }
+    /**
+     * Create a new database file for the subclass of VersionedSqliteDb.
+     * @param fileName the name of a local
+     * @note The required versions are saved as [[myVersion]] or newer for both read and write.
+     */
+    static createNewDb(fileName) {
+        const db = new this(); // "as any" necessary because VersionedSqliteDb is abstract
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync((0, path_1.dirname)(fileName));
+        if (fs.existsSync(fileName))
+            fs.unlinkSync(fileName);
+        db.createDb(fileName);
+        db.createDDL();
+        const minVer = `^${db.myVersion}`;
+        db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });
+        db.closeDb(true);
+    }
+    /**
+     * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.
+     * Throws otherwise.
+     */
+    verifyVersions() {
+        const versions = this.getRequiredVersions();
+        const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.
+        const range = isReadonly ? versions.readVersion : versions.writeVersion;
+        if (semver.satisfies(this.myVersion, range))
+            return;
+        this.closeDb();
+        const tooNew = semver.gtr(this.myVersion, range);
+        throw new Error(`${this.nativeDb.getFilePath()} requires ${tooNew ? "older" : "newer"} version of ${this.constructor.name} for ${isReadonly ? "read" : "write"}`);
+    }
+    /**
+     * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.
+     * Throws otherwise.
+     * @see [[SqliteDb.openDb]] for argument types
+     */
+    openDb(dbName, openMode, container) {
+        super.openDb(dbName, openMode, container);
+        this.verifyVersions();
+    }
+    async upgradeSchema(arg) {
+        // can't use "this" because it checks for version, which we don't want here
+        return (arg.lockContainer) ?
+            super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :
+            super.withOpenDb({ ...arg, openMode: core_bentley_1.OpenMode.ReadWrite }, arg.upgradeFn);
+    }
+}
+VersionedSqliteDb._versionProps = { namespace: "SQLiteDb", name: "versions" };
+exports.VersionedSqliteDb = VersionedSqliteDb;
 /** @public */
 (function (SQLiteDb) {
     /** Default transaction mode for SQLiteDbs.

package/lib/cjs/SQLiteDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,sDAAsE;AAEtE,+CAA4C;AAC5C,6CAA0C;AAC1C,uDAAoE;AAEpE,0BAA0B;AAC1B,0DAA0D;AAE1D;;GAEG;AACH,MAAa,QAAQ;IAArB;QACE,gBAAgB;QACA,aAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtD,0BAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAuMxE,CAAC;IArMC,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC1C,CAAC;IAED,yBAAyB;IAClB,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQD,gBAAgB;IACT,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAYD,gBAAgB;IACT,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/D,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEvE;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI;YACF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAAkB;QACvF,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7J,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,oGAAoG;IAC7F,WAAW;QAChB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAED,yHAAyH;IAClH,cAAc;QACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAE1C,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI;YACF,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;SAC7C;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;SACpB;gBAAS;YACR,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;CACF;AA1MD,4BA0MC;AAED,cAAc;AACd,WAAiB,QAAQ;IAqDvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjHgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAiHxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SQLiteDb\r\n */\r\n\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, IDisposable, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\n\r\n// cspell:ignore savepoint\r\n/* eslint-disable @typescript-eslint/unified-signatures */\r\n\r\n/** A SQLiteDb file\r\n * @public\r\n */\r\nexport class SQLiteDb implements IDisposable {\r\n  /** @internal */\r\n  public readonly nativeDb = new IModelHost.platform.SQLiteDb();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** @internal */\r\n  public static createBlobIO(): SQLiteDb.BlobIO {\r\n    return new IModelHost.platform.BlobIO();\r\n  }\r\n\r\n  /** alias for closeDb. */\r\n  public dispose(): void {\r\n    this.closeDb();\r\n  }\r\n\r\n  /** Create a SQLiteDb\r\n   * @param dbName The path to the SQLiteDb file to create.\r\n   */\r\n  public createDb(dbName: string): void;\r\n  /** @beta */\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\r\n  /** @internal */\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\r\n    this.nativeDb.createDb(dbName, container, params);\r\n  }\r\n\r\n  /** Open a SQLiteDb.\r\n   * @param dbName The path to the SQLiteDb file to open\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\r\n  /**\r\n   * @param container optional CloudContainer holding database\r\n   * @beta\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\r\n\r\n  /** @internal */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\r\n    this.nativeDb.openDb(dbName, openMode, container);\r\n  }\r\n\r\n  /** Close SQLiteDb.\r\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\r\n   */\r\n  public closeDb(saveChanges?: boolean): void {\r\n    if (saveChanges && this.isOpen)\r\n      this.saveChanges();\r\n    this._sqliteStatementCache.clear();\r\n    this.nativeDb.closeDb();\r\n  }\r\n\r\n  /** Returns true if this SQLiteDb is open */\r\n  public get isOpen(): boolean { return this.nativeDb.isOpen(); }\r\n\r\n  /** Returns true if this SQLiteDb is open readonly */\r\n  public get isReadonly(): boolean { return this.nativeDb.isReadonly(); }\r\n\r\n  /**\r\n   * Open a database, perform an operation, then close the database.\r\n   *\r\n   * Details:\r\n   * - if database is open, throw an error\r\n   * - open a database\r\n   * - call a function with the database opened. If it is async, await its return.\r\n   * - if function throws, abandon all changes, close database, and rethrow\r\n   * - save all changes\r\n   * - close the database\r\n   * @return value from operation\r\n   */\r\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\r\n    if (this.isOpen)\r\n      throw new Error(\"database is already open\");\r\n\r\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\r\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\r\n    try {\r\n      const result = operation();\r\n      result instanceof Promise ? result.then(save, abandon) : save();\r\n      return result;\r\n    } catch (e) {\r\n      abandon();\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on a database in a CloudContainer with the write lock held.\r\n   *\r\n   * Details:\r\n   * - acquire the write lock on a CloudContainer\r\n   * - call `withOpenDb` with openMode `ReadWrite`\r\n   * - upload changes\r\n   * - release the write lock\r\n   * @param args arguments to lock the container and open the database\r\n   * @param operation an operation performed on the database with the write lock held.\r\n   * @return value from operation\r\n   * @internal\r\n   */\r\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => T) {\r\n    return CloudSqlite.withWriteLock(args.user, args.container, () => this.withOpenDb({ ...args, openMode: OpenMode.ReadWrite }, operation), args.busyHandler);\r\n  }\r\n\r\n  /** vacuum this database\r\n   * @see https://www.sqlite.org/lang_vacuum.html\r\n   */\r\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\r\n    this.nativeDb.vacuum(args);\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */\r\n  public saveChanges(): void {\r\n    this.nativeDb.saveChanges();\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */\r\n  public abandonChanges(): void {\r\n    this.nativeDb.abandonChanges();\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    const release = () => stmt.dispose();\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\r\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\r\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\r\n   */\r\n  public withSavePoint(savePointName: string, operation: () => void) {\r\n    if (this.isReadonly)\r\n      throw new Error(\"database is readonly\");\r\n\r\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\r\n    try {\r\n      operation();\r\n      this.executeSQL(`RELEASE ${savePointName}`);\r\n    } catch (e) {\r\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n     * @param sql The SQLite SQL statement to prepare\r\n     * @param logErrors Determine if errors are logged or not\r\n     * @internal\r\n     */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this.nativeDb, logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** execute an SQL statement */\r\n  public executeSQL(sql: string): DbResult {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    try {\r\n      return stmt.step();\r\n    } finally {\r\n      stmt.dispose();\r\n    }\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace SQLiteDb {\r\n  /** interface for reading and writing to a blob in a SQLiteDb\r\n   * @internal\r\n   */\r\n  export interface BlobIO {\r\n    /** Close this BlobIO if it is opened.\r\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\r\n      */\r\n    close(): void;\r\n    /** get the total number of bytes in the blob */\r\n    getNumBytes(): number;\r\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\r\n    isValid(): boolean;\r\n    /** Open this BlobIO against a table/row/column in a Db */\r\n    open(\r\n      /** The database for the blob */\r\n      db: IModelJsNative.AnyDb,\r\n      args: {\r\n        /** the name of the table for the blob*/\r\n        tableName: string;\r\n        /** the name of the column for the blob */\r\n        columnName: string;\r\n        /** The rowId of the blob */\r\n        row: number;\r\n        /** If true, open this BlobIO for write access */\r\n        writeable?: boolean;\r\n      }): void;\r\n    /** Read from a blob\r\n       * @returns the contents of the requested byte range\r\n       */\r\n    read(args: {\r\n      /** The number of bytes to read */\r\n      numBytes: number;\r\n      /** starting offset within the blob to read */\r\n      offset: number;\r\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\r\n      blob?: ArrayBuffer;\r\n    }): Uint8Array;\r\n    /** Reposition this BlobIO to a new rowId\r\n       * @note this BlobIO must be valid when this methods is called.\r\n       */\r\n    changeRow(row: number): void;\r\n    /** Write to a blob */\r\n    write(args: {\r\n      /** The number of bytes to write  */\r\n      numBytes: number;\r\n      /** starting offset within the blob to write */\r\n      offset: number;\r\n      /** the value to write */\r\n      blob: ArrayBuffer;\r\n    }): void;\r\n  }\r\n\r\n  /** Default transaction mode for SQLiteDbs.\r\n   * @see https://www.sqlite.org/lang_transaction.html\r\n   */\r\n  export enum DefaultTxnMode {\r\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\r\n    None = 0,\r\n    /** A deferred transaction is started when the file is first opened. This is the default. */\r\n    Deferred = 1,\r\n    /** An immediate transaction is started when the file is first opened. */\r\n    Immediate = 2,\r\n    /** An exclusive transaction is started when the file is first opened. */\r\n    Exclusive = 3\r\n  }\r\n\r\n  /** parameters common to opening or creating a new SQLiteDb */\r\n  export interface OpenOrCreateParams {\r\n    /** If true, do not require that the `be_Prop` table exist */\r\n    rawSQLite?: boolean;\r\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\r\n    immutable?: boolean;\r\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\r\n    skipFileCheck?: boolean;\r\n    /** the default transaction mode\r\n   * @see [[SQLiteDb.DefaultTxnMode]]\r\n  */\r\n    defaultTxn?: 0 | 1 | 2 | 3;\r\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\r\n    queryParam?: string;\r\n  }\r\n\r\n  /** Parameters for opening an existing SQLiteDb */\r\n  export interface OpenParams extends OpenOrCreateParams {\r\n    /** use OpenMode.ReadWrite to open the file with write access */\r\n    openMode: OpenMode;\r\n  }\r\n\r\n  /** Size of a SQLiteDb page in bytes */\r\n  export interface PageSize {\r\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\r\n    pageSize?: number;\r\n  }\r\n\r\n  /** Parameters for creating a new SQLiteDb */\r\n  export type CreateParams = OpenOrCreateParams & PageSize;\r\n\r\n  /** Arguments for `SqliteDb.withOpenDb` */\r\n  export interface WithOpenDbArgs {\r\n    /** The name of the database to open */\r\n    dbName: string;\r\n    /** either an object with the open parameters or just OpenMode value. */\r\n    openMode?: OpenMode | SQLiteDb.OpenParams;\r\n    /** @internal */\r\n    container?: CloudSqlite.CloudContainer;\r\n  }\r\n\r\n  /** Arguments for `SQLiteDb.vacuum` */\r\n  export interface VacuumDbArgs extends PageSize {\r\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\r\n    into?: LocalFileName;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,+BAA+B;AAC/B,iCAAiC;AAEjC,sDAAyD;AAEzD,+CAA4C;AAC5C,6CAA0C;AAC1C,6CAA0C;AAC1C,uDAAoE;AAEpE,0CAA0C;AAE1C,0DAA0D;AAE1D;;;GAGG;AACH,MAAa,QAAQ;IAArB;QACE,gBAAgB;QACA,aAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtD,0BAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAmOxE,CAAC;IAjOC,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/D,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEvE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI;YACF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACtK,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAE1C,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI;YACF,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;SAC7C;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;SACpB;gBAAS;YACR,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;CACF;AAtOD,4BAsOC;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAkB,SAAQ,QAAQ;IActD;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAC9J,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,kCAAkC,CAAC,CAAC;YAC5F,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB;QAC/C,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAEpK,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAA0H;QACnJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AA7FgB,+BAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;AADlE,8CAAiB;AAiGvC,cAAc;AACd,WAAiB,QAAQ;IAqEvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjIgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAiIxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SQLiteDb\r\n */\r\n\r\nimport * as fs from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\n\r\n// cspell:ignore savepoint julianday rowid\r\n\r\n/* eslint-disable @typescript-eslint/unified-signatures */\r\n\r\n/**\r\n * A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\r\n * @public\r\n */\r\nexport class SQLiteDb {\r\n  /** @internal */\r\n  public readonly nativeDb = new IModelHost.platform.SQLiteDb();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** @internal */\r\n  public static createBlobIO(): SQLiteDb.BlobIO {\r\n    return new IModelHost.platform.BlobIO();\r\n  }\r\n\r\n  /** alias for closeDb.\r\n   * @deprecated in 4.0, use [[closeDb]]\r\n   */\r\n  public dispose(): void {\r\n    this.closeDb();\r\n  }\r\n\r\n  /** Create a SQLiteDb\r\n   * @param dbName The path to the SQLiteDb file to create.\r\n   */\r\n  public createDb(dbName: string): void;\r\n  /** @beta */\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\r\n    this.nativeDb.createDb(dbName, container, params);\r\n  }\r\n\r\n  /** Open a SQLiteDb.\r\n   * @param dbName The path to the SQLiteDb file to open\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\r\n  /**\r\n   * @param container optional CloudContainer holding database\r\n   * @beta\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\r\n    this.nativeDb.openDb(dbName, openMode, container);\r\n  }\r\n\r\n  /** Close SQLiteDb.\r\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\r\n   */\r\n  public closeDb(saveChanges?: boolean): void {\r\n    if (saveChanges && this.isOpen)\r\n      this.saveChanges();\r\n    this._sqliteStatementCache.clear();\r\n    this.nativeDb.closeDb();\r\n  }\r\n\r\n  /** Returns true if this SQLiteDb is open */\r\n  public get isOpen(): boolean { return this.nativeDb.isOpen(); }\r\n\r\n  /** Returns true if this SQLiteDb is open readonly */\r\n  public get isReadonly(): boolean { return this.nativeDb.isReadonly(); }\r\n\r\n  /** Create a new table in this database. */\r\n  protected createTable(args: {\r\n    /** The name of the table to create. */\r\n    tableName: string;\r\n    /** all of the columns in the table. */\r\n    columns: string;\r\n    /** any unique or foreign key constraints */\r\n    constraints?: string;\r\n    /** if true, add a \"lastMod\" timestamp column and triggers to automatically update it. */\r\n    addTimestamp?: boolean;\r\n  }) {\r\n    const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\r\n    const constraints = args.constraints ? `,${args.constraints}` : \"\";\r\n    this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\r\n    if (args.addTimestamp)\r\n      this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\r\n  }\r\n\r\n  /**\r\n   * Get the last modified date for a row in a table of this database.\r\n   * @note the table must have been created with `addTimestamp: true`\r\n  */\r\n  public readLastModTime(tableName: string, rowId: number): Date {\r\n    return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\r\n      stmt.bindInteger(1, rowId);\r\n      return stmt.getValueDate(0);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Open a database, perform an operation, then close the database.\r\n   *\r\n   * Details:\r\n   * - if database is open, throw an error\r\n   * - open a database\r\n   * - call a function with the database opened. If it is async, await its return.\r\n   * - if function throws, abandon all changes, close database, and rethrow\r\n   * - save all changes\r\n   * - close the database\r\n   * @return value from operation\r\n   */\r\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\r\n    if (this.isOpen)\r\n      throw new Error(\"database is already open\");\r\n\r\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\r\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\r\n    try {\r\n      const result = operation();\r\n      result instanceof Promise ? result.then(save, abandon) : save();\r\n      return result;\r\n    } catch (e) {\r\n      abandon();\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on a database in a CloudContainer with the write lock held.\r\n   *\r\n   * Details:\r\n   * - acquire the write lock on a CloudContainer\r\n   * - call `withOpenDb` with openMode `ReadWrite`\r\n   * - upload changes\r\n   * - release the write lock\r\n   * @param args arguments to lock the container and open the database\r\n   * @param operation an operation performed on the database with the write lock held.\r\n   * @return value from operation\r\n   * @internal\r\n   */\r\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => Promise<T>) {\r\n    return CloudSqlite.withWriteLock(args.moniker, args.container, async () => this.withOpenDb({ ...args, openMode: OpenMode.ReadWrite }, operation), args.busyHandler);\r\n  }\r\n\r\n  /** vacuum this database\r\n   * @see https://www.sqlite.org/lang_vacuum.html\r\n   */\r\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\r\n    this.nativeDb.vacuum(args);\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */\r\n  public saveChanges(): void {\r\n    this.nativeDb.saveChanges();\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */\r\n  public abandonChanges(): void {\r\n    this.nativeDb.abandonChanges();\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    const release = () => stmt.dispose();\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\r\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\r\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\r\n   */\r\n  public withSavePoint(savePointName: string, operation: () => void) {\r\n    if (this.isReadonly)\r\n      throw new Error(\"database is readonly\");\r\n\r\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\r\n    try {\r\n      operation();\r\n      this.executeSQL(`RELEASE ${savePointName}`);\r\n    } catch (e) {\r\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n     * @param sql The SQLite SQL statement to prepare\r\n     * @param logErrors Determine if errors are logged or not\r\n     * @internal\r\n     */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this.nativeDb, logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** execute an SQL statement */\r\n  public executeSQL(sql: string): DbResult {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    try {\r\n      return stmt.step();\r\n    } finally {\r\n      stmt.dispose();\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\r\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\r\n * always used for access.\r\n *\r\n * Notes:\r\n *  - This class may be used either to access a local file, or one stored in a cloud container.\r\n *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\r\n * tables.\r\n * @beta\r\n */\r\nexport abstract class VersionedSqliteDb extends SQLiteDb {\r\n  protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\r\n\r\n  /** The current semver \"persistence version\" of this class.\r\n   * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\r\n   * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\r\n   * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\r\n   * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\r\n   * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\r\n   * supported by it, the user will be informed that they need to upgrade their software.\r\n   * @note this identifier is independent of versions in `package.json` files.\r\n  */\r\n  public abstract myVersion: string;\r\n\r\n  /**\r\n   * Change the \"versions required to open this database\" property stored in this database. After this call,\r\n   * versions of software that don't meet the supplied ranges will fail.\r\n   * @param versions the new versions required for reading and writing this database.\r\n   * @note the database must be opened for write access.\r\n   */\r\n  public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\r\n    // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\r\n    this.nativeDb.saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\r\n  }\r\n\r\n  /** Get the required version ranges necessary to open this VersionedSqliteDb. */\r\n  public getRequiredVersions() {\r\n    const checkIsString = (value: any) => {\r\n      if (typeof value !== \"string\")\r\n        throw new Error(`CloudDb ${this.nativeDb.getFilePath()} has invalid \"versions\" property`);\r\n      return value;\r\n    };\r\n    const versionJson = checkIsString(this.nativeDb.queryFileProperty(VersionedSqliteDb._versionProps, true));\r\n    const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\r\n    checkIsString(versionRanges.readVersion);\r\n    checkIsString(versionRanges.writeVersion);\r\n    return versionRanges;\r\n  }\r\n\r\n  /**\r\n   * Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\r\n   */\r\n  protected abstract createDDL(): void;\r\n\r\n  /**\r\n   * Create a new database file for the subclass of VersionedSqliteDb.\r\n   * @param fileName the name of a local\r\n   * @note The required versions are saved as [[myVersion]] or newer for both read and write.\r\n   */\r\n  public static createNewDb(fileName: LocalFileName) {\r\n    const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\r\n    IModelJsFs.recursiveMkDirSync(dirname(fileName));\r\n    if (fs.existsSync(fileName))\r\n      fs.unlinkSync(fileName);\r\n\r\n    db.createDb(fileName);\r\n    db.createDDL();\r\n    const minVer = `^${db.myVersion}`;\r\n    db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\r\n    db.closeDb(true);\r\n  }\r\n\r\n  /**\r\n   * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n   * Throws otherwise.\r\n   */\r\n  protected verifyVersions() {\r\n    const versions = this.getRequiredVersions();\r\n    const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\r\n    const range = isReadonly ? versions.readVersion : versions.writeVersion;\r\n    if (semver.satisfies(this.myVersion, range))\r\n      return;\r\n\r\n    this.closeDb();\r\n    const tooNew = semver.gtr(this.myVersion, range);\r\n    throw new Error(`${this.nativeDb.getFilePath()} requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`);\r\n\r\n  }\r\n\r\n  /**\r\n   * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n   * Throws otherwise.\r\n   * @see [[SqliteDb.openDb]] for argument types\r\n   */\r\n  public override openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\r\n    super.openDb(dbName, openMode, container);\r\n    this.verifyVersions();\r\n  }\r\n\r\n  public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, moniker: string }, upgradeFn: () => void }) {\r\n    // can't use \"this\" because it checks for version, which we don't want here\r\n    return (arg.lockContainer) ?\r\n      super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\r\n      super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace SQLiteDb {\r\n  /** A semver version range.\r\n   * @see https://docs.npmjs.com/cli/v6/using-npm/semver\r\n   */\r\n  export type VersionRange = string;\r\n\r\n  /**\r\n   * A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\r\n   * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\r\n   */\r\n  export interface RequiredVersionRanges {\r\n    /** a range of acceptable persistence versions for reading from a VersionedSqliteDb. */\r\n    readonly readVersion: VersionRange;\r\n    /** a range of acceptable persistence versions for writing to a VersionedSqliteDb. */\r\n    readonly writeVersion: VersionRange;\r\n  }\r\n\r\n  /** interface for reading and writing to a blob in a SQLiteDb\r\n   * @internal\r\n   */\r\n  export interface BlobIO {\r\n    /** Close this BlobIO if it is opened.\r\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\r\n      */\r\n    close(): void;\r\n    /** get the total number of bytes in the blob */\r\n    getNumBytes(): number;\r\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\r\n    isValid(): boolean;\r\n    /** Open this BlobIO against a table/row/column in a Db */\r\n    open(\r\n      /** The database for the blob */\r\n      db: IModelJsNative.AnyDb,\r\n      args: {\r\n        /** the name of the table for the blob*/\r\n        tableName: string;\r\n        /** the name of the column for the blob */\r\n        columnName: string;\r\n        /** The rowId of the blob */\r\n        row: number;\r\n        /** If true, open this BlobIO for write access */\r\n        writeable?: boolean;\r\n      }): void;\r\n    /** Read from a blob\r\n       * @returns the contents of the requested byte range\r\n       */\r\n    read(args: {\r\n      /** The number of bytes to read */\r\n      numBytes: number;\r\n      /** starting offset within the blob to read */\r\n      offset: number;\r\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\r\n      blob?: ArrayBuffer;\r\n    }): Uint8Array;\r\n    /** Reposition this BlobIO to a new rowId\r\n       * @note this BlobIO must be valid when this methods is called.\r\n       */\r\n    changeRow(row: number): void;\r\n    /** Write to a blob */\r\n    write(args: {\r\n      /** The number of bytes to write  */\r\n      numBytes: number;\r\n      /** starting offset within the blob to write */\r\n      offset: number;\r\n      /** the value to write */\r\n      blob: ArrayBuffer;\r\n    }): void;\r\n  }\r\n\r\n  /** Default transaction mode for SQLiteDbs.\r\n   * @see https://www.sqlite.org/lang_transaction.html\r\n   */\r\n  export enum DefaultTxnMode {\r\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\r\n    None = 0,\r\n    /** A deferred transaction is started when the file is first opened. This is the default. */\r\n    Deferred = 1,\r\n    /** An immediate transaction is started when the file is first opened. */\r\n    Immediate = 2,\r\n    /** An exclusive transaction is started when the file is first opened. */\r\n    Exclusive = 3\r\n  }\r\n\r\n  /** parameters common to opening or creating a new SQLiteDb */\r\n  export interface OpenOrCreateParams {\r\n    /** If true, do not require that the `be_Prop` table exist */\r\n    rawSQLite?: boolean;\r\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\r\n    immutable?: boolean;\r\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\r\n    skipFileCheck?: boolean;\r\n    /** the default transaction mode\r\n   * @see [[SQLiteDb.DefaultTxnMode]]\r\n  */\r\n    defaultTxn?: 0 | 1 | 2 | 3;\r\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\r\n    queryParam?: string;\r\n  }\r\n\r\n  /** Parameters for opening an existing SQLiteDb */\r\n  export interface OpenParams extends OpenOrCreateParams {\r\n    /** use OpenMode.ReadWrite to open the file with write access */\r\n    openMode: OpenMode;\r\n  }\r\n\r\n  /** Size of a SQLiteDb page in bytes */\r\n  export interface PageSize {\r\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\r\n    pageSize?: number;\r\n  }\r\n\r\n  /** Parameters for creating a new SQLiteDb */\r\n  export type CreateParams = OpenOrCreateParams & PageSize;\r\n\r\n  /** Arguments for `SqliteDb.withOpenDb` */\r\n  export interface WithOpenDbArgs {\r\n    /** The name of the database to open */\r\n    dbName: string;\r\n    /** either an object with the open parameters or just OpenMode value. */\r\n    openMode?: OpenMode | SQLiteDb.OpenParams;\r\n    /** @internal */\r\n    container?: CloudSqlite.CloudContainer;\r\n  }\r\n\r\n  /** Arguments for `SQLiteDb.vacuum` */\r\n  export interface VacuumDbArgs extends PageSize {\r\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\r\n    into?: LocalFileName;\r\n  }\r\n}\r\n"]}

package/lib/cjs/ViewDefinition.d.ts

@@ -22,8 +22,7 @@ export declare class ModelSelector extends DefinitionElement {
     constructor(props: ModelSelectorProps, iModel: IModelDb);
     /** @internal */
     toJSON(): ModelSelectorProps;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** Create a Code for a ModelSelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
      * @param iModel  The IModelDb
      * @param scopeModelId The Id of the DefinitionModel that contains the ModelSelector and provides the scope for its name.
@@ -65,8 +64,7 @@ export declare class CategorySelector extends DefinitionElement {
     constructor(props: CategorySelectorProps, iModel: IModelDb);
     /** @internal */
     toJSON(): CategorySelectorProps;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
      * @param iModel  The IModelDb
      * @param scopeModelId The Id of the DefinitionModel that contains the CategorySelector and provides the scope for its name.
@@ -119,8 +117,7 @@ export declare abstract class ViewDefinition extends DefinitionElement {
     protected constructor(props: ViewDefinitionProps, iModel: IModelDb);
     /** @internal */
     toJSON(): ViewDefinitionProps;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** @beta */
     static readonly requiredReferenceKeys: ReadonlyArray<string>;
     /** @alpha */
@@ -203,8 +200,7 @@ export declare class SpatialViewDefinition extends ViewDefinition3d {
     static fromJSON(props: Omit<SpatialViewDefinitionProps, "classFullName">, iModel: IModelDb): SpatialViewDefinition;
     /** Convert this view to its JSON representation. */
     toJSON(): SpatialViewDefinitionProps;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** @beta */
     static readonly requiredReferenceKeys: ReadonlyArray<string>;
     /** @alpha */
@@ -292,8 +288,7 @@ export declare class ViewDefinition2d extends ViewDefinition {
     constructor(props: ViewDefinition2dProps, iModel: IModelDb);
     /** @internal */
     toJSON(): ViewDefinition2dProps;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** Provides access to optional detail settings for this view. */
     get details(): ViewDetails;
     /** Load this view's DisplayStyle2d from the IModelDb. */
@@ -419,8 +414,7 @@ export declare class ViewAttachment extends GraphicalElement2d {
     static get className(): string;
     view: RelatedElement;
     constructor(props: ViewAttachmentProps, iModel: IModelDb);
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** The position in space of a Light.
  * @internal

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

@@ -1 +1 @@
-{"version":3,"file":"ViewDefinition.d.ts","sourceRoot":"","sources":["../../src/ViewDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,SAAS,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,KAAK,EAAY,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAa,QAAQ,EAAE,kBAAkB,EAChH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAe,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,cAAc,EACzH,mBAAmB,EAAE,kBAAkB,EAAe,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,EACtH,0BAA0B,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,WAAW,EAC/H,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAE1E,mFAAmF;IAC5E,MAAM,EAAE,UAAU,EAAE,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvD,gBAAgB;IACA,MAAM,IAAI,kBAAkB;IAM5C,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAKtF;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,aAAa;IAUvH;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,UAAU;CAIrH;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,mFAAmF;IAC5E,UAAU,EAAE,UAAU,EAAE,CAAC;IAChC,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAK1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;IAM/C,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAKtF;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,gBAAgB;IAW9H;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU;CAIzH;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,yEAAyE;IAClE,kBAAkB,EAAE,UAAU,CAAC;IACtC,qEAAqE;IAC9D,cAAc,EAAE,UAAU,CAAC;IAElC,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAYlE,gBAAgB;IACA,MAAM,IAAI,mBAAmB;IAO7C,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAUtF,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAA4E;IACxJ,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAI9F;IAEF,gBAAgB;qBACU,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IAU9J,oDAAoD;IAC7C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,mDAAmD;IAC5C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IACrD,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IAErD,uDAAuD;IAChD,gBAAgB,IAAI,YAAY;IAEvC,2DAA2D;IACpD,oBAAoB,IAAI,gBAAgB;IAE/C,iEAAiE;IACjE,aAAoB,OAAO,IAAI,WAAW,CAAC;IAE3C,8GAA8G;IACvG,8BAA8B,IAAI,UAAU;IAInD;;OAEG;IACI,8BAA8B,CAAC,KAAK,EAAE,UAAU;IAIvD;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,0EAA0E;IACnE,QAAQ,EAAE,OAAO,CAAC;IACzB,sDAAsD;IAC/C,MAAM,EAAE,OAAO,CAAC;IACvB,8EAA8E;IACvE,OAAO,EAAE,QAAQ,CAAC;IACzB,2DAA2D;IACpD,MAAM,EAAE,kBAAkB,CAAC;IAClC,4DAA4D;IACrD,MAAM,EAAE,MAAM,CAAC;IAEtB,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAUjE,gBAAgB;IACA,MAAM,IAAI,qBAAqB;IAU/C,iEAAiE;IACjE,IAAW,OAAO,IAAI,aAAa,CAA0B;IAE7D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,sEAAsE;IAC/D,eAAe,EAAE,UAAU,CAAC;IAEnC,gBAAgB;gBACG,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAOtE,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,0BAA0B,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAIjG,oDAAoD;IACpC,MAAM,IAAI,0BAA0B;IAMpD,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAKtF,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAAuD;IAEnI,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAG9F;IAEF,wDAAwD;IACjD,iBAAiB,IAAI,aAAa;IACzC;;;;;;;;;;;;;OAaG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,qBAAqB;IA0BzS;;;;;OAKG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,UAAU;CAI/R;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAyC;gBAC3E,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAC/D;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,0BAA0B;IAqBhQ;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,UAAU;IAKhP,oFAAoF;IAC7E,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAOtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,kDAAkD;IAC3C,WAAW,EAAE,UAAU,CAAC;IAC/B,+DAA+D;IACxD,MAAM,EAAE,OAAO,CAAC;IACvB,uEAAuE;IAChE,KAAK,EAAE,OAAO,CAAC;IACtB,iCAAiC;IAC1B,KAAK,EAAE,KAAK,CAAC;IAEpB,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IASjE,gBAAgB;IACA,MAAM,IAAI,qBAAqB;IAS/C,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAKtF,iEAAiE;IACjE,IAAW,OAAO,IAAI,WAAW,CAA0B;IAE3D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAIjE;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,qBAAqB;IAejN,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,qBAAqB,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAI5F;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU;CAIvM;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;CAChE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAG,MAAM,CAAC;gBACH,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,EAAG,MAAM,CAAC;IACb,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;gBACF,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF;;;;OAIG;WACoB,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAI3G;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAE,cAAc,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAK/D,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAIvF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,sBAAsB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E,iDAAiD;IAC1C,OAAO,EAAG,OAAO,CAAC;IACzB,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;CACxD"}
+{"version":3,"file":"ViewDefinition.d.ts","sourceRoot":"","sources":["../../src/ViewDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,SAAS,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,KAAK,EAAY,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAa,QAAQ,EAAE,kBAAkB,EAChH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAe,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,cAAc,EACzH,mBAAmB,EAAE,kBAAkB,EAAe,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,EACtH,0BAA0B,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,WAAW,EAC/H,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAE1E,mFAAmF;IAC5E,MAAM,EAAE,UAAU,EAAE,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvD,gBAAgB;IACA,MAAM,IAAI,kBAAkB;cAMzB,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,aAAa;IAUvH;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,UAAU;CAIrH;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,mFAAmF;IAC5E,UAAU,EAAE,UAAU,EAAE,CAAC;IAChC,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAK1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;cAM5B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,gBAAgB;IAW9H;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU;CAIzH;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,yEAAyE;IAClE,kBAAkB,EAAE,UAAU,CAAC;IACtC,qEAAqE;IAC9D,cAAc,EAAE,UAAU,CAAC;IAElC,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAYlE,gBAAgB;IACA,MAAM,IAAI,mBAAmB;cAO1B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAU9E,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAA4E;IACxJ,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAI9F;IAEF,gBAAgB;qBACU,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IAU9J,oDAAoD;IAC7C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,mDAAmD;IAC5C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IACrD,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IAErD,uDAAuD;IAChD,gBAAgB,IAAI,YAAY;IAEvC,2DAA2D;IACpD,oBAAoB,IAAI,gBAAgB;IAE/C,iEAAiE;IACjE,aAAoB,OAAO,IAAI,WAAW,CAAC;IAE3C,8GAA8G;IACvG,8BAA8B,IAAI,UAAU;IAInD;;OAEG;IACI,8BAA8B,CAAC,KAAK,EAAE,UAAU;IAIvD;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,0EAA0E;IACnE,QAAQ,EAAE,OAAO,CAAC;IACzB,sDAAsD;IAC/C,MAAM,EAAE,OAAO,CAAC;IACvB,8EAA8E;IACvE,OAAO,EAAE,QAAQ,CAAC;IACzB,2DAA2D;IACpD,MAAM,EAAE,kBAAkB,CAAC;IAClC,4DAA4D;IACrD,MAAM,EAAE,MAAM,CAAC;IAEtB,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAUjE,gBAAgB;IACA,MAAM,IAAI,qBAAqB;IAU/C,iEAAiE;IACjE,IAAW,OAAO,IAAI,aAAa,CAA0B;IAE7D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,sEAAsE;IAC/D,eAAe,EAAE,UAAU,CAAC;IAEnC,gBAAgB;gBACG,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAOtE,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,0BAA0B,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAIjG,oDAAoD;IACpC,MAAM,IAAI,0BAA0B;cAMjC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAAuD;IAEnI,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAG9F;IAEF,wDAAwD;IACjD,iBAAiB,IAAI,aAAa;IACzC;;;;;;;;;;;;;OAaG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,qBAAqB;IA0BzS;;;;;OAKG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,UAAU;CAI/R;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAyC;gBAC3E,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAC/D;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,0BAA0B;IAqBhQ;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,UAAU;IAKhP,oFAAoF;IAC7E,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAOtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,kDAAkD;IAC3C,WAAW,EAAE,UAAU,CAAC;IAC/B,+DAA+D;IACxD,MAAM,EAAE,OAAO,CAAC;IACvB,uEAAuE;IAChE,KAAK,EAAE,OAAO,CAAC;IACtB,iCAAiC;IAC1B,KAAK,EAAE,KAAK,CAAC;IAEpB,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IASjE,gBAAgB;IACA,MAAM,IAAI,qBAAqB;cAS5B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E,iEAAiE;IACjE,IAAW,OAAO,IAAI,WAAW,CAA0B;IAE3D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAIjE;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,qBAAqB;IAejN,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,qBAAqB,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAI5F;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU;CAIvM;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;CAChE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAG,MAAM,CAAC;gBACH,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,EAAG,MAAM,CAAC;IACb,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;gBACF,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF;;;;OAIG;WACoB,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAI3G;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAE,cAAc,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;cAK5C,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAI/E;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,sBAAsB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E,iDAAiD;IAC1C,OAAO,EAAG,OAAO,CAAC;IACzB,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;CACxD"}