npm - @itwin/core-backend - Versions diffs - 3.0.0-dev.103 → 3.0.0-dev.107 - Mend

@itwin/core-backend 3.0.0-dev.103 → 3.0.0-dev.107

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

package/lib/cjs/IModelHost.d.ts +16 -6
package/lib/cjs/IModelHost.d.ts.map +1 -1
package/lib/cjs/IModelHost.js +16 -5
package/lib/cjs/IModelHost.js.map +1 -1
package/lib/cjs/assets/Settings.schema.json +25 -0
package/lib/cjs/core-backend.d.ts +7 -0
package/lib/cjs/core-backend.d.ts.map +1 -1
package/lib/cjs/core-backend.js +7 -0
package/lib/cjs/core-backend.js.map +1 -1
package/lib/cjs/workspace/Settings.d.ts +180 -0
package/lib/cjs/workspace/Settings.d.ts.map +1 -0
package/lib/cjs/workspace/Settings.js +148 -0
package/lib/cjs/workspace/Settings.js.map +1 -0
package/lib/cjs/workspace/SettingsSpecRegistry.d.ts +68 -0
package/lib/cjs/workspace/SettingsSpecRegistry.d.ts.map +1 -0
package/lib/cjs/workspace/SettingsSpecRegistry.js +122 -0
package/lib/cjs/workspace/SettingsSpecRegistry.js.map +1 -0
package/lib/cjs/workspace/Workspace.d.ts +255 -0
package/lib/cjs/workspace/Workspace.d.ts.map +1 -0
package/lib/cjs/workspace/Workspace.js +291 -0
package/lib/cjs/workspace/Workspace.js.map +1 -0
package/package.json +15 -14

package/lib/cjs/IModelHost.d.ts CHANGED Viewed

@@ -4,9 +4,10 @@
 import { IModelJsNative } from "@bentley/imodeljs-native";
 import { TelemetryManager } from "@bentley/telemetry-client";
 import { AccessToken, BeEvent, GuidString, Mutable } from "@itwin/core-bentley";
-import { AuthorizationClient, SessionProps } from "@itwin/core-common";
+import { AuthorizationClient, LocalDirName, SessionProps } from "@itwin/core-common";
 import { BackendHubAccess } from "./BackendHubAccess";
 import { CloudStorageService, CloudStorageServiceCredentials, CloudStorageTileUploader } from "./CloudStorageBackend";
