@itwin/core-backend 5.0.0-dev.106 → 5.0.0-dev.109

package/lib/cjs/workspace/WorkspaceEditor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WorkspaceEditor.d.ts","sourceRoot":"","sources":["../../../src/workspace/WorkspaceEditor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EACL,yBAAyB,EAAE,SAAS,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,WAAW,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,eAAe,EAAE,yBAAyB,EACtL,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,EAC5D,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,YAAY;AACZ,yBAAiB,eAAe,CAAC;IAC/B;;;;OAIG;IACH,SAAgB,SAAS,IAAI,eAAe,CAE3C;IAED;;OAEG;IACH,SAAgB,aAAa,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,QAAQ,EAAE,mBAAmB,CAAA;KAAE,GAAG,IAAI,CAEzG;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAC3B,iFAAiF;IACjF,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE;;;;;;;OAOG;IACH,2BAA2B,CAAC,KAAK,EAAE,+BAA+B,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,yBAAyB,CAAC;QAAC,KAAK,EAAE,yBAAyB,CAAA;KAAE,CAAC,CAAC;IAErJ;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,eAAe,CAAC;QAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;QAAC,QAAQ,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAExI;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAEzD;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IAE5D;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,IAAI,IAAI,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;AAE5H;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,oEAAoE;IACpE,WAAW,EAAE,2BAA2B,CAAC;IACzC,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,QAAQ,CAAC,SAAS,EAAE,0BAA0B,CAAC;IAC/C;;OAEG;IACH,IAAI,UAAU,IAAI,qBAAqB,GAAG,SAAS,CAAC;IAEpD;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpD;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7D;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEnD;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IAElE;;;;;;OAMG;IACH,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE/D;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9F;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/E;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;CAClD;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,yBAAyB,GAAG,0BAA0B,CAAC;IAE1E;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEvF;;;OAGG;IACH,uBAAuB,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEpG;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}
+{"version":3,"file":"WorkspaceEditor.d.ts","sourceRoot":"","sources":["../../../src/workspace/WorkspaceEditor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EACL,yBAAyB,EAAE,SAAS,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,WAAW,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,eAAe,EAAE,yBAAyB,EACtL,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,EAC5D,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,YAAY;AACZ,yBAAiB,eAAe,CAAC;IAC/B;;;;OAIG;IACH,SAAgB,SAAS,IAAI,eAAe,CAE3C;IAED;;OAEG;IACH,SAAgB,aAAa,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,QAAQ,EAAE,mBAAmB,CAAA;KAAE,GAAG,IAAI,CAEzG;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAC3B,iFAAiF;IACjF,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE;;;;;;;OAOG;IACH,2BAA2B,CAAC,KAAK,EAAE,+BAA+B,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,yBAAyB,CAAC;QAAC,KAAK,EAAE,yBAAyB,CAAA;KAAE,CAAC,CAAC;IAErJ;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,eAAe,CAAC;QAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;QAAC,QAAQ,EAAE,mBAAmB,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAExI;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAEzD;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IAE5D;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,IAAI,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,oEAAoE;IACpE,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC;IACzC,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,QAAQ,CAAC,SAAS,EAAE,0BAA0B,CAAC;IAC/C;;OAEG;IACH,IAAI,UAAU,IAAI,qBAAqB,GAAG,SAAS,CAAC;IAEpD;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpD;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7D;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEnD;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IAElE;;;;;;OAMG;IACH,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE/D;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9F;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/E;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;CAClD;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,yBAAyB,GAAG,0BAA0B,CAAC;IAE1E;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEvF;;;OAGG;IACH,uBAAuB,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEpG;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}

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

@@ -1 +1 @@
-{"version":3,"file":"WorkspaceEditor.js","sourceRoot":"","sources":["../../../src/workspace/WorkspaceEditor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAUH,+EAA4E;AAC5E,uEAA+E;AAC/E,iDAAgE;AAEhE,YAAY;AACZ,IAAiB,eAAe,CAgB/B;AAhBD,WAAiB,eAAe;IAC9B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,IAAA,wCAAwB,GAAE,CAAC;IACpC,CAAC;IAFe,yBAAS,YAExB,CAAA;IAED;;OAEG;IACH,SAAgB,aAAa,CAAC,IAAqE;QACjG,qCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,6BAAa,gBAE5B,CAAA;AACH,CAAC,EAhBgB,eAAe,+BAAf,eAAe,QAgB/B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport { LocalFileName } from \"@itwin/core-common\";\nimport { SQLiteDb } from \"../SQLiteDb\";\nimport { SettingsContainer } from \"./Settings\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport {\n  GetWorkspaceContainerArgs, Workspace, WorkspaceContainer, WorkspaceContainerProps, WorkspaceDb, WorkspaceDbCloudProps, WorkspaceDbManifest, WorkspaceDbName, WorkspaceDbNameAndVersion,\n  WorkspaceDbProps, WorkspaceDbVersion, WorkspaceResourceName,\n} from \"./Workspace\";\nimport { WorkspaceSqliteDb } from \"../internal/workspace/WorkspaceSqliteDb\";\nimport { constructWorkspaceEditor } from \"../internal/workspace/WorkspaceImpl\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\n\n/** @beta */\nexport namespace WorkspaceEditor {\n  /**\n   * Create a new [[WorkspaceEditor]] for creating new versions of [[WorkspaceDb]]s.\n   * @note the caller becomes the owner of the Workspace.Editor and is responsible for calling [[WorkspaceEditor.close]] on it when they are finished using it.\n   * @note It is illegal to have more than one Workspace.Editor active in a single session.\n   */\n  export function construct(): WorkspaceEditor {\n    return constructWorkspaceEditor();\n  }\n\n  /**\n   * Create a new, empty, [[EditableWorkspaceDb]] file on the local filesystem for importing [[Workspace]] resources.\n   */\n  export function createEmptyDb(args: { localFileName: LocalFileName, manifest: WorkspaceDbManifest }): void {\n    WorkspaceSqliteDb.createNewDb(args.localFileName, args);\n  }\n}\n\n/** Arguments supplied to [[WorkspaceEditor.createNewCloudContainer]] to create a new [[EditableWorkspaceContainer]].\n * @beta\n */\nexport interface CreateNewWorkspaceContainerArgs {\n  /**\n   * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,\n   * and the location of the datacenter\n   */\n  scope: BlobContainer.Scope;\n  /** The manifest to be stored in the default WorkspaceDb in the new container. */\n  manifest: WorkspaceDbManifest;\n  /** Metadata stored by the BlobContainer service */\n  metadata: Omit<BlobContainer.Metadata, \"containerType\">;\n  /** The name of the default [[WorkspaceDb]] created inside the new container.\n   * Default: \"workspace-db\";\n   */\n  dbName?: WorkspaceDbName;\n}\n\n/**\n * A [[WorkspaceContainer]] opened for editing by a [[WorkspaceEditor]].\n * You can create new [[WorkspaceDb]]s or new versions of existing [[WorkspaceDb]]s inside it.\n * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via\n * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,\n * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.\n * @beta\n */\nexport interface EditableWorkspaceContainer extends WorkspaceContainer {\n  /**\n   * Create a copy of an existing [[WorkspaceDb]] in this container with a new [[WorkspaceDbVersion]].\n   * The copy should be modified with new content before the write lock is released,\n   * and thereafter may never be modified again.\n   * @note The copy actually shares all of the data with the original, but with copy-on-write if/when data in the new WorkspaceDb is modified.\n   * @param props - The properties that determine the source WorkspaceDb to serve as the basis for the new version.\n   * @returns A promise that resolves to an object containing the old and new WorkspaceDb names and versions.\n   */\n  createNewWorkspaceDbVersion(props: CreateNewWorkspaceDbVersionArgs): Promise<{ oldDb: WorkspaceDbNameAndVersion, newDb: WorkspaceDbNameAndVersion }>;\n\n  /**\n   * Create a new, empty [[WorkspaceDb]].\n   * @param args - The arguments for creating the new WorkspaceDb.\n   * @returns A promise that resolves to an EditableWorkspaceDb.\n   */\n  createDb(args: { dbName?: WorkspaceDbName, version?: WorkspaceDbVersion, manifest: WorkspaceDbManifest }): Promise<EditableWorkspaceDb>;\n\n  /**\n   * Get the cloud properties of this container.\n   */\n  readonly cloudProps: WorkspaceContainerProps | undefined;\n\n  /**\n   * Get an editable [[WorkspaceDb]] to add, delete, or update resources *within a newly created version* of a WorkspaceDb.\n   * @param props - The properties of the WorkspaceDb.\n   */\n  getEditableDb(props: WorkspaceDbProps): EditableWorkspaceDb;\n\n  /**\n   * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or\n   * [[abandonChanges]] to release the lock and discard your changes.\n   * Only one use can hold the write lock at any given time. However, readers can continue to read the published contents of the container while\n   * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].\n   * @param user - The name of the user acquiring the write lock.\n   */\n  acquireWriteLock(user: string): void;\n\n  /**\n   * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It\n   * publishes and uploads the changes made to any [[WorkspaceDb]]s while the lock was held, after which those dbs become immutable.\n   */\n  releaseWriteLock(): void;\n\n  /**\n   * Abandon any changes made to the container and release the write lock. Any newly created versions of WorkspaceDbs are discarded.\n   */\n  abandonChanges(): void;\n}\n\n/**\n * The release increment for a version number, used as part of [[CreateNewWorkspaceDbVersionArgs]] to specify the kind of version to create.\n * @see [semver.ReleaseType](https://www.npmjs.com/package/semver)\n * @beta\n */\nexport type WorkspaceDbVersionIncrement = \"major\" | \"minor\" | \"patch\" | \"premajor\" | \"preminor\" | \"prepatch\" | \"prerelease\";\n\n/**\n * Arguments supplied to [[Workspace.createNewWorkspaceDbVersion]].\n * @beta\n */\nexport interface CreateNewWorkspaceDbVersionArgs {\n  /**\n   * The properties that determine the source [[WorkspaceDb]] to serve as the basis for the new version.\n   * This is usually the latest version, but it is possible to create patches to older versions.\n   */\n  fromProps?: WorkspaceDbProps;\n  /** The type of version increment to apply to the source version. */\n  versionType: WorkspaceDbVersionIncrement;\n  /** For prerelease versions, a string that becomes part of the version name. */\n  identifier?: string;\n}\n\n/**\n * An editable [[WorkspaceDb]]. This is used only by tools to allow administrators to create and modify WorkspaceDbs.\n * For cloud-based WorkspaceDbs, the container's write token must be obtained via [[EditableWorkspaceContainer.acquireWriteLock]] before the methods in this interface may be used.\n * Normally, only admins will have write access to a [[Workspace]].\n * Only one admin at a time may be editing a Workspace.\n * @beta\n */\nexport interface EditableWorkspaceDb extends WorkspaceDb {\n  readonly container: EditableWorkspaceContainer;\n  /**\n   * The cloud properties of the [[WorkspaceDb]], if this is a cloud-based WorkspaceDb.\n   */\n  get cloudProps(): WorkspaceDbCloudProps | undefined;\n\n  /**\n   * Update the contents of the manifest in this WorkspaceDb.\n   * @param manifest - The updated manifest.\n   */\n  updateManifest(manifest: WorkspaceDbManifest): void;\n\n  /**\n   * Add or update a resource in this WorkspaceDb that can be loaded as a [[SettingsDictionary]].\n   * The `settings` will be stored as stringified JSON.\n   * @param settings - The settings object to add or update.\n   * @param rscName - The name of the settings resource. Defaults to \"settingsDictionary\" if undefined.\n   */\n  updateSettingsResource(settings: SettingsContainer, rscName?: string): void;\n\n  /**\n   * Add a new string resource to this WorkspaceDb.\n   * @param rscName - The name of the string resource.\n   * @param val - The string to save.\n   * @throws if a string resource named `rscName` already exists.\n   */\n  addString(rscName: WorkspaceResourceName, val: string): void;\n\n  /**\n   * Update an existing string resource with a new value, or add it if it does not exist.\n   * @param rscName - The name of the string resource.\n   * @param val - The new value.\n   */\n  updateString(rscName: WorkspaceResourceName, val: string): void;\n\n  /**\n   * Remove a string resource.\n   * @param rscName - The name of the string resource to remove.\n   */\n  removeString(rscName: WorkspaceResourceName): void;\n\n  /**\n   * Add a new binary resource to this WorkspaceDb.\n   * @param rscName - The name of the blob resource.\n   * @param val - The blob to save.\n   * @throws if a blob resource named `rscName` already exists.\n   */\n  addBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\n\n  /**\n   * Update an existing blob resource with a new value, or add it if it does not exist.\n   * @param rscName - The name of the blob resource.\n   * @param val - The new value.\n   */\n  updateBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\n\n  /**\n   * Get a BlobIO writer for a previously-added blob WorkspaceResource.\n   * @param rscName - The name of the blob resource.\n   * @returns A BlobIO writer.\n   * @note After writing is complete, the caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\n   * @internal\n   */\n  getBlobWriter(rscName: WorkspaceResourceName): SQLiteDb.BlobIO;\n\n  /**\n   * Remove a binary resource.\n   * @param rscName - The name of the blob resource to remove.\n   */\n  removeBlob(rscName: WorkspaceResourceName): void;\n\n  /**\n   * Copy the contents of an existing local file into this WorkspaceDb as a file resource.\n   * @param rscName - The name of the file resource.\n   * @param localFileName - The name of a local file to be read.\n   * @param fileExt - The extension to be appended to the generated fileName when this WorkspaceDb is extracted from the WorkspaceDb.\n   * By default, the characters after the last \".\" in `localFileName` are used. Pass this argument to override that.\n   */\n  addFile(rscName: WorkspaceResourceName, localFileName: LocalFileName, fileExt?: string): void;\n\n  /**\n   * Replace an existing file resource with the contents of another local file.\n   * @param rscName - The name of the file resource.\n   * @param localFileName - The name of a local file to be read.\n   * @throws If the file resource does not exist.\n   */\n  updateFile(rscName: WorkspaceResourceName, localFileName: LocalFileName): void;\n\n  /**\n   * Remove a file resource.\n   * @param rscName - The name of the file resource to remove.\n   */\n  removeFile(rscName: WorkspaceResourceName): void;\n}\n\n/** An object that permits administrators to modify the contents of a [[Workspace]].\n * Use [[WorkspaceEditor.construct]] to obtain a WorkspaceEditor, and [[close]] when finished using it.\n * Only one WorkspaceEditor may be in use at any given time.\n * Use [[getContainer]] to edit an existing [[WorkspaceContainer]], or [[createNewCloudContainer]] to create a new [[WorkspaceContainer]].\n * @beta\n */\nexport interface WorkspaceEditor {\n  /** @internal */\n  [_implementationProhibited]: unknown;\n\n  /**\n   * The workspace dedicated to this editor.\n   * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s. It has its own [[Settings]] and [[WorkspaceDb]]s.\n   */\n  readonly workspace: Workspace;\n\n  /**\n   * Retrieves a container for the editor with the specified properties and access token.\n   */\n  getContainer(args: GetWorkspaceContainerArgs): EditableWorkspaceContainer;\n\n  /**\n   * Asynchronously retrieves a container for the editor with the specified properties.\n   */\n  getContainerAsync(props: WorkspaceContainerProps): Promise<EditableWorkspaceContainer>;\n\n  /**\n   * Creates a new cloud container for holding WorkspaceDbs, from the [[BlobContainer]] service.\n   * @note The current user must have administrator rights for the iTwin for the container.\n   */\n  createNewCloudContainer(args: CreateNewWorkspaceContainerArgs): Promise<EditableWorkspaceContainer>;\n\n  /**\n   * Closes this editor. All [[workspace]] containers are dropped.\n   */\n  close(): void;\n}\n"]}
+{"version":3,"file":"WorkspaceEditor.js","sourceRoot":"","sources":["../../../src/workspace/WorkspaceEditor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAUH,+EAA4E;AAC5E,uEAA+E;AAC/E,iDAAgE;AAGhE,YAAY;AACZ,IAAiB,eAAe,CAgB/B;AAhBD,WAAiB,eAAe;IAC9B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,IAAA,wCAAwB,GAAE,CAAC;IACpC,CAAC;IAFe,yBAAS,YAExB,CAAA;IAED;;OAEG;IACH,SAAgB,aAAa,CAAC,IAAqE;QACjG,qCAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAFe,6BAAa,gBAE5B,CAAA;AACH,CAAC,EAhBgB,eAAe,+BAAf,eAAe,QAgB/B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport { LocalFileName } from \"@itwin/core-common\";\nimport { SQLiteDb } from \"../SQLiteDb\";\nimport { SettingsContainer } from \"./Settings\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport {\n  GetWorkspaceContainerArgs, Workspace, WorkspaceContainer, WorkspaceContainerProps, WorkspaceDb, WorkspaceDbCloudProps, WorkspaceDbManifest, WorkspaceDbName, WorkspaceDbNameAndVersion,\n  WorkspaceDbProps, WorkspaceDbVersion, WorkspaceResourceName,\n} from \"./Workspace\";\nimport { WorkspaceSqliteDb } from \"../internal/workspace/WorkspaceSqliteDb\";\nimport { constructWorkspaceEditor } from \"../internal/workspace/WorkspaceImpl\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\nimport { CloudSqlite } from \"../CloudSqlite\";\n\n/** @beta */\nexport namespace WorkspaceEditor {\n  /**\n   * Create a new [[WorkspaceEditor]] for creating new versions of [[WorkspaceDb]]s.\n   * @note the caller becomes the owner of the Workspace.Editor and is responsible for calling [[WorkspaceEditor.close]] on it when they are finished using it.\n   * @note It is illegal to have more than one Workspace.Editor active in a single session.\n   */\n  export function construct(): WorkspaceEditor {\n    return constructWorkspaceEditor();\n  }\n\n  /**\n   * Create a new, empty, [[EditableWorkspaceDb]] file on the local filesystem for importing [[Workspace]] resources.\n   */\n  export function createEmptyDb(args: { localFileName: LocalFileName, manifest: WorkspaceDbManifest }): void {\n    WorkspaceSqliteDb.createNewDb(args.localFileName, args);\n  }\n}\n\n/** Arguments supplied to [[WorkspaceEditor.createNewCloudContainer]] to create a new [[EditableWorkspaceContainer]].\n * @beta\n */\nexport interface CreateNewWorkspaceContainerArgs {\n  /**\n   * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,\n   * and the location of the datacenter\n   */\n  scope: BlobContainer.Scope;\n  /** The manifest to be stored in the default WorkspaceDb in the new container. */\n  manifest: WorkspaceDbManifest;\n  /** Metadata stored by the BlobContainer service */\n  metadata: Omit<BlobContainer.Metadata, \"containerType\">;\n  /** The name of the default [[WorkspaceDb]] created inside the new container.\n   * Default: \"workspace-db\";\n   */\n  dbName?: WorkspaceDbName;\n}\n\n/**\n * A [[WorkspaceContainer]] opened for editing by a [[WorkspaceEditor]].\n * You can create new [[WorkspaceDb]]s or new versions of existing [[WorkspaceDb]]s inside it.\n * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via\n * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,\n * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.\n * @beta\n */\nexport interface EditableWorkspaceContainer extends WorkspaceContainer {\n  /**\n   * Create a copy of an existing [[WorkspaceDb]] in this container with a new [[WorkspaceDbVersion]].\n   * The copy should be modified with new content before the write lock is released,\n   * and thereafter may never be modified again.\n   * @note The copy actually shares all of the data with the original, but with copy-on-write if/when data in the new WorkspaceDb is modified.\n   * @param props - The properties that determine the source WorkspaceDb to serve as the basis for the new version.\n   * @returns A promise that resolves to an object containing the old and new WorkspaceDb names and versions.\n   */\n  createNewWorkspaceDbVersion(props: CreateNewWorkspaceDbVersionArgs): Promise<{ oldDb: WorkspaceDbNameAndVersion, newDb: WorkspaceDbNameAndVersion }>;\n\n  /**\n   * Create a new, empty [[WorkspaceDb]].\n   * @param args - The arguments for creating the new WorkspaceDb.\n   * @returns A promise that resolves to an EditableWorkspaceDb.\n   */\n  createDb(args: { dbName?: WorkspaceDbName, version?: WorkspaceDbVersion, manifest: WorkspaceDbManifest }): Promise<EditableWorkspaceDb>;\n\n  /**\n   * Get the cloud properties of this container.\n   */\n  readonly cloudProps: WorkspaceContainerProps | undefined;\n\n  /**\n   * Get an editable [[WorkspaceDb]] to add, delete, or update resources *within a newly created version* of a WorkspaceDb.\n   * @param props - The properties of the WorkspaceDb.\n   */\n  getEditableDb(props: WorkspaceDbProps): EditableWorkspaceDb;\n\n  /**\n   * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or\n   * [[abandonChanges]] to release the lock and discard your changes.\n   * Only one use can hold the write lock at any given time. However, readers can continue to read the published contents of the container while\n   * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].\n   * @param user - The name of the user acquiring the write lock.\n   */\n  acquireWriteLock(user: string): void;\n\n  /**\n   * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It\n   * publishes and uploads the changes made to any [[WorkspaceDb]]s while the lock was held, after which those dbs become immutable.\n   */\n  releaseWriteLock(): void;\n\n  /**\n   * Abandon any changes made to the container and release the write lock. Any newly created versions of WorkspaceDbs are discarded.\n   */\n  abandonChanges(): void;\n}\n\n/**\n * Arguments supplied to [[Workspace.createNewWorkspaceDbVersion]].\n * @beta\n */\nexport interface CreateNewWorkspaceDbVersionArgs {\n  /**\n   * The properties that determine the source [[WorkspaceDb]] to serve as the basis for the new version.\n   * This is usually the latest version, but it is possible to create patches to older versions.\n   */\n  fromProps?: WorkspaceDbProps;\n  /** The type of version increment to apply to the source version. */\n  versionType: CloudSqlite.SemverIncrement;\n  /** For prerelease versions, a string that becomes part of the version name. */\n  identifier?: string;\n}\n\n/**\n * An editable [[WorkspaceDb]]. This is used only by tools to allow administrators to create and modify WorkspaceDbs.\n * For cloud-based WorkspaceDbs, the container's write token must be obtained via [[EditableWorkspaceContainer.acquireWriteLock]] before the methods in this interface may be used.\n * Normally, only admins will have write access to a [[Workspace]].\n * Only one admin at a time may be editing a Workspace.\n * @beta\n */\nexport interface EditableWorkspaceDb extends WorkspaceDb {\n  readonly container: EditableWorkspaceContainer;\n  /**\n   * The cloud properties of the [[WorkspaceDb]], if this is a cloud-based WorkspaceDb.\n   */\n  get cloudProps(): WorkspaceDbCloudProps | undefined;\n\n  /**\n   * Update the contents of the manifest in this WorkspaceDb.\n   * @param manifest - The updated manifest.\n   */\n  updateManifest(manifest: WorkspaceDbManifest): void;\n\n  /**\n   * Add or update a resource in this WorkspaceDb that can be loaded as a [[SettingsDictionary]].\n   * The `settings` will be stored as stringified JSON.\n   * @param settings - The settings object to add or update.\n   * @param rscName - The name of the settings resource. Defaults to \"settingsDictionary\" if undefined.\n   */\n  updateSettingsResource(settings: SettingsContainer, rscName?: string): void;\n\n  /**\n   * Add a new string resource to this WorkspaceDb.\n   * @param rscName - The name of the string resource.\n   * @param val - The string to save.\n   * @throws if a string resource named `rscName` already exists.\n   */\n  addString(rscName: WorkspaceResourceName, val: string): void;\n\n  /**\n   * Update an existing string resource with a new value, or add it if it does not exist.\n   * @param rscName - The name of the string resource.\n   * @param val - The new value.\n   */\n  updateString(rscName: WorkspaceResourceName, val: string): void;\n\n  /**\n   * Remove a string resource.\n   * @param rscName - The name of the string resource to remove.\n   */\n  removeString(rscName: WorkspaceResourceName): void;\n\n  /**\n   * Add a new binary resource to this WorkspaceDb.\n   * @param rscName - The name of the blob resource.\n   * @param val - The blob to save.\n   * @throws if a blob resource named `rscName` already exists.\n   */\n  addBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\n\n  /**\n   * Update an existing blob resource with a new value, or add it if it does not exist.\n   * @param rscName - The name of the blob resource.\n   * @param val - The new value.\n   */\n  updateBlob(rscName: WorkspaceResourceName, val: Uint8Array): void;\n\n  /**\n   * Get a BlobIO writer for a previously-added blob WorkspaceResource.\n   * @param rscName - The name of the blob resource.\n   * @returns A BlobIO writer.\n   * @note After writing is complete, the caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\n   * @internal\n   */\n  getBlobWriter(rscName: WorkspaceResourceName): SQLiteDb.BlobIO;\n\n  /**\n   * Remove a binary resource.\n   * @param rscName - The name of the blob resource to remove.\n   */\n  removeBlob(rscName: WorkspaceResourceName): void;\n\n  /**\n   * Copy the contents of an existing local file into this WorkspaceDb as a file resource.\n   * @param rscName - The name of the file resource.\n   * @param localFileName - The name of a local file to be read.\n   * @param fileExt - The extension to be appended to the generated fileName when this WorkspaceDb is extracted from the WorkspaceDb.\n   * By default, the characters after the last \".\" in `localFileName` are used. Pass this argument to override that.\n   */\n  addFile(rscName: WorkspaceResourceName, localFileName: LocalFileName, fileExt?: string): void;\n\n  /**\n   * Replace an existing file resource with the contents of another local file.\n   * @param rscName - The name of the file resource.\n   * @param localFileName - The name of a local file to be read.\n   * @throws If the file resource does not exist.\n   */\n  updateFile(rscName: WorkspaceResourceName, localFileName: LocalFileName): void;\n\n  /**\n   * Remove a file resource.\n   * @param rscName - The name of the file resource to remove.\n   */\n  removeFile(rscName: WorkspaceResourceName): void;\n}\n\n/** An object that permits administrators to modify the contents of a [[Workspace]].\n * Use [[WorkspaceEditor.construct]] to obtain a WorkspaceEditor, and [[close]] when finished using it.\n * Only one WorkspaceEditor may be in use at any given time.\n * Use [[getContainer]] to edit an existing [[WorkspaceContainer]], or [[createNewCloudContainer]] to create a new [[WorkspaceContainer]].\n * @beta\n */\nexport interface WorkspaceEditor {\n  /** @internal */\n  [_implementationProhibited]: unknown;\n\n  /**\n   * The workspace dedicated to this editor.\n   * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s. It has its own [[Settings]] and [[WorkspaceDb]]s.\n   */\n  readonly workspace: Workspace;\n\n  /**\n   * Retrieves a container for the editor with the specified properties and access token.\n   */\n  getContainer(args: GetWorkspaceContainerArgs): EditableWorkspaceContainer;\n\n  /**\n   * Asynchronously retrieves a container for the editor with the specified properties.\n   */\n  getContainerAsync(props: WorkspaceContainerProps): Promise<EditableWorkspaceContainer>;\n\n  /**\n   * Creates a new cloud container for holding WorkspaceDbs, from the [[BlobContainer]] service.\n   * @note The current user must have administrator rights for the iTwin for the container.\n   */\n  createNewCloudContainer(args: CreateNewWorkspaceContainerArgs): Promise<EditableWorkspaceContainer>;\n\n  /**\n   * Closes this editor. All [[workspace]] containers are dropped.\n   */\n  close(): void;\n}\n"]}

package/lib/esm/CatalogDb.d.ts

@@ -0,0 +1,103 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { type CatalogIModel, IModelConnectionProps } from "@itwin/core-common";
+import { IpcHandler } from "./IpcHost";
+import { StandaloneDb } from "./IModelDb";
+/** A [[StandaloneDb]] that provides read-only access to the contents of a [CatalogIModel]($common).
+ * @see [[CatalogDb.openReadonly]] to instantiate this type.
+ * @beta
+ */
+export interface CatalogDb extends StandaloneDb {
+    /** Get the catalog's manifest. */
+    getManifest(): CatalogIModel.Manifest | undefined;
+    /** Get the catalog's version information. */
+    getVersion(): string;
+    /** Get the catalog's manifest and version. */
+    getInfo(): {
+        manifest?: CatalogIModel.Manifest;
+        version: string;
+    };
+    /** Returns true if the catalog was opened in read-write mode. */
+    isEditable(): this is EditableCatalogDb;
+}
+/** A writable [[CatalogDb]].
+ * @see [[CatalogDb.openEditable]] to instantiate this type.
+ * @beta
+ */
+export interface EditableCatalogDb extends CatalogDb {
+    /** Update the contents of the catalog manifest.  */
+    updateCatalogManifest(manifest: CatalogIModel.Manifest): void;
+}
+/** @beta */
+export declare namespace CatalogDb {
+    /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].
+     * @returns The properties of the newly created container.
+     * @note creating new containers requires "admin" authorization.
+    */
+    function createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps>;
+    /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.
+     * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].
+     * @note This requires "write" authorization to the container
+     */
+    function acquireWriteLock(args: {
+        /** The id of the container */
+        containerId: string;
+        /**
+         * The name of the individual acquiring the lock. This will be shown to others who attempt to acquire the lock while it is held.
+         * It is also stored in the "lastEditedBy" field of the manifest of any new version edited while the lock is held.
+         */
+        username: string;
+    }): Promise<void>;
+    /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */
+    function releaseWriteLock(args: {
+        /** The id of the container */
+        containerId: string;
+        /** If true, abandon all local changes before releasing the lock */
+        abandon?: true;
+    }): Promise<void>;
+    /** Open an [[EditableCatalogDb]] for write access.
+     * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.
+     * @note The write lock must be held for this operation to succeed
+     */
+    function openEditable(args: CatalogIModel.OpenArgs): Promise<EditableCatalogDb>;
+    /** Open a [[CatalogDb]] for read-only access. */
+    function openReadonly(args: CatalogIModel.OpenArgs): Promise<CatalogDb>;
+    /**
+     * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy
+     * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.
+     * @note The write lock must be held for this operation to succeed
+     */
+    function createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{
+        oldDb: CatalogIModel.NameAndVersion;
+        newDb: CatalogIModel.NameAndVersion;
+    }>;
+}
+/**
+ * Handler for Ipc access to CatalogIModels. Registered by NativeHost.
+ * @internal
+ */
+export declare class CatalogIModelHandler extends IpcHandler implements CatalogIModel.IpcMethods {
+    get channelName(): CatalogIModel.IpcChannel;
+    createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps>;
+    acquireWriteLock(args: {
+        containerId: string;
+        username: string;
+    }): Promise<void>;
+    releaseWriteLock(args: {
+        containerId: string;
+        abandon?: true;
+    }): Promise<void>;
+    openReadonly(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps>;
+    openEditable(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps>;
+    createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{
+        oldDb: CatalogIModel.NameAndVersion;
+        newDb: CatalogIModel.NameAndVersion;
+    }>;
+    getInfo(key: string): Promise<{
+        manifest?: CatalogIModel.Manifest;
+        version: string;
+    }>;
+    updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;
+}
+//# sourceMappingURL=CatalogDb.d.ts.map

package/lib/esm/CatalogDb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogDb.d.ts","sourceRoot":"","sources":["../../src/CatalogDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAkC,KAAK,aAAa,EAAoB,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACjI,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAkE1C;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,kCAAkC;IAClC,WAAW,IAAI,aAAa,CAAC,QAAQ,GAAG,SAAS,CAAC;IAClD,6CAA6C;IAC7C,UAAU,IAAI,MAAM,CAAC;IACrB,8CAA8C;IAC9C,OAAO,IAAI;QAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAClE,iEAAiE;IACjE,UAAU,IAAI,IAAI,IAAI,iBAAiB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,oDAAoD;IACpD,qBAAqB,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC;CAC/D;AA6DD,YAAY;AACZ,yBAAiB,SAAS,CAAC;IACzB;;;MAGE;IACF,SAAsB,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAgD7H;IAED;;;OAGG;IACH,SAAsB,gBAAgB,CAAC,IAAI,EAAE;QAC3C,8BAA8B;QAC9B,WAAW,EAAE,MAAM,CAAC;QACpB;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGhB;IAED,mKAAmK;IACnK,SAAsB,gBAAgB,CAAC,IAAI,EAAE;QAC3C,8BAA8B;QAC9B,WAAW,EAAE,MAAM,CAAC;QACpB,mEAAmE;QACnE,OAAO,CAAC,EAAE,IAAI,CAAA;KACf,GAAG,OAAO,CAAC,IAAI,CAAC,CAKhB;IAED;;;OAGG;IACH,SAAsB,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAiB3F;IAED,iDAAiD;IACjD,SAAsB,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAcnF;IAED;;;;OAIG;IACH,SAAsB,gBAAgB,CAAC,IAAI,EAAE,aAAa,CAAC,oBAAoB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;QAAC,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;KAAE,CAAC,CAIvK;CACF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,UAAW,YAAW,aAAa,CAAC,UAAU;IACtF,IAAW,WAAW,IAAI,aAAa,CAAC,UAAU,CAAgC;IAErE,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC;IAGxG,gBAAgB,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAGjF,gBAAgB,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,CAAC;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAG/E,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAG1E,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAG1E,gBAAgB,CAAC,IAAI,EAAE,aAAa,CAAC,oBAAoB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;QAAC,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC;KAAE,CAAC;IAGlJ,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAGrF,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjG"}

package/lib/esm/CatalogDb.js

@@ -0,0 +1,267 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+import * as fs from "fs";
+import { join } from "path";
+import { CloudSqlite } from "./CloudSqlite";
+import { IModelHost, KnownLocations } from "./IModelHost";
+import { BriefcaseIdValue, CatalogError, CloudSqliteError } from "@itwin/core-common";
+import { IpcHandler } from "./IpcHost";
+import { StandaloneDb } from "./IModelDb";
+import { Guid, OpenMode } from "@itwin/core-bentley";
+import { _nativeDb } from "./internal/Symbols";
+import { IModelNative } from "./internal/NativePlatform";
+let readonlyCloudCache;
+let writeableCloudCache;
+const catalogManifestName = "CatalogManifest";
+// we make a readonly CloudCache and a writeable CloudCache. That way the access token authorizations are distinct.
+function makeCloudCache(arg, writeable) {
+    const cache = CloudSqlite.CloudCaches.getCache(arg);
+    // if the cache was just created, add the "catalog" members as hidden
+    if (undefined === cache.catalogContainers) {
+        CloudSqlite.addHiddenProperty(cache, "catalogContainers", new Map());
+        CloudSqlite.addHiddenProperty(cache, "writeable", writeable);
+    }
+    return cache;
+}
+// find an existing CloudContainer for accessing a CatalogIModel, or make a new one and connect it
+async function getCatalogContainerObj(cache, containerId) {
+    const cloudContainer = cache.catalogContainers.get(containerId);
+    if (undefined !== cloudContainer)
+        return cloudContainer;
+    const accessLevel = cache.writeable ? "write" : "read";
+    const tokenProps = await CloudSqlite.getBlobService().requestToken({ containerId, accessLevel, userToken: await IModelHost.getAccessToken() });
+    const container = CloudSqlite.createCloudContainer({
+        accessLevel,
+        baseUri: tokenProps.baseUri,
+        containerId,
+        storageType: tokenProps.provider,
+        writeable: cache.writeable,
+        accessToken: tokenProps.token
+    });
+    cache.catalogContainers.set(containerId, container); // save the container in the map of ContainerIds so we can reuse them
+    container.connect(cache);
+    return container;
+}
+function getReadonlyCloudCache() { return readonlyCloudCache ??= makeCloudCache({ cacheName: "catalogs", cacheSize: "10G" }, false); }
+;
+function getWritableCloudCache() { return writeableCloudCache ??= makeCloudCache({ cacheName: "writeableCatalogs", cacheSize: "10G" }, true); }
+;
+async function getReadonlyContainer(containerId) { return getCatalogContainerObj(getReadonlyCloudCache(), containerId); }
+;
+async function getWriteableContainer(containerId) { return getCatalogContainerObj(getWritableCloudCache(), containerId); }
+;
+/** Throw an error if the write lock is not held for the supplied container */
+function ensureLocked(container, reason) {
+    if (!container.hasWriteLock)
+        CloudSqliteError.throwError("write-lock-not-held", { message: `Write lock must be held to ${reason}` });
+}
+/** update the manifest in a CatalogIModel (calls `saveChanges`) */
+function updateManifest(nativeDb, manifest) {
+    nativeDb.saveLocalValue(catalogManifestName, JSON.stringify(manifest));
+    nativeDb.saveChanges("update manifest");
+}
+function catalogDbNameWithDefault(dbName) {
+    return dbName ?? "catalog-db";
+}
+/** A StandaloneDb that holds a CatalogIModel */
+class CatalogDbImpl extends StandaloneDb {
+    isEditable() {
+        return false;
+    }
+    getManifest() {
+        const manifestString = this[_nativeDb].queryLocalValue(catalogManifestName);
+        if (undefined === manifestString)
+            return undefined;
+        return JSON.parse(manifestString);
+    }
+    getVersion() {
+        return CloudSqlite.parseDbFileName(this[_nativeDb].getFilePath()).version;
+    }
+    getInfo() {
+        return { manifest: this.getManifest(), version: this.getVersion() };
+    }
+}
+/**
+ * A CatalogDb that permits editing.
+ * This class ensures that CatalogIModels never have a Txn table when they are published.
+ * It also automatically updates the `lastEditedBy` field in the CatalogManifest.
+ */
+class EditableCatalogDbImpl extends CatalogDbImpl {
+    isEditable() {
+        return true;
+    }
+    updateCatalogManifest(manifest) {
+        updateManifest(this[_nativeDb], manifest);
+    }
+    // Make sure the txn table is deleted and update the manifest every time we close.
+    beforeClose() {
+        try {
+            const manifest = this.getManifest();
+            const container = this.cloudContainer;
+            if (container && manifest) {
+                manifest.lastEditedBy = CloudSqlite.getWriteLockHeldBy(container);
+                this.updateCatalogManifest(manifest);
+            }
+            // when saved, CatalogIModels should never have any Txns. If we wanted to create a changeset, we'd have to do it here.
+            this[_nativeDb].deleteAllTxns();
+        }
+        catch { } // ignore errors attempting to update
+        // might also want to vacuum here?
+        super.beforeClose();
+    }
+}
+function findCatalogByKey(key) {
+    return CatalogDbImpl.findByKey(key);
+}
+/** @beta */
+export var CatalogDb;
+(function (CatalogDb) {
+    /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].
+     * @returns The properties of the newly created container.
+     * @note creating new containers requires "admin" authorization.
+    */
+    async function createNewContainer(args) {
+        const dbName = catalogDbNameWithDefault(args.dbName);
+        CloudSqlite.validateDbName(dbName);
+        CloudSqlite.validateDbVersion(args.version);
+        const tmpName = join(KnownLocations.tmpdir, `temp-${dbName}`);
+        try {
+            // make a copy of the file they supplied so we can modify its contents safely
+            fs.copyFileSync(args.localCatalogFile, tmpName);
+            const nativeDb = new IModelNative.platform.DgnDb();
+            nativeDb.openIModel(tmpName, OpenMode.ReadWrite);
+            nativeDb.setITwinId(Guid.empty); // catalogs must be a StandaloneDb
+            nativeDb.setIModelId(Guid.createValue()); // make sure its iModelId is unique
+            updateManifest(nativeDb, args.manifest); // store the manifest inside the Catalog
+            nativeDb.deleteAllTxns(); // Catalogs should never have Txns (and, this must be empty before resetting BriefcaseId)
+            nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned); // catalogs should always be unassigned
+            nativeDb.saveChanges(); // save change to briefcaseId
+            nativeDb.vacuum();
+            nativeDb.closeFile();
+        }
+        catch (e) {
+            CatalogError.throwError("invalid-seed-catalog", { message: "Illegal seed catalog", ...args, cause: e });
+        }
+        const userToken = await IModelHost.getAccessToken();
+        // create tne new container from the blob service, requires "admin" authorization
+        const cloudContainerProps = await CloudSqlite.getBlobService().create({ scope: { iTwinId: args.iTwinId }, metadata: { ...args.metadata, containerType: "CatalogIModel" }, userToken });
+        // now create a CloudSqlite container object to access it
+        const container = CloudSqlite.createCloudContainer({
+            accessToken: await CloudSqlite.requestToken(cloudContainerProps),
+            accessLevel: "admin",
+            writeable: true,
+            baseUri: cloudContainerProps.baseUri,
+            containerId: cloudContainerProps.containerId,
+            storageType: cloudContainerProps.provider,
+        });
+        // initialize the container for use by CloudSqlite
+        container.initializeContainer({ blockSize: 4 * 1024 * 1024 });
+        container.connect(getWritableCloudCache());
+        // upload the initial version of the Catalog
+        await CloudSqlite.withWriteLock({ user: "initialize", container }, async () => {
+            await CloudSqlite.uploadDb(container, { dbName: CloudSqlite.makeSemverName(dbName, args.version), localFileName: tmpName });
+            fs.unlinkSync(tmpName); // delete temporary copy of catalog
+        });
+        container.disconnect();
+        return cloudContainerProps;
+    }
+    CatalogDb.createNewContainer = createNewContainer;
+    /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.
+     * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].
+     * @note This requires "write" authorization to the container
+     */
+    async function acquireWriteLock(args) {
+        const container = await getWriteableContainer(args.containerId);
+        return CloudSqlite.acquireWriteLock({ container, user: args.username });
+    }
+    CatalogDb.acquireWriteLock = acquireWriteLock;
+    /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */
+    async function releaseWriteLock(args) {
+        const container = await getWriteableContainer(args.containerId);
+        if (args.abandon)
+            container.abandonChanges();
+        CloudSqlite.releaseWriteLock(container);
+    }
+    CatalogDb.releaseWriteLock = releaseWriteLock;
+    /** Open an [[EditableCatalogDb]] for write access.
+     * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.
+     * @note The write lock must be held for this operation to succeed
+     */
+    async function openEditable(args) {
+        const dbName = catalogDbNameWithDefault(args.dbName);
+        if (undefined === args.containerId) // local file?
+            return EditableCatalogDbImpl.openFile(dbName, OpenMode.ReadWrite, args);
+        const container = await getWriteableContainer(args.containerId);
+        ensureLocked(container, "open a Catalog for editing"); // editing Catalogs requires the write lock
+        // look up the full name with version
+        const dbFullName = CloudSqlite.querySemverMatch({ container, dbName, version: args.version ?? "*" });
+        if (!CloudSqlite.isSemverEditable(dbFullName, container))
+            CloudSqliteError.throwError("already-published", { message: "Catalog has already been published and is not editable. Make a new version first.", ...args });
+        if (args.prefetch)
+            CloudSqlite.startCloudPrefetch(container, dbFullName);
+        return EditableCatalogDbImpl.openFile(dbFullName, OpenMode.ReadWrite, { container, ...args });
+    }
+    CatalogDb.openEditable = openEditable;
+    /** Open a [[CatalogDb]] for read-only access. */
+    async function openReadonly(args) {
+        const dbName = catalogDbNameWithDefault(args.dbName);
+        if (undefined === args.containerId) // local file?
+            return CatalogDbImpl.openFile(dbName, OpenMode.Readonly, args);
+        const container = await getReadonlyContainer(args.containerId);
+        if (args.syncWithCloud)
+            container.checkForChanges();
+        const dbFullName = CloudSqlite.querySemverMatch({ container, ...args, dbName });
+        if (args.prefetch)
+            CloudSqlite.startCloudPrefetch(container, dbFullName);
+        return CatalogDbImpl.openFile(dbFullName, OpenMode.Readonly, { container, ...args });
+    }
+    CatalogDb.openReadonly = openReadonly;
+    /**
+     * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy
+     * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.
+     * @note The write lock must be held for this operation to succeed
+     */
+    async function createNewVersion(args) {
+        const container = await getWriteableContainer(args.containerId);
+        ensureLocked(container, "create a new version");
+        return CloudSqlite.createNewDbVersion(container, { ...args, fromDb: { ...args.fromDb, dbName: catalogDbNameWithDefault(args.fromDb.dbName) } });
+    }
+    CatalogDb.createNewVersion = createNewVersion;
+})(CatalogDb || (CatalogDb = {}));
+/**
+ * Handler for Ipc access to CatalogIModels. Registered by NativeHost.
+ * @internal
+ */
+export class CatalogIModelHandler extends IpcHandler {
+    get channelName() { return "catalogIModel/ipc"; }
+    async createNewContainer(args) {
+        return CatalogDb.createNewContainer(args);
+    }
+    async acquireWriteLock(args) {
+        return CatalogDb.acquireWriteLock(args);
+    }
+    async releaseWriteLock(args) {
+        return CatalogDb.releaseWriteLock(args);
+    }
+    async openReadonly(args) {
+        return ((await CatalogDb.openReadonly(args)).getConnectionProps());
+    }
+    async openEditable(args) {
+        return (await CatalogDb.openEditable(args)).getConnectionProps();
+    }
+    async createNewVersion(args) {
+        return CatalogDb.createNewVersion(args);
+    }
+    async getInfo(key) {
+        return findCatalogByKey(key).getInfo();
+    }
+    async updateCatalogManifest(key, manifest) {
+        findCatalogByKey(key).updateCatalogManifest(manifest);
+    }
+}
+//# sourceMappingURL=CatalogDb.js.map

