@itwin/core-common 3.5.0-dev.8 → 3.5.1

package/lib/cjs/NativeAppProps.d.ts

@@ -1,123 +1,123 @@
-/** @packageDocumentation
- * @module NativeApp
- */
-import { AccessToken, GuidString } from "@itwin/core-bentley";
-import { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from "./BriefcaseTypes";
-/** @internal */
-export declare const nativeAppChannel = "nativeApp";
-/** @internal */
-export declare const nativeAppNotify = "nativeApp-notify";
-/**
- * Type of value for storage values
- * @beta
- */
-export declare type StorageValue = string | number | boolean | undefined | Uint8Array;
-/** Indicates whether or not the computer is currently connected to the internet.
- * @beta
- */
-export declare enum InternetConnectivityStatus {
-    Online = 0,
-    Offline = 1
-}
-/** Describes whether the user or the browser overrode the internet connectivity status.
- * @beta
- */
-export declare enum OverriddenBy {
-    Browser = 0,
-    User = 1
-}
-/**
- * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.
- * @internal
- */
-export interface NativeAppNotifications {
-    notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;
-}
-/**
- * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.
- * @internal
- */
-export interface NativeAppFunctions {
-    /** If the user is signed in a valid access token will be returned. */
-    getAccessToken: () => Promise<AccessToken | undefined>;
-    /** Check if the internet is reachable. */
-    checkInternetConnectivity(): Promise<InternetConnectivityStatus>;
-    /** Manually override internet reachability for testing purposes.
-     * @param _status New status to set on backend.
-     */
-    overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;
-    /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */
-    acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;
-    /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.
-     * @note this merely returns the full path fileName. It does not test for the existence of the file.
-      */
-    getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;
-    /** Download a briefcase file for the supplied briefcase properties. */
-    downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;
-    /**
-     * Cancels the previously requested download of a briefcase
-     * @param _key Key to locate the briefcase in the disk cache
-     * @note returns true if the cancel request was acknowledged. false otherwise
-     */
-    requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;
-    /**
-     * Delete a previously downloaded briefcase. The briefcase must be closed.
-     * @param _fileName the Briefcase to delete
-     */
-    deleteBriefcaseFiles(_fileName: string): Promise<void>;
-    /**
-     * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.
-     * @note returns array of LocalBriefcaseProps.
-     */
-    getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;
-    /**
-     * Open a key/value pair base storage
-     * @param _storageId string identifier of storage
-     */
-    storageMgrOpen(_storageId: string): Promise<string>;
-    /**
-     * Close a key/value pair base storage
-     * @param _storageId string identifier of storage
-     * @param _deleteOnClose delete the storage on close
-     */
-    storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;
-    /**
-     * Get the names of available storages
-     * @note returns list of storage names
-     */
-    storageMgrNames(): Promise<string[]>;
-    /**
-     * Get the value associated with a key.
-     * @param _storageId string identifier of storage
-     * @param _key key identifier for value
-     * @note returns key value or undefined
-     */
-    storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;
-    /**
-     * Set a value for a key.
-     * @param _storageId string identifier of storage
-     * @param _key key identifier for value
-     * @param _value value to be set
-     */
-    storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;
-    /**
-     * Remove a key/value pair.
-     * @param _storageId string identifier of storage
-     * @param _key key identifier for value
-     */
-    storageRemove(_storageId: string, _key: string): Promise<void>;
-    /**
-     * Get list of keys in a storage.
-     * @param _storageId string identifier of storage
-     * @note returns list of storage ids
-     */
-    storageKeys(_storageId: string): Promise<string[]>;
-    /**
-     * Delete all key/value pairs.
-     * @param _storageId string identifier of storage
-     */
-    storageRemoveAll(_storageId: string): Promise<void>;
-    /** get the type of a value for a key, or undefined if not present. */
-    storageGetValueType(_storageId: string, _key: string): Promise<"number" | "string" | "boolean" | "Uint8Array" | "null" | undefined>;
-}
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { AccessToken, GuidString } from "@itwin/core-bentley";
+import { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from "./BriefcaseTypes";
+/** @internal */
+export declare const nativeAppChannel = "nativeApp";
+/** @internal */
+export declare const nativeAppNotify = "nativeApp-notify";
+/**
+ * Type of value for storage values
+ * @beta
+ */
+export declare type StorageValue = string | number | boolean | undefined | Uint8Array;
+/** Indicates whether or not the computer is currently connected to the internet.
+ * @beta
+ */
+export declare enum InternetConnectivityStatus {
+    Online = 0,
+    Offline = 1
+}
+/** Describes whether the user or the browser overrode the internet connectivity status.
+ * @beta
+ */
+export declare enum OverriddenBy {
+    Browser = 0,
+    User = 1
+}
+/**
+ * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.
+ * @internal
+ */
+export interface NativeAppNotifications {
+    notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;
+}
+/**
+ * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.
+ * @internal
+ */
+export interface NativeAppFunctions {
+    /** If the user is signed in a valid access token will be returned. */
+    getAccessToken: () => Promise<AccessToken | undefined>;
+    /** Check if the internet is reachable. */
+    checkInternetConnectivity(): Promise<InternetConnectivityStatus>;
+    /** Manually override internet reachability for testing purposes.
+     * @param _status New status to set on backend.
+     */
+    overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;
+    /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */
+    acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;
+    /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.
+     * @note this merely returns the full path fileName. It does not test for the existence of the file.
+      */
+    getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;
+    /** Download a briefcase file for the supplied briefcase properties. */
+    downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;
+    /**
+     * Cancels the previously requested download of a briefcase
+     * @param _key Key to locate the briefcase in the disk cache
+     * @note returns true if the cancel request was acknowledged. false otherwise
+     */
+    requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;
+    /**
+     * Delete a previously downloaded briefcase. The briefcase must be closed.
+     * @param _fileName the Briefcase to delete
+     */
+    deleteBriefcaseFiles(_fileName: string): Promise<void>;
+    /**
+     * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.
+     * @note returns array of LocalBriefcaseProps.
+     */
+    getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;
+    /**
+     * Open a key/value pair base storage
+     * @param _storageId string identifier of storage
+     */
+    storageMgrOpen(_storageId: string): Promise<string>;
+    /**
+     * Close a key/value pair base storage
+     * @param _storageId string identifier of storage
+     * @param _deleteOnClose delete the storage on close
+     */
+    storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;
+    /**
+     * Get the names of available storages
+     * @note returns list of storage names
+     */
+    storageMgrNames(): Promise<string[]>;
+    /**
+     * Get the value associated with a key.
+     * @param _storageId string identifier of storage
+     * @param _key key identifier for value
+     * @note returns key value or undefined
+     */
+    storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;
+    /**
+     * Set a value for a key.
+     * @param _storageId string identifier of storage
+     * @param _key key identifier for value
+     * @param _value value to be set
+     */
+    storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;
+    /**
+     * Remove a key/value pair.
+     * @param _storageId string identifier of storage
+     * @param _key key identifier for value
+     */
+    storageRemove(_storageId: string, _key: string): Promise<void>;
+    /**
+     * Get list of keys in a storage.
+     * @param _storageId string identifier of storage
+     * @note returns list of storage ids
+     */
+    storageKeys(_storageId: string): Promise<string[]>;
+    /**
+     * Delete all key/value pairs.
+     * @param _storageId string identifier of storage
+     */
+    storageRemoveAll(_storageId: string): Promise<void>;
+    /** get the type of a value for a key, or undefined if not present. */
+    storageGetValueType(_storageId: string, _key: string): Promise<"number" | "string" | "boolean" | "Uint8Array" | "null" | undefined>;
+}
 //# sourceMappingURL=NativeAppProps.d.ts.map

package/lib/cjs/NativeAppProps.js

@@ -1,31 +1,31 @@
-"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 NativeApp
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OverriddenBy = exports.InternetConnectivityStatus = exports.nativeAppNotify = exports.nativeAppChannel = void 0;
-/** @internal */
-exports.nativeAppChannel = "nativeApp";
-/** @internal */
-exports.nativeAppNotify = "nativeApp-notify";
-/** Indicates whether or not the computer is currently connected to the internet.
- * @beta
- */
-var InternetConnectivityStatus;
-(function (InternetConnectivityStatus) {
-    InternetConnectivityStatus[InternetConnectivityStatus["Online"] = 0] = "Online";
-    InternetConnectivityStatus[InternetConnectivityStatus["Offline"] = 1] = "Offline";
-})(InternetConnectivityStatus = exports.InternetConnectivityStatus || (exports.InternetConnectivityStatus = {}));
-/** Describes whether the user or the browser overrode the internet connectivity status.
- * @beta
- */
-var OverriddenBy;
-(function (OverriddenBy) {
-    OverriddenBy[OverriddenBy["Browser"] = 0] = "Browser";
-    OverriddenBy[OverriddenBy["User"] = 1] = "User";
-})(OverriddenBy = exports.OverriddenBy || (exports.OverriddenBy = {}));
+"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 NativeApp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OverriddenBy = exports.InternetConnectivityStatus = exports.nativeAppNotify = exports.nativeAppChannel = void 0;
+/** @internal */
+exports.nativeAppChannel = "nativeApp";
+/** @internal */
+exports.nativeAppNotify = "nativeApp-notify";
+/** Indicates whether or not the computer is currently connected to the internet.
+ * @beta
+ */
+var InternetConnectivityStatus;
+(function (InternetConnectivityStatus) {
+    InternetConnectivityStatus[InternetConnectivityStatus["Online"] = 0] = "Online";
+    InternetConnectivityStatus[InternetConnectivityStatus["Offline"] = 1] = "Offline";
+})(InternetConnectivityStatus = exports.InternetConnectivityStatus || (exports.InternetConnectivityStatus = {}));
+/** Describes whether the user or the browser overrode the internet connectivity status.
+ * @beta
+ */
+var OverriddenBy;
+(function (OverriddenBy) {
+    OverriddenBy[OverriddenBy["Browser"] = 0] = "Browser";
+    OverriddenBy[OverriddenBy["User"] = 1] = "User";
+})(OverriddenBy = exports.OverriddenBy || (exports.OverriddenBy = {}));
 //# sourceMappingURL=NativeAppProps.js.map

package/lib/cjs/NativeAppProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeAppProps.js","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,gBAAgB;AACH,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAC5C,gBAAgB;AACH,QAAA,eAAe,GAAG,kBAAkB,CAAC;AAQlD;;GAEG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;AACT,CAAC,EAHW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAGrC;AAED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,+CAAI,CAAA;AACN,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB","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 NativeApp\r\n */\r\n\r\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\r\nimport { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from \"./BriefcaseTypes\";\r\n\r\n/** @internal */\r\nexport const nativeAppChannel = \"nativeApp\";\r\n/** @internal */\r\nexport const nativeAppNotify = \"nativeApp-notify\";\r\n\r\n/**\r\n * Type of value for storage values\r\n * @beta\r\n */\r\nexport type StorageValue = string | number | boolean | undefined | Uint8Array;\r\n\r\n/** Indicates whether or not the computer is currently connected to the internet.\r\n * @beta\r\n */\r\nexport enum InternetConnectivityStatus {\r\n  Online,\r\n  Offline,\r\n}\r\n\r\n/** Describes whether the user or the browser overrode the internet connectivity status.\r\n * @beta\r\n */\r\nexport enum OverriddenBy {\r\n  Browser,\r\n  User,\r\n}\r\n\r\n/**\r\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.\r\n * @internal\r\n */\r\nexport interface NativeAppNotifications {\r\n  notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;\r\n}\r\n\r\n/**\r\n * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.\r\n * @internal\r\n */\r\nexport interface NativeAppFunctions {\r\n\r\n  /** If the user is signed in a valid access token will be returned. */\r\n  getAccessToken: () => Promise<AccessToken | undefined>;\r\n\r\n  /** Check if the internet is reachable. */\r\n  checkInternetConnectivity(): Promise<InternetConnectivityStatus>;\r\n\r\n  /** Manually override internet reachability for testing purposes.\r\n   * @param _status New status to set on backend.\r\n   */\r\n  overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;\r\n\r\n  /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */\r\n  acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;\r\n\r\n  /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.\r\n   * @note this merely returns the full path fileName. It does not test for the existence of the file.\r\n    */\r\n  getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;\r\n\r\n  /** Download a briefcase file for the supplied briefcase properties. */\r\n  downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;\r\n\r\n  /**\r\n   * Cancels the previously requested download of a briefcase\r\n   * @param _key Key to locate the briefcase in the disk cache\r\n   * @note returns true if the cancel request was acknowledged. false otherwise\r\n   */\r\n  requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;\r\n\r\n  /**\r\n   * Delete a previously downloaded briefcase. The briefcase must be closed.\r\n   * @param _fileName the Briefcase to delete\r\n   */\r\n  deleteBriefcaseFiles(_fileName: string): Promise<void>;\r\n\r\n  /**\r\n   * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.\r\n   * @note returns array of LocalBriefcaseProps.\r\n   */\r\n  getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;\r\n\r\n  /**\r\n   * Open a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageMgrOpen(_storageId: string): Promise<string>;\r\n\r\n  /**\r\n   * Close a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   * @param _deleteOnClose delete the storage on close\r\n   */\r\n  storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;\r\n\r\n  /**\r\n   * Get the names of available storages\r\n   * @note returns list of storage names\r\n   */\r\n  storageMgrNames(): Promise<string[]>;\r\n\r\n  /**\r\n   * Get the value associated with a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @note returns key value or undefined\r\n   */\r\n  storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;\r\n\r\n  /**\r\n   * Set a value for a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @param _value value to be set\r\n   */\r\n  storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;\r\n\r\n  /**\r\n   * Remove a key/value pair.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   */\r\n  storageRemove(_storageId: string, _key: string): Promise<void>;\r\n\r\n  /**\r\n   * Get list of keys in a storage.\r\n   * @param _storageId string identifier of storage\r\n   * @note returns list of storage ids\r\n   */\r\n  storageKeys(_storageId: string): Promise<string[]>;\r\n\r\n  /**\r\n   * Delete all key/value pairs.\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageRemoveAll(_storageId: string): Promise<void>;\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  storageGetValueType(_storageId: string, _key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined>;\r\n}\r\n"]}
+{"version":3,"file":"NativeAppProps.js","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,gBAAgB;AACH,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAC5C,gBAAgB;AACH,QAAA,eAAe,GAAG,kBAAkB,CAAC;AAQlD;;GAEG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;AACT,CAAC,EAHW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAGrC;AAED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,+CAAI,CAAA;AACN,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\nimport { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from \"./BriefcaseTypes\";\n\n/** @internal */\nexport const nativeAppChannel = \"nativeApp\";\n/** @internal */\nexport const nativeAppNotify = \"nativeApp-notify\";\n\n/**\n * Type of value for storage values\n * @beta\n */\nexport type StorageValue = string | number | boolean | undefined | Uint8Array;\n\n/** Indicates whether or not the computer is currently connected to the internet.\n * @beta\n */\nexport enum InternetConnectivityStatus {\n  Online,\n  Offline,\n}\n\n/** Describes whether the user or the browser overrode the internet connectivity status.\n * @beta\n */\nexport enum OverriddenBy {\n  Browser,\n  User,\n}\n\n/**\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.\n * @internal\n */\nexport interface NativeAppNotifications {\n  notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;\n}\n\n/**\n * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.\n * @internal\n */\nexport interface NativeAppFunctions {\n\n  /** If the user is signed in a valid access token will be returned. */\n  getAccessToken: () => Promise<AccessToken | undefined>;\n\n  /** Check if the internet is reachable. */\n  checkInternetConnectivity(): Promise<InternetConnectivityStatus>;\n\n  /** Manually override internet reachability for testing purposes.\n   * @param _status New status to set on backend.\n   */\n  overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;\n\n  /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */\n  acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;\n\n  /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.\n   * @note this merely returns the full path fileName. It does not test for the existence of the file.\n    */\n  getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;\n\n  /** Download a briefcase file for the supplied briefcase properties. */\n  downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;\n\n  /**\n   * Cancels the previously requested download of a briefcase\n   * @param _key Key to locate the briefcase in the disk cache\n   * @note returns true if the cancel request was acknowledged. false otherwise\n   */\n  requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;\n\n  /**\n   * Delete a previously downloaded briefcase. The briefcase must be closed.\n   * @param _fileName the Briefcase to delete\n   */\n  deleteBriefcaseFiles(_fileName: string): Promise<void>;\n\n  /**\n   * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.\n   * @note returns array of LocalBriefcaseProps.\n   */\n  getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;\n\n  /**\n   * Open a key/value pair base storage\n   * @param _storageId string identifier of storage\n   */\n  storageMgrOpen(_storageId: string): Promise<string>;\n\n  /**\n   * Close a key/value pair base storage\n   * @param _storageId string identifier of storage\n   * @param _deleteOnClose delete the storage on close\n   */\n  storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;\n\n  /**\n   * Get the names of available storages\n   * @note returns list of storage names\n   */\n  storageMgrNames(): Promise<string[]>;\n\n  /**\n   * Get the value associated with a key.\n   * @param _storageId string identifier of storage\n   * @param _key key identifier for value\n   * @note returns key value or undefined\n   */\n  storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;\n\n  /**\n   * Set a value for a key.\n   * @param _storageId string identifier of storage\n   * @param _key key identifier for value\n   * @param _value value to be set\n   */\n  storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;\n\n  /**\n   * Remove a key/value pair.\n   * @param _storageId string identifier of storage\n   * @param _key key identifier for value\n   */\n  storageRemove(_storageId: string, _key: string): Promise<void>;\n\n  /**\n   * Get list of keys in a storage.\n   * @param _storageId string identifier of storage\n   * @note returns list of storage ids\n   */\n  storageKeys(_storageId: string): Promise<string[]>;\n\n  /**\n   * Delete all key/value pairs.\n   * @param _storageId string identifier of storage\n   */\n  storageRemoveAll(_storageId: string): Promise<void>;\n\n  /** get the type of a value for a key, or undefined if not present. */\n  storageGetValueType(_storageId: string, _key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined>;\n}\n"]}