+import { Workspace, WorkspaceOpts } from "./workspace/Workspace";
 /** @alpha */
 export interface CrashReportingConfigNameValuePair {
     name: string;
@@ -56,9 +57,13 @@ export declare class IModelHostConfiguration {
      *   - etc.
      * @see [[IModelHost.cacheDir]] for the value it's set to after startup
      */
-    cacheDir?: string;
+    cacheDir?: LocalDirName;
+    /** Options for creating the [[Workspace]]
+     * @beta
+     */
+    workspace?: WorkspaceOpts;
     /** The directory where the app's assets are found. */
-    appAssetsDir?: string;
+    appAssetsDir?: LocalDirName;
     /** The kind of iModel hub server to use.
      * @beta
      */
@@ -119,6 +124,7 @@ export declare class IModelHost {
     static readonly telemetry: TelemetryManager;
     static backendVersion: string;
     private static _cacheDir;
+    private static _workspace;
     private static _platform?;
     /** @internal */
     static get platform(): typeof IModelJsNative;
@@ -138,8 +144,12 @@ export declare class IModelHost {
     /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
     static get applicationVersion(): string;
     static set applicationVersion(version: string);
-    /** Root of the directory holding all the files that iModel.js caches */
-    static get cacheDir(): string;
+    /** Root directory holding files that iTwin.js caches */
+    static get cacheDir(): LocalDirName;
+    /** The Workspace for this `IModelHost`
+     * @beta
+     */
+    static get workspace(): Workspace;
     /** The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. */
     static snapshotFileNameResolver?: FileNameResolver;
     /** Get the current access token for this IModelHost, or a blank string if none is available.
@@ -183,7 +193,7 @@ export declare class IModelHost {
     static startup(configuration?: IModelHostConfiguration): Promise<void>;
     private static _briefcaseCacheDir;
     private static logStartup;
-    private static setupCacheDirs;
+    private static setupHostDirs;
     /** This method must be called when an iModel.js services is shut down. Raises [[onBeforeShutdown]] */
     static shutdown(): Promise<void>;
     /**

package/lib/cjs/IModelHost.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"IModelHost.d.ts","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAU,OAAO,EAAQ,UAAU,EAAkC,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC/I,OAAO,EAAE,mBAAmB,EAA8B,YAAY,EAAE,MAAM,oBAAoB,CAAC;~~AAEnG~~,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAItD,OAAO,EAAoB,mBAAmB,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;~~AAexI~~,aAAa;AACb,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wOAAwO;IACxO,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0KAA0K;IAC1K,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,MAAM,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAC7C;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,uBAAuB;IAElC;;;;;;;;;;;;;OAaG;IACI,QAAQ,CAAC,EAAE,~~MAAM~~,CAAC;~~IAEzB~~,sDAAsD;IAC/C,YAAY,CAAC,EAAE,~~MAAM~~,CAAC;~~IAE7B~~;;OAEG;IACI,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACI,oBAAoB,CAAC,EAAE,8BAA8B,CAAC;IAE7D;;OAEG;IACI,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACI,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACI,sBAAsB,SAAqD;IAClF;;OAEG;IACI,yBAAyB,SAAqD;IACrF;;OAEG;IACH,OAAc,yBAAyB,SAAa;IAEpD;;OAEG;IACH,OAAc,+BAA+B,SAAM;IACnD;;OAEG;IACI,wBAAwB,EAAE,MAAM,CAA2D;IAElG;;OAEG;IACH,OAAc,2BAA2B,SAAgB;IACzD;;OAEG;IACI,oBAAoB,EAAE,MAAM,CAAuD;IAE1F;;OAEG;IACI,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAEpD;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO;IACP,OAAc,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAExD,aAAa;IACb,gBAAuB,SAAS,mBAA0B;IAE1D,OAAc,cAAc,SAAM;IAClC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAM;~~IAE9B~~,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAwB;IACjD,gBAAgB;IAChB,WAAkB,QAAQ,IAAI,OAAO,cAAc,CAIlD;IAED,OAAc,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACtD,iEAAiE;IACjE,gBAAuB,cAAc,gBAAqB,IAAI,EAAI;IAElE,yEAAyE;IACzE,gBAAuB,gBAAgB,gBAAqB,IAAI,EAAI;IAEpE,gBAAgB;IAChB,gBAAuB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAyE;IAE9H,kCAAkC;IAClC,WAAkB,SAAS,IACK,UAAU,CADsB;IAChE,WAAkB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAkC;IAE5E,mJAAmJ;IACnJ,WAAkB,aAAa,IACK,MAAM,CAD8B;IACxE,WAAkB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAsC;IAEhF,qJAAqJ;IACrJ,WAAkB,kBAAkB,IACU,MAAM,CAD8B;IAClF,WAAkB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAgD;IAEpG,~~wEAAwE~~;~~IACxE~~,WAAkB,QAAQ,IAAI,~~MAAM~~,CAA2B;~~IAE/D~~,wGAAwG;IACxG,OAAc,wBAAwB,CAAC,EAAE,gBAAgB,CAAC;IAE1D;;;;;;OAMG;WACiB,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAQ1D,gBAAgB;WACF,QAAQ;IAGtB,gBAAgB;WACF,UAAU,IAAI,IAAI;IAKhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAW/B,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAa5C;;;;;OAKG;IACH,OAAc,gBAAgB,EAAE,mBAAmB,CAAC;IAEpD,gBAAgB;IAChB,OAAc,YAAY,EAAE,wBAAwB,CAAC;IAErD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAmB;IAC5C,gBAAgB;WACF,YAAY,CAAC,SAAS,EAAE,gBAAgB;IAEtD;;OAEG;IACH,WAAkB,SAAS,IAAI,gBAAgB,CAA4B;IAE3E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,8CAA8C;IAC9C,WAAkB,OAAO,YAA4B;IACrD;;;;OAIG;WACiB,OAAO,CAAC,aAAa,GAAE,uBAAuD,GAAG,OAAO,CAAC,IAAI,CAAC;~~IA0ElH~~,OAAO,CAAC,MAAM,CAAC,kBAAkB,~~CAAS~~;~~IAE1C~~,OAAO,CAAC,MAAM,CAAC,UAAU;IAuBzB,OAAO,CAAC,MAAM,CAAC,~~cAAc~~;~~IAM7B~~,sGAAsG;WAClF,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAW7C;;;;;OAKG;WACW,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAKvE;;;;OAIG;WACW,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3D;;;OAGG;WACW,wBAAwB,IAAI,iCAAiC,EAAE;IAK7E,0DAA0D;IAC1D,WAAkB,YAAY,IAAI,MAAM,GAAG,SAAS,CAAuG;IAE3J;;OAEG;IACH,WAAkB,sBAAsB,IAAI,MAAM,CAEjD;IACD;;OAEG;IACH,WAAkB,yBAAyB,IAAI,MAAM,CAEpD;IAED,2FAA2F;IAC3F,WAAkB,wBAAwB,IAAI,MAAM,CAAiK;IACrN,4FAA4F;IAC5F,WAAkB,oBAAoB,IAAI,MAAM,CAAyJ;IAEzM;;OAEG;IACH,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;OAEG;IACH,WAAkB,0BAA0B,IAAI,OAAO,CAA2H;IAElL;;OAEG;IACH,WAAkB,mBAAmB,IAAI,OAAO,CAAoE;IAEpH,OAAO,CAAC,MAAM,CAAC,cAAc;CAgB9B;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,oCAAoC;IACpC,WAAkB,YAAY,IAAI,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAEzF;IAED,gBAAgB;WACF,IAAI,IAAI,OAAO,cAAc;CAG5C;AAED;;GAEG;AACH,qBAAa,cAAc;IAEzB,iEAAiE;IACjE,WAAkB,eAAe,IAAI,MAAM,CAAqD;IAEhG,8DAA8D;IAC9D,WAAkB,gBAAgB,IAAI,MAAM,CAE3C;IAED,+BAA+B;IAC/B,WAAkB,MAAM,IAAI,MAAM,CAEjC;CACF;AAED;;;;GAIG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAO1C;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACjE;;;;OAIG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAOnD"}
1	+ {"version":3,"file":"IModelHost.d.ts","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAU,OAAO,EAAQ,UAAU,EAAkC,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC/I,OAAO,EAAE,mBAAmB,EAA8B,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEjH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAItD,OAAO,EAAoB,mBAAmB,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAUxI,OAAO,EAAkB,SAAS,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAMjF,aAAa;AACb,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wOAAwO;IACxO,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0KAA0K;IAC1K,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,MAAM,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAC7C;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,uBAAuB;IAElC;;;;;;;;;;;;;OAaG;IACI,QAAQ,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACI,SAAS,CAAC,EAAE,aAAa,CAAC;IAEjC,sDAAsD;IAC/C,YAAY,CAAC,EAAE,YAAY,CAAC;IAEnC;;OAEG;IACI,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACI,oBAAoB,CAAC,EAAE,8BAA8B,CAAC;IAE7D;;OAEG;IACI,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACI,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACI,sBAAsB,SAAqD;IAClF;;OAEG;IACI,yBAAyB,SAAqD;IACrF;;OAEG;IACH,OAAc,yBAAyB,SAAa;IAEpD;;OAEG;IACH,OAAc,+BAA+B,SAAM;IACnD;;OAEG;IACI,wBAAwB,EAAE,MAAM,CAA2D;IAElG;;OAEG;IACH,OAAc,2BAA2B,SAAgB;IACzD;;OAEG;IACI,oBAAoB,EAAE,MAAM,CAAuD;IAE1F;;OAEG;IACI,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAEpD;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO;IACP,OAAc,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAExD,aAAa;IACb,gBAAuB,SAAS,mBAA0B;IAE1D,OAAc,cAAc,SAAM;IAClC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAM;IAC9B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAY;IAErC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAwB;IACjD,gBAAgB;IAChB,WAAkB,QAAQ,IAAI,OAAO,cAAc,CAIlD;IAED,OAAc,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACtD,iEAAiE;IACjE,gBAAuB,cAAc,gBAAqB,IAAI,EAAI;IAElE,yEAAyE;IACzE,gBAAuB,gBAAgB,gBAAqB,IAAI,EAAI;IAEpE,gBAAgB;IAChB,gBAAuB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAyE;IAE9H,kCAAkC;IAClC,WAAkB,SAAS,IACK,UAAU,CADsB;IAChE,WAAkB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAkC;IAE5E,mJAAmJ;IACnJ,WAAkB,aAAa,IACK,MAAM,CAD8B;IACxE,WAAkB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAsC;IAEhF,qJAAqJ;IACrJ,WAAkB,kBAAkB,IACU,MAAM,CAD8B;IAClF,WAAkB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAgD;IAEpG,wDAAwD;IACxD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;IACH,WAAkB,SAAS,IAAI,SAAS,CAA4B;IAEpE,wGAAwG;IACxG,OAAc,wBAAwB,CAAC,EAAE,gBAAgB,CAAC;IAE1D;;;;;;OAMG;WACiB,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAQ1D,gBAAgB;WACF,QAAQ;IAGtB,gBAAgB;WACF,UAAU,IAAI,IAAI;IAKhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAW/B,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAa5C;;;;;OAKG;IACH,OAAc,gBAAgB,EAAE,mBAAmB,CAAC;IAEpD,gBAAgB;IAChB,OAAc,YAAY,EAAE,wBAAwB,CAAC;IAErD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAmB;IAC5C,gBAAgB;WACF,YAAY,CAAC,SAAS,EAAE,gBAAgB;IAEtD;;OAEG;IACH,WAAkB,SAAS,IAAI,gBAAgB,CAA4B;IAE3E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,8CAA8C;IAC9C,WAAkB,OAAO,YAA4B;IACrD;;;;OAIG;WACiB,OAAO,CAAC,aAAa,GAAE,uBAAuD,GAAG,OAAO,CAAC,IAAI,CAAC;IA4ElH,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAe;IAEhD,OAAO,CAAC,MAAM,CAAC,UAAU;IAuBzB,OAAO,CAAC,MAAM,CAAC,aAAa;IAU5B,sGAAsG;WAClF,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAW7C;;;;;OAKG;WACW,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAKvE;;;;OAIG;WACW,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3D;;;OAGG;WACW,wBAAwB,IAAI,iCAAiC,EAAE;IAK7E,0DAA0D;IAC1D,WAAkB,YAAY,IAAI,MAAM,GAAG,SAAS,CAAuG;IAE3J;;OAEG;IACH,WAAkB,sBAAsB,IAAI,MAAM,CAEjD;IACD;;OAEG;IACH,WAAkB,yBAAyB,IAAI,MAAM,CAEpD;IAED,2FAA2F;IAC3F,WAAkB,wBAAwB,IAAI,MAAM,CAAiK;IACrN,4FAA4F;IAC5F,WAAkB,oBAAoB,IAAI,MAAM,CAAyJ;IAEzM;;OAEG;IACH,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;OAEG;IACH,WAAkB,0BAA0B,IAAI,OAAO,CAA2H;IAElL;;OAEG;IACH,WAAkB,mBAAmB,IAAI,OAAO,CAAoE;IAEpH,OAAO,CAAC,MAAM,CAAC,cAAc;CAgB9B;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,oCAAoC;IACpC,WAAkB,YAAY,IAAI,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAEzF;IAED,gBAAgB;WACF,IAAI,IAAI,OAAO,cAAc;CAG5C;AAED;;GAEG;AACH,qBAAa,cAAc;IAEzB,iEAAiE;IACjE,WAAkB,eAAe,IAAI,MAAM,CAAqD;IAEhG,8DAA8D;IAC9D,WAAkB,gBAAgB,IAAI,MAAM,CAE3C;IAED,+BAA+B;IAC/B,WAAkB,MAAM,IAAI,MAAM,CAEjC;CACF;AAED;;;;GAIG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAO1C;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACjE;;;;OAIG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAOnD"}

package/lib/cjs/IModelHost.js CHANGED Viewed

@@ -29,6 +29,7 @@ const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
 const SnapshotIModelRpcImpl_1 = require("./rpc-impl/SnapshotIModelRpcImpl");
 const WipRpcImpl_1 = require("./rpc-impl/WipRpcImpl");
 const RpcBackend_1 = require("./RpcBackend");
+const Workspace_1 = require("./workspace/Workspace");
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
 /** Configuration of core-backend.
  * @public
@@ -87,8 +88,12 @@ class IModelHost {
     /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
     static get applicationVersion() { return this.session.applicationVersion; }
     static set applicationVersion(version) { this.session.applicationVersion = version; }
-    /** Root of the directory holding all the files that iModel.js caches */
+    /** Root directory holding files that iTwin.js caches */
     static get cacheDir() { return this._cacheDir; }
+    /** The Workspace for this `IModelHost`
+     * @beta
+     */
+    static get workspace() { return this._workspace; }
     /** Get the current access token for this IModelHost, or a blank string if none is available.
      * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
      * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
@@ -190,7 +195,8 @@ class IModelHost {
                 }
             }
         }
-        this.setupCacheDirs(configuration);
+        this.setupHostDirs(configuration);
+        this._workspace = new Workspace_1.ITwinWorkspace(configuration.workspace);
         BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
         [
             IModelReadRpcImpl_1.IModelReadRpcImpl,
@@ -232,9 +238,14 @@ class IModelHost {
         }
         core_bentley_1.Logger.logTrace(loggerCategory, "IModelHost.startup", () => startupInfo);
     }
-    static setupCacheDirs(configuration) {
-        this._cacheDir = configuration.cacheDir ? path.normalize(configuration.cacheDir) : imodeljs_native_1.NativeLibrary.defaultCacheDir;
-        IModelJsFs_1.IModelJsFs.recursiveMkDirSync(this._cacheDir); // make sure the directory for cacheDir exists.
+    static setupHostDirs(configuration) {
+        var _a;
+        const setupDir = (dir) => {
+            dir = path.normalize(dir);
+            IModelJsFs_1.IModelJsFs.recursiveMkDirSync(dir);
+            return dir;
+        };
+        this._cacheDir = setupDir((_a = configuration.cacheDir) !== null && _a !== void 0 ? _a : imodeljs_native_1.NativeLibrary.defaultCacheDir);
         this._briefcaseCacheDir = path.join(this._cacheDir, "imodels");
     }
     /** This method must be called when an iModel.js services is shut down. Raises [[onBeforeShutdown]] */

package/lib/cjs/IModelHost.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"IModelHost.js","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,iCAAiC;AACjC,8DAAyE;AACzE,gEAA6D;AAC7D,sDAA+I;AAC/I,oDAAmG;AACnG,qEAAkE;AAElE,mEAAgE;AAChE,mDAAgD;AAChD,yDAAsD;AACtD,+DAAwI;AACxI,iEAA8D;AAC9D,2DAAwD;AACxD,6CAA0C;AAC1C,gEAA6D;AAC7D,oEAAiE;AACjE,oEAAiE;AACjE,4EAAyE;AACzE,sDAAmD;AACnD,6CAAoD;AAEpD,MAAM,cAAc,GAAG,6CAAqB,CAAC,UAAU,CAAC;AAqCxD;;GAEG;AACH,MAAa,uBAAuB;IAApC;QAyCE;;WAEG;QACI,2BAAsB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAClF;;WAEG;QACI,8BAAyB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAUrF;;WAEG;QACI,6BAAwB,GAAW,uBAAuB,CAAC,+BAA+B,CAAC;QAMlG;;WAEG;QACI,yBAAoB,GAAW,uBAAuB,CAAC,2BAA2B,CAAC;IAO5F,CAAC;;AA7ED,0DA6EC;AA5BC;;GAEG;AACW,iDAAyB,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpD;;GAEG;AACW,uDAA+B,GAAG,EAAE,CAAC;AAMnD;;GAEG;AACW,mDAA2B,GAAG,EAAE,GAAG,OAAO,CAAC;AAa3D;;;GAGG;AACH,MAAa,UAAU;IACrB,gBAAwB,CAAC;IAUzB,gBAAgB;IACT,MAAM,KAAK,QAAQ;QACxB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAYD,kCAAkC;IAC3B,MAAM,KAAK,SAAS,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,MAAM,KAAK,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;IAE5E,mJAAmJ;IAC5I,MAAM,KAAK,aAAa,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,aAAa,CAAC,EAAU,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC,CAAC,CAAC;IAEhF,qJAAqJ;IAC9I,MAAM,KAAK,kBAAkB,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,MAAM,KAAK,kBAAkB,CAAC,OAAe,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAEpG,wEAAwE;IACjE,MAAM,KAAK,QAAQ,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAK/D;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc;;QAChC,IAAI;YACF,OAAO,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,mBAAmB,0CAAE,cAAc,EAAE,CAAA,CAAC,mCAAI,EAAE,CAAC;SACjE;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IACxC,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,UAAU;QACtB,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,QAA+B;QAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,SAAS,KAAK,QAAQ;YACxB,OAAO;QAET,IAAI,CAAC,8BAAe,CAAC,kBAAkB;YACrC,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAEvC,QAAQ,CAAC,MAAM,GAAG,qBAAM,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,6BAA6B;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAAC,CAAC,yDAAyD;QACzJ,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1C,IAAI,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC;YAChD,OAAO;QACT,IAAI,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE;YAC/D,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC,CAAC,iCAAiC;YAChG,OAAO;SACR;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,+BAA+B,WAAW,qCAAqC,eAAe,GAAG,CAAC,CAAC;IACpJ,CAAC;IAcD,gBAAgB;IACT,MAAM,CAAC,YAAY,CAAC,SAA2B,IAAI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;IAExF;;OAEG;IACI,MAAM,KAAK,SAAS,KAAuB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAG3E,8CAA8C;IACvC,MAAM,KAAK,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAyC,IAAI,uBAAuB,EAAE;QAChG,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO,CAAC,4BAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE;YAC7B,UAAU,CAAC,SAAS,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,yDAAyD;QACtH,IAAA,iCAAoB,GAAE,CAAC;QAEvB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;YAChC,IAAI;gBACF,IAAI,CAAC,UAAU,EAAE,CAAC;aACnB;YAAC,OAAO,KAAK,EAAE;gBACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,mDAAmD,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC5G,MAAM,KAAK,CAAC;aACb;SACF;QAED,IAAI,aAAa,CAAC,oBAAoB,IAAI,aAAa,CAAC,oBAAoB,CAAC,QAAQ,IAAI,CAAC,8BAAe,CAAC,oBAAoB,IAAI,CAAC,8BAAe,CAAC,kBAAkB,EAAE;YACrK,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YAEpE,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4BAA4B,EAAE,GAAG,EAAE;;gBAAC,OAAA,CAAC;oBACnE,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,mBAAmB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,mBAAmB;oBAC5E,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,eAAe,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,eAAe;iBACrE,CAAC,CAAA;aAAA,CAAC,CAAC;YAEJ,IAAI,aAAa,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;gBACvD,IAAI;oBACF,sFAAsF;oBACtF,MAAM,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,yDAAyD;oBACxG,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;oBACrD,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;oBACrE,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iDAAiD,CAAC,CAAC;iBACpF;gBAAC,OAAO,GAAG,EAAE;oBACZ,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,+BAA+B,CAAC,CAAC;iBACpE;aACF;SACF;QAED,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACnC,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAErD;YACE,qCAAiB;YACjB,qCAAiB;YACjB,6CAAqB;YACrB,uBAAU;YACV,iCAAe;SAChB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,0CAA0C;QAE9E;YACE,6BAAa;YACb,6BAAa;YACb,mCAAgB;SACjB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,8BAA8B;QAE9E,IAAI,SAAS,KAAK,aAAa,CAAC,SAAS;YACvC,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC;QAClD,UAAU,CAAC,aAAa,GAAG,aAAa,CAAC;QACzC,UAAU,CAAC,cAAc,EAAE,CAAC;QAE5B,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEjF,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChD,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC;IAIO,MAAM,CAAC,UAAU;QACvB,IAAI,CAAC,qBAAM,CAAC,SAAS,CAAC,cAAc,EAAE,uBAAQ,CAAC,KAAK,CAAC;YACnD,OAAO;QAET,uIAAuI;QACvI,IAAI,WAAW,GAAQ,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACpD,IAAI,WAAW,EAAE;YACf,sKAAsK;YACtK,MAAM,qBAAqB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrD,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtC,WAAW,GAAG;oBACZ,GAAG,WAAW;oBACd,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;oBACjC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC;oBAClC,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAC;iBACtC,CAAC;aACH;SACF;QAED,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,oBAAoB,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,aAAsC;QAClE,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,+BAAa,CAAC,eAAe,CAAC;QACjH,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,+CAA+C;QAC9F,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,sGAAsG;IAC/F,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,oEAAoE;QACpE,IAAI,CAAC,UAAU,CAAC,QAAQ;YACtB,OAAO;QAET,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC;QAC5B,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;QACzC,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrC,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa;QAC9D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,yBAAyB,CAAC,IAAY;QAClD,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB;QACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,EAAE,CAAC;IACnD,CAAC;IAED,0DAA0D;IACnD,MAAM,KAAK,YAAY,KAAyB,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE3J;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACtJ,CAAC;IACD;;OAEG;IACI,MAAM,KAAK,yBAAyB;QACzC,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACzJ,CAAC;IAED,2FAA2F;IACpF,MAAM,KAAK,wBAAwB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC,uBAAuB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACrN,4FAA4F;IACrF,MAAM,KAAK,oBAAoB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAEzM;;OAEG;IACI,MAAM,KAAK,sBAAsB;;QACtC,OAAO,SAAS,MAAK,MAAA,UAAU,CAAC,aAAa,0CAAE,oBAAoB,CAAA,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,0BAA0B,KAAc,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAElL;;OAEG;IACI,MAAM,KAAK,mBAAmB,aAAc,OAAO,KAAK,MAAK,MAAA,UAAU,CAAC,aAAa,0CAAE,mBAAmB,CAAA,CAAC,CAAC,CAAC;IAE5G,MAAM,CAAC,cAAc;QAC3B,MAAM,MAAM,GAAG,UAAU,CAAC,aAAc,CAAC;QACzC,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,CAAC;QAChD,IAAI,SAAS,KAAK,WAAW;YAC3B,OAAO;QAET,UAAU,CAAC,YAAY,GAAG,IAAI,8CAAwB,EAAE,CAAC;QAEzD,IAAI,WAAW,CAAC,OAAO,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE;YACnE,UAAU,CAAC,gBAAgB,GAAG,IAAI,sCAAgB,CAAC,WAAW,CAAC,CAAC;SACjE;aAAM,IAAI,WAAW,CAAC,OAAO,KAAK,UAAU,EAAE;YAC7C,UAAU,CAAC,gBAAgB,GAAG,IAAI,+CAAsB,CAAC,WAAW,CAAC,CAAC;SACvE;aAAM,IAAI,WAAW,CAAC,OAAO,KAAK,UAAU,EAAE;YAC7C,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,uDAAuD,CAAC,CAAC;SACrG;IACH,CAAC;;AAnUH,gCAoUC;AAhUC,aAAa;AACU,oBAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC;AAE5C,yBAAc,GAAG,EAAE,CAAC;AACnB,oBAAS,GAAG,EAAE,CAAC;AAW9B,iEAAiE;AAC1C,yBAAc,GAAG,IAAI,sBAAO,EAAc,CAAC;AAElE,yEAAyE;AAClD,2BAAgB,GAAG,IAAI,sBAAO,EAAc,CAAC;AAEpE,gBAAgB;AACO,kBAAO,GAA0B,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;AAyF/G,mBAAQ,GAAG,KAAK,CAAC;AAmNlC;;GAEG;AACH,MAAa,QAAQ;IACnB,oCAAoC;IAC7B,MAAM,KAAK,YAAY;QAC5B,OAAO,OAAO,CAAC,QAAe,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,IAAI;QAChB,OAAO,8BAAe,CAAC,kBAAkB,CAAC,CAAC,CAAE,OAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,+BAAa,CAAC,IAAI,EAAE,CAAC;IACvH,CAAC;CACF;AAVD,4BAUC;AAED;;GAEG;AACH,MAAa,cAAc;IAEzB,iEAAiE;IAC1D,MAAM,KAAK,eAAe,KAAa,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAEhG,8DAA8D;IACvD,MAAM,KAAK,gBAAgB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,+BAA+B;IACxB,MAAM,KAAK,MAAM;QACtB,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;CACF;AAdD,wCAcC;AAED;;;;GAIG;AACH,MAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAgB,IAAwB,OAAO,SAAS,CAAC,CAAC,CAAC;IAChF;;;;OAIG;IACI,UAAU,CAAC,OAAe;QAC/B,MAAM,gBAAgB,GAAuB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,OAAO,eAAe,CAAC,CAAC;SACzE;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD;;;OAGG;IACI,kBAAkB,CAAC,UAAkB,IAAwB,OAAO,UAAU,CAAC,CAAC,CAAC;IACxF;;;;OAIG;IACI,eAAe,CAAC,UAAkB;QACvC,MAAM,gBAAgB,GAAuB,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACjF,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,UAAU,eAAe,CAAC,CAAC;SAC5E;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF;AAnCD,4CAmCC","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 IModelHost\r\n /\r\n\r\nimport as os from \"os\";\r\nimport * as path from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { TelemetryManager } from \"@bentley/telemetry-client\";\r\nimport { AccessToken, assert, BeEvent, Guid, GuidString, IModelStatus, Logger, LogLevel, Mutable, ProcessDetector } from \"@itwin/core-bentley\";\r\nimport { AuthorizationClient, BentleyStatus, IModelError, SessionProps } from \"@itwin/core-common\";\r\nimport { AliCloudStorageService } from \"./AliCloudStorageService\";\r\nimport { BackendHubAccess } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BisCoreSchema } from \"./BisCoreSchema\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { AzureBlobStorage, CloudStorageService, CloudStorageServiceCredentials, CloudStorageTileUploader } from \"./CloudStorageBackend\";\r\nimport { FunctionalSchema } from \"./domains/FunctionalSchema\";\r\nimport { GenericSchema } from \"./domains/GenericSchema\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { DevToolsRpcImpl } from \"./rpc-impl/DevToolsRpcImpl\";\r\nimport { IModelReadRpcImpl } from \"./rpc-impl/IModelReadRpcImpl\";\r\nimport { IModelTileRpcImpl } from \"./rpc-impl/IModelTileRpcImpl\";\r\nimport { SnapshotIModelRpcImpl } from \"./rpc-impl/SnapshotIModelRpcImpl\";\r\nimport { WipRpcImpl } from \"./rpc-impl/WipRpcImpl\";\r\nimport { initializeRpcBackend } from \"./RpcBackend\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.IModelHost;\r\n\r\n// cspell:ignore nodereport fatalerror apicall alicloud rpcs\r\n\r\n/** @alpha /\r\nexport interface CrashReportingConfigNameValuePair {\r\n name: string;\r\n value: string;\r\n}\r\n\r\n/* Configuration of the crash-reporting system.\r\n * @alpha\r\n /\r\nexport interface CrashReportingConfig {\r\n /* The directory to which .dmp and/or iModelJsNativeCrash.properties.txt files are written. This directory will be created if it does not already exist. /\r\n crashDir: string;\r\n /* max # .dmp files that may exist in crashDir. The default is 50. /\r\n maxDumpsInDir?: number;\r\n /* Enable crash-dumps? If so, .dmp and .properties.txt files will be generated and written to crashDir in the event of an unhandled native-code exception. If not, only .properties.txt files will be written. The default is false. /\r\n enableCrashDumps?: boolean;\r\n /* If enableCrashDumps is true, do you want a full-memory dump? Defaults to false. /\r\n wantFullMemoryDumps?: boolean;\r\n /* Enable node-report? If so, node-report files will be generated in the event of an unhandled exception or fatal error and written to crashDir. The default is false. /\r\n enableNodeReport?: boolean;\r\n /* Additional name, value pairs to write to iModelJsNativeCrash.properties.txt file in the event of a crash. /\r\n params?: CrashReportingConfigNameValuePair[];\r\n /** Run this .js file to process .dmp and node-report files in the event of a crash.\r\n * This script will be executed with a single command-line parameter: the name of the dump or node-report file.\r\n * In the case of a dump file, there will be a second file with the same basename and the extension \".properties.txt\".\r\n * Since it runs in a separate process, this script will have no access to the Javascript\r\n * context of the exiting backend. No default.\r\n /\r\n dumpProcessorScriptFileName?: string;\r\n /* Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false /\r\n uploadToBentley?: boolean;\r\n}\r\n\r\n/* Configuration of core-backend.\r\n * @public\r\n /\r\nexport class IModelHostConfiguration {\r\n\r\n /\r\n Root of the directory holding all the files that iModel.js caches\r\n * - If not specified at startup a platform specific default is used -\r\n * - Windows: $(HOMEDIR)/AppData/Local/iModelJs/\r\n * - Mac/iOS: $(HOMEDIR)/Library/Caches/iModelJs/\r\n * - Linux: $(HOMEDIR)/.cache/iModelJs/\r\n * where $(HOMEDIR) is documented [here](https://nodejs.org/api/os.html#os_os_homedir)\r\n * - if specified, ensure it is set to a folder with read/write access.\r\n * - Sub-folders within this folder organize various caches -\r\n * - bc/ -> Briefcases\r\n * - appSettings/ -> Offline application settings (only relevant in native applications)\r\n * - etc.\r\n * @see [[IModelHost.cacheDir]] for the value it's set to after startup\r\n /\r\n public cacheDir?: string;\r\n\r\n /* The directory where the app's assets are found. /\r\n public appAssetsDir?: string;\r\n\r\n /* The kind of iModel hub server to use.\r\n * @beta\r\n /\r\n public hubAccess?: BackendHubAccess;\r\n\r\n /* The credentials to use for the tile cache service. If omitted, a local cache will be used.\r\n * @beta\r\n /\r\n public tileCacheCredentials?: CloudStorageServiceCredentials;\r\n\r\n /* Whether to restrict tile cache URLs by client IP address (if available).\r\n * @beta\r\n /\r\n public restrictTileUrlsByClientIp?: boolean;\r\n\r\n /* Whether to compress cached tiles.\r\n * Defaults to `true`.\r\n /\r\n public compressCachedTiles?: boolean;\r\n\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n /* The default time, in milliseconds, used for [[tileTreeRequestTimeout]] and [[tileContentRequestTimeout]]. To change this, override one or both of those properties.\r\n * @internal\r\n /\r\n public static defaultTileRequestTimeout = 20 1000;\r\n\r\n /** The default time, in seconds, used for [[logTileLoadTimeThreshold]]. To change this, override that property.\r\n * @internal\r\n /\r\n public static defaultLogTileLoadTimeThreshold = 40;\r\n /* The backend will log when a tile took longer to load than this threshold in seconds.\r\n * @internal\r\n /\r\n public logTileLoadTimeThreshold: number = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\r\n\r\n /* The default size, in bytes, used for [[logTileSizeThreshold]]. To change this, override that property.\r\n * @internal\r\n /\r\n public static defaultLogTileSizeThreshold = 20 1000000;\r\n /** The backend will log when a tile is loaded with a size in bytes above this threshold.\r\n * @internal\r\n /\r\n public logTileSizeThreshold: number = IModelHostConfiguration.defaultLogTileSizeThreshold;\r\n\r\n /* Crash-reporting configuration\r\n * @alpha\r\n /\r\n public crashReportingConfig?: CrashReportingConfig;\r\n\r\n}\r\n\r\n/* IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.\r\n * See [the learning article]($docs/learning/backend/IModelHost.md)\r\n * @public\r\n /\r\nexport class IModelHost {\r\n private constructor() { }\r\n public static authorizationClient?: AuthorizationClient;\r\n\r\n /* @alpha /\r\n public static readonly telemetry = new TelemetryManager();\r\n\r\n public static backendVersion = \"\";\r\n private static _cacheDir = \"\";\r\n\r\n private static _platform?: typeof IModelJsNative;\r\n /* @internal /\r\n public static get platform(): typeof IModelJsNative {\r\n if (this._platform === undefined)\r\n throw new Error(\"IModelHost.startup must be called first\");\r\n return this._platform;\r\n }\r\n\r\n public static configuration?: IModelHostConfiguration;\r\n /* Event raised just after the backend IModelHost was started /\r\n public static readonly onAfterStartup = new BeEvent<() => void>();\r\n\r\n /* Event raised just before the backend IModelHost is to be shut down /\r\n public static readonly onBeforeShutdown = new BeEvent<() => void>();\r\n\r\n /* @internal /\r\n public static readonly session: Mutable<SessionProps> = { applicationId: \"2686\", applicationVersion: \"1.0.0\", sessionId: \"\" };\r\n\r\n /* A uniqueId for this session /\r\n public static get sessionId() { return this.session.sessionId; }\r\n public static set sessionId(id: GuidString) { this.session.sessionId = id; }\r\n\r\n /* The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. /\r\n public static get applicationId() { return this.session.applicationId; }\r\n public static set applicationId(id: string) { this.session.applicationId = id; }\r\n\r\n /* The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. /\r\n public static get applicationVersion() { return this.session.applicationVersion; }\r\n public static set applicationVersion(version: string) { this.session.applicationVersion = version; }\r\n\r\n /* Root of the directory holding all the files that iModel.js caches /\r\n public static get cacheDir(): string { return this._cacheDir; }\r\n\r\n /* The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. /\r\n public static snapshotFileNameResolver?: FileNameResolver;\r\n\r\n /* Get the current access token for this IModelHost, or a blank string if none is available.\r\n * @note for web backends, this will always return a blank string because the backend itself has no token (but never needs one either.)\r\n * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend\r\n * obtains the token and forwards it to the frontend.\r\n * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value\r\n * returned by this method may change over time throughout the course of a session.\r\n /\r\n public static async getAccessToken(): Promise<AccessToken> {\r\n try {\r\n return (await this.authorizationClient?.getAccessToken()) ?? \"\";\r\n } catch (e) {\r\n return \"\";\r\n }\r\n }\r\n\r\n /* @internal /\r\n public static flushLog() {\r\n return this.platform.DgnDb.flushLog();\r\n }\r\n /* @internal /\r\n public static loadNative(): void {\r\n const platform = Platform.load();\r\n this.registerPlatform(platform);\r\n }\r\n\r\n private static registerPlatform(platform: typeof IModelJsNative): void {\r\n this._platform = platform;\r\n if (undefined === platform)\r\n return;\r\n\r\n if (!ProcessDetector.isMobileAppBackend)\r\n this.validateNativePlatformVersion();\r\n\r\n platform.logger = Logger;\r\n }\r\n\r\n private static validateNativePlatformVersion(): void {\r\n const requiredVersion = require(\"../../package.json\").dependencies[\"@bentley/imodeljs-native\"]; // eslint-disable-line @typescript-eslint/no-var-requires\r\n const thisVersion = this.platform.version;\r\n if (semver.satisfies(thisVersion, requiredVersion))\r\n return;\r\n if (IModelJsFs.existsSync(path.join(__dirname, \"DevBuild.txt\"))) {\r\n console.log(\"Bypassing version checks for development build\"); // eslint-disable-line no-console\r\n return;\r\n }\r\n this._platform = undefined;\r\n throw new IModelError(IModelStatus.BadRequest, `imodeljs-native version is (${thisVersion}). core-backend requires version (${requiredVersion})`);\r\n }\r\n\r\n /\r\n @beta\r\n * @note A reference implementation is set by default for [AzureBlobStorage]. To supply a different implementation for any service provider (such as AWS),\r\n * set this property with a custom [CloudStorageService] and also set [IModelHostConfiguration.tileCacheCredentials] using \"external\" for the service name.\r\n * Note that the account and access key members of [CloudStorageServiceCredentials] may have blank values unless the custom service implementation uses them.\r\n /\r\n public static tileCacheService: CloudStorageService;\r\n\r\n /* @internal /\r\n public static tileUploader: CloudStorageTileUploader;\r\n\r\n private static _hubAccess: BackendHubAccess;\r\n /* @internal /\r\n public static setHubAccess(hubAccess: BackendHubAccess) { this._hubAccess = hubAccess; }\r\n\r\n /* Provides access to the IModelHub for this IModelHost\r\n * @beta\r\n /\r\n public static get hubAccess(): BackendHubAccess { return this._hubAccess; }\r\n\r\n private static _isValid = false;\r\n /* Returns true if IModelHost is started. /\r\n public static get isValid() { return this._isValid; }\r\n /* This method must be called before any iModel.js services are used.\r\n * @param configuration Host configuration data.\r\n * Raises [[onAfterStartup]].\r\n * @see [[shutdown]].\r\n /\r\n public static async startup(configuration: IModelHostConfiguration = new IModelHostConfiguration()): Promise<void> {\r\n if (this._isValid)\r\n return; // we're already initialized\r\n this._isValid = true;\r\n\r\n if (IModelHost.sessionId === \"\")\r\n IModelHost.sessionId = Guid.createValue();\r\n\r\n this.logStartup();\r\n\r\n this.backendVersion = require(\"../../package.json\").version; // eslint-disable-line @typescript-eslint/no-var-requires\r\n initializeRpcBackend();\r\n\r\n if (this._platform === undefined) {\r\n try {\r\n this.loadNative();\r\n } catch (error) {\r\n Logger.logError(loggerCategory, \"Error registering/loading the native platform API\", () => (configuration));\r\n throw error;\r\n }\r\n }\r\n\r\n if (configuration.crashReportingConfig && configuration.crashReportingConfig.crashDir && !ProcessDetector.isElectronAppBackend && !ProcessDetector.isMobileAppBackend) {\r\n this.platform.setCrashReporting(configuration.crashReportingConfig);\r\n\r\n Logger.logTrace(loggerCategory, \"Configured crash reporting\", () => ({\r\n enableCrashDumps: configuration.crashReportingConfig?.enableCrashDumps,\r\n wantFullMemoryDumps: configuration.crashReportingConfig?.wantFullMemoryDumps,\r\n enableNodeReport: configuration.crashReportingConfig?.enableNodeReport,\r\n uploadToBentley: configuration.crashReportingConfig?.uploadToBentley,\r\n }));\r\n\r\n if (configuration.crashReportingConfig.enableNodeReport) {\r\n try {\r\n // node-report reports on V8 fatal errors and unhandled exceptions/Promise rejections.\r\n const nodereport = require(\"node-report/api\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n nodereport.setEvents(\"exception+fatalerror+apicall\");\r\n nodereport.setDirectory(configuration.crashReportingConfig.crashDir);\r\n nodereport.setVerbose(\"yes\");\r\n Logger.logTrace(loggerCategory, \"Configured native crash reporting (node-report)\");\r\n } catch (err) {\r\n Logger.logWarning(loggerCategory, \"node-report is not installed.\");\r\n }\r\n }\r\n }\r\n\r\n this.setupCacheDirs(configuration);\r\n BriefcaseManager.initialize(this._briefcaseCacheDir);\r\n\r\n [\r\n IModelReadRpcImpl,\r\n IModelTileRpcImpl,\r\n SnapshotIModelRpcImpl,\r\n WipRpcImpl,\r\n DevToolsRpcImpl,\r\n ].forEach((rpc) => rpc.register()); // register all of the RPC implementations\r\n\r\n [\r\n BisCoreSchema,\r\n GenericSchema,\r\n FunctionalSchema,\r\n ].forEach((schema) => schema.registerSchema()); // register all of the schemas\r\n\r\n if (undefined !== configuration.hubAccess)\r\n IModelHost._hubAccess = configuration.hubAccess;\r\n IModelHost.configuration = configuration;\r\n IModelHost.setupTileCache();\r\n\r\n this.platform.setUseTileCache(configuration.tileCacheCredentials ? false : true);\r\n\r\n process.once(\"beforeExit\", IModelHost.shutdown);\r\n IModelHost.onAfterStartup.raiseEvent();\r\n }\r\n\r\n private static _briefcaseCacheDir: string;\r\n\r\n private static logStartup() {\r\n if (!Logger.isEnabled(loggerCategory, LogLevel.Trace))\r\n return;\r\n\r\n // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing\r\n let startupInfo: any = {};\r\n const serviceName = process.env.FABRIC_SERVICE_NAME;\r\n if (serviceName) {\r\n // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85\r\n const serviceNameComponents = serviceName.split(\"/\");\r\n if (serviceNameComponents.length === 7) {\r\n startupInfo = {\r\n ...startupInfo,\r\n iTwinId: serviceNameComponents[4],\r\n iModelId: serviceNameComponents[5],\r\n changesetId: serviceNameComponents[6],\r\n };\r\n }\r\n }\r\n\r\n Logger.logTrace(loggerCategory, \"IModelHost.startup\", () => startupInfo);\r\n }\r\n\r\n private static setupCacheDirs(configuration: IModelHostConfiguration) {\r\n this._cacheDir = configuration.cacheDir ? path.normalize(configuration.cacheDir) : NativeLibrary.defaultCacheDir;\r\n IModelJsFs.recursiveMkDirSync(this._cacheDir); // make sure the directory for cacheDir exists.\r\n this._briefcaseCacheDir = path.join(this._cacheDir, \"imodels\");\r\n }\r\n\r\n /* This method must be called when an iModel.js services is shut down. Raises [[onBeforeShutdown]] /\r\n public static async shutdown(): Promise<void> {\r\n // NB: This method is set as a node listener where `this` is unbound\r\n if (!IModelHost._isValid)\r\n return;\r\n\r\n IModelHost._isValid = false;\r\n IModelHost.onBeforeShutdown.raiseEvent();\r\n IModelHost.configuration = undefined;\r\n process.removeListener(\"beforeExit\", IModelHost.shutdown);\r\n }\r\n\r\n /\r\n Add or update a property that should be included in a crash report.\r\n * @param name The name of the property\r\n * @param value The value of the property\r\n * @alpha\r\n /\r\n public static setCrashReportProperty(name: string, value: string): void {\r\n assert(undefined !== this._platform);\r\n this._platform.setCrashReportProperty(name, value);\r\n }\r\n\r\n /\r\n Remove a previously defined property so that will not be included in a crash report.\r\n * @param name The name of the property\r\n * @alpha\r\n /\r\n public static removeCrashReportProperty(name: string): void {\r\n assert(undefined !== this._platform);\r\n this._platform.setCrashReportProperty(name, undefined);\r\n }\r\n\r\n /\r\n Get all properties that will be included in a crash report.\r\n * @alpha\r\n /\r\n public static getCrashReportProperties(): CrashReportingConfigNameValuePair[] {\r\n assert(undefined !== this._platform);\r\n return this._platform.getCrashReportProperties();\r\n }\r\n\r\n /* The directory where application assets may be found /\r\n public static get appAssetsDir(): string \| undefined { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }\r\n\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public static get tileTreeRequestTimeout(): number {\r\n return undefined !== IModelHost.configuration ? IModelHost.configuration.tileTreeRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;\r\n }\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public static get tileContentRequestTimeout(): number {\r\n return undefined !== IModelHost.configuration ? IModelHost.configuration.tileContentRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;\r\n }\r\n\r\n /* The backend will log when a tile took longer to load than this threshold in seconds. /\r\n public static get logTileLoadTimeThreshold(): number { return undefined !== IModelHost.configuration ? IModelHost.configuration.logTileLoadTimeThreshold : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }\r\n /* The backend will log when a tile is loaded with a size in bytes above this threshold. /\r\n public static get logTileSizeThreshold(): number { return undefined !== IModelHost.configuration ? IModelHost.configuration.logTileSizeThreshold : IModelHostConfiguration.defaultLogTileSizeThreshold; }\r\n\r\n /* Whether external tile caching is active.\r\n * @internal\r\n /\r\n public static get usingExternalTileCache(): boolean {\r\n return undefined !== IModelHost.configuration?.tileCacheCredentials;\r\n }\r\n\r\n /* Whether to restrict tile cache URLs by client IP address.\r\n * @internal\r\n /\r\n public static get restrictTileUrlsByClientIp(): boolean { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }\r\n\r\n /* Whether to compress cached tiles.\r\n * @internal\r\n /\r\n public static get compressCachedTiles(): boolean { return false !== IModelHost.configuration?.compressCachedTiles; }\r\n\r\n private static setupTileCache() {\r\n const config = IModelHost.configuration!;\r\n const credentials = config.tileCacheCredentials;\r\n if (undefined === credentials)\r\n return;\r\n\r\n IModelHost.tileUploader = new CloudStorageTileUploader();\r\n\r\n if (credentials.service === \"azure\" && !IModelHost.tileCacheService) {\r\n IModelHost.tileCacheService = new AzureBlobStorage(credentials);\r\n } else if (credentials.service === \"alicloud\") {\r\n IModelHost.tileCacheService = new AliCloudStorageService(credentials);\r\n } else if (credentials.service !== \"external\") {\r\n throw new IModelError(BentleyStatus.ERROR, \"Unsupported cloud service credentials for tile cache.\");\r\n }\r\n }\r\n}\r\n\r\n/* Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].\r\n * @public\r\n /\r\nexport class Platform {\r\n /* Get the name of the platform. /\r\n public static get platformName(): \"win32\" \| \"linux\" \| \"darwin\" \| \"ios\" \| \"android\" \| \"uwp\" {\r\n return process.platform as any;\r\n }\r\n\r\n /* @internal /\r\n public static load(): typeof IModelJsNative {\r\n return ProcessDetector.isMobileAppBackend ? (process as any)._linkedBinding(\"iModelJsNative\") : NativeLibrary.load();\r\n }\r\n}\r\n\r\n/* Well known directories that may be used by the application. Also see [[Platform]]\r\n * @public\r\n /\r\nexport class KnownLocations {\r\n\r\n /* The directory where the imodeljs-native assets are stored. /\r\n public static get nativeAssetsDir(): string { return IModelHost.platform.DgnDb.getAssetsDir(); }\r\n\r\n /* The directory where the core-backend assets are stored. /\r\n public static get packageAssetsDir(): string {\r\n return path.join(__dirname, \"assets\");\r\n }\r\n\r\n /* The temporary directory. /\r\n public static get tmpdir(): string {\r\n return os.tmpdir();\r\n }\r\n}\r\n\r\n/* Extend this class to provide custom file name resolution behavior.\r\n * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.\r\n * @see [[IModelHost.snapshotFileNameResolver]]\r\n * @public\r\n /\r\nexport abstract class FileNameResolver {\r\n /* Resolve a file name from the specified key.\r\n * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.\r\n * @returns The resolved file name or `undefined` if not found.\r\n /\r\n public tryResolveKey(_fileKey: string): string \| undefined { return undefined; }\r\n /* Resolve a file name from the specified key.\r\n * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.\r\n * @returns The resolved file name.\r\n * @throws [[IModelError]] if not found.\r\n /\r\n public resolveKey(fileKey: string): string {\r\n const resolvedFileName: string \| undefined = this.tryResolveKey(fileKey);\r\n if (undefined === resolvedFileName) {\r\n throw new IModelError(IModelStatus.NotFound, `${fileKey} not resolved`);\r\n }\r\n return resolvedFileName;\r\n }\r\n /* Resolve the input file name, which may be a partial name, into a full path file name.\r\n * @param inFileName The partial file name.\r\n * @returns The resolved full path file name or `undefined` if not found.\r\n /\r\n public tryResolveFileName(inFileName: string): string \| undefined { return inFileName; }\r\n /* Resolve the input file name, which may be a partial name, into a full path file name.\r\n * @param inFileName The partial file name.\r\n * @returns The resolved full path file name.\r\n * @throws [[IModelError]] if not found.\r\n */\r\n public resolveFileName(inFileName: string): string {\r\n const resolvedFileName: string \| undefined = this.tryResolveFileName(inFileName);\r\n if (undefined === resolvedFileName) {\r\n throw new IModelError(IModelStatus.NotFound, `${inFileName} not resolved`);\r\n }\r\n return resolvedFileName;\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"IModelHost.js","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,iCAAiC;AACjC,8DAAyE;AACzE,gEAA6D;AAC7D,sDAA+I;AAC/I,oDAAiH;AACjH,qEAAkE;AAElE,mEAAgE;AAChE,mDAAgD;AAChD,yDAAsD;AACtD,+DAAwI;AACxI,iEAA8D;AAC9D,2DAAwD;AACxD,6CAA0C;AAC1C,gEAA6D;AAC7D,oEAAiE;AACjE,oEAAiE;AACjE,4EAAyE;AACzE,sDAAmD;AACnD,6CAAoD;AACpD,qDAAiF;AAEjF,MAAM,cAAc,GAAG,6CAAqB,CAAC,UAAU,CAAC;AAqCxD;;GAEG;AACH,MAAa,uBAAuB;IAApC;QA8CE;;WAEG;QACI,2BAAsB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAClF;;WAEG;QACI,8BAAyB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAUrF;;WAEG;QACI,6BAAwB,GAAW,uBAAuB,CAAC,+BAA+B,CAAC;QAMlG;;WAEG;QACI,yBAAoB,GAAW,uBAAuB,CAAC,2BAA2B,CAAC;IAO5F,CAAC;;AAlFD,0DAkFC;AA5BC;;GAEG;AACW,iDAAyB,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpD;;GAEG;AACW,uDAA+B,GAAG,EAAE,CAAC;AAMnD;;GAEG;AACW,mDAA2B,GAAG,EAAE,GAAG,OAAO,CAAC;AAa3D;;;GAGG;AACH,MAAa,UAAU;IACrB,gBAAwB,CAAC;IAWzB,gBAAgB;IACT,MAAM,KAAK,QAAQ;QACxB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAYD,kCAAkC;IAC3B,MAAM,KAAK,SAAS,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,MAAM,KAAK,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;IAE5E,mJAAmJ;IAC5I,MAAM,KAAK,aAAa,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,aAAa,CAAC,EAAU,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC,CAAC,CAAC;IAEhF,qJAAqJ;IAC9I,MAAM,KAAK,kBAAkB,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,MAAM,KAAK,kBAAkB,CAAC,OAAe,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAEpG,wDAAwD;IACjD,MAAM,KAAK,QAAQ,KAAmB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE;;OAEG;IACI,MAAM,KAAK,SAAS,KAAgB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAKpE;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc;;QAChC,IAAI;YACF,OAAO,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,mBAAmB,0CAAE,cAAc,EAAE,CAAA,CAAC,mCAAI,EAAE,CAAC;SACjE;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IACxC,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,UAAU;QACtB,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,QAA+B;QAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,SAAS,KAAK,QAAQ;YACxB,OAAO;QAET,IAAI,CAAC,8BAAe,CAAC,kBAAkB;YACrC,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAEvC,QAAQ,CAAC,MAAM,GAAG,qBAAM,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,6BAA6B;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAAC,CAAC,yDAAyD;QACzJ,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1C,IAAI,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC;YAChD,OAAO;QACT,IAAI,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE;YAC/D,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC,CAAC,iCAAiC;YAChG,OAAO;SACR;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,+BAA+B,WAAW,qCAAqC,eAAe,GAAG,CAAC,CAAC;IACpJ,CAAC;IAcD,gBAAgB;IACT,MAAM,CAAC,YAAY,CAAC,SAA2B,IAAI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;IAExF;;OAEG;IACI,MAAM,KAAK,SAAS,KAAuB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAG3E,8CAA8C;IACvC,MAAM,KAAK,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAyC,IAAI,uBAAuB,EAAE;QAChG,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO,CAAC,4BAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE;YAC7B,UAAU,CAAC,SAAS,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,yDAAyD;QACtH,IAAA,iCAAoB,GAAE,CAAC;QAEvB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;YAChC,IAAI;gBACF,IAAI,CAAC,UAAU,EAAE,CAAC;aACnB;YAAC,OAAO,KAAK,EAAE;gBACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,mDAAmD,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC5G,MAAM,KAAK,CAAC;aACb;SACF;QAED,IAAI,aAAa,CAAC,oBAAoB,IAAI,aAAa,CAAC,oBAAoB,CAAC,QAAQ,IAAI,CAAC,8BAAe,CAAC,oBAAoB,IAAI,CAAC,8BAAe,CAAC,kBAAkB,EAAE;YACrK,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YAEpE,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4BAA4B,EAAE,GAAG,EAAE;;gBAAC,OAAA,CAAC;oBACnE,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,mBAAmB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,mBAAmB;oBAC5E,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,eAAe,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,eAAe;iBACrE,CAAC,CAAA;aAAA,CAAC,CAAC;YAEJ,IAAI,aAAa,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;gBACvD,IAAI;oBACF,sFAAsF;oBACtF,MAAM,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,yDAAyD;oBACxG,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;oBACrD,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;oBACrE,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iDAAiD,CAAC,CAAC;iBACpF;gBAAC,OAAO,GAAG,EAAE;oBACZ,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,+BAA+B,CAAC,CAAC;iBACpE;aACF;SACF;QAED,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,IAAI,0BAAc,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAE9D,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAErD;YACE,qCAAiB;YACjB,qCAAiB;YACjB,6CAAqB;YACrB,uBAAU;YACV,iCAAe;SAChB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,0CAA0C;QAE9E;YACE,6BAAa;YACb,6BAAa;YACb,mCAAgB;SACjB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,8BAA8B;QAE9E,IAAI,SAAS,KAAK,aAAa,CAAC,SAAS;YACvC,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC;QAClD,UAAU,CAAC,aAAa,GAAG,aAAa,CAAC;QACzC,UAAU,CAAC,cAAc,EAAE,CAAC;QAE5B,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEjF,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChD,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC;IAIO,MAAM,CAAC,UAAU;QACvB,IAAI,CAAC,qBAAM,CAAC,SAAS,CAAC,cAAc,EAAE,uBAAQ,CAAC,KAAK,CAAC;YACnD,OAAO;QAET,uIAAuI;QACvI,IAAI,WAAW,GAAQ,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACpD,IAAI,WAAW,EAAE;YACf,sKAAsK;YACtK,MAAM,qBAAqB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrD,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtC,WAAW,GAAG;oBACZ,GAAG,WAAW;oBACd,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;oBACjC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC;oBAClC,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAC;iBACtC,CAAC;aACH;SACF;QAED,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,oBAAoB,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,aAAsC;;QACjE,MAAM,QAAQ,GAAG,CAAC,GAAiB,EAAE,EAAE;YACrC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC1B,uBAAU,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACnC,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,MAAA,aAAa,CAAC,QAAQ,mCAAI,+BAAa,CAAC,eAAe,CAAC,CAAC;QACnF,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,sGAAsG;IAC/F,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,oEAAoE;QACpE,IAAI,CAAC,UAAU,CAAC,QAAQ;YACtB,OAAO;QAET,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC;QAC5B,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;QACzC,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrC,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa;QAC9D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,yBAAyB,CAAC,IAAY;QAClD,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB;QACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,EAAE,CAAC;IACnD,CAAC;IAED,0DAA0D;IACnD,MAAM,KAAK,YAAY,KAAyB,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE3J;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACtJ,CAAC;IACD;;OAEG;IACI,MAAM,KAAK,yBAAyB;QACzC,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACzJ,CAAC;IAED,2FAA2F;IACpF,MAAM,KAAK,wBAAwB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC,uBAAuB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACrN,4FAA4F;IACrF,MAAM,KAAK,oBAAoB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAEzM;;OAEG;IACI,MAAM,KAAK,sBAAsB;;QACtC,OAAO,SAAS,MAAK,MAAA,UAAU,CAAC,aAAa,0CAAE,oBAAoB,CAAA,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,0BAA0B,KAAc,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAElL;;OAEG;IACI,MAAM,KAAK,mBAAmB,aAAc,OAAO,KAAK,MAAK,MAAA,UAAU,CAAC,aAAa,0CAAE,mBAAmB,CAAA,CAAC,CAAC,CAAC;IAE5G,MAAM,CAAC,cAAc;QAC3B,MAAM,MAAM,GAAG,UAAU,CAAC,aAAc,CAAC;QACzC,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,CAAC;QAChD,IAAI,SAAS,KAAK,WAAW;YAC3B,OAAO;QAET,UAAU,CAAC,YAAY,GAAG,IAAI,8CAAwB,EAAE,CAAC;QAEzD,IAAI,WAAW,CAAC,OAAO,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE;YACnE,UAAU,CAAC,gBAAgB,GAAG,IAAI,sCAAgB,CAAC,WAAW,CAAC,CAAC;SACjE;aAAM,IAAI,WAAW,CAAC,OAAO,KAAK,UAAU,EAAE;YAC7C,UAAU,CAAC,gBAAgB,GAAG,IAAI,+CAAsB,CAAC,WAAW,CAAC,CAAC;SACvE;aAAM,IAAI,WAAW,CAAC,OAAO,KAAK,UAAU,EAAE;YAC7C,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,uDAAuD,CAAC,CAAC;SACrG;IACH,CAAC;;AA/UH,gCAgVC;AA5UC,aAAa;AACU,oBAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC;AAE5C,yBAAc,GAAG,EAAE,CAAC;AACnB,oBAAS,GAAG,EAAE,CAAC;AAY9B,iEAAiE;AAC1C,yBAAc,GAAG,IAAI,sBAAO,EAAc,CAAC;AAElE,yEAAyE;AAClD,2BAAgB,GAAG,IAAI,sBAAO,EAAc,CAAC;AAEpE,gBAAgB;AACO,kBAAO,GAA0B,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;AA8F/G,mBAAQ,GAAG,KAAK,CAAC;AAyNlC;;GAEG;AACH,MAAa,QAAQ;IACnB,oCAAoC;IAC7B,MAAM,KAAK,YAAY;QAC5B,OAAO,OAAO,CAAC,QAAe,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,IAAI;QAChB,OAAO,8BAAe,CAAC,kBAAkB,CAAC,CAAC,CAAE,OAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,+BAAa,CAAC,IAAI,EAAE,CAAC;IACvH,CAAC;CACF;AAVD,4BAUC;AAED;;GAEG;AACH,MAAa,cAAc;IAEzB,iEAAiE;IAC1D,MAAM,KAAK,eAAe,KAAa,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAEhG,8DAA8D;IACvD,MAAM,KAAK,gBAAgB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,+BAA+B;IACxB,MAAM,KAAK,MAAM;QACtB,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;CACF;AAdD,wCAcC;AAED;;;;GAIG;AACH,MAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAgB,IAAwB,OAAO,SAAS,CAAC,CAAC,CAAC;IAChF;;;;OAIG;IACI,UAAU,CAAC,OAAe;QAC/B,MAAM,gBAAgB,GAAuB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,OAAO,eAAe,CAAC,CAAC;SACzE;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD;;;OAGG;IACI,kBAAkB,CAAC,UAAkB,IAAwB,OAAO,UAAU,CAAC,CAAC,CAAC;IACxF;;;;OAIG;IACI,eAAe,CAAC,UAAkB;QACvC,MAAM,gBAAgB,GAAuB,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACjF,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,UAAU,eAAe,CAAC,CAAC;SAC5E;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF;AAnCD,4CAmCC","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 IModelHost\r\n /\r\n\r\nimport as os from \"os\";\r\nimport * as path from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { TelemetryManager } from \"@bentley/telemetry-client\";\r\nimport { AccessToken, assert, BeEvent, Guid, GuidString, IModelStatus, Logger, LogLevel, Mutable, ProcessDetector } from \"@itwin/core-bentley\";\r\nimport { AuthorizationClient, BentleyStatus, IModelError, LocalDirName, SessionProps } from \"@itwin/core-common\";\r\nimport { AliCloudStorageService } from \"./AliCloudStorageService\";\r\nimport { BackendHubAccess } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BisCoreSchema } from \"./BisCoreSchema\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { AzureBlobStorage, CloudStorageService, CloudStorageServiceCredentials, CloudStorageTileUploader } from \"./CloudStorageBackend\";\r\nimport { FunctionalSchema } from \"./domains/FunctionalSchema\";\r\nimport { GenericSchema } from \"./domains/GenericSchema\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { DevToolsRpcImpl } from \"./rpc-impl/DevToolsRpcImpl\";\r\nimport { IModelReadRpcImpl } from \"./rpc-impl/IModelReadRpcImpl\";\r\nimport { IModelTileRpcImpl } from \"./rpc-impl/IModelTileRpcImpl\";\r\nimport { SnapshotIModelRpcImpl } from \"./rpc-impl/SnapshotIModelRpcImpl\";\r\nimport { WipRpcImpl } from \"./rpc-impl/WipRpcImpl\";\r\nimport { initializeRpcBackend } from \"./RpcBackend\";\r\nimport { ITwinWorkspace, Workspace, WorkspaceOpts } from \"./workspace/Workspace\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.IModelHost;\r\n\r\n// cspell:ignore nodereport fatalerror apicall alicloud rpcs\r\n\r\n/** @alpha /\r\nexport interface CrashReportingConfigNameValuePair {\r\n name: string;\r\n value: string;\r\n}\r\n\r\n/* Configuration of the crash-reporting system.\r\n * @alpha\r\n /\r\nexport interface CrashReportingConfig {\r\n /* The directory to which .dmp and/or iModelJsNativeCrash.properties.txt files are written. This directory will be created if it does not already exist. /\r\n crashDir: string;\r\n /* max # .dmp files that may exist in crashDir. The default is 50. /\r\n maxDumpsInDir?: number;\r\n /* Enable crash-dumps? If so, .dmp and .properties.txt files will be generated and written to crashDir in the event of an unhandled native-code exception. If not, only .properties.txt files will be written. The default is false. /\r\n enableCrashDumps?: boolean;\r\n /* If enableCrashDumps is true, do you want a full-memory dump? Defaults to false. /\r\n wantFullMemoryDumps?: boolean;\r\n /* Enable node-report? If so, node-report files will be generated in the event of an unhandled exception or fatal error and written to crashDir. The default is false. /\r\n enableNodeReport?: boolean;\r\n /* Additional name, value pairs to write to iModelJsNativeCrash.properties.txt file in the event of a crash. /\r\n params?: CrashReportingConfigNameValuePair[];\r\n /** Run this .js file to process .dmp and node-report files in the event of a crash.\r\n * This script will be executed with a single command-line parameter: the name of the dump or node-report file.\r\n * In the case of a dump file, there will be a second file with the same basename and the extension \".properties.txt\".\r\n * Since it runs in a separate process, this script will have no access to the Javascript\r\n * context of the exiting backend. No default.\r\n /\r\n dumpProcessorScriptFileName?: string;\r\n /* Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false /\r\n uploadToBentley?: boolean;\r\n}\r\n\r\n/* Configuration of core-backend.\r\n * @public\r\n /\r\nexport class IModelHostConfiguration {\r\n\r\n /\r\n Root of the directory holding all the files that iModel.js caches\r\n * - If not specified at startup a platform specific default is used -\r\n * - Windows: $(HOMEDIR)/AppData/Local/iModelJs/\r\n * - Mac/iOS: $(HOMEDIR)/Library/Caches/iModelJs/\r\n * - Linux: $(HOMEDIR)/.cache/iModelJs/\r\n * where $(HOMEDIR) is documented [here](https://nodejs.org/api/os.html#os_os_homedir)\r\n * - if specified, ensure it is set to a folder with read/write access.\r\n * - Sub-folders within this folder organize various caches -\r\n * - bc/ -> Briefcases\r\n * - appSettings/ -> Offline application settings (only relevant in native applications)\r\n * - etc.\r\n * @see [[IModelHost.cacheDir]] for the value it's set to after startup\r\n /\r\n public cacheDir?: LocalDirName;\r\n\r\n /* Options for creating the [[Workspace]]\r\n * @beta\r\n /\r\n public workspace?: WorkspaceOpts;\r\n\r\n /* The directory where the app's assets are found. /\r\n public appAssetsDir?: LocalDirName;\r\n\r\n /* The kind of iModel hub server to use.\r\n * @beta\r\n /\r\n public hubAccess?: BackendHubAccess;\r\n\r\n /* The credentials to use for the tile cache service. If omitted, a local cache will be used.\r\n * @beta\r\n /\r\n public tileCacheCredentials?: CloudStorageServiceCredentials;\r\n\r\n /* Whether to restrict tile cache URLs by client IP address (if available).\r\n * @beta\r\n /\r\n public restrictTileUrlsByClientIp?: boolean;\r\n\r\n /* Whether to compress cached tiles.\r\n * Defaults to `true`.\r\n /\r\n public compressCachedTiles?: boolean;\r\n\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n /* The default time, in milliseconds, used for [[tileTreeRequestTimeout]] and [[tileContentRequestTimeout]]. To change this, override one or both of those properties.\r\n * @internal\r\n /\r\n public static defaultTileRequestTimeout = 20 1000;\r\n\r\n /** The default time, in seconds, used for [[logTileLoadTimeThreshold]]. To change this, override that property.\r\n * @internal\r\n /\r\n public static defaultLogTileLoadTimeThreshold = 40;\r\n /* The backend will log when a tile took longer to load than this threshold in seconds.\r\n * @internal\r\n /\r\n public logTileLoadTimeThreshold: number = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\r\n\r\n /* The default size, in bytes, used for [[logTileSizeThreshold]]. To change this, override that property.\r\n * @internal\r\n /\r\n public static defaultLogTileSizeThreshold = 20 1000000;\r\n /** The backend will log when a tile is loaded with a size in bytes above this threshold.\r\n * @internal\r\n /\r\n public logTileSizeThreshold: number = IModelHostConfiguration.defaultLogTileSizeThreshold;\r\n\r\n /* Crash-reporting configuration\r\n * @alpha\r\n /\r\n public crashReportingConfig?: CrashReportingConfig;\r\n\r\n}\r\n\r\n/* IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.\r\n * See [the learning article]($docs/learning/backend/IModelHost.md)\r\n * @public\r\n /\r\nexport class IModelHost {\r\n private constructor() { }\r\n public static authorizationClient?: AuthorizationClient;\r\n\r\n /* @alpha /\r\n public static readonly telemetry = new TelemetryManager();\r\n\r\n public static backendVersion = \"\";\r\n private static _cacheDir = \"\";\r\n private static _workspace: Workspace;\r\n\r\n private static _platform?: typeof IModelJsNative;\r\n /* @internal /\r\n public static get platform(): typeof IModelJsNative {\r\n if (this._platform === undefined)\r\n throw new Error(\"IModelHost.startup must be called first\");\r\n return this._platform;\r\n }\r\n\r\n public static configuration?: IModelHostConfiguration;\r\n /* Event raised just after the backend IModelHost was started /\r\n public static readonly onAfterStartup = new BeEvent<() => void>();\r\n\r\n /* Event raised just before the backend IModelHost is to be shut down /\r\n public static readonly onBeforeShutdown = new BeEvent<() => void>();\r\n\r\n /* @internal /\r\n public static readonly session: Mutable<SessionProps> = { applicationId: \"2686\", applicationVersion: \"1.0.0\", sessionId: \"\" };\r\n\r\n /* A uniqueId for this session /\r\n public static get sessionId() { return this.session.sessionId; }\r\n public static set sessionId(id: GuidString) { this.session.sessionId = id; }\r\n\r\n /* The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. /\r\n public static get applicationId() { return this.session.applicationId; }\r\n public static set applicationId(id: string) { this.session.applicationId = id; }\r\n\r\n /* The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. /\r\n public static get applicationVersion() { return this.session.applicationVersion; }\r\n public static set applicationVersion(version: string) { this.session.applicationVersion = version; }\r\n\r\n /* Root directory holding files that iTwin.js caches /\r\n public static get cacheDir(): LocalDirName { return this._cacheDir; }\r\n\r\n /* The Workspace for this `IModelHost`\r\n * @beta\r\n /\r\n public static get workspace(): Workspace { return this._workspace; }\r\n\r\n /* The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. /\r\n public static snapshotFileNameResolver?: FileNameResolver;\r\n\r\n /* Get the current access token for this IModelHost, or a blank string if none is available.\r\n * @note for web backends, this will always return a blank string because the backend itself has no token (but never needs one either.)\r\n * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend\r\n * obtains the token and forwards it to the frontend.\r\n * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value\r\n * returned by this method may change over time throughout the course of a session.\r\n /\r\n public static async getAccessToken(): Promise<AccessToken> {\r\n try {\r\n return (await this.authorizationClient?.getAccessToken()) ?? \"\";\r\n } catch (e) {\r\n return \"\";\r\n }\r\n }\r\n\r\n /* @internal /\r\n public static flushLog() {\r\n return this.platform.DgnDb.flushLog();\r\n }\r\n /* @internal /\r\n public static loadNative(): void {\r\n const platform = Platform.load();\r\n this.registerPlatform(platform);\r\n }\r\n\r\n private static registerPlatform(platform: typeof IModelJsNative): void {\r\n this._platform = platform;\r\n if (undefined === platform)\r\n return;\r\n\r\n if (!ProcessDetector.isMobileAppBackend)\r\n this.validateNativePlatformVersion();\r\n\r\n platform.logger = Logger;\r\n }\r\n\r\n private static validateNativePlatformVersion(): void {\r\n const requiredVersion = require(\"../../package.json\").dependencies[\"@bentley/imodeljs-native\"]; // eslint-disable-line @typescript-eslint/no-var-requires\r\n const thisVersion = this.platform.version;\r\n if (semver.satisfies(thisVersion, requiredVersion))\r\n return;\r\n if (IModelJsFs.existsSync(path.join(__dirname, \"DevBuild.txt\"))) {\r\n console.log(\"Bypassing version checks for development build\"); // eslint-disable-line no-console\r\n return;\r\n }\r\n this._platform = undefined;\r\n throw new IModelError(IModelStatus.BadRequest, `imodeljs-native version is (${thisVersion}). core-backend requires version (${requiredVersion})`);\r\n }\r\n\r\n /\r\n @beta\r\n * @note A reference implementation is set by default for [AzureBlobStorage]. To supply a different implementation for any service provider (such as AWS),\r\n * set this property with a custom [CloudStorageService] and also set [IModelHostConfiguration.tileCacheCredentials] using \"external\" for the service name.\r\n * Note that the account and access key members of [CloudStorageServiceCredentials] may have blank values unless the custom service implementation uses them.\r\n /\r\n public static tileCacheService: CloudStorageService;\r\n\r\n /* @internal /\r\n public static tileUploader: CloudStorageTileUploader;\r\n\r\n private static _hubAccess: BackendHubAccess;\r\n /* @internal /\r\n public static setHubAccess(hubAccess: BackendHubAccess) { this._hubAccess = hubAccess; }\r\n\r\n /* Provides access to the IModelHub for this IModelHost\r\n * @beta\r\n /\r\n public static get hubAccess(): BackendHubAccess { return this._hubAccess; }\r\n\r\n private static _isValid = false;\r\n /* Returns true if IModelHost is started. /\r\n public static get isValid() { return this._isValid; }\r\n /* This method must be called before any iModel.js services are used.\r\n * @param configuration Host configuration data.\r\n * Raises [[onAfterStartup]].\r\n * @see [[shutdown]].\r\n /\r\n public static async startup(configuration: IModelHostConfiguration = new IModelHostConfiguration()): Promise<void> {\r\n if (this._isValid)\r\n return; // we're already initialized\r\n this._isValid = true;\r\n\r\n if (IModelHost.sessionId === \"\")\r\n IModelHost.sessionId = Guid.createValue();\r\n\r\n this.logStartup();\r\n\r\n this.backendVersion = require(\"../../package.json\").version; // eslint-disable-line @typescript-eslint/no-var-requires\r\n initializeRpcBackend();\r\n\r\n if (this._platform === undefined) {\r\n try {\r\n this.loadNative();\r\n } catch (error) {\r\n Logger.logError(loggerCategory, \"Error registering/loading the native platform API\", () => (configuration));\r\n throw error;\r\n }\r\n }\r\n\r\n if (configuration.crashReportingConfig && configuration.crashReportingConfig.crashDir && !ProcessDetector.isElectronAppBackend && !ProcessDetector.isMobileAppBackend) {\r\n this.platform.setCrashReporting(configuration.crashReportingConfig);\r\n\r\n Logger.logTrace(loggerCategory, \"Configured crash reporting\", () => ({\r\n enableCrashDumps: configuration.crashReportingConfig?.enableCrashDumps,\r\n wantFullMemoryDumps: configuration.crashReportingConfig?.wantFullMemoryDumps,\r\n enableNodeReport: configuration.crashReportingConfig?.enableNodeReport,\r\n uploadToBentley: configuration.crashReportingConfig?.uploadToBentley,\r\n }));\r\n\r\n if (configuration.crashReportingConfig.enableNodeReport) {\r\n try {\r\n // node-report reports on V8 fatal errors and unhandled exceptions/Promise rejections.\r\n const nodereport = require(\"node-report/api\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n nodereport.setEvents(\"exception+fatalerror+apicall\");\r\n nodereport.setDirectory(configuration.crashReportingConfig.crashDir);\r\n nodereport.setVerbose(\"yes\");\r\n Logger.logTrace(loggerCategory, \"Configured native crash reporting (node-report)\");\r\n } catch (err) {\r\n Logger.logWarning(loggerCategory, \"node-report is not installed.\");\r\n }\r\n }\r\n }\r\n\r\n this.setupHostDirs(configuration);\r\n this._workspace = new ITwinWorkspace(configuration.workspace);\r\n\r\n BriefcaseManager.initialize(this._briefcaseCacheDir);\r\n\r\n [\r\n IModelReadRpcImpl,\r\n IModelTileRpcImpl,\r\n SnapshotIModelRpcImpl,\r\n WipRpcImpl,\r\n DevToolsRpcImpl,\r\n ].forEach((rpc) => rpc.register()); // register all of the RPC implementations\r\n\r\n [\r\n BisCoreSchema,\r\n GenericSchema,\r\n FunctionalSchema,\r\n ].forEach((schema) => schema.registerSchema()); // register all of the schemas\r\n\r\n if (undefined !== configuration.hubAccess)\r\n IModelHost._hubAccess = configuration.hubAccess;\r\n IModelHost.configuration = configuration;\r\n IModelHost.setupTileCache();\r\n\r\n this.platform.setUseTileCache(configuration.tileCacheCredentials ? false : true);\r\n\r\n process.once(\"beforeExit\", IModelHost.shutdown);\r\n IModelHost.onAfterStartup.raiseEvent();\r\n }\r\n\r\n private static _briefcaseCacheDir: LocalDirName;\r\n\r\n private static logStartup() {\r\n if (!Logger.isEnabled(loggerCategory, LogLevel.Trace))\r\n return;\r\n\r\n // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing\r\n let startupInfo: any = {};\r\n const serviceName = process.env.FABRIC_SERVICE_NAME;\r\n if (serviceName) {\r\n // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85\r\n const serviceNameComponents = serviceName.split(\"/\");\r\n if (serviceNameComponents.length === 7) {\r\n startupInfo = {\r\n ...startupInfo,\r\n iTwinId: serviceNameComponents[4],\r\n iModelId: serviceNameComponents[5],\r\n changesetId: serviceNameComponents[6],\r\n };\r\n }\r\n }\r\n\r\n Logger.logTrace(loggerCategory, \"IModelHost.startup\", () => startupInfo);\r\n }\r\n\r\n private static setupHostDirs(configuration: IModelHostConfiguration) {\r\n const setupDir = (dir: LocalDirName) => {\r\n dir = path.normalize(dir);\r\n IModelJsFs.recursiveMkDirSync(dir);\r\n return dir;\r\n };\r\n this._cacheDir = setupDir(configuration.cacheDir ?? NativeLibrary.defaultCacheDir);\r\n this._briefcaseCacheDir = path.join(this._cacheDir, \"imodels\");\r\n }\r\n\r\n /* This method must be called when an iModel.js services is shut down. Raises [[onBeforeShutdown]] /\r\n public static async shutdown(): Promise<void> {\r\n // NB: This method is set as a node listener where `this` is unbound\r\n if (!IModelHost._isValid)\r\n return;\r\n\r\n IModelHost._isValid = false;\r\n IModelHost.onBeforeShutdown.raiseEvent();\r\n IModelHost.configuration = undefined;\r\n process.removeListener(\"beforeExit\", IModelHost.shutdown);\r\n }\r\n\r\n /\r\n Add or update a property that should be included in a crash report.\r\n * @param name The name of the property\r\n * @param value The value of the property\r\n * @alpha\r\n /\r\n public static setCrashReportProperty(name: string, value: string): void {\r\n assert(undefined !== this._platform);\r\n this._platform.setCrashReportProperty(name, value);\r\n }\r\n\r\n /\r\n Remove a previously defined property so that will not be included in a crash report.\r\n * @param name The name of the property\r\n * @alpha\r\n /\r\n public static removeCrashReportProperty(name: string): void {\r\n assert(undefined !== this._platform);\r\n this._platform.setCrashReportProperty(name, undefined);\r\n }\r\n\r\n /\r\n Get all properties that will be included in a crash report.\r\n * @alpha\r\n /\r\n public static getCrashReportProperties(): CrashReportingConfigNameValuePair[] {\r\n assert(undefined !== this._platform);\r\n return this._platform.getCrashReportProperties();\r\n }\r\n\r\n /* The directory where application assets may be found /\r\n public static get appAssetsDir(): string \| undefined { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }\r\n\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public static get tileTreeRequestTimeout(): number {\r\n return undefined !== IModelHost.configuration ? IModelHost.configuration.tileTreeRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;\r\n }\r\n /* The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n /\r\n public static get tileContentRequestTimeout(): number {\r\n return undefined !== IModelHost.configuration ? IModelHost.configuration.tileContentRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;\r\n }\r\n\r\n /* The backend will log when a tile took longer to load than this threshold in seconds. /\r\n public static get logTileLoadTimeThreshold(): number { return undefined !== IModelHost.configuration ? IModelHost.configuration.logTileLoadTimeThreshold : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }\r\n /* The backend will log when a tile is loaded with a size in bytes above this threshold. /\r\n public static get logTileSizeThreshold(): number { return undefined !== IModelHost.configuration ? IModelHost.configuration.logTileSizeThreshold : IModelHostConfiguration.defaultLogTileSizeThreshold; }\r\n\r\n /* Whether external tile caching is active.\r\n * @internal\r\n /\r\n public static get usingExternalTileCache(): boolean {\r\n return undefined !== IModelHost.configuration?.tileCacheCredentials;\r\n }\r\n\r\n /* Whether to restrict tile cache URLs by client IP address.\r\n * @internal\r\n /\r\n public static get restrictTileUrlsByClientIp(): boolean { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }\r\n\r\n /* Whether to compress cached tiles.\r\n * @internal\r\n /\r\n public static get compressCachedTiles(): boolean { return false !== IModelHost.configuration?.compressCachedTiles; }\r\n\r\n private static setupTileCache() {\r\n const config = IModelHost.configuration!;\r\n const credentials = config.tileCacheCredentials;\r\n if (undefined === credentials)\r\n return;\r\n\r\n IModelHost.tileUploader = new CloudStorageTileUploader();\r\n\r\n if (credentials.service === \"azure\" && !IModelHost.tileCacheService) {\r\n IModelHost.tileCacheService = new AzureBlobStorage(credentials);\r\n } else if (credentials.service === \"alicloud\") {\r\n IModelHost.tileCacheService = new AliCloudStorageService(credentials);\r\n } else if (credentials.service !== \"external\") {\r\n throw new IModelError(BentleyStatus.ERROR, \"Unsupported cloud service credentials for tile cache.\");\r\n }\r\n }\r\n}\r\n\r\n/* Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].\r\n * @public\r\n /\r\nexport class Platform {\r\n /* Get the name of the platform. /\r\n public static get platformName(): \"win32\" \| \"linux\" \| \"darwin\" \| \"ios\" \| \"android\" \| \"uwp\" {\r\n return process.platform as any;\r\n }\r\n\r\n /* @internal /\r\n public static load(): typeof IModelJsNative {\r\n return ProcessDetector.isMobileAppBackend ? (process as any)._linkedBinding(\"iModelJsNative\") : NativeLibrary.load();\r\n }\r\n}\r\n\r\n/* Well known directories that may be used by the application. Also see [[Platform]]\r\n * @public\r\n /\r\nexport class KnownLocations {\r\n\r\n /* The directory where the imodeljs-native assets are stored. /\r\n public static get nativeAssetsDir(): string { return IModelHost.platform.DgnDb.getAssetsDir(); }\r\n\r\n /* The directory where the core-backend assets are stored. /\r\n public static get packageAssetsDir(): string {\r\n return path.join(__dirname, \"assets\");\r\n }\r\n\r\n /* The temporary directory. /\r\n public static get tmpdir(): string {\r\n return os.tmpdir();\r\n }\r\n}\r\n\r\n/* Extend this class to provide custom file name resolution behavior.\r\n * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.\r\n * @see [[IModelHost.snapshotFileNameResolver]]\r\n * @public\r\n /\r\nexport abstract class FileNameResolver {\r\n /* Resolve a file name from the specified key.\r\n * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.\r\n * @returns The resolved file name or `undefined` if not found.\r\n /\r\n public tryResolveKey(_fileKey: string): string \| undefined { return undefined; }\r\n /* Resolve a file name from the specified key.\r\n * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.\r\n * @returns The resolved file name.\r\n * @throws [[IModelError]] if not found.\r\n /\r\n public resolveKey(fileKey: string): string {\r\n const resolvedFileName: string \| undefined = this.tryResolveKey(fileKey);\r\n if (undefined === resolvedFileName) {\r\n throw new IModelError(IModelStatus.NotFound, `${fileKey} not resolved`);\r\n }\r\n return resolvedFileName;\r\n }\r\n /* Resolve the input file name, which may be a partial name, into a full path file name.\r\n * @param inFileName The partial file name.\r\n * @returns The resolved full path file name or `undefined` if not found.\r\n /\r\n public tryResolveFileName(inFileName: string): string \| undefined { return inFileName; }\r\n /* Resolve the input file name, which may be a partial name, into a full path file name.\r\n * @param inFileName The partial file name.\r\n * @returns The resolved full path file name.\r\n * @throws [[IModelError]] if not found.\r\n */\r\n public resolveFileName(inFileName: string): string {\r\n const resolvedFileName: string \| undefined = this.tryResolveFileName(inFileName);\r\n if (undefined === resolvedFileName) {\r\n throw new IModelError(IModelStatus.NotFound, `${inFileName} not resolved`);\r\n }\r\n return resolvedFileName;\r\n }\r\n}\r\n"]}

package/lib/cjs/assets/Settings.schema.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "$id": "http://itwinjs.org/json-schema/settings",
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "schema for iTwin settings",
+  "description": "base schema for iTwin.js settings",
+  "type": "object",
+  "properties": {
+    "groupName": {
+      "type": "string",
+      "description": "the name for a group of settings"
+    },
+    "order": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "for sorting settings groups in an editor"
+    },
+    "extensionId": {
+      "type": "string",
+      "description": "the name of the extension for these settings"
+    }
+  },
+  "required": [
+    "groupName"
+  ]
+}

