@itwin/core-mobile 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/cjs/backend/MobileFileHandler.d.ts

@@ -1,113 +1,113 @@
-/** @packageDocumentation
- * @module iModelHub
- */
-/// <reference types="node" />
-import * as https from "https";
-import { AccessToken, BentleyError, GetMetaDataFunction } from "@itwin/core-bentley";
-import { ProgressCallback } from "./Request";
-/** Interface to cancel a request
-  * @beta
-  */
-export interface CancelRequest {
-    /** Returns true if cancel request was acknowledged */
-    cancel: () => boolean;
-}
-/** Error thrown when user cancelled operation
-  * @internal
-  */
-export declare class UserCancelledError extends BentleyError {
-    constructor(errorNumber: number, message: string, getMetaData?: GetMetaDataFunction);
-}
-/** Error thrown fail to download file. ErrorNumber will correspond to HTTP error code.
-  * @internal
-  */
-export declare class DownloadFailed extends BentleyError {
-    constructor(errorNumber: number, message: string, getMetaData?: GetMetaDataFunction);
-}
-/** Error thrown when sas-url provided for download has expired
-  * @internal
-  */
-export declare class SasUrlExpired extends BentleyError {
-    constructor(errorNumber: number, message: string, getMetaData?: GetMetaDataFunction);
-}
-/**
- * Provides methods to work with the file system and azure storage. An instance of this class has to be provided to [[IModelClient]] for file upload/download methods to work.
- * @internal
- */
-export declare class MobileFileHandler {
-    /** @internal */
-    agent?: https.Agent;
-    /**
-     * Constructor for MobileFileHandler.
-     */
-    constructor();
-    /** Create a directory, recursively setting up the path as necessary. */
-    private static makeDirectoryRecursive;
-    /**
-     * Make url safe for logging by removing sensitive information
-     * @param url input url that will be strip of search and query parameters and replace them by ... for security reason
-     */
-    private static getSafeUrlForLogging;
-    /**
-     * Check if sas url has expired
-     * @param download sas url for download
-     * @param futureSeconds should be valid in future for given seconds.
-     */
-    static isUrlExpired(downloadUrl: string, futureSeconds?: number): boolean;
-    /**
-     * Download a file from AzureBlobStorage for iModelHub. Creates the directory containing the file if necessary. If there is an error in the operation, incomplete file is deleted from disk.
-     * @param downloadUrl URL to download file from.
-     * @param downloadToPathname Pathname to download the file to.
-     * @param fileSize Size of the file that's being downloaded.
-     * @param progressCallback Callback for tracking progress.
-     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
-     */
-    downloadFile(_accessToken: AccessToken, downloadUrl: string, downloadToPathname: string, fileSize?: number, progressCallback?: ProgressCallback, cancelRequest?: CancelRequest): Promise<void>;
-    /** Get encoded block id from its number. */
-    private getBlockId;
-    private uploadChunk;
-    /**
-     * Upload a file to AzureBlobStorage for iModelHub.
-     * @param uploadUrl URL to upload the file to.
-     * @param uploadFromPathname Pathname to upload the file from.
-     * @param progressCallback Callback for tracking progress.
-     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
-     */
-    uploadFile(accessToken: AccessToken, uploadUrlString: string, uploadFromPathname: string, progressCallback?: ProgressCallback): Promise<void>;
-    /**
-     * Get size of a file.
-     * @param filePath Path of the file.
-     * @returns Size of the file.
-     */
-    getFileSize(filePath: string): number;
-    /**
-     * Check if path is a directory.
-     * @param filePath Path of the file.
-     * @returns True if path is directory.
-     */
-    isDirectory(filePath: string): boolean;
-    /**
-     * Check if path exists.
-     * @param filePath Path of the file.
-     * @returns True if path exists.
-     */
-    exists(filePath: string): boolean;
-    /**
-     * Deletes file.
-     * @param filePath Path of the file.
-     */
-    unlink(filePath: string): void;
-    /**
-     * Get file name from the path.
-     * @param filePath Path of the file.
-     * @returns File name.
-     */
-    basename(filePath: string): string;
-    /**
-     * Join multiple strings into a single path.
-     * @param paths Strings to join.
-     * @returns Joined path.
-     */
-    join(...paths: string[]): string;
-}
+/** @packageDocumentation
+ * @module iModelHub
+ */
+/// <reference types="node" />
+import * as https from "node:https";
+import { AccessToken, BentleyError, GetMetaDataFunction } from "@itwin/core-bentley";
+import { ProgressCallback } from "./Request";
+/** Interface to cancel a request
+  * @beta
+  */
+export interface CancelRequest {
+    /** Returns true if cancel request was acknowledged */
+    cancel: () => boolean;
+}
+/** Error thrown when user cancelled operation
+  * @internal
+  */
+export declare class UserCancelledError extends BentleyError {
+    constructor(errorNumber: number, message: string, getMetaData?: GetMetaDataFunction);
+}
+/** Error thrown fail to download file. ErrorNumber will correspond to HTTP error code.
+  * @internal
+  */
+export declare class DownloadFailed extends BentleyError {
+    constructor(errorNumber: number, message: string, getMetaData?: GetMetaDataFunction);
+}
+/** Error thrown when sas-url provided for download has expired
+  * @internal
+  */
+export declare class SasUrlExpired extends BentleyError {
+    constructor(errorNumber: number, message: string, getMetaData?: GetMetaDataFunction);
+}
+/**
+ * Provides methods to work with the file system and azure storage. An instance of this class has to be provided to [[IModelClient]] for file upload/download methods to work.
+ * @internal
+ */
+export declare class MobileFileHandler {
+    /** @internal */
+    agent?: https.Agent;
+    /**
+     * Constructor for MobileFileHandler.
+     */
+    constructor();
+    /** Create a directory, recursively setting up the path as necessary. */
+    private static makeDirectoryRecursive;
+    /**
+     * Make url safe for logging by removing sensitive information
+     * @param url input url that will be strip of search and query parameters and replace them by ... for security reason
+     */
+    private static getSafeUrlForLogging;
+    /**
+     * Check if sas url has expired
+     * @param download sas url for download
+     * @param futureSeconds should be valid in future for given seconds.
+     */
+    static isUrlExpired(downloadUrl: string, futureSeconds?: number): boolean;
+    /**
+     * Download a file from AzureBlobStorage for iModelHub. Creates the directory containing the file if necessary. If there is an error in the operation, incomplete file is deleted from disk.
+     * @param downloadUrl URL to download file from.
+     * @param downloadToPathname Pathname to download the file to.
+     * @param fileSize Size of the file that's being downloaded.
+     * @param progressCallback Callback for tracking progress.
+     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
+     */
+    downloadFile(_accessToken: AccessToken, downloadUrl: string, downloadToPathname: string, fileSize?: number, progressCallback?: ProgressCallback, cancelRequest?: CancelRequest): Promise<void>;
+    /** Get encoded block id from its number. */
+    private getBlockId;
+    private uploadChunk;
+    /**
+     * Upload a file to AzureBlobStorage for iModelHub.
+     * @param uploadUrl URL to upload the file to.
+     * @param uploadFromPathname Pathname to upload the file from.
+     * @param progressCallback Callback for tracking progress.
+     * @throws [[IModelHubClientError]] with [IModelHubStatus.UndefinedArgumentError]($bentley) if one of the arguments is undefined or empty.
+     */
+    uploadFile(accessToken: AccessToken, uploadUrlString: string, uploadFromPathname: string, progressCallback?: ProgressCallback): Promise<void>;
+    /**
+     * Get size of a file.
+     * @param filePath Path of the file.
+     * @returns Size of the file.
+     */
+    getFileSize(filePath: string): number;
+    /**
+     * Check if path is a directory.
+     * @param filePath Path of the file.
+     * @returns True if path is directory.
+     */
+    isDirectory(filePath: string): boolean;
+    /**
+     * Check if path exists.
+     * @param filePath Path of the file.
+     * @returns True if path exists.
+     */
+    exists(filePath: string): boolean;
+    /**
+     * Deletes file.
+     * @param filePath Path of the file.
+     */
+    unlink(filePath: string): void;
+    /**
+     * Get file name from the path.
+     * @param filePath Path of the file.
+     * @returns File name.
+     */
+    basename(filePath: string): string;
+    /**
+     * Join multiple strings into a single path.
+     * @param paths Strings to join.
+     * @returns Joined path.
+     */
+    join(...paths: string[]): string;
+}
 //# sourceMappingURL=MobileFileHandler.d.ts.map