package/lib/esm/CatalogDb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogDb.js","sourceRoot":"","sources":["../../src/CatalogDb.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAsB,gBAAgB,EAAyB,MAAM,oBAAoB,CAAC;AACjI,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAQzD,IAAI,kBAAiD,CAAC;AACtD,IAAI,mBAAkD,CAAC;AACvD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAE9C,mHAAmH;AACnH,SAAS,cAAc,CAAC,GAAoC,EAAE,SAAkB;IAC9E,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAsB,CAAC;IACzE,qEAAqE;IACrE,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1C,WAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,GAAG,EAAsC,CAAC,CAAC;QACzG,WAAW,CAAC,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kGAAkG;AAClG,KAAK,UAAU,sBAAsB,CAAC,KAAwB,EAAE,WAAmB;IACjF,MAAM,cAAc,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAChE,IAAI,SAAS,KAAK,cAAc;QAC9B,OAAO,cAAc,CAAC;IAExB,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAC/I,MAAM,SAAS,GAAG,WAAW,CAAC,oBAAoB,CAAC;QACjD,WAAW;QACX,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,WAAW;QACX,WAAW,EAAE,UAAU,CAAC,QAAQ;QAChC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,UAAU,CAAC,KAAK;KAC9B,CAAC,CAAC;IACH,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,qEAAqE;IAC1H,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,KAAK,OAAO,kBAAkB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACtI,SAAS,qBAAqB,KAAK,OAAO,mBAAmB,KAAK,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAC/I,KAAK,UAAU,oBAAoB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AACjI,KAAK,UAAU,qBAAqB,CAAC,WAAmB,IAAI,OAAO,sBAAsB,CAAC,qBAAqB,EAAE,EAAE,WAAW,CAAC,CAAA,CAAC,CAAC;AAAA,CAAC;AAElI,8EAA8E;AAC9E,SAAS,YAAY,CAAC,SAAqC,EAAE,MAAc;IACzE,IAAI,CAAC,SAAS,CAAC,YAAY;QACzB,gBAAgB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,8BAA8B,MAAM,EAAE,EAAE,CAAC,CAAC;AAC5G,CAAC;AACD,mEAAmE;AACnE,SAAS,cAAc,CAAC,QAA8B,EAAE,QAAgC;IACtF,QAAQ,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;AAC1C,CAAC;AACD,SAAS,wBAAwB,CAAC,MAAe;IAC/C,OAAO,MAAM,IAAI,YAAY,CAAC;AAChC,CAAC;AA0BD,gDAAgD;AAChD,MAAM,aAAc,SAAQ,YAAY;IAC/B,UAAU;QACf,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,WAAW;QAChB,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;QAC5E,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO,SAAS,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAA2B,CAAC;IAC9D,CAAC;IAEM,UAAU;QACf,OAAO,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC;IAC5E,CAAC;IAEM,OAAO;QACZ,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;IACtE,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,qBAAsB,SAAQ,aAAa;IAC/B,UAAU;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,qBAAqB,CAAC,QAAgC;QAC3D,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,kFAAkF;IAClE,WAAW;QACzB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC;YACtC,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;gBAC1B,QAAQ,CAAC,YAAY,GAAG,WAAW,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBAClE,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;YACvC,CAAC;YAED,sHAAsH;YACtH,IAAI,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAEjD,kCAAkC;QAClC,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,GAAW;IACnC,OAAO,aAAa,CAAC,SAAS,CAAC,GAAG,CAAsC,CAAC;AAC3E,CAAC;AAED,YAAY;AACZ,MAAM,KAAW,SAAS,CAuIzB;AAvID,WAAiB,SAAS;IACxB;;;MAGE;IACK,KAAK,UAAU,kBAAkB,CAAC,IAA0C;QACjF,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACnC,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,MAAM,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,6EAA6E;YAC7E,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnD,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;YACjD,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,kCAAkC;YACnE,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,mCAAmC;YAC7E,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,wCAAwC;YACjF,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,yFAAyF;YACnH,QAAQ,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,uCAAuC;YAC/F,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,6BAA6B;YACrD,QAAQ,CAAC,MAAM,EAAE,CAAC;YAClB,QAAQ,CAAC,SAAS,EAAE,CAAC;QACvB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,YAAY,CAAC,UAAU,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1G,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,iFAAiF;QACjF,MAAM,mBAAmB,GAAG,MAAM,WAAW,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAEvL,yDAAyD;QACzD,MAAM,SAAS,GAAG,WAAW,CAAC,oBAAoB,CAAC;YACjD,WAAW,EAAE,MAAM,WAAW,CAAC,YAAY,CAAC,mBAAmB,CAAC;YAChE,WAAW,EAAE,OAAO;YACpB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,mBAAmB,CAAC,OAAO;YACpC,WAAW,EAAE,mBAAmB,CAAC,WAAW;YAC5C,WAAW,EAAE,mBAAmB,CAAC,QAAQ;SAC1C,CAAC,CAAC;QAEH,kDAAkD;QAClD,SAAS,CAAC,mBAAmB,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;QAC9D,SAAS,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE3C,4CAA4C;QAC5C,MAAM,WAAW,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,KAAK,IAAI,EAAE;YAC5E,MAAM,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;YAC5H,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAmC;QAC7D,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAhDqB,4BAAkB,qBAgDvC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAQtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,WAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;IAXqB,0BAAgB,mBAWrC,CAAA;IAED,mKAAmK;IAC5J,KAAK,UAAU,gBAAgB,CAAC,IAKtC;QACC,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,OAAO;YACd,SAAS,CAAC,cAAc,EAAE,CAAC;QAC7B,WAAW,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IAVqB,0BAAgB,mBAUrC,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,CAA0B,CAAC;QAEnG,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC,CAAC,2CAA2C;QAElG,qCAAqC;QACrC,MAAM,UAAU,GAAG,WAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;QACrG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAC;YACtD,gBAAgB,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE,OAAO,EAAE,mFAAmF,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QAE7J,IAAI,IAAI,CAAC,QAAQ;YACf,WAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAA0B,CAAC;IACzH,CAAC;IAjBqB,sBAAY,eAiBjC,CAAA;IAED,iDAAiD;IAC1C,KAAK,UAAU,YAAY,CAAC,IAA4B;QAC7D,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,cAAc;YAChD,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAkB,CAAC;QAElF,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,aAAa;YACpB,SAAS,CAAC,eAAe,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,WAAW,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ;YACf,WAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,aAAa,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,CAAkB,CAAC;IACxG,CAAC;IAdqB,sBAAY,eAcjC,CAAA;IAED;;;;OAIG;IACI,KAAK,UAAU,gBAAgB,CAAC,IAAwC;QAC7E,MAAM,SAAS,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,YAAY,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QAChD,OAAO,WAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAClJ,CAAC;IAJqB,0BAAgB,mBAIrC,CAAA;AACH,CAAC,EAvIgB,SAAS,KAAT,SAAS,QAuIzB;AAED;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,UAAU;IAClD,IAAW,WAAW,KAA+B,OAAO,mBAAmB,CAAC,CAAC,CAAC;IAE3E,KAAK,CAAC,kBAAkB,CAAC,IAA0C;QACxE,OAAO,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAgD;QAC5E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAA8C;QAC1E,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,IAA4B;QACpD,OAAO,CAAC,MAAM,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACnE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,IAAwC;QACpE,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IACM,KAAK,CAAC,qBAAqB,CAAC,GAAW,EAAE,QAAgC;QAC9E,gBAAgB,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport * as fs from \"fs\";\nimport { join } from \"path\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelHost, KnownLocations } from \"./IModelHost\";\nimport { BriefcaseIdValue, CatalogError, type CatalogIModel, CloudSqliteError, IModelConnectionProps } from \"@itwin/core-common\";\nimport { IpcHandler } from \"./IpcHost\";\nimport { StandaloneDb } from \"./IModelDb\";\nimport { Guid, OpenMode } from \"@itwin/core-bentley\";\nimport { _nativeDb } from \"./internal/Symbols\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\n\ninterface CatalogCloudCache extends CloudSqlite.CloudCache {\n  writeable: boolean;\n  catalogContainers: Map<string, CloudSqlite.CloudContainer>;\n}\n\nlet readonlyCloudCache: CatalogCloudCache | undefined;\nlet writeableCloudCache: CatalogCloudCache | undefined;\nconst catalogManifestName = \"CatalogManifest\";\n\n// we make a readonly CloudCache and a writeable CloudCache. That way the access token authorizations are distinct.\nfunction makeCloudCache(arg: CloudSqlite.CreateCloudCacheArg, writeable: boolean) {\n  const cache = CloudSqlite.CloudCaches.getCache(arg) as CatalogCloudCache;\n  // if the cache was just created, add the \"catalog\" members as hidden\n  if (undefined === cache.catalogContainers) {\n    CloudSqlite.addHiddenProperty(cache, \"catalogContainers\", new Map<string, CloudSqlite.CloudContainer>());\n    CloudSqlite.addHiddenProperty(cache, \"writeable\", writeable);\n  }\n  return cache;\n}\n\n// find an existing CloudContainer for accessing a CatalogIModel, or make a new one and connect it\nasync function getCatalogContainerObj(cache: CatalogCloudCache, containerId: string): Promise<CloudSqlite.CloudContainer> {\n  const cloudContainer = cache.catalogContainers.get(containerId);\n  if (undefined !== cloudContainer)\n    return cloudContainer;\n\n  const accessLevel = cache.writeable ? \"write\" : \"read\";\n  const tokenProps = await CloudSqlite.getBlobService().requestToken({ containerId, accessLevel, userToken: await IModelHost.getAccessToken() });\n  const container = CloudSqlite.createCloudContainer({\n    accessLevel,\n    baseUri: tokenProps.baseUri,\n    containerId,\n    storageType: tokenProps.provider,\n    writeable: cache.writeable,\n    accessToken: tokenProps.token\n  });\n  cache.catalogContainers.set(containerId, container); // save the container in the map of ContainerIds so we can reuse them\n  container.connect(cache);\n  return container;\n}\n\nfunction getReadonlyCloudCache() { return readonlyCloudCache ??= makeCloudCache({ cacheName: \"catalogs\", cacheSize: \"10G\" }, false) };\nfunction getWritableCloudCache() { return writeableCloudCache ??= makeCloudCache({ cacheName: \"writeableCatalogs\", cacheSize: \"10G\" }, true) };\nasync function getReadonlyContainer(containerId: string) { return getCatalogContainerObj(getReadonlyCloudCache(), containerId) };\nasync function getWriteableContainer(containerId: string) { return getCatalogContainerObj(getWritableCloudCache(), containerId) };\n\n/** Throw an error if the write lock is not held for the supplied container */\nfunction ensureLocked(container: CloudSqlite.CloudContainer, reason: string) {\n  if (!container.hasWriteLock)\n    CloudSqliteError.throwError(\"write-lock-not-held\", { message: `Write lock must be held to ${reason}` });\n}\n/** update the manifest in a CatalogIModel (calls `saveChanges`) */\nfunction updateManifest(nativeDb: IModelJsNative.DgnDb, manifest: CatalogIModel.Manifest) {\n  nativeDb.saveLocalValue(catalogManifestName, JSON.stringify(manifest));\n  nativeDb.saveChanges(\"update manifest\");\n}\nfunction catalogDbNameWithDefault(dbName?: string): string {\n  return dbName ?? \"catalog-db\";\n}\n\n/** A [[StandaloneDb]] that provides read-only access to the contents of a [CatalogIModel]($common).\n * @see [[CatalogDb.openReadonly]] to instantiate this type.\n * @beta\n */\nexport interface CatalogDb extends StandaloneDb {\n  /** Get the catalog's manifest. */\n  getManifest(): CatalogIModel.Manifest | undefined;\n  /** Get the catalog's version information. */\n  getVersion(): string;\n  /** Get the catalog's manifest and version. */\n  getInfo(): { manifest?: CatalogIModel.Manifest, version: string };\n  /** Returns true if the catalog was opened in read-write mode. */\n  isEditable(): this is EditableCatalogDb;\n}\n\n/** A writable [[CatalogDb]].\n * @see [[CatalogDb.openEditable]] to instantiate this type.\n * @beta\n */\nexport interface EditableCatalogDb extends CatalogDb {\n  /** Update the contents of the catalog manifest.  */\n  updateCatalogManifest(manifest: CatalogIModel.Manifest): void;\n}\n\n/** A StandaloneDb that holds a CatalogIModel */\nclass CatalogDbImpl extends StandaloneDb implements CatalogDb {\n  public isEditable(): this is EditableCatalogDb {\n    return false;\n  }\n\n  public getManifest(): CatalogIModel.Manifest | undefined {\n    const manifestString = this[_nativeDb].queryLocalValue(catalogManifestName);\n    if (undefined === manifestString)\n      return undefined;\n    return JSON.parse(manifestString) as CatalogIModel.Manifest;\n  }\n\n  public getVersion(): string {\n    return CloudSqlite.parseDbFileName(this[_nativeDb].getFilePath()).version;\n  }\n\n  public getInfo() {\n    return { manifest: this.getManifest(), version: this.getVersion() };\n  }\n}\n\n/**\n * A CatalogDb that permits editing.\n * This class ensures that CatalogIModels never have a Txn table when they are published.\n * It also automatically updates the `lastEditedBy` field in the CatalogManifest.\n */\nclass EditableCatalogDbImpl extends CatalogDbImpl implements EditableCatalogDb {\n  public override isEditable(): this is EditableCatalogDb {\n    return true;\n  }\n\n  public updateCatalogManifest(manifest: CatalogIModel.Manifest): void {\n    updateManifest(this[_nativeDb], manifest);\n  }\n\n  // Make sure the txn table is deleted and update the manifest every time we close.\n  public override beforeClose(): void {\n    try {\n      const manifest = this.getManifest();\n      const container = this.cloudContainer;\n      if (container && manifest) {\n        manifest.lastEditedBy = CloudSqlite.getWriteLockHeldBy(container);\n        this.updateCatalogManifest(manifest);\n      }\n\n      // when saved, CatalogIModels should never have any Txns. If we wanted to create a changeset, we'd have to do it here.\n      this[_nativeDb].deleteAllTxns();\n    } catch { } // ignore errors attempting to update\n\n    // might also want to vacuum here?\n    super.beforeClose();\n  }\n}\n\nfunction findCatalogByKey(key: string): CatalogDbImpl & EditableCatalogDb {\n  return CatalogDbImpl.findByKey(key) as CatalogDbImpl & EditableCatalogDb;\n}\n\n/** @beta */\nexport namespace CatalogDb {\n  /** Create a new [[BlobContainer]] to hold versions of a [[CatalogDb]].\n   * @returns The properties of the newly created container.\n   * @note creating new containers requires \"admin\" authorization.\n  */\n  export async function createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    CloudSqlite.validateDbName(dbName);\n    CloudSqlite.validateDbVersion(args.version);\n\n    const tmpName = join(KnownLocations.tmpdir, `temp-${dbName}`);\n    try {\n      // make a copy of the file they supplied so we can modify its contents safely\n      fs.copyFileSync(args.localCatalogFile, tmpName);\n      const nativeDb = new IModelNative.platform.DgnDb();\n      nativeDb.openIModel(tmpName, OpenMode.ReadWrite);\n      nativeDb.setITwinId(Guid.empty); // catalogs must be a StandaloneDb\n      nativeDb.setIModelId(Guid.createValue()); // make sure its iModelId is unique\n      updateManifest(nativeDb, args.manifest); // store the manifest inside the Catalog\n      nativeDb.deleteAllTxns(); // Catalogs should never have Txns (and, this must be empty before resetting BriefcaseId)\n      nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned); // catalogs should always be unassigned\n      nativeDb.saveChanges(); // save change to briefcaseId\n      nativeDb.vacuum();\n      nativeDb.closeFile();\n    } catch (e: unknown) {\n      CatalogError.throwError(\"invalid-seed-catalog\", { message: \"Illegal seed catalog\", ...args, cause: e });\n    }\n\n    const userToken = await IModelHost.getAccessToken();\n    // create tne new container from the blob service, requires \"admin\" authorization\n    const cloudContainerProps = await CloudSqlite.getBlobService().create({ scope: { iTwinId: args.iTwinId }, metadata: { ...args.metadata, containerType: \"CatalogIModel\" }, userToken });\n\n    // now create a CloudSqlite container object to access it\n    const container = CloudSqlite.createCloudContainer({\n      accessToken: await CloudSqlite.requestToken(cloudContainerProps),\n      accessLevel: \"admin\",\n      writeable: true,\n      baseUri: cloudContainerProps.baseUri,\n      containerId: cloudContainerProps.containerId,\n      storageType: cloudContainerProps.provider,\n    });\n\n    // initialize the container for use by CloudSqlite\n    container.initializeContainer({ blockSize: 4 * 1024 * 1024 });\n    container.connect(getWritableCloudCache());\n\n    // upload the initial version of the Catalog\n    await CloudSqlite.withWriteLock({ user: \"initialize\", container }, async () => {\n      await CloudSqlite.uploadDb(container, { dbName: CloudSqlite.makeSemverName(dbName, args.version), localFileName: tmpName });\n      fs.unlinkSync(tmpName); // delete temporary copy of catalog\n    });\n    container.disconnect();\n    return cloudContainerProps;\n  }\n\n  /** Acquire the write lock for a [CatalogIModel]($common) container. Only one person may obtain the write lock at a time.\n   * You must obtain the lock before attempting to write to the container via functions like [[CatalogDb.openEditable]] and [[CatalogDb.createNewVersion]].\n   * @note This requires \"write\" authorization to the container\n   */\n  export async function acquireWriteLock(args: {\n    /** The id of the container */\n    containerId: string,\n    /**\n     * The name of the individual acquiring the lock. This will be shown to others who attempt to acquire the lock while it is held.\n     * It is also stored in the \"lastEditedBy\" field of the manifest of any new version edited while the lock is held.\n     */\n    username: string;\n  }): Promise<void> {\n    const container = await getWriteableContainer(args.containerId);\n    return CloudSqlite.acquireWriteLock({ container, user: args.username });\n  }\n\n  /** Release the write lock on a [CatalogIModel]($common) container. This uploads all changes made while the lock is held, so they become visible to other users. */\n  export async function releaseWriteLock(args: {\n    /** The id of the container */\n    containerId: string,\n    /** If true, abandon all local changes before releasing the lock */\n    abandon?: true\n  }): Promise<void> {\n    const container = await getWriteableContainer(args.containerId);\n    if (args.abandon)\n      container.abandonChanges();\n    CloudSqlite.releaseWriteLock(container);\n  }\n\n  /** Open an [[EditableCatalogDb]] for write access.\n   * @note Once a version of a catalog iModel has been published (i.e. the write lock has been released), it is no longer editable, *unless* it is a prerelease version.\n   * @note The write lock must be held for this operation to succeed\n   */\n  export async function openEditable(args: CatalogIModel.OpenArgs): Promise<EditableCatalogDb> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    if (undefined === args.containerId) // local file?\n      return EditableCatalogDbImpl.openFile(dbName, OpenMode.ReadWrite, args) as EditableCatalogDbImpl;\n\n    const container = await getWriteableContainer(args.containerId);\n    ensureLocked(container, \"open a Catalog for editing\"); // editing Catalogs requires the write lock\n\n    // look up the full name with version\n    const dbFullName = CloudSqlite.querySemverMatch({ container, dbName, version: args.version ?? \"*\" });\n    if (!CloudSqlite.isSemverEditable(dbFullName, container))\n      CloudSqliteError.throwError(\"already-published\", { message: \"Catalog has already been published and is not editable. Make a new version first.\", ...args })\n\n    if (args.prefetch)\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\n\n    return EditableCatalogDbImpl.openFile(dbFullName, OpenMode.ReadWrite, { container, ...args }) as EditableCatalogDbImpl;\n  }\n\n  /** Open a [[CatalogDb]] for read-only access. */\n  export async function openReadonly(args: CatalogIModel.OpenArgs): Promise<CatalogDb> {\n    const dbName = catalogDbNameWithDefault(args.dbName);\n    if (undefined === args.containerId) // local file?\n      return CatalogDbImpl.openFile(dbName, OpenMode.Readonly, args) as CatalogDbImpl;\n\n    const container = await getReadonlyContainer(args.containerId);\n    if (args.syncWithCloud)\n      container.checkForChanges();\n\n    const dbFullName = CloudSqlite.querySemverMatch({ container, ...args, dbName });\n    if (args.prefetch)\n      CloudSqlite.startCloudPrefetch(container, dbFullName);\n\n    return CatalogDbImpl.openFile(dbFullName, OpenMode.Readonly, { container, ...args }) as CatalogDbImpl;\n  }\n\n  /**\n   * Create a new version of a [CatalogIModel]($common) as a copy of an existing version. Immediately after this operation, the new version will be an exact copy\n   * of the source CatalogIModel. Then, use [[CatalogDb.openEditable]] to modify the new version with new content.\n   * @note The write lock must be held for this operation to succeed\n   */\n  export async function createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\n    const container = await getWriteableContainer(args.containerId);\n    ensureLocked(container, \"create a new version\");\n    return CloudSqlite.createNewDbVersion(container, { ...args, fromDb: { ...args.fromDb, dbName: catalogDbNameWithDefault(args.fromDb.dbName) } });\n  }\n}\n\n/**\n * Handler for Ipc access to CatalogIModels. Registered by NativeHost.\n * @internal\n */\nexport class CatalogIModelHandler extends IpcHandler implements CatalogIModel.IpcMethods {\n  public get channelName(): CatalogIModel.IpcChannel { return \"catalogIModel/ipc\"; }\n\n  public async createNewContainer(args: CatalogIModel.CreateNewContainerArgs): Promise<CatalogIModel.NewContainerProps> {\n    return CatalogDb.createNewContainer(args);\n  }\n  public async acquireWriteLock(args: { containerId: string, username: string; }): Promise<void> {\n    return CatalogDb.acquireWriteLock(args);\n  }\n  public async releaseWriteLock(args: { containerId: string, abandon?: true; }): Promise<void> {\n    return CatalogDb.releaseWriteLock(args);\n  }\n  public async openReadonly(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\n    return ((await CatalogDb.openReadonly(args)).getConnectionProps());\n  }\n  public async openEditable(args: CatalogIModel.OpenArgs): Promise<IModelConnectionProps> {\n    return (await CatalogDb.openEditable(args)).getConnectionProps();\n  }\n  public async createNewVersion(args: CatalogIModel.CreateNewVersionArgs): Promise<{ oldDb: CatalogIModel.NameAndVersion; newDb: CatalogIModel.NameAndVersion; }> {\n    return CatalogDb.createNewVersion(args);\n  }\n  public async getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }> {\n    return findCatalogByKey(key).getInfo();\n  }\n  public async updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void> {\n    findCatalogByKey(key).updateCatalogManifest(manifest);\n  }\n}\n"]}