package/lib/cjs/core-backend.d.ts CHANGED Viewed

@@ -46,6 +46,9 @@ export * from "./AliCloudStorageService";
 export * from "./DevTools";
 export * from "./LocalhostIpcHost";
 export * from "./ElementGraphics";
+export * from "./workspace/Settings";
+export * from "./workspace/SettingsSpecRegistry";
+export * from "./workspace/Workspace";
 export * from "./IModelDb";
 /** @docs-package-description
  * The core-backend package always runs on the computer with a local Briefcase.
@@ -159,4 +162,8 @@ export * from "./IModelDb";
  * @docs-group-description HubAccess
  * APIs for working with IModelHub
  */
+/**
+ * @docs-group-description Workspace
+ * APIs for loading and using Settings and Workspace resources
+ */
 //# sourceMappingURL=core-backend.d.ts.map

package/lib/cjs/core-backend.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"core-backend.d.ts","sourceRoot":"","sources":["../../src/core-backend.ts"],"names":[],"mappings":"AAIA,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChF,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAE3B;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG"}
1	+ {"version":3,"file":"core-backend.d.ts","sourceRoot":"","sources":["../../src/core-backend.ts"],"names":[],"mappings":"AAIA,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChF,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC;AAE3B;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG"}

package/lib/cjs/core-backend.js CHANGED Viewed

