@itwin/core-backend 4.6.0-dev.22 → 4.6.0-dev.23

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAA8E;AAC9E,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAE3C,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IAEtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE;YACvC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;SACtD;aAAM;YACL,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;SAC1F;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE;YACb,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAChC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE;oBACxC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;wBACnC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS;4BAC3B,OAAO,WAA0B,CAAC;wBACpC,IAAI;4BACF,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE;gCAChD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK;oCACzC,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACvJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;6BAC7E;4BACD,OAAO,EAAE,CAAC;yBACX;wBAAC,OAAO,KAAU,EAAE;4BACnB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;yBACtE;qBACF;iBACF;aACF;SACF;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAGO,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChI,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YACf,OAAO,aAAa,CAAC;QAEvB,IAAI;YACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO,MAAM,gBAAgB,CAAC;SAC/B;gBAAS;YACR,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,oCAAoC;SAC3E;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,sJAAsJ;QACtJ,MAAM,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAQD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE;YACvE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,8CAA8C;aAC/E;YACD,qFAAqF;YACrF,OAAO,WAAW,CAAC;SACpB;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YACtE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,wBAAwB;QACxB,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE;YACN,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,UAAU,CAAC,CAAC;YAC3E,OAAO,EAAE,CAAC;SACX;QAED,IAAI;YACF,wBAAwB;YACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;YACxD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;SACpE;QAAC,OAAO,CAAC,EAAE;YACV,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8DAA8D,EAAE,EAAE,KAAK,EAAE,2BAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;YAEzJ,mKAAmK;YACnK,MAAM,OAAO,GAAG;gBACd,UAAU;gBACV,SAAS,EAAE,uCAAmB,CAAC,WAAW,CAAC,UAAU,CAAC;gBACtD,UAAU,EAAE,EAAE;aACf,CAAC;YACF,EAAE,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,uCAAmB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;YAElF,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8BAA8B,EAAE,UAAU,CAAC,CAAC;gBAC5E,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,8CAA8C;aAC/E;YACD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,EAAE,UAAU,CAAC,CAAC;SACrE;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAQM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,IAAI,UAAU,CAAC,QAAQ;YACrB,MAAM,uBAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChE,mDAAmD;QACnD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;;AA7Gc,sCAAkB,GAAsC,IAAI,GAAG,EAAE,CAAC;AA7DtE,kDAAmB","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 RpcInterface\r\n */\r\n\r\nimport { AccessToken, assert, BeDuration, BentleyError, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\r\nimport { CheckpointManager, V1CheckpointManager } from \"../CheckpointManager\";\r\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\r\n\r\n/** @internal */\r\nexport interface DownloadAndOpenArgs {\r\n  activity: RpcActivity; // eslint-disable-line deprecation/deprecation\r\n  tokenProps: IModelRpcOpenProps;\r\n  syncMode: SyncMode;\r\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\r\n  timeout?: number;\r\n  forceDownload?: boolean;\r\n}\r\n/**\r\n * Utility to open the iModel for RPC interfaces\r\n * @internal\r\n */\r\nexport class RpcBriefcaseUtility {\r\n\r\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    const { activity, tokenProps } = args;\r\n    const accessToken = activity.accessToken;\r\n    assert(undefined !== tokenProps.iModelId);\r\n\r\n    const iModelId = tokenProps.iModelId;\r\n    let myBriefcaseIds: number[];\r\n    if (args.syncMode === SyncMode.PullOnly) {\r\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\r\n    } else {\r\n      // check with iModelHub and see if we already have acquired any briefcaseIds\r\n      myBriefcaseIds = await IModelHost.hubAccess.getMyBriefcaseIds({ accessToken, iModelId });\r\n    }\r\n\r\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\r\n\r\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\r\n    if (resolvers) {\r\n      for (const resolver of resolvers) {\r\n        for (const briefcaseId of myBriefcaseIds) {\r\n          const fileName = resolver({ briefcaseId, iModelId });\r\n          if (IModelJsFs.existsSync(fileName)) {\r\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\r\n            if (briefcaseDb !== undefined)\r\n              return briefcaseDb as BriefcaseDb;\r\n            try {\r\n              if (args.forceDownload)\r\n                throw new Error(); // causes delete below\r\n              const db = await BriefcaseDb.open({ fileName });\r\n              if (db.changeset.id !== tokenProps.changeset?.id) {\r\n                assert(undefined !== tokenProps.changeset);\r\n                const toIndex = tokenProps.changeset?.index ??\r\n                  (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\r\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\r\n              }\r\n              return db;\r\n            } catch (error: any) {\r\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\r\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\r\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\r\n            }\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    // no local briefcase available. Download one and open it.\r\n    assert(undefined !== tokenProps.iTwinId);\r\n    const request: RequestNewBriefcaseArg = {\r\n      accessToken,\r\n      iTwinId: tokenProps.iTwinId,\r\n      iModelId,\r\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\r\n    };\r\n\r\n    const props = await BriefcaseManager.downloadBriefcase(request);\r\n    return BriefcaseDb.open(props);\r\n  }\r\n\r\n  private static _briefcasePromises: Map<string, Promise<BriefcaseDb>> = new Map();\r\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    const key = `${args.tokenProps.iModelId}:${args.tokenProps.changeset?.id}:${args.tokenProps.changeset?.index}:${args.syncMode}`;\r\n    const cachedPromise = this._briefcasePromises.get(key);\r\n    if (cachedPromise)\r\n      return cachedPromise;\r\n\r\n    try {\r\n      const briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\r\n      this._briefcasePromises.set(key, briefcasePromise);\r\n      return await briefcasePromise;\r\n    } finally {\r\n      this._briefcasePromises.delete(key);  // the download and open is now done\r\n    }\r\n  }\r\n\r\n  /** find a previously opened iModel for RPC.\r\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\r\n   * to refresh the daemon, even though it will be used for all authorized users.\r\n   * @param the IModelRpcProps to locate the opened iModel.\r\n   */\r\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\r\n    const iModelDb = IModelDb.findByKey(iModel.key);\r\n\r\n    // call refreshContainer, just in case this is a V2 checkpoint whose sasToken is about to expire, or its default transaction is about to be restarted.\r\n    await iModelDb.refreshContainerForRpc(accessToken);\r\n    return iModelDb;\r\n  }\r\n\r\n  public static async open(args: DownloadAndOpenArgs & { syncMode: SyncMode.FixedVersion }): Promise<IModelDb>;\r\n  /**\r\n   * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\r\n  public static async open(args: DownloadAndOpenArgs & { syncMode: Exclude<SyncMode, \"FixedVersion\"> }): Promise<IModelDb>;\r\n  /**\r\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\r\n   * a RpcPendingResponse exception is thrown\r\n   */\r\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\r\n    const { activity, tokenProps, syncMode } = args;\r\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", tokenProps);\r\n\r\n    const timeout = args.timeout ?? 1000;\r\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\r\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\r\n\r\n      if (briefcaseDb === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", tokenProps);\r\n        throw new RpcPendingResponse(); // eslint-disable-line deprecation/deprecation\r\n      }\r\n      // note: usage is logged in the function BriefcaseManager.downloadNewBriefcaseAndOpen\r\n      return briefcaseDb;\r\n    }\r\n    if (!tokenProps.iModelId || !tokenProps.iTwinId || !tokenProps.changeset)\r\n      throw new IModelError(IModelStatus.BadArg, \"invalid arguments\");\r\n\r\n    const checkpoint = {\r\n      iModelId: tokenProps.iModelId,\r\n      iTwinId: tokenProps.iTwinId,\r\n      changeset: tokenProps.changeset,\r\n      accessToken: activity.accessToken,\r\n    };\r\n\r\n    // opening a checkpoint.\r\n    let db: SnapshotDb | void;\r\n    // first check if it's already open\r\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\r\n    if (db) {\r\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", tokenProps);\r\n      return db;\r\n    }\r\n\r\n    try {\r\n      // now try V2 checkpoint\r\n      db = await SnapshotDb.openCheckpointFromRpc(checkpoint);\r\n      Logger.logTrace(loggerCategory, \"using V2 checkpoint\", tokenProps);\r\n    } catch (e) {\r\n      Logger.logTrace(loggerCategory, \"unable to open V2 checkpoint - falling back to V1 checkpoint\", { error: BentleyError.getErrorProps(e), ...tokenProps });\r\n\r\n      // this isn't a v2 checkpoint. Set up a race between the specified timeout period and the open. Throw an RpcPendingResponse exception if the timeout happens first.\r\n      const request = {\r\n        checkpoint,\r\n        localFile: V1CheckpointManager.getFileName(checkpoint),\r\n        aliasFiles: [],\r\n      };\r\n      db = await BeDuration.race(timeout, V1CheckpointManager.getCheckpointDb(request));\r\n\r\n      if (db === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open V1 checkpoint - pending\", tokenProps);\r\n        throw new RpcPendingResponse(); // eslint-disable-line deprecation/deprecation\r\n      }\r\n      Logger.logTrace(loggerCategory, \"Opened V1 checkpoint\", tokenProps);\r\n    }\r\n\r\n    return db;\r\n  }\r\n\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;\r\n  /**\r\n   * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, \"FixedVersion\">, timeout?: number): Promise<IModelConnectionProps>;\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> { // eslint-disable-line deprecation/deprecation\r\n    if (tokenProps.iModelId)\r\n      await IModelHost.tileStorage?.initialize(tokenProps.iModelId);\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0G;AAC1G,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAA8E;AAC9E,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAE3C,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IAEtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;QACvD,CAAC;aAAM,CAAC;YACN,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;oBACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACpC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS;4BAC3B,OAAO,WAA0B,CAAC;wBACpC,IAAI,CAAC;4BACH,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC;gCACjD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK;oCACzC,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACvJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;4BAC9E,CAAC;4BACD,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAAC,OAAO,KAAU,EAAE,CAAC;4BACpB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;wBACvE,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAGO,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChI,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YACf,OAAO,aAAa,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO,MAAM,gBAAgB,CAAC;QAChC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,oCAAoC;QAC5E,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,sJAAsJ;QACtJ,MAAM,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAQD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE,CAAC;YACxE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,8CAA8C;YAChF,CAAC;YACD,qFAAqF;YACrF,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YACtE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,wBAAwB;QACxB,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,UAAU,CAAC,CAAC;YAC3E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,CAAC;YACH,wBAAwB;YACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;YACxD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;QACrE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8DAA8D,EAAE,EAAE,KAAK,EAAE,2BAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;YAEzJ,mKAAmK;YACnK,MAAM,OAAO,GAAG;gBACd,UAAU;gBACV,SAAS,EAAE,uCAAmB,CAAC,WAAW,CAAC,UAAU,CAAC;gBACtD,UAAU,EAAE,EAAE;aACf,CAAC;YACF,EAAE,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,uCAAmB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;YAElF,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8BAA8B,EAAE,UAAU,CAAC,CAAC;gBAC5E,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,8CAA8C;YAChF,CAAC;YACD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,EAAE,UAAU,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAQM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,IAAI,UAAU,CAAC,QAAQ;YACrB,MAAM,uBAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChE,mDAAmD;QACnD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;;AA1KH,kDA4KC;AA/GgB,sCAAkB,GAAsC,IAAI,GAAG,EAAE,CAAC","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 RpcInterface\r\n */\r\n\r\nimport { AccessToken, assert, BeDuration, BentleyError, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\r\nimport { CheckpointManager, V1CheckpointManager } from \"../CheckpointManager\";\r\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\r\n\r\n/** @internal */\r\nexport interface DownloadAndOpenArgs {\r\n  activity: RpcActivity; // eslint-disable-line deprecation/deprecation\r\n  tokenProps: IModelRpcOpenProps;\r\n  syncMode: SyncMode;\r\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\r\n  timeout?: number;\r\n  forceDownload?: boolean;\r\n}\r\n/**\r\n * Utility to open the iModel for RPC interfaces\r\n * @internal\r\n */\r\nexport class RpcBriefcaseUtility {\r\n\r\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    const { activity, tokenProps } = args;\r\n    const accessToken = activity.accessToken;\r\n    assert(undefined !== tokenProps.iModelId);\r\n\r\n    const iModelId = tokenProps.iModelId;\r\n    let myBriefcaseIds: number[];\r\n    if (args.syncMode === SyncMode.PullOnly) {\r\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\r\n    } else {\r\n      // check with iModelHub and see if we already have acquired any briefcaseIds\r\n      myBriefcaseIds = await IModelHost.hubAccess.getMyBriefcaseIds({ accessToken, iModelId });\r\n    }\r\n\r\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\r\n\r\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\r\n    if (resolvers) {\r\n      for (const resolver of resolvers) {\r\n        for (const briefcaseId of myBriefcaseIds) {\r\n          const fileName = resolver({ briefcaseId, iModelId });\r\n          if (IModelJsFs.existsSync(fileName)) {\r\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\r\n            if (briefcaseDb !== undefined)\r\n              return briefcaseDb as BriefcaseDb;\r\n            try {\r\n              if (args.forceDownload)\r\n                throw new Error(); // causes delete below\r\n              const db = await BriefcaseDb.open({ fileName });\r\n              if (db.changeset.id !== tokenProps.changeset?.id) {\r\n                assert(undefined !== tokenProps.changeset);\r\n                const toIndex = tokenProps.changeset?.index ??\r\n                  (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\r\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\r\n              }\r\n              return db;\r\n            } catch (error: any) {\r\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\r\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\r\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\r\n            }\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    // no local briefcase available. Download one and open it.\r\n    assert(undefined !== tokenProps.iTwinId);\r\n    const request: RequestNewBriefcaseArg = {\r\n      accessToken,\r\n      iTwinId: tokenProps.iTwinId,\r\n      iModelId,\r\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\r\n    };\r\n\r\n    const props = await BriefcaseManager.downloadBriefcase(request);\r\n    return BriefcaseDb.open(props);\r\n  }\r\n\r\n  private static _briefcasePromises: Map<string, Promise<BriefcaseDb>> = new Map();\r\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    const key = `${args.tokenProps.iModelId}:${args.tokenProps.changeset?.id}:${args.tokenProps.changeset?.index}:${args.syncMode}`;\r\n    const cachedPromise = this._briefcasePromises.get(key);\r\n    if (cachedPromise)\r\n      return cachedPromise;\r\n\r\n    try {\r\n      const briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\r\n      this._briefcasePromises.set(key, briefcasePromise);\r\n      return await briefcasePromise;\r\n    } finally {\r\n      this._briefcasePromises.delete(key);  // the download and open is now done\r\n    }\r\n  }\r\n\r\n  /** find a previously opened iModel for RPC.\r\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\r\n   * to refresh the daemon, even though it will be used for all authorized users.\r\n   * @param the IModelRpcProps to locate the opened iModel.\r\n   */\r\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\r\n    const iModelDb = IModelDb.findByKey(iModel.key);\r\n\r\n    // call refreshContainer, just in case this is a V2 checkpoint whose sasToken is about to expire, or its default transaction is about to be restarted.\r\n    await iModelDb.refreshContainerForRpc(accessToken);\r\n    return iModelDb;\r\n  }\r\n\r\n  public static async open(args: DownloadAndOpenArgs & { syncMode: SyncMode.FixedVersion }): Promise<IModelDb>;\r\n  /**\r\n   * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\r\n  public static async open(args: DownloadAndOpenArgs & { syncMode: Exclude<SyncMode, \"FixedVersion\"> }): Promise<IModelDb>;\r\n  /**\r\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\r\n   * a RpcPendingResponse exception is thrown\r\n   */\r\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\r\n    const { activity, tokenProps, syncMode } = args;\r\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", tokenProps);\r\n\r\n    const timeout = args.timeout ?? 1000;\r\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\r\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\r\n\r\n      if (briefcaseDb === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", tokenProps);\r\n        throw new RpcPendingResponse(); // eslint-disable-line deprecation/deprecation\r\n      }\r\n      // note: usage is logged in the function BriefcaseManager.downloadNewBriefcaseAndOpen\r\n      return briefcaseDb;\r\n    }\r\n    if (!tokenProps.iModelId || !tokenProps.iTwinId || !tokenProps.changeset)\r\n      throw new IModelError(IModelStatus.BadArg, \"invalid arguments\");\r\n\r\n    const checkpoint = {\r\n      iModelId: tokenProps.iModelId,\r\n      iTwinId: tokenProps.iTwinId,\r\n      changeset: tokenProps.changeset,\r\n      accessToken: activity.accessToken,\r\n    };\r\n\r\n    // opening a checkpoint.\r\n    let db: SnapshotDb | void;\r\n    // first check if it's already open\r\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\r\n    if (db) {\r\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", tokenProps);\r\n      return db;\r\n    }\r\n\r\n    try {\r\n      // now try V2 checkpoint\r\n      db = await SnapshotDb.openCheckpointFromRpc(checkpoint);\r\n      Logger.logTrace(loggerCategory, \"using V2 checkpoint\", tokenProps);\r\n    } catch (e) {\r\n      Logger.logTrace(loggerCategory, \"unable to open V2 checkpoint - falling back to V1 checkpoint\", { error: BentleyError.getErrorProps(e), ...tokenProps });\r\n\r\n      // this isn't a v2 checkpoint. Set up a race between the specified timeout period and the open. Throw an RpcPendingResponse exception if the timeout happens first.\r\n      const request = {\r\n        checkpoint,\r\n        localFile: V1CheckpointManager.getFileName(checkpoint),\r\n        aliasFiles: [],\r\n      };\r\n      db = await BeDuration.race(timeout, V1CheckpointManager.getCheckpointDb(request));\r\n\r\n      if (db === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open V1 checkpoint - pending\", tokenProps);\r\n        throw new RpcPendingResponse(); // eslint-disable-line deprecation/deprecation\r\n      }\r\n      Logger.logTrace(loggerCategory, \"Opened V1 checkpoint\", tokenProps);\r\n    }\r\n\r\n    return db;\r\n  }\r\n\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;\r\n  /**\r\n   * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, \"FixedVersion\">, timeout?: number): Promise<IModelConnectionProps>;\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> { // eslint-disable-line deprecation/deprecation\r\n    if (tokenProps.iModelId)\r\n      await IModelHost.tileStorage?.initialize(tokenProps.iModelId);\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\r\n  }\r\n\r\n}\r\n"]}

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"SnapshotIModelRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/SnapshotIModelRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAE4B;AAC5B,0CAAyC;AACzC,8CAA2C;AAE3C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,0BAAY;IAC9C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,wCAA0B,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExG,kGAAkG;IAC3F,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAA0B;QAChE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,uBAAU,CAAC,wBAAwB,EAAE;YACvC,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACpF,IAAI,SAAS,KAAK,gBAAgB;gBAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC;SACtC;QACD,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAA0B;QACjE,MAAM,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC;QAErC,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC/F,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,KAAK,CAAC,UAA0B;QAC3C,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,sDA4BC","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 RpcInterface\r\n */\r\n\r\nimport {\r\n  IModelConnectionProps, IModelNotFoundResponse, IModelRpcProps, RpcInterface, RpcManager, SnapshotIModelRpcInterface, SnapshotOpenOptions,\r\n} from \"@itwin/core-common\";\r\nimport { SnapshotDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\n\r\n/** The backend implementation of SnapshotIModelRpcInterface.\r\n * @internal\r\n */\r\nexport class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface { // eslint-disable-line deprecation/deprecation\r\n  public static register() { RpcManager.registerImpl(SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }\r\n\r\n  /** Ask the backend to open a snapshot iModel from a file name that is resolved by the backend. */\r\n  public async openFile(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\r\n    let resolvedFileName: string | undefined = filePath;\r\n    if (IModelHost.snapshotFileNameResolver) {\r\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath);\r\n      if (undefined === resolvedFileName)\r\n        throw new IModelNotFoundResponse();\r\n    }\r\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\r\n  }\r\n\r\n  /** Ask the backend to open a snapshot iModel from a key that is resolved by the backend. */\r\n  public async openRemote(fileKey: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\r\n    const resolvedFileName = IModelHost.snapshotFileNameResolver?.resolveKey(fileKey);\r\n    if (undefined === resolvedFileName)\r\n      throw new IModelNotFoundResponse();\r\n\r\n    return SnapshotDb.openFile(resolvedFileName, { key: fileKey, ...opts }).getConnectionProps();\r\n  }\r\n\r\n  /** Ask the backend to close a snapshot iModel. */\r\n  public async close(tokenProps: IModelRpcProps): Promise<boolean> {\r\n    SnapshotDb.findByKey(tokenProps.key).close();\r\n    return true;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SnapshotIModelRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/SnapshotIModelRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAE4B;AAC5B,0CAAyC;AACzC,8CAA2C;AAE3C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,0BAAY;IAC9C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,wCAA0B,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExG,kGAAkG;IAC3F,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAA0B;QAChE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,uBAAU,CAAC,wBAAwB,EAAE,CAAC;YACxC,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACpF,IAAI,SAAS,KAAK,gBAAgB;gBAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC;QACvC,CAAC;QACD,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAA0B;QACjE,MAAM,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC;QAErC,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC/F,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,KAAK,CAAC,UAA0B;QAC3C,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,sDA4BC","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 RpcInterface\r\n */\r\n\r\nimport {\r\n  IModelConnectionProps, IModelNotFoundResponse, IModelRpcProps, RpcInterface, RpcManager, SnapshotIModelRpcInterface, SnapshotOpenOptions,\r\n} from \"@itwin/core-common\";\r\nimport { SnapshotDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\n\r\n/** The backend implementation of SnapshotIModelRpcInterface.\r\n * @internal\r\n */\r\nexport class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface { // eslint-disable-line deprecation/deprecation\r\n  public static register() { RpcManager.registerImpl(SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }\r\n\r\n  /** Ask the backend to open a snapshot iModel from a file name that is resolved by the backend. */\r\n  public async openFile(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\r\n    let resolvedFileName: string | undefined = filePath;\r\n    if (IModelHost.snapshotFileNameResolver) {\r\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath);\r\n      if (undefined === resolvedFileName)\r\n        throw new IModelNotFoundResponse();\r\n    }\r\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\r\n  }\r\n\r\n  /** Ask the backend to open a snapshot iModel from a key that is resolved by the backend. */\r\n  public async openRemote(fileKey: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\r\n    const resolvedFileName = IModelHost.snapshotFileNameResolver?.resolveKey(fileKey);\r\n    if (undefined === resolvedFileName)\r\n      throw new IModelNotFoundResponse();\r\n\r\n    return SnapshotDb.openFile(resolvedFileName, { key: fileKey, ...opts }).getConnectionProps();\r\n  }\r\n\r\n  /** Ask the backend to close a snapshot iModel. */\r\n  public async close(tokenProps: IModelRpcProps): Promise<boolean> {\r\n    SnapshotDb.findByKey(tokenProps.key).close();\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/cjs/workspace/Settings.js

@@ -29,7 +29,7 @@ var SettingsPriority;
     SettingsPriority[SettingsPriority["iTwin"] = 400] = "iTwin";
     /** values that apply to a single iModel. */
     SettingsPriority[SettingsPriority["iModel"] = 500] = "iModel";
-})(SettingsPriority = exports.SettingsPriority || (exports.SettingsPriority = {}));
+})(SettingsPriority || (exports.SettingsPriority = SettingsPriority = {}));
 /** @internal */
 function deepClone(obj) {
     if (!obj || typeof obj !== "object")

package/lib/cjs/workspace/Settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAA8D;AAE9D,8CAA2C;AAmD3C;;;EAGE;AACF,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,6CAA6C;IAC7C,iEAAc,CAAA;IACd,iDAAiD;IACjD,uEAAiB,CAAA;IACjB,2DAA2D;IAC3D,yEAAkB,CAAA;IAClB,oDAAoD;IACpD,2DAAW,CAAA;IACX,4CAA4C;IAC5C,6DAAY,CAAA;AACd,CAAC,EAXW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAW3B;AAyGD,gBAAgB;AAChB,SAAS,SAAS,CAAwB,GAAQ;IAChD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QACjC,OAAO,GAAG,CAAC;IAEb,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;IACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;SAC9B;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,kBAAkB;IACtB,YAAmC,IAAY,EAAkB,QAA0B,EAAkB,QAA2B;QAArG,SAAI,GAAJ,IAAI,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAkB;QAAkB,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACtI,UAAU,CAAwB,WAAmB;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;IACrD,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,YAAY;IAAzB;QACU,kBAAa,GAAyB,EAAE,CAAC;QAGjC,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAyGhE,CAAC;IA3GW,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IAGX,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;SACnD;IACH,CAAC;IAEM,OAAO,CAAC,cAAsB,EAAE,QAA0B,EAAE,YAAoB;QACrF,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,aAAa,CAAC,cAAsB,EAAE,QAA0B,EAAE,QAA2B;QAClG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QAChG,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACnD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACtC,OAAO;iBACR;aACF;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,cAAc,CAAC,cAA8B,EAAE,UAAU,GAAG,IAAI;QACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE;gBACjD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,cAAc,CAAwB,IAAiB,EAAE,QAA4B,EAAE,YAAgB;QAC5G,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAkB,CAAC;YACnD,MAAM,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,SAAS,KAAK,QAAQ,EAAE;gBAC1B,OAAO,QAAQ,CAAC;aACjB;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,UAAU,CAAwB,IAAiB,EAAE,YAAgB;QAC1E,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAI,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,cAAc,CAAwB,IAAiB;QAC5D,MAAM,GAAG,GAA0B,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,CAAI,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE;YAC3D,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC;IAIM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACvD,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAgB,IAAI,CAAC,CAAC;QACjD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3D,CAAC;IAGM,QAAQ,CAAwB,IAAiB,EAAE,YAAuB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAW,IAAI,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;CACF;AA7GD,oCA6GC","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 Workspace\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/** The type of a Setting, according to its schema\r\n * @beta\r\n */\r\nexport type SettingType = JSONSchemaType;\r\n\r\n/**\r\n * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSchema]].\r\n * @see [SettingName]($docs/learning/backend/Workspace#settingnames)\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.\r\n * DictionaryNames must be valid JavaScript property names.\r\n * @beta\r\n */\r\nexport type DictionaryName = string;\r\n\r\n/**\r\n * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The\r\n * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.\r\n * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,\r\n * applications can \"combine\" the prioritized Setting values as appropriate. The default implementation of this function\r\n * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority\r\n * value is returned.\r\n * @beta\r\n */\r\nexport type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;\r\n\r\n/** An entry in the array returned by [[Settings.inspectSetting]]\r\n * @beta\r\n *\r\n */\r\nexport interface SettingInspector<T> { value: T, dictionary: DictionaryName, priority: number }\r\n\r\n/** An object with string-named members (as opposed to an array object).\r\n * @beta\r\n */\r\nexport interface SettingObject {\r\n  [name: string]: SettingType;\r\n}\r\n\r\n/**\r\n * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but\r\n * may also be created in memory by applications\r\n * @beta\r\n */\r\nexport type SettingDictionary = SettingObject;\r\n\r\n/**\r\n * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.\r\n * @beta\r\n*/\r\nexport enum SettingsPriority {\r\n  /** values supplied default-settings files */\r\n  defaults = 100,\r\n  /** values supplied by applications at runtime */\r\n  application = 200,\r\n  /** values that apply to all iTwins for an organization. */\r\n  organization = 300,\r\n  /** values that apply to all iModels in an iTwin. */\r\n  iTwin = 400,\r\n  /** values that apply to a single iModel. */\r\n  iModel = 500,\r\n}\r\n\r\n/** The current set of Settings for a Workspace.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** Event raised whenever a SettingsDictionary is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read\r\n   * and parsed and the fileName is used as the DictionaryName.\r\n   * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Add all files in the supplied directory with the extension \".json\" or \".json5\"\r\n   * @param dirName the name of a local settings directory\r\n   */\r\n  addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settingsJson the JSON5 stringified string to be parsed.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;\r\n\r\n  /** Add a SettingDictionary object.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settings the SettingDictionary object to be added.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;\r\n\r\n  /** Remove a SettingDictionary by name. */\r\n  dropDictionary(dictionaryName: DictionaryName): void;\r\n\r\n  /**\r\n   * Resolve a setting, by name, using a SettingResolver.\r\n   * @param settingName The name of the setting to resolve\r\n   * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.\r\n   * @returns the resolved setting value.\r\n   */\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;\r\n\r\n  /** Get the highest priority setting for a SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary.\r\n   * @note This method is generic on SettingType, but no type checking is actually performed at run time. So, if you\r\n   * 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.\r\n   * You must always type check the result. Use the non-generic \"get\" methods (e.g. [[getString]]) if you only want the value\r\n   * if its type is correct.\r\n   */\r\n  getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Get a string setting by SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a string.\r\n   */\r\n  getString(settingName: SettingName, defaultValue: string): string;\r\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\r\n\r\n  /** Get a boolean setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a boolean.\r\n  */\r\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\r\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\r\n\r\n  /** Get a number setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a number.\r\n  */\r\n  getNumber(settingName: SettingName, defaultValue: number): number;\r\n  getNumber(settingName: SettingName): number | undefined;\r\n\r\n  /** Get an object setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an object.\r\n  */\r\n  getObject<T extends object>(settingName: SettingName, defaultValue: T): T;\r\n  getObject<T extends object>(settingName: SettingName): T | undefined;\r\n\r\n  /** Get an array setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.\r\n  */\r\n  getArray<T extends SettingType>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends SettingType>(settingName: SettingName): Array<T> | undefined;\r\n\r\n  /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.\r\n   * @note this method is mainly for debugging and diagnostics.\r\n   */\r\n  inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];\r\n}\r\n\r\n/** @internal */\r\nfunction deepClone<T extends SettingType>(obj: any): T {\r\n  if (!obj || typeof obj !== \"object\")\r\n    return obj;\r\n\r\n  const result = Array.isArray(obj) ? [] : {} as any;\r\n  Object.keys(obj).forEach((key: string) => {\r\n    const val = obj[key];\r\n    if (val && typeof val === \"object\") {\r\n      result[key] = deepClone(val);\r\n    } else {\r\n      result[key] = val;\r\n    }\r\n  });\r\n  return result;\r\n}\r\n\r\nclass SettingsDictionary {\r\n  public constructor(public readonly name: string, public readonly priority: SettingsPriority, public readonly settings: SettingDictionary) { }\r\n  public getSetting<T extends SettingType>(settingName: string): SettingType | undefined {\r\n    return this.settings[settingName] as T | undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * Internal implementation of Settings interface.\r\n * @internal\r\n */\r\nexport class BaseSettings implements Settings {\r\n  private _dictionaries: SettingsDictionary[] = [];\r\n  protected verifyPriority(_priority: SettingsPriority) { }\r\n  public close() { }\r\n  public readonly onSettingsChanged = new BeEvent<() => void>();\r\n\r\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\r\n    this.addJson(fileName, priority, fs.readFileSync(fileName, \"utf-8\"));\r\n  }\r\n\r\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName), priority);\r\n    }\r\n  }\r\n\r\n  public addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string) {\r\n    this.addDictionary(dictionaryName, priority, parse(settingsJson));\r\n  }\r\n\r\n  public addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary) {\r\n    this.verifyPriority(priority);\r\n    this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice\r\n    const file = new SettingsDictionary(dictionaryName, priority, settings);\r\n    const doAdd = () => {\r\n      for (let i = 0; i < this._dictionaries.length; ++i) {\r\n        if (this._dictionaries[i].priority <= file.priority) {\r\n          this._dictionaries.splice(i, 0, file);\r\n          return;\r\n        }\r\n      }\r\n      this._dictionaries.push(file);\r\n    };\r\n    doAdd();\r\n    this.onSettingsChanged.raiseEvent();\r\n  }\r\n\r\n  public dropDictionary(dictionaryName: DictionaryName, raiseEvent = true) {\r\n    for (let i = 0; i < this._dictionaries.length; ++i) {\r\n      if (this._dictionaries[i].name === dictionaryName) {\r\n        this._dictionaries.splice(i, 1);\r\n        if (raiseEvent)\r\n          this.onSettingsChanged.raiseEvent();\r\n        return true;\r\n      }\r\n    }\r\n    return false;\r\n  }\r\n\r\n  public resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined {\r\n    for (const dict of this._dictionaries) {\r\n      const val = dict.getSetting(name) as T | undefined;\r\n      const resolved = val && resolver(val, dict.name, dict.priority);\r\n      if (undefined !== resolved) {\r\n        return resolved;\r\n      }\r\n    }\r\n    return defaultValue;\r\n  }\r\n\r\n  public getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined {\r\n    return this.resolveSetting(name, (val) => deepClone<T>(val)) ?? defaultValue;\r\n  }\r\n\r\n  /** for debugging. Returns an array of all values for a setting, sorted by priority.\r\n   * @note values are not cloned. Do not modify objects or arrays.\r\n   */\r\n  public inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[] {\r\n    const all: SettingInspector<T>[] = [];\r\n    this.resolveSetting<T>(name, (value, dictionary, priority) => {\r\n      all.push({ value, dictionary, priority });\r\n      return undefined;\r\n    });\r\n\r\n    return all;\r\n  }\r\n\r\n  public getString(name: SettingName, defaultValue: string): string;\r\n  public getString(name: SettingName): string | undefined;\r\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\r\n    const out = this.getSetting<string>(name);\r\n    return typeof out === \"string\" ? out : defaultValue;\r\n  }\r\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\r\n  public getBoolean(name: SettingName): boolean | undefined;\r\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\r\n    const out = this.getSetting<boolean>(name);\r\n    return typeof out === \"boolean\" ? out : defaultValue;\r\n  }\r\n  public getNumber(name: SettingName, defaultValue: number): number;\r\n  public getNumber(name: SettingName): number | undefined;\r\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\r\n    const out = this.getSetting<number>(name);\r\n    return typeof out === \"number\" ? out : defaultValue;\r\n  }\r\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\r\n  public getObject<T extends object>(name: SettingName): T | undefined;\r\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\r\n    const out = this.getSetting<SettingObject>(name);\r\n    return typeof out === \"object\" ? out as T : defaultValue;\r\n  }\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue: Array<T>): Array<T>;\r\n  public getArray<T extends SettingType>(name: SettingName): Array<T> | undefined;\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue?: Array<T>): Array<T> | undefined {\r\n    const out = this.getSetting<Array<T>>(name);\r\n    return Array.isArray(out) ? out : defaultValue;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAA8D;AAE9D,8CAA2C;AAmD3C;;;EAGE;AACF,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,6CAA6C;IAC7C,iEAAc,CAAA;IACd,iDAAiD;IACjD,uEAAiB,CAAA;IACjB,2DAA2D;IAC3D,yEAAkB,CAAA;IAClB,oDAAoD;IACpD,2DAAW,CAAA;IACX,4CAA4C;IAC5C,6DAAY,CAAA;AACd,CAAC,EAXW,gBAAgB,gCAAhB,gBAAgB,QAW3B;AAyGD,gBAAgB;AAChB,SAAS,SAAS,CAAwB,GAAQ;IAChD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QACjC,OAAO,GAAG,CAAC;IAEb,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;IACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,kBAAkB;IACtB,YAAmC,IAAY,EAAkB,QAA0B,EAAkB,QAA2B;QAArG,SAAI,GAAJ,IAAI,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAkB;QAAkB,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACtI,UAAU,CAAwB,WAAmB;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;IACrD,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,YAAY;IAAzB;QACU,kBAAa,GAAyB,EAAE,CAAC;QAGjC,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAyGhE,CAAC;IA3GW,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IAGX,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEM,OAAO,CAAC,cAAsB,EAAE,QAA0B,EAAE,YAAoB;QACrF,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,aAAa,CAAC,cAAsB,EAAE,QAA0B,EAAE,QAA2B;QAClG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QAChG,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACnD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACpD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACtC,OAAO;gBACT,CAAC;YACH,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,cAAc,CAAC,cAA8B,EAAE,UAAU,GAAG,IAAI;QACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACnD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBAClD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,cAAc,CAAwB,IAAiB,EAAE,QAA4B,EAAE,YAAgB;QAC5G,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAkB,CAAC;YACnD,MAAM,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAC3B,OAAO,QAAQ,CAAC;YAClB,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,UAAU,CAAwB,IAAiB,EAAE,YAAgB;QAC1E,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAI,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,cAAc,CAAwB,IAAiB;QAC5D,MAAM,GAAG,GAA0B,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,CAAI,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE;YAC3D,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC;IAIM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACvD,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAgB,IAAI,CAAC,CAAC;QACjD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3D,CAAC;IAGM,QAAQ,CAAwB,IAAiB,EAAE,YAAuB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAW,IAAI,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;CACF;AA7GD,oCA6GC","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 Workspace\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/** The type of a Setting, according to its schema\r\n * @beta\r\n */\r\nexport type SettingType = JSONSchemaType;\r\n\r\n/**\r\n * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSchema]].\r\n * @see [SettingName]($docs/learning/backend/Workspace#settingnames)\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.\r\n * DictionaryNames must be valid JavaScript property names.\r\n * @beta\r\n */\r\nexport type DictionaryName = string;\r\n\r\n/**\r\n * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The\r\n * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.\r\n * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,\r\n * applications can \"combine\" the prioritized Setting values as appropriate. The default implementation of this function\r\n * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority\r\n * value is returned.\r\n * @beta\r\n */\r\nexport type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;\r\n\r\n/** An entry in the array returned by [[Settings.inspectSetting]]\r\n * @beta\r\n *\r\n */\r\nexport interface SettingInspector<T> { value: T, dictionary: DictionaryName, priority: number }\r\n\r\n/** An object with string-named members (as opposed to an array object).\r\n * @beta\r\n */\r\nexport interface SettingObject {\r\n  [name: string]: SettingType;\r\n}\r\n\r\n/**\r\n * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but\r\n * may also be created in memory by applications\r\n * @beta\r\n */\r\nexport type SettingDictionary = SettingObject;\r\n\r\n/**\r\n * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.\r\n * @beta\r\n*/\r\nexport enum SettingsPriority {\r\n  /** values supplied default-settings files */\r\n  defaults = 100,\r\n  /** values supplied by applications at runtime */\r\n  application = 200,\r\n  /** values that apply to all iTwins for an organization. */\r\n  organization = 300,\r\n  /** values that apply to all iModels in an iTwin. */\r\n  iTwin = 400,\r\n  /** values that apply to a single iModel. */\r\n  iModel = 500,\r\n}\r\n\r\n/** The current set of Settings for a Workspace.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** Event raised whenever a SettingsDictionary is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read\r\n   * and parsed and the fileName is used as the DictionaryName.\r\n   * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Add all files in the supplied directory with the extension \".json\" or \".json5\"\r\n   * @param dirName the name of a local settings directory\r\n   */\r\n  addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settingsJson the JSON5 stringified string to be parsed.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;\r\n\r\n  /** Add a SettingDictionary object.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settings the SettingDictionary object to be added.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;\r\n\r\n  /** Remove a SettingDictionary by name. */\r\n  dropDictionary(dictionaryName: DictionaryName): void;\r\n\r\n  /**\r\n   * Resolve a setting, by name, using a SettingResolver.\r\n   * @param settingName The name of the setting to resolve\r\n   * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.\r\n   * @returns the resolved setting value.\r\n   */\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;\r\n\r\n  /** Get the highest priority setting for a SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary.\r\n   * @note This method is generic on SettingType, but no type checking is actually performed at run time. So, if you\r\n   * 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.\r\n   * You must always type check the result. Use the non-generic \"get\" methods (e.g. [[getString]]) if you only want the value\r\n   * if its type is correct.\r\n   */\r\n  getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Get a string setting by SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a string.\r\n   */\r\n  getString(settingName: SettingName, defaultValue: string): string;\r\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\r\n\r\n  /** Get a boolean setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a boolean.\r\n  */\r\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\r\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\r\n\r\n  /** Get a number setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a number.\r\n  */\r\n  getNumber(settingName: SettingName, defaultValue: number): number;\r\n  getNumber(settingName: SettingName): number | undefined;\r\n\r\n  /** Get an object setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an object.\r\n  */\r\n  getObject<T extends object>(settingName: SettingName, defaultValue: T): T;\r\n  getObject<T extends object>(settingName: SettingName): T | undefined;\r\n\r\n  /** Get an array setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.\r\n  */\r\n  getArray<T extends SettingType>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends SettingType>(settingName: SettingName): Array<T> | undefined;\r\n\r\n  /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.\r\n   * @note this method is mainly for debugging and diagnostics.\r\n   */\r\n  inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];\r\n}\r\n\r\n/** @internal */\r\nfunction deepClone<T extends SettingType>(obj: any): T {\r\n  if (!obj || typeof obj !== \"object\")\r\n    return obj;\r\n\r\n  const result = Array.isArray(obj) ? [] : {} as any;\r\n  Object.keys(obj).forEach((key: string) => {\r\n    const val = obj[key];\r\n    if (val && typeof val === \"object\") {\r\n      result[key] = deepClone(val);\r\n    } else {\r\n      result[key] = val;\r\n    }\r\n  });\r\n  return result;\r\n}\r\n\r\nclass SettingsDictionary {\r\n  public constructor(public readonly name: string, public readonly priority: SettingsPriority, public readonly settings: SettingDictionary) { }\r\n  public getSetting<T extends SettingType>(settingName: string): SettingType | undefined {\r\n    return this.settings[settingName] as T | undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * Internal implementation of Settings interface.\r\n * @internal\r\n */\r\nexport class BaseSettings implements Settings {\r\n  private _dictionaries: SettingsDictionary[] = [];\r\n  protected verifyPriority(_priority: SettingsPriority) { }\r\n  public close() { }\r\n  public readonly onSettingsChanged = new BeEvent<() => void>();\r\n\r\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\r\n    this.addJson(fileName, priority, fs.readFileSync(fileName, \"utf-8\"));\r\n  }\r\n\r\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName), priority);\r\n    }\r\n  }\r\n\r\n  public addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string) {\r\n    this.addDictionary(dictionaryName, priority, parse(settingsJson));\r\n  }\r\n\r\n  public addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary) {\r\n    this.verifyPriority(priority);\r\n    this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice\r\n    const file = new SettingsDictionary(dictionaryName, priority, settings);\r\n    const doAdd = () => {\r\n      for (let i = 0; i < this._dictionaries.length; ++i) {\r\n        if (this._dictionaries[i].priority <= file.priority) {\r\n          this._dictionaries.splice(i, 0, file);\r\n          return;\r\n        }\r\n      }\r\n      this._dictionaries.push(file);\r\n    };\r\n    doAdd();\r\n    this.onSettingsChanged.raiseEvent();\r\n  }\r\n\r\n  public dropDictionary(dictionaryName: DictionaryName, raiseEvent = true) {\r\n    for (let i = 0; i < this._dictionaries.length; ++i) {\r\n      if (this._dictionaries[i].name === dictionaryName) {\r\n        this._dictionaries.splice(i, 1);\r\n        if (raiseEvent)\r\n          this.onSettingsChanged.raiseEvent();\r\n        return true;\r\n      }\r\n    }\r\n    return false;\r\n  }\r\n\r\n  public resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined {\r\n    for (const dict of this._dictionaries) {\r\n      const val = dict.getSetting(name) as T | undefined;\r\n      const resolved = val && resolver(val, dict.name, dict.priority);\r\n      if (undefined !== resolved) {\r\n        return resolved;\r\n      }\r\n    }\r\n    return defaultValue;\r\n  }\r\n\r\n  public getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined {\r\n    return this.resolveSetting(name, (val) => deepClone<T>(val)) ?? defaultValue;\r\n  }\r\n\r\n  /** for debugging. Returns an array of all values for a setting, sorted by priority.\r\n   * @note values are not cloned. Do not modify objects or arrays.\r\n   */\r\n  public inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[] {\r\n    const all: SettingInspector<T>[] = [];\r\n    this.resolveSetting<T>(name, (value, dictionary, priority) => {\r\n      all.push({ value, dictionary, priority });\r\n      return undefined;\r\n    });\r\n\r\n    return all;\r\n  }\r\n\r\n  public getString(name: SettingName, defaultValue: string): string;\r\n  public getString(name: SettingName): string | undefined;\r\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\r\n    const out = this.getSetting<string>(name);\r\n    return typeof out === \"string\" ? out : defaultValue;\r\n  }\r\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\r\n  public getBoolean(name: SettingName): boolean | undefined;\r\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\r\n    const out = this.getSetting<boolean>(name);\r\n    return typeof out === \"boolean\" ? out : defaultValue;\r\n  }\r\n  public getNumber(name: SettingName, defaultValue: number): number;\r\n  public getNumber(name: SettingName): number | undefined;\r\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\r\n    const out = this.getSetting<number>(name);\r\n    return typeof out === \"number\" ? out : defaultValue;\r\n  }\r\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\r\n  public getObject<T extends object>(name: SettingName): T | undefined;\r\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\r\n    const out = this.getSetting<SettingObject>(name);\r\n    return typeof out === \"object\" ? out as T : defaultValue;\r\n  }\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue: Array<T>): Array<T>;\r\n  public getArray<T extends SettingType>(name: SettingName): Array<T> | undefined;\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue?: Array<T>): Array<T> | undefined {\r\n    const out = this.getSetting<Array<T>>(name);\r\n    return Array.isArray(out) ? out : defaultValue;\r\n  }\r\n}\r\n"]}

