@bentley/imodeljs-native 3.4.9 → 3.4.12

package/{CloudSqlite.d.ts → NativeCloudSqlite.d.ts}

@@ -1,166 +1,120 @@
-/** @packageDocumentation
- * @module iModels
- */
-/// <reference types="node" />
-import * as child_process from "child_process";
-import { IModelJsNative } from "./NativeLibrary";
-/**
- * @note This package may only have **dev** dependencies on @itwin packages, so they are *not* available at runtime. Therefore we can only import **types** from them.
- */
-import type { LocalFileName } from "@itwin/core-common";
-export declare namespace CloudSqlite {
-    const enum LogMask {
-        LOG_HTTP = 1,
-        LOG_UPLOAD = 2,
-        LOG_CLEANUP = 4,
-        LOG_EVENT = 8
-    }
-    /** Properties that specify how to access the account for a cloud blob-store container. */
-    interface AccountAccessProps {
-        /** blob storage module: e.g. "azure", "google", "aws". May also include URI style parameters. */
-        storageType: string;
-        /** blob store account name, or a URI for custom domains. */
-        accessName: string;
-    }
-    /** Properties of a CloudContainer. */
-    interface ContainerProps {
-        /** the name of the container. */
-        containerId: string;
-        /** an alias for the container. Defaults to `containerId` */
-        alias?: string;
-        /** token that grants access to the container. For sas=1 `storageType`s, this is the sasToken. For sas=0, this is the account key */
-        accessToken: string;
-        /** if true, container is attached with write permissions, and accessToken must provide write access to the cloud container. */
-        writeable?: boolean;
-        /** if true, container is attached in "secure" mode (blocks are encrypted). Only supported in daemon mode. */
-        secure?: boolean;
-    }
-    /** Returned from `CloudContainer.queryDatabase` describing one database in the container */
-    interface CachedDbProps {
-        /** The total of (4Mb) blocks in the database. */
-        readonly totalBlocks: number;
-        /** the number of blocks of the database that have been downloaded into the CloudCache */
-        readonly localBlocks: number;
-        /** the number of blocks from this database that have been modified in the CloudCache and need to be uploaded. */
-        readonly dirtyBlocks: number;
-        /** If true, the database currently has transactions in the WAL file and may not be uploaded until they have been checkPointed. */
-        readonly transactions: boolean;
-        /** the state of this database. Indicates whether the database is new or deleted since last upload */
-        readonly state: "" | "copied" | "deleted";
-    }
-    /** Properties for accessing a CloudContainer */
-    type ContainerAccessProps = AccountAccessProps & ContainerProps & {
-        /** Duration for holding write lock, in seconds. After this time the write lock expires if not refreshed. Default is one hour. */
-        durationSeconds?: number;
-    };
-    /** The name of a CloudSqlite database within a CloudContainer. */
-    interface DbNameProp {
-        /** the name of the database within the CloudContainer.
-         * @note names of databases within a CloudContainer are always **case sensitive** on all platforms.*/
-        dbName: string;
-    }
-    /** Properties for accessing a database within a CloudContainer */
-    interface DbProps extends DbNameProp {
-        /** the name of the local file to access the database. */
-        localFileName: LocalFileName;
-    }
-    type TransferDirection = "upload" | "download";
-    interface TransferProgress {
-        /** a user-supplied progress function called during the transfer operation. Return a non-0 value to abort the transfer. */
-        onProgress?: (loaded: number, total: number) => number;
-    }
-    interface CloudHttpProps {
-        /** The number of simultaneous HTTP requests.  Default is 6. */
-        nRequests?: number;
-    }
-    interface PrefetchProps extends CloudHttpProps {
-        /** timeout between requests, in milliseconds. Default is 100. */
-        timeout?: number;
-        /** The number of prefetch requests to issue while there is foreground activity. Default is 3. */
-        minRequests?: number;
-    }
-    type TransferDbProps = DbProps & TransferProgress & CloudHttpProps;
-    /** Properties for creating a CloudCache. */
-    interface CacheProps extends CloudHttpProps {
-        /** full path of directory for cache to store its files. Must be on a (preferably fast) local drive, and must be empty when the cache is first created. */
-        rootDir: string;
-        /** name of this cache. It is possible to have more than one CloudCache in the same session. */
-        name: string;
-        /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */
-        cacheSize?: string;
-        /** turn on diagnostics for `curl` (outputs to stderr) */
-        curlDiagnostics?: boolean;
-    }
-    /** Properties for creating a new instance of a daemon process. */
-    interface DaemonProps {
-        /** full path name of daemon.exe file. Default is to find "iTwinDaemon.exe" in the same directory as this library. */
-        exePath?: string;
-        /** daemon connection address. Default is "127.0.0.1" */
-        addr?: string;
-        /** port number. Default 22002 */
-        portNumber?: number;
-        /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */
-        cacheSize?: string;
-        /** logging options */
-        log?: string;
-        /** if true, don't include timestamps in log messages */
-        noTimeStamps?: boolean;
-        /** The amount of time, in seconds before an http request made to cloud storage by the daemon times out. Default 600 seconds. */
-        httptimeout?: number;
-        /** options for spawn */
-        spawnOptions?: child_process.SpawnOptions;
-    }
-    type DaemonCommandArg = DbNameProp & AccountAccessProps & CacheProps & ContainerProps;
-    class Daemon {
-        private static exeName;
-        static daemonDir(props: CacheProps): string;
-        /** Start the Daemon process using the supplied properties. The process will be detached from the current process. */
-        static start(props: DaemonProps & CacheProps): child_process.ChildProcess;
-    }
-    /** @internal */
-    function transferDb(direction: TransferDirection, container: IModelJsNative.CloudContainer, props: TransferDbProps): Promise<void>;
-    /** Upload a database into a CloudContainer
-     * @param container the CloudContainer holding the database. Must be connected.
-     * @param props the properties that describe the database to be downloaded, plus optionally an `onProgress` function.
-     * @note this function requires that the write lock be held on the container
-     */
-    function uploadDb(container: IModelJsNative.CloudContainer, props: TransferDbProps): Promise<void>;
-    /** Download a database from a CloudContainer
-     * @param container the CloudContainer holding the database. Must be connected.
-     * @param props the properties that describe the database to be downloaded, plus optionally an `onProgress` function.
-     * @returns a Promise that is resolved when the download completes.
-     * @note the download is "restartable." If the transfer is aborted and then re-requested, it will continue from where
-     * it left off rather than re-downloading the entire file.
-     */
-    function downloadDb(container: IModelJsNative.CloudContainer, props: TransferDbProps): Promise<void>;
-    /** Optional method to be called when an attempt to acquire the write lock fails because another user currently holds it.
-     * @param lockedBy The identifier supplied by the application/user that currently holds the lock.
-     * @param expires a stringified Date (in local time) indicating when the lock will expire.
-     * @return "stop" to give up and stop retrying. Generally, it's a good idea to wait for some time before returning.
-     */
-    type WriteLockBusyHandler = (lockedBy: string, expires: string) => Promise<void | "stop">;
-    /**
-     * Attempt to acquire the write lock for a container, with retries.
-     * If write lock is held by another user, call busyHandler if supplied. If no busyHandler, or handler returns "stop", throw. Otherwise try again.
-     * @note if write lock is already held, this function does nothing.
-     * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us
-     * @param container the CloudContainer for which the lock is to be acquired
-     * @param busyHandler if present, function called when the write lock is currently held by another user.
-     */
-    function acquireWriteLock(user: string, container: IModelJsNative.CloudContainer, busyHandler?: WriteLockBusyHandler): Promise<void>;
-    /**
-     * Perform an asynchronous write operation on a CloudContainer with the write lock held.
-     * 1. if write lock is already held, call operation and return.
-     * 2. attempt to acquire the write lock, with retries. Throw if unable to obtain write lock.
-     * 3. perform the operation
-     * 3.a if the operation throws, abandon all changes and re-throw
-     * 4. release the write lock.
-     * 5. return value from operation
-     * @param user the name to be displayed to other users in the event they attempt to obtain the lock while it is held by us
-     * @param container the CloudContainer for which the lock is to be acquired
-     * @param operation an asynchronous operation performed with the write lock held.
-     * @param busyHandler if present, function called when the write lock is currently held by another user.
-     */
-    function withWriteLock<T>(user: string, container: IModelJsNative.CloudContainer, operation: () => T, busyHandler?: WriteLockBusyHandler): Promise<T>;
-}
-//# sourceMappingURL=CloudSqlite.d.ts.map
+/** @packageDocumentation
+ * @module iModels
+ */
+/// <reference types="node" />
+import * as child_process from "child_process";
+/**
+ * @note This package may only have **dev** dependencies on @itwin packages, so they are *not* available at runtime. Therefore we can only import **types** from them.
+ */
+import type { LocalFileName } from "@itwin/core-common";
+export declare namespace NativeCloudSqlite {
+    const enum LogMask {
+        LOG_HTTP = 1,
+        LOG_UPLOAD = 2,
+        LOG_CLEANUP = 4,
+        LOG_EVENT = 8
+    }
+    /** Properties that specify how to access the account for a cloud blob-store container. */
+    interface AccountAccessProps {
+        /** blob storage module: e.g. "azure", "google", "aws". May also include URI style parameters. */
+        storageType: string;
+        /** blob store account name, or a URI for custom domains. */
+        accessName: string;
+    }
+    /** Properties of a CloudContainer. */
+    interface ContainerProps {
+        /** the name of the container. */
+        containerId: string;
+        /** an alias for the container. Defaults to `containerId` */
+        alias?: string;
+        /** token that grants access to the container. For sas=1 `storageType`s, this is the sasToken. For sas=0, this is the account key */
+        accessToken: string;
+        /** if true, container is attached with write permissions, and accessToken must provide write access to the cloud container. */
+        writeable?: boolean;
+        /** if true, container is attached in "secure" mode (blocks are encrypted). Only supported in daemon mode. */
+        secure?: boolean;
+    }
+    /** Returned from `CloudContainer.queryDatabase` describing one database in the container */
+    interface CachedDbProps {
+        /** The total of (4Mb) blocks in the database. */
+        readonly totalBlocks: number;
+        /** the number of blocks of the database that have been downloaded into the CloudCache */
+        readonly localBlocks: number;
+        /** the number of blocks from this database that have been modified in the CloudCache and need to be uploaded. */
+        readonly dirtyBlocks: number;
+        /** If true, the database currently has transactions in the WAL file and may not be uploaded until they have been checkPointed. */
+        readonly transactions: boolean;
+        /** the state of this database. Indicates whether the database is new or deleted since last upload */
+        readonly state: "" | "copied" | "deleted";
+    }
+    /** Properties for accessing a CloudContainer */
+    type ContainerAccessProps = AccountAccessProps & ContainerProps & {
+        /** Duration for holding write lock, in seconds. After this time the write lock expires if not refreshed. Default is one hour. */
+        durationSeconds?: number;
+    };
+    /** The name of a CloudSqlite database within a CloudContainer. */
+    interface DbNameProp {
+        /** the name of the database within the CloudContainer.
+         * @note names of databases within a CloudContainer are always **case sensitive** on all platforms.*/
+        dbName: string;
+    }
+    /** Properties for accessing a database within a CloudContainer */
+    interface DbProps extends DbNameProp {
+        /** the name of the local file to access the database. */
+        localFileName: LocalFileName;
+    }
+    type TransferDirection = "upload" | "download";
+    interface TransferProgress {
+        /** a user-supplied progress function called during the transfer operation. Return a non-0 value to abort the transfer. */
+        onProgress?: (loaded: number, total: number) => number;
+    }
+    interface CloudHttpProps {
+        /** The number of simultaneous HTTP requests.  Default is 6. */
+        nRequests?: number;
+    }
+    interface PrefetchProps extends CloudHttpProps {
+        /** timeout between requests, in milliseconds. Default is 100. */
+        timeout?: number;
+        /** The number of prefetch requests to issue while there is foreground activity. Default is 3. */
+        minRequests?: number;
+    }
+    type TransferDbProps = DbProps & TransferProgress & CloudHttpProps;
+    /** Properties for creating a CloudCache. */
+    interface CacheProps extends CloudHttpProps {
+        /** full path of directory for cache to store its files. Must be on a (preferably fast) local drive, and must be empty when the cache is first created. */
+        rootDir: string;
+        /** name of this cache. It is possible to have more than one CloudCache in the same session. */
+        name: string;
+        /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */
+        cacheSize?: string;
+        /** turn on diagnostics for `curl` (outputs to stderr) */
+        curlDiagnostics?: boolean;
+    }
+    /** Properties for creating a new instance of a daemon process. */
+    interface DaemonProps {
+        /** full path name of daemon.exe file. Default is to find "iTwinDaemon.exe" in the same directory as this library. */
+        exePath?: string;
+        /** daemon connection address. Default is "127.0.0.1" */
+        addr?: string;
+        /** port number. Default 22002 */
+        portNumber?: number;
+        /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */
+        cacheSize?: string;
+        /** logging options */
+        log?: string;
+        /** if true, don't include timestamps in log messages */
+        noTimeStamps?: boolean;
+        /** The amount of time, in seconds before an http request made to cloud storage by the daemon times out. Default 600 seconds. */
+        httptimeout?: number;
+        /** options for spawn */
+        spawnOptions?: child_process.SpawnOptions;
+    }
+    type DaemonCommandArg = DbNameProp & AccountAccessProps & CacheProps & ContainerProps;
+    class Daemon {
+        static exeName(props: DaemonProps): string;
+        static daemonDir(props: CacheProps): string;
+        /** Start the Daemon process using the supplied properties. The process will be detached from the current process. */
+        static start(props: DaemonProps & CacheProps): child_process.ChildProcess;
+    }
+}
+//# sourceMappingURL=NativeCloudSqlite.d.ts.map