@@ -65,6 +65,9 @@ __exportStar(require("./AliCloudStorageService"), exports);
 __exportStar(require("./DevTools"), exports);
 __exportStar(require("./LocalhostIpcHost"), exports);
 __exportStar(require("./ElementGraphics"), exports);
+__exportStar(require("./workspace/Settings"), exports);
+__exportStar(require("./workspace/SettingsSpecRegistry"), exports);
+__exportStar(require("./workspace/Workspace"), exports);
 __exportStar(require("./IModelDb"), exports); // must be last
 /** @docs-package-description
  * The core-backend package always runs on the computer with a local Briefcase.
@@ -178,4 +181,8 @@ __exportStar(require("./IModelDb"), exports); // must be last
  * @docs-group-description HubAccess
  * APIs for working with IModelHub
  */
+/**
+ * @docs-group-description Workspace
+ * APIs for loading and using Settings and Workspace resources
+ */
 //# sourceMappingURL=core-backend.js.map

package/lib/cjs/core-backend.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"core-backend.js","sourceRoot":"","sources":["../../src/core-backend.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,qDAAmC;AACnC,6CAA2B;AAC3B,yDAAuC;AACvC,sDAAoC;AACpC,kDAAgC;AAChC,8CAA4B;AAC5B,iDAA+B;AAC/B,yCAAuB;AACvB,uDAAqC;AACrC,mDAAiC;AACjC,4CAA0B;AAC1B,kDAAgC;AAChC,2CAAyB;AACzB,mDAAiC;AACjC,mDAAiC;AACjC,+CAA6B;AAC7B,qDAAmC;AACnC,iDAA+B;AAC/B,4CAA0B;AAC1B,+CAA6B;AAC7B,8CAA4B;AAC5B,0DAAwC;AACxC,6CAA2B;AAC3B,0CAAwB;AACxB,2DAAyC;AACzC,+CAA6B;AAC7B,2CAAyB;AACzB,oDAAkC;AAClC,6CAA2B;AAC3B,mDAAiC;AACjC,kDAAgC;AAChC,sDAAoC;AACpC,6DAA2C;AAC3C,+DAA6C;AAC7C,0DAAwC;AACxC,4DAA0C;AAC1C,4DAAgF;AAAvE,iHAAA,cAAc,OAAA;AAAE,uHAAA,oBAAoB,OAAA;AAC7C,uDAAqC;AACrC,+CAA6B;AAC7B,uDAAqC;AACrC,4CAA0B;AAC1B,qDAAmC;AACnC,+CAA6B;AAC7B,wDAAsC;AACtC,2DAAyC;AACzC,6CAA2B;AAC3B,qDAAmC;AACnC,oDAAkC;AAClC,6CAA2B,CAAC,eAAe;AAE3C;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG","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\nexport * from \"./BriefcaseManager\";\r\nexport * from \"./Category\";\r\nexport * from \"./ChangeSummaryManager\";\r\nexport * from \"./CheckpointManager\";\r\nexport * from \"./ClassRegistry\";\r\nexport * from \"./CodeSpecs\";\r\nexport * from \"./DisplayStyle\";\r\nexport * from \"./ECDb\";\r\nexport * from \"./ECSchemaXmlContext\";\r\nexport * from \"./ECSqlStatement\";\r\nexport * from \"./Element\";\r\nexport * from \"./ElementAspect\";\r\nexport * from \"./Entity\";\r\nexport * from \"./ExportGraphics\";\r\nexport * from \"./ExternalSource\";\r\nexport * from \"./IModelJsFs\";\r\nexport * from \"./BackendHubAccess\";\r\nexport * from \"./Relationship\";\r\nexport * from \"./Texture\";\r\nexport * from \"./TxnManager\";\r\nexport * from \"./LineStyle\";\r\nexport * from \"./BackendLoggerCategory\";\r\nexport * from \"./Material\";\r\nexport * from \"./Model\";\r\nexport * from \"./NavigationRelationship\";\r\nexport * from \"./RpcBackend\";\r\nexport * from \"./Schema\";\r\nexport * from \"./SqliteStatement\";\r\nexport * from \"./SQLiteDb\";\r\nexport * from \"./ViewDefinition\";\r\nexport * from \"./BisCoreSchema\";\r\nexport * from \"./ChangedElementsDb\";\r\nexport * from \"./domains/FunctionalSchema\";\r\nexport * from \"./domains/FunctionalElements\";\r\nexport * from \"./domains/GenericSchema\";\r\nexport * from \"./domains/GenericElements\";\r\nexport { IModelJsNative, NativeLoggerCategory } from \"@bentley/imodeljs-native\";\r\nexport * from \"./IModelCloneContext\";\r\nexport * from \"./IModelHost\";\r\nexport * from \"./IModelSchemaLoader\";\r\nexport * from \"./IpcHost\";\r\nexport * from \"./NativeAppStorage\";\r\nexport * from \"./NativeHost\";\r\nexport * from \"./CloudStorageBackend\";\r\nexport * from \"./AliCloudStorageService\";\r\nexport * from \"./DevTools\";\r\nexport * from \"./LocalhostIpcHost\";\r\nexport * from \"./ElementGraphics\";\r\nexport * from \"./IModelDb\"; // must be last\r\n\r\n/** @docs-package-description\r\n * The core-backend package always runs on the computer with a local Briefcase.\r\n \r\n It contains classes that [backend code]($docs/learning/backend/index.md) can use to work with directly with iModels.\r\n /\r\n/\r\n @docs-group-description IModelHost\r\n * Classes for configuring and administering the backend [host]($docs/learning/backend/IModelHost.md).\r\n * See [the learning article]($docs/learning/backend/IModelHost.md).\r\n /\r\n/\r\n @docs-group-description iModels\r\n * Classes for working with [iModels]($docs/learning/iModels.md).\r\n * See [the learning article]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Schema\r\n * Classes for working with [ECSchemas]($docs/learning/backend/SchemasAndElementsInTypeScript.md)\r\n /\r\n/\r\n @docs-group-description Models\r\n * Subclasses of [Models]($docs/BIS/intro/model-fundamentals.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Elements\r\n * Subclasses of [Elements]($docs/BIS/intro/element-fundamentals.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Codes\r\n * Classes for working with [Codes]($docs/BIS/intro/codes.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description ViewDefinitions\r\n * Classes for working with Elements that define what appears in [Views]($docs/learning/frontend/views.md).\r\n * See [the learning articles]($docs/learning/backend/createelements/#orthographicviewdefinition).\r\n /\r\n/\r\n @docs-group-description Relationships\r\n * Classes that describe the [relationships]($docs/bis/intro/relationship-fundamentals.md) between elements.\r\n /\r\n/\r\n @docs-group-description ElementAspects\r\n * Subclasses of [ElementAspects]($docs/bis/intro/elementaspect-fundamentals.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Categories\r\n * Classes for [Categories]($docs/bis/intro/categories.md).\r\n /\r\n/\r\n @docs-group-description Symbology\r\n * Classes for defining the appearance of element geometry\r\n /\r\n/\r\n @docs-group-description ECDb\r\n * Classes for working with ECDb.\r\n /\r\n/\r\n @docs-group-description SQLiteDb\r\n * Classes for working with SQLiteDb.\r\n /\r\n/\r\n @docs-group-description NativeApp\r\n * Classes for working with Mobile/Desktop Application.\r\n /\r\n/\r\n @docs-group-description ECSQL\r\n * Classes for working with [ECSQL]($docs/learning/ECSQL.md)\r\n /\r\n/\r\n @docs-group-description SQLite\r\n * Classes for working directly with SQLite\r\n /\r\n/\r\n @docs-group-description Portability\r\n * Classes to help write [portable apps]($docs/learning/Portability.md) and libraries that will run on any platform, including web apps, node services, Electron desktops apps, and mobile apps.\r\n /\r\n/\r\n @docs-group-description Utils\r\n * Miscellaneous utility classes.\r\n /\r\n/\r\n @docs-group-description Logging\r\n * Logger categories used by this package.\r\n /\r\n/\r\n @docs-group-description RpcInterface\r\n * Classes for working with [RpcInterfaces]($docs/learning/RpcInterface.md).\r\n /\r\n/\r\n @docs-group-description CloudStorageBackend\r\n * Classes for working with cloud storage.\r\n /\r\n/\r\n @docs-group-description AliCloudStorageService\r\n * Classes for working with cloud storage using AliCloud.\r\n /\r\n/\r\n @docs-group-description Authentication\r\n * Classes for working with Authentication.\r\n /\r\n/\r\n @docs-group-description Tiles\r\n * APIs for working with tile graphics.\r\n /\r\n/\r\n @docs-group-description HubAccess\r\n * APIs for working with IModelHub\r\n */\r\n"]}
1	+ {"version":3,"file":"core-backend.js","sourceRoot":"","sources":["../../src/core-backend.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA;;;+FAG+F;AAC/F,qDAAmC;AACnC,6CAA2B;AAC3B,yDAAuC;AACvC,sDAAoC;AACpC,kDAAgC;AAChC,8CAA4B;AAC5B,iDAA+B;AAC/B,yCAAuB;AACvB,uDAAqC;AACrC,mDAAiC;AACjC,4CAA0B;AAC1B,kDAAgC;AAChC,2CAAyB;AACzB,mDAAiC;AACjC,mDAAiC;AACjC,+CAA6B;AAC7B,qDAAmC;AACnC,iDAA+B;AAC/B,4CAA0B;AAC1B,+CAA6B;AAC7B,8CAA4B;AAC5B,0DAAwC;AACxC,6CAA2B;AAC3B,0CAAwB;AACxB,2DAAyC;AACzC,+CAA6B;AAC7B,2CAAyB;AACzB,oDAAkC;AAClC,6CAA2B;AAC3B,mDAAiC;AACjC,kDAAgC;AAChC,sDAAoC;AACpC,6DAA2C;AAC3C,+DAA6C;AAC7C,0DAAwC;AACxC,4DAA0C;AAC1C,4DAAgF;AAAvE,iHAAA,cAAc,OAAA;AAAE,uHAAA,oBAAoB,OAAA;AAC7C,uDAAqC;AACrC,+CAA6B;AAC7B,uDAAqC;AACrC,4CAA0B;AAC1B,qDAAmC;AACnC,+CAA6B;AAC7B,wDAAsC;AACtC,2DAAyC;AACzC,6CAA2B;AAC3B,qDAAmC;AACnC,oDAAkC;AAClC,uDAAqC;AACrC,mEAAiD;AACjD,wDAAsC;AACtC,6CAA2B,CAAC,eAAe;AAE3C;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG","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\nexport * from \"./BriefcaseManager\";\r\nexport * from \"./Category\";\r\nexport * from \"./ChangeSummaryManager\";\r\nexport * from \"./CheckpointManager\";\r\nexport * from \"./ClassRegistry\";\r\nexport * from \"./CodeSpecs\";\r\nexport * from \"./DisplayStyle\";\r\nexport * from \"./ECDb\";\r\nexport * from \"./ECSchemaXmlContext\";\r\nexport * from \"./ECSqlStatement\";\r\nexport * from \"./Element\";\r\nexport * from \"./ElementAspect\";\r\nexport * from \"./Entity\";\r\nexport * from \"./ExportGraphics\";\r\nexport * from \"./ExternalSource\";\r\nexport * from \"./IModelJsFs\";\r\nexport * from \"./BackendHubAccess\";\r\nexport * from \"./Relationship\";\r\nexport * from \"./Texture\";\r\nexport * from \"./TxnManager\";\r\nexport * from \"./LineStyle\";\r\nexport * from \"./BackendLoggerCategory\";\r\nexport * from \"./Material\";\r\nexport * from \"./Model\";\r\nexport * from \"./NavigationRelationship\";\r\nexport * from \"./RpcBackend\";\r\nexport * from \"./Schema\";\r\nexport * from \"./SqliteStatement\";\r\nexport * from \"./SQLiteDb\";\r\nexport * from \"./ViewDefinition\";\r\nexport * from \"./BisCoreSchema\";\r\nexport * from \"./ChangedElementsDb\";\r\nexport * from \"./domains/FunctionalSchema\";\r\nexport * from \"./domains/FunctionalElements\";\r\nexport * from \"./domains/GenericSchema\";\r\nexport * from \"./domains/GenericElements\";\r\nexport { IModelJsNative, NativeLoggerCategory } from \"@bentley/imodeljs-native\";\r\nexport * from \"./IModelCloneContext\";\r\nexport * from \"./IModelHost\";\r\nexport * from \"./IModelSchemaLoader\";\r\nexport * from \"./IpcHost\";\r\nexport * from \"./NativeAppStorage\";\r\nexport * from \"./NativeHost\";\r\nexport * from \"./CloudStorageBackend\";\r\nexport * from \"./AliCloudStorageService\";\r\nexport * from \"./DevTools\";\r\nexport * from \"./LocalhostIpcHost\";\r\nexport * from \"./ElementGraphics\";\r\nexport * from \"./workspace/Settings\";\r\nexport * from \"./workspace/SettingsSpecRegistry\";\r\nexport * from \"./workspace/Workspace\";\r\nexport * from \"./IModelDb\"; // must be last\r\n\r\n/** @docs-package-description\r\n * The core-backend package always runs on the computer with a local Briefcase.\r\n \r\n It contains classes that [backend code]($docs/learning/backend/index.md) can use to work with directly with iModels.\r\n /\r\n/\r\n @docs-group-description IModelHost\r\n * Classes for configuring and administering the backend [host]($docs/learning/backend/IModelHost.md).\r\n * See [the learning article]($docs/learning/backend/IModelHost.md).\r\n /\r\n/\r\n @docs-group-description iModels\r\n * Classes for working with [iModels]($docs/learning/iModels.md).\r\n * See [the learning article]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Schema\r\n * Classes for working with [ECSchemas]($docs/learning/backend/SchemasAndElementsInTypeScript.md)\r\n /\r\n/\r\n @docs-group-description Models\r\n * Subclasses of [Models]($docs/BIS/intro/model-fundamentals.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Elements\r\n * Subclasses of [Elements]($docs/BIS/intro/element-fundamentals.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Codes\r\n * Classes for working with [Codes]($docs/BIS/intro/codes.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description ViewDefinitions\r\n * Classes for working with Elements that define what appears in [Views]($docs/learning/frontend/views.md).\r\n * See [the learning articles]($docs/learning/backend/createelements/#orthographicviewdefinition).\r\n /\r\n/\r\n @docs-group-description Relationships\r\n * Classes that describe the [relationships]($docs/bis/intro/relationship-fundamentals.md) between elements.\r\n /\r\n/\r\n @docs-group-description ElementAspects\r\n * Subclasses of [ElementAspects]($docs/bis/intro/elementaspect-fundamentals.md).\r\n * See [the learning articles]($docs/learning/backend/index.md).\r\n /\r\n/\r\n @docs-group-description Categories\r\n * Classes for [Categories]($docs/bis/intro/categories.md).\r\n /\r\n/\r\n @docs-group-description Symbology\r\n * Classes for defining the appearance of element geometry\r\n /\r\n/\r\n @docs-group-description ECDb\r\n * Classes for working with ECDb.\r\n /\r\n/\r\n @docs-group-description SQLiteDb\r\n * Classes for working with SQLiteDb.\r\n /\r\n/\r\n @docs-group-description NativeApp\r\n * Classes for working with Mobile/Desktop Application.\r\n /\r\n/\r\n @docs-group-description ECSQL\r\n * Classes for working with [ECSQL]($docs/learning/ECSQL.md)\r\n /\r\n/\r\n @docs-group-description SQLite\r\n * Classes for working directly with SQLite\r\n /\r\n/\r\n @docs-group-description Portability\r\n * Classes to help write [portable apps]($docs/learning/Portability.md) and libraries that will run on any platform, including web apps, node services, Electron desktops apps, and mobile apps.\r\n /\r\n/\r\n @docs-group-description Utils\r\n * Miscellaneous utility classes.\r\n /\r\n/\r\n @docs-group-description Logging\r\n * Logger categories used by this package.\r\n /\r\n/\r\n @docs-group-description RpcInterface\r\n * Classes for working with [RpcInterfaces]($docs/learning/RpcInterface.md).\r\n /\r\n/\r\n @docs-group-description CloudStorageBackend\r\n * Classes for working with cloud storage.\r\n /\r\n/\r\n @docs-group-description AliCloudStorageService\r\n * Classes for working with cloud storage using AliCloud.\r\n /\r\n/\r\n @docs-group-description Authentication\r\n * Classes for working with Authentication.\r\n /\r\n/\r\n @docs-group-description Tiles\r\n * APIs for working with tile graphics.\r\n /\r\n/\r\n @docs-group-description HubAccess\r\n * APIs for working with IModelHub\r\n /\r\n/\r\n @docs-group-description Workspace\r\n * APIs for loading and using Settings and Workspace resources\r\n */\r\n"]}