package/lib/cjs/backend/MobileFileHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MobileFileHandler.d.ts","sourceRoot":"","sources":["../../../src/backend/MobileFileHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAGH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,mBAAmB,EAAU,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAyC,MAAM,WAAW,CAAC;AAWpF;;IAEI;AACJ,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB;AAED;;IAEI;AACJ,qBAAa,kBAAmB,SAAQ,YAAY;gBAC/B,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAI3F;AAED;;IAEI;AACJ,qBAAa,cAAe,SAAQ,YAAY;gBAC3B,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAI3F;AAED;;IAEI;AACJ,qBAAa,aAAc,SAAQ,YAAY;gBAC1B,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAI3F;AAED;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,gBAAgB;IACT,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;IAE3B;;OAEG;;IAIH,wEAAwE;IACxE,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAQrC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IASnC;;;;OAIG;WACW,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO;IAehF;;;;;;;OAOG;IACU,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC3M,4CAA4C;IAC5C,OAAO,CAAC,UAAU;YAIJ,WAAW;IA0BzB;;;;;;OAMG;IACU,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6C1J;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIxC;;;OAGG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIrC;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIzC;;;;OAIG;IACI,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;CAGxC"}
+{"version":3,"file":"MobileFileHandler.d.ts","sourceRoot":"","sources":["../../../src/backend/MobileFileHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAIH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,mBAAmB,EAAU,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAyC,MAAM,WAAW,CAAC;AAUpF;;IAEI;AACJ,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB;AAED;;IAEI;AACJ,qBAAa,kBAAmB,SAAQ,YAAY;gBAC/B,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAI3F;AAED;;IAEI;AACJ,qBAAa,cAAe,SAAQ,YAAY;gBAC3B,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAI3F;AAED;;IAEI;AACJ,qBAAa,aAAc,SAAQ,YAAY;gBAC1B,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAI3F;AAED;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,gBAAgB;IACT,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;IAE3B;;OAEG;;IAIH,wEAAwE;IACxE,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAQrC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IASnC;;;;OAIG;WACW,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO;IAehF;;;;;;;OAOG;IACU,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC3M,4CAA4C;IAC5C,OAAO,CAAC,UAAU;YAIJ,WAAW;IA0BzB;;;;;;OAMG;IACU,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6C1J;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIxC;;;OAGG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIrC;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIzC;;;;OAIG;IACI,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;CAGxC"}