package/NativeCloudSqlite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeCloudSqlite.d.ts","sourceRoot":"","sources":["../src/NativeCloudSqlite.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,KAAK,aAAa,MAAM,eAAe,CAAC;AAM/C;;GAEG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKxD,yBAAiB,iBAAiB,CAAC;IAEjC,WAAkB,OAAO;QACvB,QAAQ,IAAS;QAAE,UAAU,IAAS;QAAE,WAAW,IAAS;QAAE,SAAS,IAAS;KACjF;IAED,0FAA0F;IAC1F,UAAiB,kBAAkB;QACjC,iGAAiG;QACjG,WAAW,EAAE,MAAM,CAAC;QACpB,4DAA4D;QAC5D,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,sCAAsC;IACtC,UAAiB,cAAc;QAC7B,iCAAiC;QACjC,WAAW,EAAE,MAAM,CAAC;QACpB,4DAA4D;QAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oIAAoI;QACpI,WAAW,EAAE,MAAM,CAAC;QACpB,+HAA+H;QAC/H,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,6GAA6G;QAC7G,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;IAED,4FAA4F;IAC5F,UAAiB,aAAa;QAC5B,iDAAiD;QACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,yFAAyF;QACzF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,iHAAiH;QACjH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,kIAAkI;QAClI,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;QAC/B,qGAAqG;QACrG,QAAQ,CAAC,KAAK,EAAE,EAAE,GAAG,QAAQ,GAAG,SAAS,CAAC;KAC3C;IAED,gDAAgD;IAChD,KAAY,oBAAoB,GAAG,kBAAkB,GAAG,cAAc,GAAG;QACvE,iIAAiI;QACjI,eAAe,CAAC,EAAE,MAAM,CAAA;KACzB,CAAC;IAEF,kEAAkE;IAClE,UAAiB,UAAU;QACzB;6GACqG;QACrG,MAAM,EAAE,MAAM,CAAA;KACf;IAED,kEAAkE;IAClE,UAAiB,OAAQ,SAAQ,UAAU;QACzC,yDAAyD;QACzD,aAAa,EAAE,aAAa,CAAA;KAC7B;IAED,KAAY,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtD,UAAiB,gBAAgB;QAC/B,0HAA0H;QAC1H,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;KACvD;IAED,UAAiB,cAAc;QAC7B,+DAA+D;QAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,aAAc,SAAQ,cAAc;QACnD,iEAAiE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,iGAAiG;QACjG,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,KAAY,eAAe,GAAG,OAAO,GAAG,gBAAgB,GAAG,cAAc,CAAC;IAE1E,4CAA4C;IAC5C,UAAiB,UAAW,SAAQ,cAAc;QAChD,0JAA0J;QAC1J,OAAO,EAAE,MAAM,CAAC;QAChB,+FAA+F;QAC/F,IAAI,EAAE,MAAM,CAAC;QACb,oHAAoH;QACpH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,yDAAyD;QACzD,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;IAED,kEAAkE;IAClE,UAAiB,WAAW;QAC1B,qHAAqH;QACrH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,wDAAwD;QACxD,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,iCAAiC;QACjC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,oHAAoH;QACpH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,sBAAsB;QACtB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,wDAAwD;QACxD,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,gIAAgI;QAChI,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,wBAAwB;QACxB,YAAY,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC;KAC3C;IACD,KAAY,gBAAgB,GAAG,UAAU,GAAG,kBAAkB,GAAG,UAAU,GAAG,cAAc,CAAC;IAE7F,MAAa,MAAM;eACH,OAAO,CAAC,KAAK,EAAE,WAAW;eAG1B,SAAS,CAAC,KAAK,EAAE,UAAU;QAIzC,qHAAqH;eACvG,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,aAAa,CAAC,YAAY;KAoBjF;CAEF"}