package/lib/cjs/workspace/Settings.d.ts ADDED Viewed

@@ -0,0 +1,180 @@
+/** @packageDocumentation
+ * @module Workspace
+ */
+import { BeEvent, JSONSchemaType } from "@itwin/core-bentley";
+import { LocalFileName } from "@itwin/core-common";
+/** The type of a Setting, according to its schema
+ * @beta
+ */
+export declare type SettingType = JSONSchemaType;
+/**
+ * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSpec]].
+ * @see [SettingName]($docs/learning/backend/Workspace#settingnames)
+ * @beta
+ */
+export declare type SettingName = string;
+/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.
+ * DictionaryNames must be valid JavaScript property names.
+ * @beta
+ */
+export declare type DictionaryName = string;
+/**
+ * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The
+ * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.
+ * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,
+ * applications can "combine" the prioritized Setting values as appropriate. The default implementation of this function
+ * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority
+ * value is returned.
+ * @beta
+ */
+export declare type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;
+/** An entry in the array returned by [[Settings.inspectSetting]]
+ * @beta
+ *
+ */
+export interface SettingInspector<T> {
+    value: T;
+    dictionary: DictionaryName;
+    priority: number;
+}
+/** An object with string-named members (as opposed to an array object).
+ * @beta
+ */
+export interface SettingObject {
+    [name: string]: SettingType;
+}
+/**
+ * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but
+ * may also be created in memory by applications
+ * @beta
+ */
+export declare type SettingDictionary = SettingObject;
+/**
+ * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.
+ * @beta
+*/
+export declare enum SettingsPriority {
+    /** values supplied default-settings files */
+    defaults = 100,
+    /** values supplied by applications at runtime */
+    application = 200,
+    /** values that apply to all iTwins for an organization. */
+    organization = 300,
+    /** values that apply to all iModels in an iTwin. */
+    iTwin = 400,
+    /** values that apply to a single iModel. */
+    iModel = 500
+}
+/** The current set of Settings for a Workspace.
+ * @beta
+ */
+export interface Settings {
+    /** Event raised whenever a SettingsDictionary is added or removed. */
+    readonly onSettingsChanged: BeEvent<() => void>;
+    /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read
+     * and parsed and the fileName is used as the DictionaryName.
+     * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.
+     * @param priority the SettingsPriority for the SettingDictionary
+     * @note If the SettingDictionary was previously added, the new content overrides the old content.
+     */
+    addFile(fileName: LocalFileName, priority: SettingsPriority): void;
+    /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.
+     * @param dictionaryName the name of the SettingDictionary
+     * @param priority the SettingsPriority for the SettingDictionary
+     * @param settingsJson the JSON5 stringified string to be parsed.
+     * @note If the SettingDictionary was previously added, the new content overrides the old content.
+     */
+    addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;
+    /** Add a SettingDictionary object.
+     * @param dictionaryName the name of the SettingDictionary
+     * @param priority the SettingsPriority for the SettingDictionary
+     * @param settings the SettingDictionary object to be added.
+     * @note If the SettingDictionary was previously added, the new content overrides the old content.
+     */
+    addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;
+    /** Remove a SettingDictionary by name. */
+    dropDictionary(dictionaryName: DictionaryName): void;
+    /**
+     * Resolve a setting, by name, using a SettingResolver.
+     * @param settingName The name of the setting to resolve
+     * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.
+     * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.
+     * @returns the resolved setting value.
+     */
+    resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;
+    resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;
+    /** Get the highest priority setting for a SettingName.
+     * @param settingName The name of the setting
+     * @param defaultValue value returned if settingName is not present in any SettingDictionary.
+     * @note This method is generic on SettingType, but no type checking is actually performed at run time. So, if you
+     * use this method to get a setting with an expected type, but its value is a different type, the return type of this method will be wrong.
+     * You must always type check the result. Use the non-generic "get" methods (e.g. [[getString]]) if you only want the value
+     * if its type is correct.
+     */
+    getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;
+    /** Get a string setting by SettingName.
+     * @param settingName The name of the setting
+     * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a string.
+     */
+    getString(settingName: SettingName, defaultValue: string): string;
+    getString(settingName: SettingName, defaultValue?: string): string | undefined;
+    /** Get a boolean setting by SettingName.
+    * @param settingName The name of the setting
+    * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a boolean.
+    */
+    getBoolean(settingName: SettingName, defaultValue: boolean): boolean;
+    getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;
+    /** Get a number setting by SettingName.
+    * @param settingName The name of the setting
+    * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a number.
+    */
+    getNumber(settingName: SettingName, defaultValue: number): number;
+    getNumber(settingName: SettingName): number | undefined;
+    /** Get an object setting by SettingName.
+    * @param settingName The name of the setting
+    * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an object.
+    */
+    getObject(settingName: SettingName, defaultValue: SettingObject): SettingObject;
+    getObject(settingName: SettingName): SettingObject | undefined;
+    /** Get an array setting by SettingName.
+    * @param settingName The name of the setting
+    * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.
+    */
+    getArray<T>(settingName: SettingName, defaultValue: Array<T>): Array<T>;
+    getArray<T>(settingName: SettingName): Array<T> | undefined;
+    /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.
+     * @note this method is mainly for debugging and diagnostics.
+     */
+    inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];
+}
+/**
+ * Internal implementation of Settings interface.
+ * @internal
+ */
+export declare class ITwinSettings implements Settings {
+    private _dictionaries;
+    readonly onSettingsChanged: BeEvent<() => void>;
+    private updateDefaults;
+    constructor();
+    addFile(fileName: LocalFileName, priority: SettingsPriority): void;
+    addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string): void;
+    addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary): void;
+    dropDictionary(dictionaryName: DictionaryName, raiseEvent?: boolean): boolean;
+    resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;
+    getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined;
+    /** for debugging. Returns an array of all values for a setting, sorted by priority.
+     * @note values are not cloned. Do not modify objects or arrays.
+     */
+    inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];
+    getString(name: SettingName, defaultValue: string): string;
+    getString(name: SettingName): string | undefined;
+    getBoolean(name: SettingName, defaultValue: boolean): boolean;
+    getBoolean(name: SettingName): boolean | undefined;
+    getNumber(name: SettingName, defaultValue: number): number;
+    getNumber(name: SettingName): number | undefined;
+    getObject(name: SettingName, defaultValue: SettingObject): SettingObject;
+    getObject(name: SettingName): SettingObject | undefined;
+    getArray<T>(name: SettingName, defaultValue: Array<T>): Array<T>;
+    getArray<T>(name: SettingName): Array<T> | undefined;
+}
+//# sourceMappingURL=Settings.d.ts.map