package/lib/cjs/workspace/SettingsSchemas.js

@@ -173,10 +173,10 @@ class SettingsSchemas {
         }
     }
 }
+exports.SettingsSchemas = SettingsSchemas;
 SettingsSchemas._allGroups = new Map();
 /** a map of all registered [[SettingSchema]]s */
 SettingsSchemas.allSchemas = new Map();
 /** event that signals that the values in [[allSchemas]] have changed in some way. */
 SettingsSchemas.onSchemaChanged = new core_bentley_1.BeEvent();
-exports.SettingsSchemas = SettingsSchemas;
 //# sourceMappingURL=SettingsSchemas.js.map

package/lib/cjs/workspace/SettingsSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAuG;AAEvG,8CAA2C;AAgC3C;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gBAAwB,CAAC,CAAC,YAAY;IAOtC,gBAAgB;IACT,MAAM,CAAC,mBAAmB,CAAI,GAAM,EAAE,UAAkB,EAAE,GAAW;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;QAC5B,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,UAAU;YACpD,OAAO,GAAG,CAAC;QAEb,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;YAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzC,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/C,SAAS;YACX,IAAI,OAAO,KAAK,KAAK,SAAS;gBAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,wBAAwB,GAAG,MAAM,KAAK,OAAO,KAAK,EAAE,CAAC,CAAC;SAC/F;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAwD;QAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,OAAO,CAAC,aAAqB;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,OAAO,CAAC,QAAuB;QAC3C,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;SAClD;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5E;IACH,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,YAAY,CAAC,OAAqB;QAC9C,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;SACzC;IACH,CAAC;IAED,oEAAoE;IAC7D,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAmC;QACtD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;gBAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,SAAiB;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,KAAK,EAAE,UAAU,EAAE;YACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAmC;QAC/E,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE;oBACrB,KAAK,MAAM,KAAK,IAAI,QAAQ;wBAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC9C;gBACD,IAAI,KAAK,EAAE;oBACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI;4BACF,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;yBACxC;wBAAC,OAAO,CAAM,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;yBAC7D;iBACJ;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI;oBACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAChD;gBAAC,OAAO,CAAM,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;iBACzD;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;SAC3E;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAyB;QACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAEhE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAA2B,UAAU,CAAC,GAAG,CAAC,CAAC;YACzD,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAA+C;QAC5E,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;;AA9KuB,0BAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;AAC3E,iDAAiD;AAC1B,0BAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;AACrE,qFAAqF;AAC9D,+BAAe,GAAG,IAAI,sBAAO,EAAc,CAAC;AANxD,0CAAe","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 Workspace\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchema, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/**\r\n * The properties of a single Setting, used by the settings editor. This interface also includes the\r\n * default value if it is not specified in any Settings file.\r\n * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.\r\n * @note the `type` member is marked optional in JSONSchema but is required for Settings.\r\n * @beta\r\n */\r\nexport interface SettingSchema extends Readonly<JSONSchema> {\r\n  readonly items?: SettingSchema; // must be single object, not array\r\n  readonly type: JSONSchemaTypeName; // type is required for settings\r\n  readonly properties?: { [name: string]: SettingSchema };\r\n\r\n  /** whether the setting replaces lower priority entries with the same name or combines with them. */\r\n  readonly cumulative?: true;\r\n}\r\n\r\n/**\r\n * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]\r\n * and are identified by their (required) `groupName` member\r\n * @beta\r\n */\r\nexport interface SettingSchemaGroup {\r\n  readonly groupName: string;\r\n  readonly properties: { [name: string]: SettingSchema };\r\n  readonly order?: number;\r\n  readonly title?: string;\r\n  readonly description?: string;\r\n  readonly extensionId?: string;\r\n}\r\n\r\n/**\r\n * The registry of available [[SettingSchemaGroup]]s.\r\n * The registry is used for editing Settings files and for finding default values for settings.\r\n * @beta\r\n */\r\nexport class SettingsSchemas {\r\n  private constructor() { } // singleton\r\n  private static readonly _allGroups = new Map<string, SettingSchemaGroup>();\r\n  /** a map of all registered [[SettingSchema]]s */\r\n  public static readonly allSchemas = new Map<string, SettingSchema>();\r\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\r\n  public static readonly onSchemaChanged = new BeEvent<() => void>();\r\n\r\n  /** @internal */\r\n  public static validateArrayObject<T>(val: T, schemaName: string, msg: string): T {\r\n    const schema = this.allSchemas.get(schemaName);\r\n    const items = schema?.items;\r\n    if (undefined === items)\r\n      return val;\r\n    const required = items.required;\r\n    const properties = items.properties;\r\n    if (undefined === required || undefined === properties)\r\n      return val;\r\n\r\n    for (const entry of required) {\r\n      const entryType = properties[entry].type;\r\n      const value = (val as any)[entry];\r\n      if (entryType === \"array\" && Array.isArray(value))\r\n        continue;\r\n      if (typeof value !== entryType)\r\n        throw new Error(`invalid \"${schemaName}\" setting entry for \"${msg}\": ${entry} is ${value}`);\r\n    }\r\n    return val;\r\n  }\r\n\r\n  /**\r\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used\r\n   * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.\r\n   */\r\n  public static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void {\r\n    if (!Array.isArray(settingsGroup))\r\n      settingsGroup = [settingsGroup];\r\n\r\n    this.doAdd(settingsGroup);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\r\n  public static addJson(settingSchema: string): void {\r\n    this.addGroup(parse(settingSchema));\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\r\n  public static addFile(fileName: LocalFileName): void {\r\n    try {\r\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\r\n    } catch (e: any) {\r\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\r\n    }\r\n  }\r\n\r\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\r\n  public static addDirectory(dirName: LocalDirName) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName));\r\n    }\r\n  }\r\n\r\n  /** Remove a previously added [[SettingSchemaGroup]] by groupName */\r\n  public static removeGroup(groupName: string): void {\r\n    this.doRemove(groupName);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  private static doAdd(settingsGroup: SettingSchemaGroup[]) {\r\n    settingsGroup.forEach((group) => {\r\n      if (undefined === group.groupName)\r\n        throw new Error(`settings group has no \"groupName\" member`);\r\n\r\n      this.doRemove(group.groupName);\r\n      this.validateAndAdd(group);\r\n      this._allGroups.set(group.groupName, group);\r\n    });\r\n  }\r\n\r\n  private static doRemove(groupName: string) {\r\n    const group = this._allGroups.get(groupName);\r\n    if (undefined !== group?.properties) {\r\n      for (const key of Object.keys(group.properties))\r\n        this.allSchemas.delete(key);\r\n    }\r\n    this._allGroups.delete(groupName);\r\n  }\r\n\r\n  private static validateName(name: string) {\r\n    if (!name.trim())\r\n      throw new Error(`empty property name`);\r\n    if (this.allSchemas.has(name))\r\n      throw new Error(`property \"${name}\" is already defined`);\r\n  }\r\n\r\n  private static validateProperty(name: string, property: SettingSchema | undefined) {\r\n    if (!property)\r\n      throw new Error(`missing required property ${name}`);\r\n\r\n    if (!property.type)\r\n      throw new Error(`property ${name} has no type`);\r\n\r\n    switch (property.type) {\r\n      case \"boolean\":\r\n      case \"integer\":\r\n      case \"null\":\r\n      case \"number\":\r\n      case \"string\":\r\n        return;\r\n\r\n      case \"object\":\r\n        const required = property.required;\r\n        const props = property.properties;\r\n        if (required && props) {\r\n          for (const entry of required)\r\n            this.validateProperty(entry, props[entry]);\r\n        }\r\n        if (props) {\r\n          for (const key of Object.keys(props))\r\n            try {\r\n              this.validateProperty(key, props[key]);\r\n            } catch (e: any) {\r\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\r\n            }\r\n        }\r\n        return;\r\n\r\n      case \"array\":\r\n        if (typeof property.items !== \"object\")\r\n          throw new Error(`array property ${name} has no items member`);\r\n        try {\r\n          this.validateProperty(\"items\", property.items);\r\n        } catch (e: any) {\r\n          throw new Error(`array property ${name}: ${e.message}`);\r\n        }\r\n        return;\r\n\r\n      default:\r\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\r\n    }\r\n  }\r\n\r\n  private static validateAndAdd(group: SettingSchemaGroup) {\r\n    const properties = group.properties;\r\n    if (undefined === properties)\r\n      throw new Error(`group ${group.groupName} has no properties`);\r\n\r\n    for (const key of Object.keys(properties)) {\r\n      this.validateName(key);\r\n      this.validateProperty(key, properties[key]);\r\n      const property: Mutable<SettingSchema> = properties[key];\r\n      property.default = property.default ?? this.getDefaultValue(property.type);\r\n      this.allSchemas.set(key, property);\r\n    }\r\n  }\r\n\r\n  private static getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\r\n    type = Array.isArray(type) ? type[0] : type;\r\n    switch (type) {\r\n      case \"boolean\":\r\n        return false;\r\n      case \"integer\":\r\n      case \"number\":\r\n        return 0;\r\n      case \"string\":\r\n        return \"\";\r\n      case \"array\":\r\n        return [];\r\n      case \"object\":\r\n        return {};\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAuG;AAEvG,8CAA2C;AAgC3C;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gBAAwB,CAAC,CAAC,YAAY;IAOtC,gBAAgB;IACT,MAAM,CAAC,mBAAmB,CAAI,GAAM,EAAE,UAAkB,EAAE,GAAW;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;QAC5B,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,UAAU;YACpD,OAAO,GAAG,CAAC;QAEb,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzC,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/C,SAAS;YACX,IAAI,OAAO,KAAK,KAAK,SAAS;gBAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,wBAAwB,GAAG,MAAM,KAAK,OAAO,KAAK,EAAE,CAAC,CAAC;QAChG,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAwD;QAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,OAAO,CAAC,aAAqB;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,OAAO,CAAC,QAAuB;QAC3C,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,YAAY,CAAC,OAAqB;QAC9C,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,oEAAoE;IAC7D,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAmC;QACtD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;gBAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,SAAiB;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,KAAK,EAAE,UAAU,EAAE,CAAC;YACpC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAmC;QAC/E,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;oBACtB,KAAK,MAAM,KAAK,IAAI,QAAQ;wBAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC/C,CAAC;gBACD,IAAI,KAAK,EAAE,CAAC;oBACV,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI,CAAC;4BACH,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;wBACzC,CAAC;wBAAC,OAAO,CAAM,EAAE,CAAC;4BAChB,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;wBAC9D,CAAC;gBACL,CAAC;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI,CAAC;oBACH,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACjD,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC1D,CAAC;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAyB;QACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAEhE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAA2B,UAAU,CAAC,GAAG,CAAC,CAAC;YACzD,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAA+C;QAC5E,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;;AAhLH,0CAiLC;AA/KyB,0BAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;AAC3E,iDAAiD;AAC1B,0BAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;AACrE,qFAAqF;AAC9D,+BAAe,GAAG,IAAI,sBAAO,EAAc,CAAC","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 Workspace\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchema, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/**\r\n * The properties of a single Setting, used by the settings editor. This interface also includes the\r\n * default value if it is not specified in any Settings file.\r\n * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.\r\n * @note the `type` member is marked optional in JSONSchema but is required for Settings.\r\n * @beta\r\n */\r\nexport interface SettingSchema extends Readonly<JSONSchema> {\r\n  readonly items?: SettingSchema; // must be single object, not array\r\n  readonly type: JSONSchemaTypeName; // type is required for settings\r\n  readonly properties?: { [name: string]: SettingSchema };\r\n\r\n  /** whether the setting replaces lower priority entries with the same name or combines with them. */\r\n  readonly cumulative?: true;\r\n}\r\n\r\n/**\r\n * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]\r\n * and are identified by their (required) `groupName` member\r\n * @beta\r\n */\r\nexport interface SettingSchemaGroup {\r\n  readonly groupName: string;\r\n  readonly properties: { [name: string]: SettingSchema };\r\n  readonly order?: number;\r\n  readonly title?: string;\r\n  readonly description?: string;\r\n  readonly extensionId?: string;\r\n}\r\n\r\n/**\r\n * The registry of available [[SettingSchemaGroup]]s.\r\n * The registry is used for editing Settings files and for finding default values for settings.\r\n * @beta\r\n */\r\nexport class SettingsSchemas {\r\n  private constructor() { } // singleton\r\n  private static readonly _allGroups = new Map<string, SettingSchemaGroup>();\r\n  /** a map of all registered [[SettingSchema]]s */\r\n  public static readonly allSchemas = new Map<string, SettingSchema>();\r\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\r\n  public static readonly onSchemaChanged = new BeEvent<() => void>();\r\n\r\n  /** @internal */\r\n  public static validateArrayObject<T>(val: T, schemaName: string, msg: string): T {\r\n    const schema = this.allSchemas.get(schemaName);\r\n    const items = schema?.items;\r\n    if (undefined === items)\r\n      return val;\r\n    const required = items.required;\r\n    const properties = items.properties;\r\n    if (undefined === required || undefined === properties)\r\n      return val;\r\n\r\n    for (const entry of required) {\r\n      const entryType = properties[entry].type;\r\n      const value = (val as any)[entry];\r\n      if (entryType === \"array\" && Array.isArray(value))\r\n        continue;\r\n      if (typeof value !== entryType)\r\n        throw new Error(`invalid \"${schemaName}\" setting entry for \"${msg}\": ${entry} is ${value}`);\r\n    }\r\n    return val;\r\n  }\r\n\r\n  /**\r\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used\r\n   * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.\r\n   */\r\n  public static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void {\r\n    if (!Array.isArray(settingsGroup))\r\n      settingsGroup = [settingsGroup];\r\n\r\n    this.doAdd(settingsGroup);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\r\n  public static addJson(settingSchema: string): void {\r\n    this.addGroup(parse(settingSchema));\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\r\n  public static addFile(fileName: LocalFileName): void {\r\n    try {\r\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\r\n    } catch (e: any) {\r\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\r\n    }\r\n  }\r\n\r\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\r\n  public static addDirectory(dirName: LocalDirName) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName));\r\n    }\r\n  }\r\n\r\n  /** Remove a previously added [[SettingSchemaGroup]] by groupName */\r\n  public static removeGroup(groupName: string): void {\r\n    this.doRemove(groupName);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  private static doAdd(settingsGroup: SettingSchemaGroup[]) {\r\n    settingsGroup.forEach((group) => {\r\n      if (undefined === group.groupName)\r\n        throw new Error(`settings group has no \"groupName\" member`);\r\n\r\n      this.doRemove(group.groupName);\r\n      this.validateAndAdd(group);\r\n      this._allGroups.set(group.groupName, group);\r\n    });\r\n  }\r\n\r\n  private static doRemove(groupName: string) {\r\n    const group = this._allGroups.get(groupName);\r\n    if (undefined !== group?.properties) {\r\n      for (const key of Object.keys(group.properties))\r\n        this.allSchemas.delete(key);\r\n    }\r\n    this._allGroups.delete(groupName);\r\n  }\r\n\r\n  private static validateName(name: string) {\r\n    if (!name.trim())\r\n      throw new Error(`empty property name`);\r\n    if (this.allSchemas.has(name))\r\n      throw new Error(`property \"${name}\" is already defined`);\r\n  }\r\n\r\n  private static validateProperty(name: string, property: SettingSchema | undefined) {\r\n    if (!property)\r\n      throw new Error(`missing required property ${name}`);\r\n\r\n    if (!property.type)\r\n      throw new Error(`property ${name} has no type`);\r\n\r\n    switch (property.type) {\r\n      case \"boolean\":\r\n      case \"integer\":\r\n      case \"null\":\r\n      case \"number\":\r\n      case \"string\":\r\n        return;\r\n\r\n      case \"object\":\r\n        const required = property.required;\r\n        const props = property.properties;\r\n        if (required && props) {\r\n          for (const entry of required)\r\n            this.validateProperty(entry, props[entry]);\r\n        }\r\n        if (props) {\r\n          for (const key of Object.keys(props))\r\n            try {\r\n              this.validateProperty(key, props[key]);\r\n            } catch (e: any) {\r\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\r\n            }\r\n        }\r\n        return;\r\n\r\n      case \"array\":\r\n        if (typeof property.items !== \"object\")\r\n          throw new Error(`array property ${name} has no items member`);\r\n        try {\r\n          this.validateProperty(\"items\", property.items);\r\n        } catch (e: any) {\r\n          throw new Error(`array property ${name}: ${e.message}`);\r\n        }\r\n        return;\r\n\r\n      default:\r\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\r\n    }\r\n  }\r\n\r\n  private static validateAndAdd(group: SettingSchemaGroup) {\r\n    const properties = group.properties;\r\n    if (undefined === properties)\r\n      throw new Error(`group ${group.groupName} has no properties`);\r\n\r\n    for (const key of Object.keys(properties)) {\r\n      this.validateName(key);\r\n      this.validateProperty(key, properties[key]);\r\n      const property: Mutable<SettingSchema> = properties[key];\r\n      property.default = property.default ?? this.getDefaultValue(property.type);\r\n      this.allSchemas.set(key, property);\r\n    }\r\n  }\r\n\r\n  private static getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\r\n    type = Array.isArray(type) ? type[0] : type;\r\n    switch (type) {\r\n      case \"boolean\":\r\n        return false;\r\n      case \"integer\":\r\n      case \"number\":\r\n        return 0;\r\n      case \"string\":\r\n        return \"\";\r\n      case \"array\":\r\n        return [];\r\n      case \"object\":\r\n        return {};\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/workspace/Workspace.js

@@ -83,7 +83,7 @@ var WorkspaceContainer;
         return `${dbName}:${WorkspaceContainer.validateVersion(version)}`;
     }
     WorkspaceContainer.makeDbFileName = makeDbFileName;
