@itwin/core-backend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/CloudSqlite.js

@@ -1,155 +1,155 @@
-"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 SQLiteDb
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloudSqlite = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const imodeljs_native_1 = require("@bentley/imodeljs-native");
-const core_bentley_1 = require("@itwin/core-bentley");
-/** Types for using SQLite files stored in cloud containers.
- * @beta
- */
-var CloudSqlite;
-(function (CloudSqlite) {
-    function createCloudContainer(args) {
-        return new imodeljs_native_1.NativeLibrary.nativeLib.CloudContainer(args);
-    }
-    CloudSqlite.createCloudContainer = createCloudContainer;
-    function createCloudCache(args) {
-        return new imodeljs_native_1.NativeLibrary.nativeLib.CloudCache(args);
-    }
-    CloudSqlite.createCloudCache = createCloudCache;
-    function startCloudPrefetch(container, dbName, args) {
-        return new imodeljs_native_1.NativeLibrary.nativeLib.CloudPrefetch(container, dbName, args);
-    }
-    CloudSqlite.startCloudPrefetch = startCloudPrefetch;
-    /** Logging categories for `CloudCache.setLogMask` */
-    let LoggingMask;
-    (function (LoggingMask) {
-        /** log all HTTP requests and responses */
-        LoggingMask[LoggingMask["HTTP"] = 1] = "HTTP";
-        /** log as blocks become dirty and must be uploaded */
-        LoggingMask[LoggingMask["DirtyBlocks"] = 2] = "DirtyBlocks";
-        /** log as blocks are added to the delete list */
-        LoggingMask[LoggingMask["AddToDelete"] = 4] = "AddToDelete";
-        /** log container lifecycle events (e.g. authorization requests, disconnects, and state transitions) */
-        LoggingMask[LoggingMask["LifecycleEvents"] = 8] = "LifecycleEvents";
-        /** Turn on all logging categories */
-        LoggingMask[LoggingMask["All"] = 255] = "All";
-        /** Disable logging */
-        LoggingMask[LoggingMask["None"] = 0] = "None";
-    })(LoggingMask = CloudSqlite.LoggingMask || (CloudSqlite.LoggingMask = {}));
-    /** @internal */
-    async function transferDb(direction, container, props) {
-        if (direction === "download")
-            (0, fs_1.mkdirSync)((0, path_1.dirname)(props.localFileName), { recursive: true }); // make sure the directory exists before starting download
-        let timer;
-        try {
-            const transfer = new imodeljs_native_1.NativeLibrary.nativeLib.CloudDbTransfer(direction, container, props);
-            let total = 0;
-            const onProgress = props.onProgress;
-            if (onProgress) {
-                timer = setInterval(async () => {
-                    const progress = transfer.getProgress();
-                    total = progress.total;
-                    if (onProgress(progress.loaded, progress.total))
-                        transfer.cancelTransfer();
-                }, 250);
-            }
-            await transfer.promise;
-            onProgress?.(total, total); // make sure we call progress func one last time when download completes
-        }
-        catch (err) {
-            if (err.message === "cancelled")
-                err.errorNumber = core_bentley_1.BriefcaseStatus.DownloadCancelled;
-            throw err;
-        }
-        finally {
-            if (timer)
-                clearInterval(timer);
-        }
-    }
-    CloudSqlite.transferDb = transferDb;
-    /** 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
-      */
-    async function uploadDb(container, props) {
-        await transferDb("upload", container, props);
-        container.checkForChanges(); // re-read the manifest so the database is available locally.
-    }
-    CloudSqlite.uploadDb = uploadDb;
-    /** 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.
-      */
-    async function downloadDb(container, props) {
-        await transferDb("download", container, props);
-    }
-    CloudSqlite.downloadDb = downloadDb;
-    /**
-      * 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.
-      * @throws if [[container]] is not connected to a CloudCache.
-      */
-    async function acquireWriteLock(user, container, busyHandler) {
-        if (container.hasWriteLock)
-            return;
-        while (true) {
-            try {
-                return container.acquireWriteLock(user);
-            }
-            catch (e) {
-                if (e.errorNumber === 5 && busyHandler && "stop" !== await busyHandler(e.lockedBy, e.expires)) // 5 === BE_SQLITE_BUSY
-                    continue; // busy handler wants to try again
-                throw e;
-            }
-        }
-    }
-    CloudSqlite.acquireWriteLock = acquireWriteLock;
-    /**
-      * 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.
-      * @returns a Promise with the result of `operation`
-      */
-    async function withWriteLock(user, container, operation, busyHandler) {
-        if (container.hasWriteLock)
-            return operation();
-        await acquireWriteLock(user, container, busyHandler);
-        try {
-            // eslint-disable-next-line @typescript-eslint/await-thenable
-            const val = await operation(); // wait for work to finish or fail
-            container.releaseWriteLock();
-            return val;
-        }
-        catch (e) {
-            container.abandonChanges(); // if operation threw, abandon all changes
-            throw e;
-        }
-    }
-    CloudSqlite.withWriteLock = withWriteLock;
-})(CloudSqlite = exports.CloudSqlite || (exports.CloudSqlite = {}));
+"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 SQLiteDb
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudSqlite = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const imodeljs_native_1 = require("@bentley/imodeljs-native");
+const core_bentley_1 = require("@itwin/core-bentley");
+/** Types for using SQLite files stored in cloud containers.
+ * @beta
+ */
+var CloudSqlite;
+(function (CloudSqlite) {
+    function createCloudContainer(args) {
+        return new imodeljs_native_1.NativeLibrary.nativeLib.CloudContainer(args);
+    }
+    CloudSqlite.createCloudContainer = createCloudContainer;
+    function createCloudCache(args) {
+        return new imodeljs_native_1.NativeLibrary.nativeLib.CloudCache(args);
+    }
+    CloudSqlite.createCloudCache = createCloudCache;
+    function startCloudPrefetch(container, dbName, args) {
+        return new imodeljs_native_1.NativeLibrary.nativeLib.CloudPrefetch(container, dbName, args);
+    }
+    CloudSqlite.startCloudPrefetch = startCloudPrefetch;
+    /** Logging categories for `CloudCache.setLogMask` */
+    let LoggingMask;
+    (function (LoggingMask) {
+        /** log all HTTP requests and responses */
+        LoggingMask[LoggingMask["HTTP"] = 1] = "HTTP";
+        /** log as blocks become dirty and must be uploaded */
+        LoggingMask[LoggingMask["DirtyBlocks"] = 2] = "DirtyBlocks";
+        /** log as blocks are added to the delete list */
+        LoggingMask[LoggingMask["AddToDelete"] = 4] = "AddToDelete";
+        /** log container lifecycle events (e.g. authorization requests, disconnects, and state transitions) */
+        LoggingMask[LoggingMask["LifecycleEvents"] = 8] = "LifecycleEvents";
+        /** Turn on all logging categories */
+        LoggingMask[LoggingMask["All"] = 255] = "All";
+        /** Disable logging */
+        LoggingMask[LoggingMask["None"] = 0] = "None";
+    })(LoggingMask = CloudSqlite.LoggingMask || (CloudSqlite.LoggingMask = {}));
+    /** @internal */
+    async function transferDb(direction, container, props) {
+        if (direction === "download")
+            (0, fs_1.mkdirSync)((0, path_1.dirname)(props.localFileName), { recursive: true }); // make sure the directory exists before starting download
+        let timer;
+        try {
+            const transfer = new imodeljs_native_1.NativeLibrary.nativeLib.CloudDbTransfer(direction, container, props);
+            let total = 0;
+            const onProgress = props.onProgress;
+            if (onProgress) {
+                timer = setInterval(async () => {
+                    const progress = transfer.getProgress();
+                    total = progress.total;
+                    if (onProgress(progress.loaded, progress.total))
+                        transfer.cancelTransfer();
+                }, 250);
+            }
+            await transfer.promise;
+            onProgress?.(total, total); // make sure we call progress func one last time when download completes
+        }
+        catch (err) {
+            if (err.message === "cancelled")
+                err.errorNumber = core_bentley_1.BriefcaseStatus.DownloadCancelled;
+            throw err;
+        }
+        finally {
+            if (timer)
+                clearInterval(timer);
+        }
+    }
+    CloudSqlite.transferDb = transferDb;
+    /** 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
+      */
+    async function uploadDb(container, props) {
+        await transferDb("upload", container, props);
+        container.checkForChanges(); // re-read the manifest so the database is available locally.
+    }
+    CloudSqlite.uploadDb = uploadDb;
+    /** 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.
+      */
+    async function downloadDb(container, props) {
+        await transferDb("download", container, props);
+    }
+    CloudSqlite.downloadDb = downloadDb;
+    /**
+      * 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.
+      * @throws if [[container]] is not connected to a CloudCache.
+      */
+    async function acquireWriteLock(user, container, busyHandler) {
+        if (container.hasWriteLock)
+            return;
+        while (true) {
+            try {
+                return container.acquireWriteLock(user);
+            }
+            catch (e) {
+                if (e.errorNumber === 5 && busyHandler && "stop" !== await busyHandler(e.lockedBy, e.expires)) // 5 === BE_SQLITE_BUSY
+                    continue; // busy handler wants to try again
+                throw e;
+            }
+        }
+    }
+    CloudSqlite.acquireWriteLock = acquireWriteLock;
+    /**
+      * 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.
+      * @returns a Promise with the result of `operation`
+      */
+    async function withWriteLock(user, container, operation, busyHandler) {
+        if (container.hasWriteLock)
+            return operation();
+        await acquireWriteLock(user, container, busyHandler);
+        try {
+            // eslint-disable-next-line @typescript-eslint/await-thenable
+            const val = await operation(); // wait for work to finish or fail
+            container.releaseWriteLock();
+            return val;
+        }
+        catch (e) {
+            container.abandonChanges(); // if operation threw, abandon all changes
+            throw e;
+        }
+    }
+    CloudSqlite.withWriteLock = withWriteLock;
+})(CloudSqlite = exports.CloudSqlite || (exports.CloudSqlite = {}));
 //# sourceMappingURL=CloudSqlite.js.map