package/lib/cjs/OctEncodedNormal.d.ts

@@ -1,34 +1,34 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { Vector3d, XYAndZ } from "@itwin/core-geometry";
-/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).
- * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.
- * @public
- */
-export declare class OctEncodedNormal {
-    /** The encoded normal. */
-    readonly value: number;
-    /** Construct directly from a 16-bit encoded value.
-     * @see [[encode]] to compute the encoded value.
-     * @see [[fromVector]] to construct from a vector.
-     */
-    constructor(val: number);
-    /** Compute the encoded 16-bit value of the supplied normalized vector. */
-    static encode(vec: XYAndZ): number;
-    /** Compute the encoded 16-bit value of the supplied normalized vector components. */
-    static encodeXYZ(nx: number, ny: number, nz: number): number;
-    /** Create an OctEncodedNormal from a normalized vector. */
-    static fromVector(val: XYAndZ): OctEncodedNormal;
-    /** Decode this oct-encoded normal into a normalized vector. */
-    decode(): Vector3d;
-    /** Decode a 16-bit encoded value into a normalized vector. */
-    static decodeValue(val: number, result?: Vector3d): Vector3d;
-}
-/** @internal */
-export declare class OctEncodedNormalPair {
-    first: OctEncodedNormal;
-    second: OctEncodedNormal;
-    constructor(first: OctEncodedNormal, second: OctEncodedNormal);
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { Vector3d, XYAndZ } from "@itwin/core-geometry";
+/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).
+ * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.
+ * @public
+ */
+export declare class OctEncodedNormal {
+    /** The encoded normal. */
+    readonly value: number;
+    /** Construct directly from a 16-bit encoded value.
+     * @see [[encode]] to compute the encoded value.
+     * @see [[fromVector]] to construct from a vector.
+     */
+    constructor(val: number);
+    /** Compute the encoded 16-bit value of the supplied normalized vector. */
+    static encode(vec: XYAndZ): number;
+    /** Compute the encoded 16-bit value of the supplied normalized vector components. */
+    static encodeXYZ(nx: number, ny: number, nz: number): number;
+    /** Create an OctEncodedNormal from a normalized vector. */
+    static fromVector(val: XYAndZ): OctEncodedNormal;
+    /** Decode this oct-encoded normal into a normalized vector. */
+    decode(): Vector3d;
+    /** Decode a 16-bit encoded value into a normalized vector. */
+    static decodeValue(val: number, result?: Vector3d): Vector3d;
+}
+/** @internal */
+export declare class OctEncodedNormalPair {
+    first: OctEncodedNormal;
+    second: OctEncodedNormal;
+    constructor(first: OctEncodedNormal, second: OctEncodedNormal);
+}
 //# sourceMappingURL=OctEncodedNormal.d.ts.map