package/NativeCloudSqlite.js

@@ -0,0 +1,53 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeCloudSqlite = void 0;
+const child_process = require("child_process");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const NativeLibrary_1 = require("./NativeLibrary");
+// cspell:ignore polltime cachesize notimestamps deletetime gctime retrytime nwrite ndelete prefetch httptimeout
+/* eslint-disable no-restricted-syntax */
+var NativeCloudSqlite;
+(function (NativeCloudSqlite) {
+    ;
+    class Daemon {
+        static exeName(props) {
+            var _a;
+            return (_a = props.exePath) !== null && _a !== void 0 ? _a : path.join(__dirname, NativeLibrary_1.NativeLibrary.archName, os.platform() === "win32" ? "iTwinDaemon.exe" : "iTwinDaemon");
+        }
+        static daemonDir(props) {
+            var _a;
+            return (_a = props.rootDir) !== null && _a !== void 0 ? _a : path.join(NativeLibrary_1.NativeLibrary.defaultCacheDir, "itwin-daemon");
+        }
+        /** Start the Daemon process using the supplied properties. The process will be detached from the current process. */
+        static start(props) {
+            const dir = this.daemonDir(props);
+            fs.mkdirSync(dir, { recursive: true }); // make sure the directory exists before starting the daemon
+            const args = [`daemon`];
+            if (props.addr !== undefined)
+                args.push(`-addr`, `${props.addr}`);
+            if (props.portNumber !== undefined)
+                args.push(`-port`, `${props.portNumber}`);
+            if (props.cacheSize)
+                args.push(`-cachesize`, `${props.cacheSize}`);
+            if (props.log)
+                args.push(`-log`, `${props.log}`);
+            if (props.noTimeStamps)
+                args.push(`-notimestamps`);
+            if (props.httptimeout !== undefined)
+                args.push(`-httptimeout`, `${props.httptimeout}`);
+            args.push(`${dir}`); // This MUST be the last arg when starting the daemon.
+            return child_process.spawn(this.exeName(props), args, Object.assign(Object.assign({}, props.spawnOptions), { windowsVerbatimArguments: true }));
+        }
+    }
+    NativeCloudSqlite.Daemon = Daemon;
+})(NativeCloudSqlite = exports.NativeCloudSqlite || (exports.NativeCloudSqlite = {}));
+//# sourceMappingURL=NativeCloudSqlite.js.map