package/lib/cjs/CloudStorageBackend.d.ts

@@ -1,59 +1,59 @@
-/// <reference types="node" />
-import { Readable } from "stream";
-import { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider, IModelRpcProps } from "@itwin/core-common";
-/** @beta */
-export interface AzureBlobStorageCredentials {
-    account: string;
-    accessKey: string;
-    baseUrl?: string;
-}
-/**
- * @beta
- * @deprecated in 3.x. Use [[TileStorage]] instead.
- */
-export interface CloudStorageUploadOptions {
-    type?: string;
-    cacheControl?: string;
-    contentEncoding?: "gzip";
-}
-/**
- * @beta
- * @deprecated in 3.x. Use [[TileStorage]] instead.
- */
-export declare abstract class CloudStorageService {
-    initialize(): void;
-    terminate(): void;
-    abstract id: CloudStorageProvider;
-    abstract obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl;
-    abstract upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string>;
-    download(_name: string): Promise<Readable | undefined>;
-    protected makeDescriptor(id: CloudStorageContainerDescriptor): {
-        name: string;
-        provider: CloudStorageProvider;
-    };
-}
-/**
- * @beta
- * @deprecated in 3.x. Use `@itwin/object-storage-oss` instead, see https://github.com/iTwin/object-storage for more details.
- */
-export declare class AzureBlobStorage extends CloudStorageService {
-    private _service;
-    private _credential;
-    private _baseUrl;
-    constructor(credentials: AzureBlobStorageCredentials);
-    readonly id = CloudStorageProvider.Azure;
-    obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl;
-    ensureContainer(name: string): Promise<void>;
-    upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string>;
-}
-/**
- * @beta
- * @deprecated in 3.x. Use [[TileStorage]] instead.
- */
-export declare class CloudStorageTileUploader {
-    private _activeUploads;
-    get activeUploads(): Iterable<Promise<void>>;
-    private uploadToCache;
-    cacheTile(tokenProps: IModelRpcProps, treeId: string, contentId: string, content: Uint8Array, guid: string | undefined, metadata?: object): Promise<void>;
-}
+/// <reference types="node" />
+import { Readable } from "stream";
+import { CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider, IModelRpcProps } from "@itwin/core-common";
+/** @beta */
+export interface AzureBlobStorageCredentials {
+    account: string;
+    accessKey: string;
+    baseUrl?: string;
+}
+/**
+ * @beta
+ * @deprecated in 3.x. Use [[TileStorage]] instead.
+ */
+export interface CloudStorageUploadOptions {
+    type?: string;
+    cacheControl?: string;
+    contentEncoding?: "gzip";
+}
+/**
+ * @beta
+ * @deprecated in 3.x. Use [[TileStorage]] instead.
+ */
+export declare abstract class CloudStorageService {
+    initialize(): void;
+    terminate(): void;
+    abstract id: CloudStorageProvider;
+    abstract obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl;
+    abstract upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string>;
+    download(_name: string): Promise<Readable | undefined>;
+    protected makeDescriptor(id: CloudStorageContainerDescriptor): {
+        name: string;
+        provider: CloudStorageProvider;
+    };
+}
+/**
+ * @beta
+ * @deprecated in 3.x. Use `@itwin/object-storage-oss` instead, see https://github.com/iTwin/object-storage for more details.
+ */
+export declare class AzureBlobStorage extends CloudStorageService {
+    private _service;
+    private _credential;
+    private _baseUrl;
+    constructor(credentials: AzureBlobStorageCredentials);
+    readonly id = CloudStorageProvider.Azure;
+    obtainContainerUrl(id: CloudStorageContainerDescriptor, expiry: Date, clientIp?: string): CloudStorageContainerUrl;
+    ensureContainer(name: string): Promise<void>;
+    upload(container: string, name: string, data: Uint8Array, options?: CloudStorageUploadOptions, metadata?: object): Promise<string>;
+}
+/**
+ * @beta
+ * @deprecated in 3.x. Use [[TileStorage]] instead.
+ */
+export declare class CloudStorageTileUploader {
+    private _activeUploads;
+    get activeUploads(): Iterable<Promise<void>>;
+    private uploadToCache;
+    cacheTile(tokenProps: IModelRpcProps, treeId: string, contentId: string, content: Uint8Array, guid: string | undefined, metadata?: object): Promise<void>;
+}
 //# sourceMappingURL=CloudStorageBackend.d.ts.map