package/lib/cjs/OctEncodedNormal.js

@@ -1,99 +1,99 @@
-"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 Rendering
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OctEncodedNormalPair = exports.OctEncodedNormal = void 0;
-const core_geometry_1 = require("@itwin/core-geometry");
-const scratchUInt16 = new Uint16Array(1);
-function clamp(val, minVal, maxVal) {
-    return val < minVal ? minVal : (val > maxVal ? maxVal : val);
-}
-function clampUint8(val) {
-    return roundUint16(0.5 + (clamp(val, -1, 1) * 0.5 + 0.5) * 255);
-}
-function roundUint16(val) {
-    scratchUInt16[0] = val;
-    return scratchUInt16[0];
-}
-function signNotZero(val) {
-    return val < 0.0 ? -1.0 : 1.0;
-}
-/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).
- * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.
- * @public
- */
-class OctEncodedNormal {
-    /** Construct directly from a 16-bit encoded value.
-     * @see [[encode]] to compute the encoded value.
-     * @see [[fromVector]] to construct from a vector.
-     */
-    constructor(val) {
-        this.value = roundUint16(val);
-    }
-    /** Compute the encoded 16-bit value of the supplied normalized vector. */
-    static encode(vec) {
-        return this.encodeXYZ(vec.x, vec.y, vec.z);
-    }
-    /** Compute the encoded 16-bit value of the supplied normalized vector components. */
-    static encodeXYZ(nx, ny, nz) {
-        const denom = Math.abs(nx) + Math.abs(ny) + Math.abs(nz);
-        let rx = nx / denom;
-        let ry = ny / denom;
-        if (nz < 0) {
-            const x = rx;
-            const y = ry;
-            rx = (1 - Math.abs(y)) * signNotZero(x);
-            ry = (1 - Math.abs(x)) * signNotZero(y);
-        }
-        return clampUint8(ry) << 8 | clampUint8(rx);
-    }
-    /** Create an OctEncodedNormal from a normalized vector. */
-    static fromVector(val) {
-        return new OctEncodedNormal(this.encode(val));
-    }
-    /** Decode this oct-encoded normal into a normalized vector. */
-    decode() {
-        return OctEncodedNormal.decodeValue(this.value);
-    }
-    /** Decode a 16-bit encoded value into a normalized vector. */
-    static decodeValue(val, result) {
-        let ex = val & 0xff;
-        let ey = val >> 8;
-        ex = ex / 255.0 * 2.0 - 1.0;
-        ey = ey / 255.0 * 2.0 - 1.0;
-        const ez = 1 - (Math.abs(ex) + Math.abs(ey));
-        let n;
-        if (result === undefined) {
-            n = new core_geometry_1.Vector3d(ex, ey, ez);
-        }
-        else {
-            n = result;
-            n.x = ex;
-            n.y = ey;
-            n.z = ez;
-        }
-        if (n.z < 0) {
-            const x = n.x;
-            const y = n.y;
-            n.x = (1 - Math.abs(y)) * signNotZero(x);
-            n.y = (1 - Math.abs(x)) * signNotZero(y);
-        }
-        n.normalizeInPlace();
-        return n;
-    }
-}
-exports.OctEncodedNormal = OctEncodedNormal;
-/** @internal */
-class OctEncodedNormalPair {
-    constructor(first, second) {
-        this.first = first;
-        this.second = second;
-    }
-}
-exports.OctEncodedNormalPair = OctEncodedNormalPair;
+"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 Rendering
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OctEncodedNormalPair = exports.OctEncodedNormal = void 0;
+const core_geometry_1 = require("@itwin/core-geometry");
+const scratchUInt16 = new Uint16Array(1);
+function clamp(val, minVal, maxVal) {
+    return val < minVal ? minVal : (val > maxVal ? maxVal : val);
+}
+function clampUint8(val) {
+    return roundUint16(0.5 + (clamp(val, -1, 1) * 0.5 + 0.5) * 255);
+}
+function roundUint16(val) {
+    scratchUInt16[0] = val;
+    return scratchUInt16[0];
+}
+function signNotZero(val) {
+    return val < 0.0 ? -1.0 : 1.0;
+}
+/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).
+ * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.
+ * @public
+ */
+class OctEncodedNormal {
+    /** Construct directly from a 16-bit encoded value.
+     * @see [[encode]] to compute the encoded value.
+     * @see [[fromVector]] to construct from a vector.
+     */
+    constructor(val) {
+        this.value = roundUint16(val);
+    }
+    /** Compute the encoded 16-bit value of the supplied normalized vector. */
+    static encode(vec) {
+        return this.encodeXYZ(vec.x, vec.y, vec.z);
+    }
+    /** Compute the encoded 16-bit value of the supplied normalized vector components. */
+    static encodeXYZ(nx, ny, nz) {
+        const denom = Math.abs(nx) + Math.abs(ny) + Math.abs(nz);
+        let rx = nx / denom;
+        let ry = ny / denom;
+        if (nz < 0) {
+            const x = rx;
+            const y = ry;
+            rx = (1 - Math.abs(y)) * signNotZero(x);
+            ry = (1 - Math.abs(x)) * signNotZero(y);
+        }
+        return clampUint8(ry) << 8 | clampUint8(rx);
+    }
+    /** Create an OctEncodedNormal from a normalized vector. */
+    static fromVector(val) {
+        return new OctEncodedNormal(this.encode(val));
+    }
+    /** Decode this oct-encoded normal into a normalized vector. */
+    decode() {
+        return OctEncodedNormal.decodeValue(this.value);
+    }
+    /** Decode a 16-bit encoded value into a normalized vector. */
+    static decodeValue(val, result) {
+        let ex = val & 0xff;
+        let ey = val >> 8;
+        ex = ex / 255.0 * 2.0 - 1.0;
+        ey = ey / 255.0 * 2.0 - 1.0;
+        const ez = 1 - (Math.abs(ex) + Math.abs(ey));
+        let n;
+        if (result === undefined) {
+            n = new core_geometry_1.Vector3d(ex, ey, ez);
+        }
+        else {
+            n = result;
+            n.x = ex;
+            n.y = ey;
+            n.z = ez;
+        }
+        if (n.z < 0) {
+            const x = n.x;
+            const y = n.y;
+            n.x = (1 - Math.abs(y)) * signNotZero(x);
+            n.y = (1 - Math.abs(x)) * signNotZero(y);
+        }
+        n.normalizeInPlace();
+        return n;
+    }
+}
+exports.OctEncodedNormal = OctEncodedNormal;
+/** @internal */
+class OctEncodedNormalPair {
+    constructor(first, second) {
+        this.first = first;
+        this.second = second;
+    }
+}
+exports.OctEncodedNormalPair = OctEncodedNormalPair;
 //# sourceMappingURL=OctEncodedNormal.js.map