package/NativeCloudSqlite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeCloudSqlite.js","sourceRoot":"","sources":["../src/NativeCloudSqlite.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+CAA+C;AAC/C,yBAAyB;AACzB,yBAAyB;AACzB,6BAA6B;AAC7B,mDAAgD;AAOhD,gHAAgH;AAChH,yCAAyC;AAEzC,IAAiB,iBAAiB,CAiJjC;AAjJD,WAAiB,iBAAiB;IAI/B,CAAC;IA8GF,MAAa,MAAM;QACV,MAAM,CAAC,OAAO,CAAC,KAAkB;;YACtC,OAAO,MAAA,KAAK,CAAC,OAAO,mCAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,6BAAa,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;QACtI,CAAC;QACM,MAAM,CAAC,SAAS,CAAC,KAAiB;;YACvC,OAAO,MAAA,KAAK,CAAC,OAAO,mCAAI,IAAI,CAAC,IAAI,CAAC,6BAAa,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;QACnF,CAAC;QAED,qHAAqH;QAC9G,MAAM,CAAC,KAAK,CAAC,KAA+B;YACjD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAClC,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,4DAA4D;YAEpG,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;gBAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACtC,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS;gBAChC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;YAC5C,IAAI,KAAK,CAAC,SAAS;gBACjB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;YAChD,IAAI,KAAK,CAAC,GAAG;gBACX,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;YACpC,IAAI,KAAK,CAAC,YAAY;gBACpB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC7B,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS;gBACjC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;YACnD,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,sDAAsD;YAC3E,OAAO,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,kCAAO,KAAK,CAAC,YAAY,KAAE,wBAAwB,EAAE,IAAI,IAAG,CAAC;QACnH,CAAC;KACF;IA7BY,wBAAM,SA6BlB,CAAA;AAEH,CAAC,EAjJgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAiJjC","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 iModels\r\n */\r\n\r\nimport * as child_process from \"child_process\";\r\nimport * as fs from \"fs\";\r\nimport * as os from \"os\";\r\nimport * as path from \"path\";\r\nimport { NativeLibrary } from \"./NativeLibrary\";\r\n\r\n/**\r\n * @note This package may only have **dev** dependencies on @itwin packages, so they are *not* available at runtime. Therefore we can only import **types** from them.\r\n */\r\nimport type { LocalFileName } from \"@itwin/core-common\";\r\n\r\n// cspell:ignore polltime cachesize notimestamps deletetime gctime retrytime nwrite ndelete prefetch httptimeout\r\n/* eslint-disable no-restricted-syntax */\r\n\r\nexport namespace NativeCloudSqlite {\r\n\r\n  export const enum LogMask {\r\n    LOG_HTTP = 0x0001, LOG_UPLOAD = 0x0002, LOG_CLEANUP = 0x0004, LOG_EVENT = 0x0008\r\n  };\r\n\r\n  /** Properties that specify how to access the account for a cloud blob-store container. */\r\n  export interface AccountAccessProps {\r\n    /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\r\n    storageType: string;\r\n    /** blob store account name, or a URI for custom domains. */\r\n    accessName: string;\r\n  }\r\n\r\n  /** Properties of a CloudContainer. */\r\n  export interface ContainerProps {\r\n    /** the name of the container. */\r\n    containerId: string;\r\n    /** an alias for the container. Defaults to `containerId` */\r\n    alias?: string;\r\n    /** token that grants access to the container. For sas=1 `storageType`s, this is the sasToken. For sas=0, this is the account key */\r\n    accessToken: string;\r\n    /** if true, container is attached with write permissions, and accessToken must provide write access to the cloud container. */\r\n    writeable?: boolean;\r\n    /** if true, container is attached in \"secure\" mode (blocks are encrypted). Only supported in daemon mode. */\r\n    secure?: boolean;\r\n  }\r\n\r\n  /** Returned from `CloudContainer.queryDatabase` describing one database in the container */\r\n  export interface CachedDbProps {\r\n    /** The total of (4Mb) blocks in the database. */\r\n    readonly totalBlocks: number,\r\n    /** the number of blocks of the database that have been downloaded into the CloudCache */\r\n    readonly localBlocks: number,\r\n    /** the number of blocks from this database that have been modified in the CloudCache and need to be uploaded. */\r\n    readonly dirtyBlocks: number,\r\n    /** If true, the database currently has transactions in the WAL file and may not be uploaded until they have been checkPointed. */\r\n    readonly transactions: boolean;\r\n    /** the state of this database. Indicates whether the database is new or deleted since last upload */\r\n    readonly state: \"\" | \"copied\" | \"deleted\";\r\n  }\r\n\r\n  /** Properties for accessing a CloudContainer */\r\n  export type ContainerAccessProps = AccountAccessProps & ContainerProps & {\r\n    /** Duration for holding write lock, in seconds. After this time the write lock expires if not refreshed. Default is one hour. */\r\n    durationSeconds?: number\r\n  };\r\n\r\n  /** The name of a CloudSqlite database within a CloudContainer. */\r\n  export interface DbNameProp {\r\n    /** the name of the database within the CloudContainer.\r\n     * @note names of databases within a CloudContainer are always **case sensitive** on all platforms.*/\r\n    dbName: string\r\n  }\r\n\r\n  /** Properties for accessing a database within a CloudContainer */\r\n  export interface DbProps extends DbNameProp {\r\n    /** the name of the local file to access the database. */\r\n    localFileName: LocalFileName\r\n  }\r\n\r\n  export type TransferDirection = \"upload\" | \"download\";\r\n  export interface TransferProgress {\r\n    /** a user-supplied progress function called during the transfer operation. Return a non-0 value to abort the transfer. */\r\n    onProgress?: (loaded: number, total: number) => number\r\n  }\r\n\r\n  export interface CloudHttpProps {\r\n    /** The number of simultaneous HTTP requests.  Default is 6. */\r\n    nRequests?: number;\r\n  }\r\n\r\n  export interface PrefetchProps extends CloudHttpProps {\r\n    /** timeout between requests, in milliseconds. Default is 100. */\r\n    timeout?: number;\r\n    /** The number of prefetch requests to issue while there is foreground activity. Default is 3. */\r\n    minRequests?: number;\r\n  }\r\n\r\n  export type TransferDbProps = DbProps & TransferProgress & CloudHttpProps;\r\n\r\n  /** Properties for creating a CloudCache. */\r\n  export interface CacheProps extends CloudHttpProps {\r\n    /** full path of directory for cache to store its files. Must be on a (preferably fast) local drive, and must be empty when the cache is first created. */\r\n    rootDir: string;\r\n    /** name of this cache. It is possible to have more than one CloudCache in the same session. */\r\n    name: string;\r\n    /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */\r\n    cacheSize?: string;\r\n    /** turn on diagnostics for `curl` (outputs to stderr) */\r\n    curlDiagnostics?: boolean;\r\n  }\r\n\r\n  /** Properties for creating a new instance of a daemon process. */\r\n  export interface DaemonProps {\r\n    /** full path name of daemon.exe file. Default is to find \"iTwinDaemon.exe\" in the same directory as this library. */\r\n    exePath?: string;\r\n    /** daemon connection address. Default is \"127.0.0.1\" */\r\n    addr?: string;\r\n    /** port number. Default 22002 */\r\n    portNumber?: number;\r\n    /** maximum cache Size. Must be a number followed by either M (for megabytes) or G (for gigabytes.) Default is 1G */\r\n    cacheSize?: string;\r\n    /** logging options */\r\n    log?: string;\r\n    /** if true, don't include timestamps in log messages */\r\n    noTimeStamps?: boolean;\r\n    /** The amount of time, in seconds before an http request made to cloud storage by the daemon times out. Default 600 seconds. */\r\n    httptimeout?: number;\r\n    /** options for spawn */\r\n    spawnOptions?: child_process.SpawnOptions;\r\n  }\r\n  export type DaemonCommandArg = DbNameProp & AccountAccessProps & CacheProps & ContainerProps;\r\n\r\n  export class Daemon {\r\n    public static exeName(props: DaemonProps) {\r\n      return props.exePath ?? path.join(__dirname, NativeLibrary.archName, os.platform() === \"win32\" ? \"iTwinDaemon.exe\" : \"iTwinDaemon\");\r\n    }\r\n    public static daemonDir(props: CacheProps) {\r\n      return props.rootDir ?? path.join(NativeLibrary.defaultCacheDir, \"itwin-daemon\");\r\n    }\r\n\r\n    /** Start the Daemon process using the supplied properties. The process will be detached from the current process. */\r\n    public static start(props: DaemonProps & CacheProps): child_process.ChildProcess {\r\n      const dir = this.daemonDir(props);\r\n      fs.mkdirSync(dir, { recursive: true }); // make sure the directory exists before starting the daemon\r\n\r\n      const args = [`daemon`];\r\n      if (props.addr !== undefined)\r\n        args.push(`-addr`, `${props.addr}`);\r\n      if (props.portNumber !== undefined)\r\n        args.push(`-port`, `${props.portNumber}`);\r\n      if (props.cacheSize)\r\n        args.push(`-cachesize`, `${props.cacheSize}`);\r\n      if (props.log)\r\n        args.push(`-log`, `${props.log}`);\r\n      if (props.noTimeStamps)\r\n        args.push(`-notimestamps`);\r\n      if (props.httptimeout !== undefined)\r\n        args.push(`-httptimeout`, `${props.httptimeout}`)\r\n      args.push(`${dir}`); // This MUST be the last arg when starting the daemon.\r\n      return child_process.spawn(this.exeName(props), args, { ...props.spawnOptions, windowsVerbatimArguments: true });\r\n    }\r\n  }\r\n\r\n}\r\n"]}