-})(WorkspaceContainer = exports.WorkspaceContainer || (exports.WorkspaceContainer = {}));
+})(WorkspaceContainer || (exports.WorkspaceContainer = WorkspaceContainer = {}));
 /** @beta */
 var WorkspaceDb;
 (function (WorkspaceDb) {
@@ -96,7 +96,7 @@ var WorkspaceDb;
         return new WorkspaceDbImpl(props, container);
     }
     WorkspaceDb.construct = construct;
-})(WorkspaceDb = exports.WorkspaceDb || (exports.WorkspaceDb = {}));
+})(WorkspaceDb || (exports.WorkspaceDb = WorkspaceDb = {}));
 /** @beta */
 var Workspace;
 (function (Workspace) {
@@ -105,7 +105,7 @@ var Workspace;
         return new WorkspaceImpl(settings, opts);
     }
     Workspace.construct = construct;
-})(Workspace = exports.Workspace || (exports.Workspace = {}));
+})(Workspace || (exports.Workspace = Workspace = {}));
 /** @beta */
 var EditableWorkspaceDb;
 (function (EditableWorkspaceDb) {
@@ -130,7 +130,7 @@ var EditableWorkspaceDb;
         db.closeDb(true);
     }
     EditableWorkspaceDb.createEmpty = createEmpty;
-})(EditableWorkspaceDb = exports.EditableWorkspaceDb || (exports.EditableWorkspaceDb = {}));
+})(EditableWorkspaceDb || (exports.EditableWorkspaceDb = EditableWorkspaceDb = {}));
 class WorkspaceImpl {
     getCloudCache() {
         return this._cloudCache ??= CloudSqlite_1.CloudSqlite.CloudCaches.getCache({ cacheName: "Workspace", cacheSize: "20G" });