@itwin/core-common 5.0.0-dev.11 → 5.0.0-dev.111

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

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseTypes.d.ts","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC3F,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,OAAO,aAAa;IAEpB,gDAAgD;IAChD,GAAG,WAAU;IAEb,gFAAgF;IAChF,UAAU,IAAI;IAEd,+EAA+E;IAC/E,SAAS,WAA4B;IAErC;;;;;;;;;;OAUG;IACH,UAAU,IAAI;CACf;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,mIAAmI;IACnI,YAAY,IAAI;IAChB,0FAA0F;IAC1F,WAAW,IAAI;IACf,qJAAqJ;IACrJ,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB,EAAE,SAAS;IAC1E,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,oBAAoB;IACpB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,uBAAuB;IACvB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAElC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,2GAA2G;IAC3G,QAAQ,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,6FAA6F;IAC7F,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,qJAAqJ;IACrJ,qBAAqB,IAAI;IAEzB,iKAAiK;IACjK,wBAAwB,IAAI;IAE5B,sMAAsM;IACtM,OAAO,IAAI;IAEX,qFAAqF;IACrF,SAAS,IAAI;CACd;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,0GAA0G;IAC1G,IAAI,IAAI;IAER,qDAAqD;IACrD,OAAO,IAAI;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEhC,6FAA6F;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC,kFAAkF;IAClF,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,oBAAY,WAAW;IACrB,sIAAsI;IACtI,QAAQ,IAAA;IAER;;;OAGG;IACH,eAAe,IAAA;IAEf,4IAA4I;IAC5I,kBAAkB,IAAA;IAElB,oIAAoI;IACpI,MAAM,IAAA;IAEN,4FAA4F;IAC5F,MAAM,IAAA;CACP"}
+{"version":3,"file":"BriefcaseTypes.d.ts","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,OAAO,aAAa;IAEpB,gDAAgD;IAChD,GAAG,WAAU;IAEb,gFAAgF;IAChF,UAAU,IAAI;IAEd,+EAA+E;IAC/E,SAAS,WAA4B;IAErC;;;;;;;;;;OAUG;IACH,UAAU,IAAI;CACf;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,mIAAmI;IACnI,YAAY,IAAI;IAChB,0FAA0F;IAC1F,WAAW,IAAI;IACf,qJAAqJ;IACrJ,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,oBAAoB;IACpB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,uBAAuB;IACvB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAElC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,2GAA2G;IAC3G,QAAQ,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,6FAA6F;IAC7F,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,qJAAqJ;IACrJ,qBAAqB,IAAI;IAEzB,iKAAiK;IACjK,wBAAwB,IAAI;IAE5B,sMAAsM;IACtM,OAAO,IAAI;IAEX,qFAAqF;IACrF,SAAS,IAAI;CACd;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,0GAA0G;IAC1G,IAAI,IAAI;IAER,qDAAqD;IACrD,OAAO,IAAI;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEhC,6FAA6F;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC,kFAAkF;IAClF,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,oBAAY,WAAW;IACrB,sIAAsI;IACtI,QAAQ,IAAA;IAER;;;OAGG;IACH,eAAe,IAAA;IAEf,4IAA4I;IAC5I,kBAAkB,IAAA;IAElB,oIAAoI;IACpI,MAAM,IAAA;IAEN,4FAA4F;IAC5F,MAAM,IAAA;CACP"}

package/lib/esm/BriefcaseTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseTypes.js","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,sEAAoB,CAAA;IAEpB,gDAAgD;IAChD,4DAAa,CAAA;IAEb,gFAAgF;IAChF,mEAAc,CAAA;IAEd,+EAA+E;IAC/E,wEAAqC,CAAA;IAErC;;;;;;;;;;OAUG;IACH,mEAAc,CAAA;AAChB,CAAC,EAzBW,gBAAgB,KAAhB,gBAAgB,QAyB3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAwID;;GAEG;AACH,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,qJAAqJ;IACrJ,mFAAyB,CAAA;IAEzB,iKAAiK;IACjK,yFAA4B,CAAA;IAE5B,sMAAsM;IACtM,uDAAW,CAAA;IAEX,qFAAqF;IACrF,2DAAa,CAAA;AACf,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAgBD;;;;GAIG;AACH,MAAM,CAAN,IAAY,WAkBX;AAlBD,WAAY,WAAW;IACrB,sIAAsI;IACtI,qDAAQ,CAAA;IAER;;;OAGG;IACH,mEAAe,CAAA;IAEf,4IAA4I;IAC5I,yEAAkB,CAAA;IAElB,oIAAoI;IACpI,iDAAM,CAAA;IAEN,4FAA4F;IAC5F,iDAAM,CAAA;AACR,CAAC,EAlBW,WAAW,KAAX,WAAW,QAkBtB","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 iModels\r\n */\r\n\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { ChangesetIdWithIndex, ChangesetIndexOrId, LocalFileName } from \"./ChangesetProps\";\r\nimport { IModelEncryptionProps, OpenDbKey } from \"./IModel\";\r\nimport { IModelVersionProps } from \"./IModelVersion\";\r\n\r\n/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .\r\n * @public\r\n * @extensions\r\n */\r\nexport type BriefcaseId = number;\r\n\r\n/** Values of [[BriefcaseId]] that have special meaning.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BriefcaseIdValue {\r\n  /** Indicates an invalid/illegal BriefcaseId */\r\n  Illegal = 0xffffffff,\r\n\r\n  /** BriefcaseIds must be less than this value */\r\n  Max = 1 << 24,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */\r\n  FirstValid = 2,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */\r\n  LastValid = BriefcaseIdValue.Max - 11,\r\n\r\n  /**\r\n   * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,\r\n   * because BriefcaseId is used to create unique ElementIds for new elements.\r\n   *\r\n   * The `Unassigned` briefcaseId is used for several purposes:\r\n   *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.\r\n   *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.\r\n   *  - **PullOnly**. A local briefcase file that may be used to \"slide\" along a timeline by applying incoming changesets.\r\n   * They are always opened readonly except to apply changesets.\r\n   *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.\r\n   */\r\n  Unassigned = 0,\r\n}\r\n\r\n/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SyncMode {\r\n  /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */\r\n  FixedVersion = 1,\r\n  /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */\r\n  PullAndPush = 2,\r\n  /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */\r\n  PullOnly = 3,\r\n}\r\n\r\n/**\r\n * Options to open a previously downloaded briefcase\r\n * @public\r\n */\r\nexport interface OpenBriefcaseOptions {\r\n  /** open briefcase Readonly */\r\n  readonly openAsReadOnly?: boolean;\r\n}\r\n\r\n/**\r\n * Properties that specify a briefcase within the local briefcase cache.\r\n * @see BriefcaseManager.getFileName\r\n * @public\r\n */\r\nexport interface BriefcaseProps {\r\n  /** Id of the iModel */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** BriefcaseId of the briefcase */\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)\r\n * @public\r\n */\r\nexport interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line @typescript-eslint/no-deprecated\r\n  /** the full path to the briefcase file  */\r\n  readonly fileName: LocalFileName;\r\n  /**\r\n   * If true, open the briefcase readonly.\r\n   * @note Readonly connections always hold a read transaction against the briefcase. That can cause the WAL file size to grow\r\n   * unbounded if changes happen while they're open (see [Checkpoint starvation](https://www.sqlite.org/wal.html#avoiding_excessively_large_wal_files))\r\n   * It is a good idea to close the readonly connection *before* closing the writeable connection so the WAL file will be deleted.\r\n   */\r\n  readonly readonly?: boolean;\r\n  /** If true, open the briefcase readonly and monitor it for changes originating from another connection.\r\n   * When such changes are detected, the default txn will be restarted.\r\n   * The restart occurs only after the next iteration of the backend event loop, and will generate events that reflect the changes from the other connection.\r\n   * This can be useful in contexts where the read-only connection is displaying a view of the contents of the briefcase while another, non-interactive program\r\n   * is adding txns to the briefcase. It may not be reliable if the writable connection is undoing or redoing txns.\r\n   * @note This cannot be used with cloud-based briefcases.\r\n   */\r\n  readonly watchForChanges?: boolean;\r\n}\r\n\r\n/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface LocalBriefcaseProps {\r\n  /** Full path of local file. */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** The iTwin containing the iModel. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** The briefcaseId. */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** The current changesetId.\r\n   * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.\r\n   */\r\n  readonly changeset: ChangesetIdWithIndex;\r\n\r\n  /** Size of the briefcase file in bytes  */\r\n  readonly fileSize: number;\r\n}\r\n\r\n/** Properties for downloading a briefcase to a local file, from iModelHub.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RequestNewBriefcaseProps {\r\n  /** iTwin that the iModel belongs to. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId for the new briefcase. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.\r\n   * Callers can use this to open the briefcase after the download completes.\r\n   * @note this member is both an input and an output.\r\n   */\r\n  readonly fileName?: LocalFileName;\r\n\r\n  /**\r\n   * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.\r\n   * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as \"pull only\" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].\r\n   * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )\r\n   * when you are done with them.\r\n   * @note this member is both an input and an output.\r\n   *\r\n   */\r\n  briefcaseId?: BriefcaseId;\r\n\r\n  /** Id of the change set of the new briefcase. If undefined, use latest. */\r\n  asOf?: IModelVersionProps;\r\n}\r\n\r\n/**\r\n * Arguments to open a Checkpoint directly from its cloud container\r\n * @beta\r\n */\r\nexport interface OpenCheckpointArgs {\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** Id of the iModel */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** changeset for the checkpoint. If undefined, attempt to open the checkpoint for the latest changeset. */\r\n  readonly changeset?: ChangesetIndexOrId;\r\n}\r\n\r\n/**\r\n * Manages the download of a briefcase\r\n * @public\r\n */\r\nexport interface BriefcaseDownloader {\r\n  /** Id of the briefcase being downloaded */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** the name of the local file for the briefcase */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** Promise that resolves when the download completes. await this to complete the download */\r\n  readonly downloadPromise: Promise<void>;\r\n\r\n  /** Request cancellation of the download */\r\n  readonly requestCancel: () => Promise<boolean>;\r\n}\r\n\r\n/** Option to control the validation and upgrade of domain schemas in the Db\r\n * @beta\r\n */\r\nexport enum DomainOptions {\r\n  /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRequiredUpgrades = 0,\r\n\r\n  /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRecommendedUpgrades = 1,\r\n\r\n  /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */\r\n  Upgrade = 2,\r\n\r\n  /** Domain schemas will neither be validated nor be upgraded. Used only internally */\r\n  SkipCheck = 3,\r\n}\r\n\r\n/** Options that control whether a profile upgrade should be performed when opening a Db\r\n * @beta\r\n */\r\nexport enum ProfileOptions {\r\n  /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */\r\n  None = 0,\r\n\r\n  /** Profile upgrade will be performed if necessary */\r\n  Upgrade = 1,\r\n}\r\n\r\n/** Arguments to validate and update the profile and domain schemas when opening a Db\r\n * @beta\r\n */\r\nexport interface UpgradeOptions {\r\n  /** Option to control the validation and upgrade of domain schemas in the Db */\r\n  readonly domain?: DomainOptions;\r\n\r\n  /** Options that control whether a profile upgrade should be performed when opening a file */\r\n  readonly profile?: ProfileOptions;\r\n\r\n  /** Options that will allow data transform during Profile/Domain schema upgrade */\r\n  readonly schemaLockHeld?: boolean;\r\n}\r\n\r\n/**\r\n * The state of the schemas in the Db compared with what the current version of the software expects\r\n * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.\r\n * @public\r\n */\r\nexport enum SchemaState {\r\n  /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */\r\n  UpToDate,\r\n\r\n  /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.\r\n   * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before\r\n   * it can write data based on that new schema.\r\n   */\r\n  UpgradeRequired,\r\n\r\n  /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */\r\n  UpgradeRecommended,\r\n\r\n  /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */\r\n  TooOld,\r\n\r\n  /** The schemas in the Db are too new to be opened by the current version of the software */\r\n  TooNew,\r\n}\r\n"]}
+{"version":3,"file":"BriefcaseTypes.js","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,sEAAoB,CAAA;IAEpB,gDAAgD;IAChD,4DAAa,CAAA;IAEb,gFAAgF;IAChF,mEAAc,CAAA;IAEd,+EAA+E;IAC/E,wEAAqC,CAAA;IAErC;;;;;;;;;;OAUG;IACH,mEAAc,CAAA;AAChB,CAAC,EAzBW,gBAAgB,KAAhB,gBAAgB,QAyB3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAwID;;GAEG;AACH,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,qJAAqJ;IACrJ,mFAAyB,CAAA;IAEzB,iKAAiK;IACjK,yFAA4B,CAAA;IAE5B,sMAAsM;IACtM,uDAAW,CAAA;IAEX,qFAAqF;IACrF,2DAAa,CAAA;AACf,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAgBD;;;;GAIG;AACH,MAAM,CAAN,IAAY,WAkBX;AAlBD,WAAY,WAAW;IACrB,sIAAsI;IACtI,qDAAQ,CAAA;IAER;;;OAGG;IACH,mEAAe,CAAA;IAEf,4IAA4I;IAC5I,yEAAkB,CAAA;IAElB,oIAAoI;IACpI,iDAAM,CAAA;IAEN,4FAA4F;IAC5F,iDAAM,CAAA;AACR,CAAC,EAlBW,WAAW,KAAX,WAAW,QAkBtB","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 { GuidString } from \"@itwin/core-bentley\";\nimport { ChangesetIdWithIndex, ChangesetIndexOrId, LocalFileName } from \"./ChangesetProps\";\nimport { OpenDbKey } from \"./IModel\";\nimport { IModelVersionProps } from \"./IModelVersion\";\n\n/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .\n * @public\n * @extensions\n */\nexport type BriefcaseId = number;\n\n/** Values of [[BriefcaseId]] that have special meaning.\n * @public\n * @extensions\n */\nexport enum BriefcaseIdValue {\n  /** Indicates an invalid/illegal BriefcaseId */\n  Illegal = 0xffffffff,\n\n  /** BriefcaseIds must be less than this value */\n  Max = 1 << 24,\n\n  /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */\n  FirstValid = 2,\n\n  /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */\n  LastValid = BriefcaseIdValue.Max - 11,\n\n  /**\n   * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,\n   * because BriefcaseId is used to create unique ElementIds for new elements.\n   *\n   * The `Unassigned` briefcaseId is used for several purposes:\n   *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.\n   *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.\n   *  - **PullOnly**. A local briefcase file that may be used to \"slide\" along a timeline by applying incoming changesets.\n   * They are always opened readonly except to apply changesets.\n   *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.\n   */\n  Unassigned = 0,\n}\n\n/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub\n * @public\n * @extensions\n */\nexport enum SyncMode {\n  /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */\n  FixedVersion = 1,\n  /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */\n  PullAndPush = 2,\n  /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */\n  PullOnly = 3,\n}\n\n/**\n * Options to open a previously downloaded briefcase\n * @public\n */\nexport interface OpenBriefcaseOptions {\n  /** open briefcase Readonly */\n  readonly openAsReadOnly?: boolean;\n}\n\n/**\n * Properties that specify a briefcase within the local briefcase cache.\n * @see BriefcaseManager.getFileName\n * @public\n */\nexport interface BriefcaseProps {\n  /** Id of the iModel */\n  readonly iModelId: GuidString;\n\n  /** BriefcaseId of the briefcase */\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)\n * @public\n */\nexport interface OpenBriefcaseProps extends OpenDbKey {\n  /** the full path to the briefcase file  */\n  readonly fileName: LocalFileName;\n  /**\n   * If true, open the briefcase readonly.\n   * @note Readonly connections always hold a read transaction against the briefcase. That can cause the WAL file size to grow\n   * unbounded if changes happen while they're open (see [Checkpoint starvation](https://www.sqlite.org/wal.html#avoiding_excessively_large_wal_files))\n   * It is a good idea to close the readonly connection *before* closing the writeable connection so the WAL file will be deleted.\n   */\n  readonly readonly?: boolean;\n  /** If true, open the briefcase readonly and monitor it for changes originating from another connection.\n   * When such changes are detected, the default txn will be restarted.\n   * The restart occurs only after the next iteration of the backend event loop, and will generate events that reflect the changes from the other connection.\n   * This can be useful in contexts where the read-only connection is displaying a view of the contents of the briefcase while another, non-interactive program\n   * is adding txns to the briefcase. It may not be reliable if the writable connection is undoing or redoing txns.\n   * @note This cannot be used with cloud-based briefcases.\n   */\n  readonly watchForChanges?: boolean;\n}\n\n/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)\n * @public\n * @extensions\n */\nexport interface LocalBriefcaseProps {\n  /** Full path of local file. */\n  readonly fileName: LocalFileName;\n\n  /** The iTwin containing the iModel. */\n  readonly iTwinId: GuidString;\n\n  /** The iModelId. */\n  readonly iModelId: GuidString;\n\n  /** The briefcaseId. */\n  readonly briefcaseId: BriefcaseId;\n\n  /** The current changesetId.\n   * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.\n   */\n  readonly changeset: ChangesetIdWithIndex;\n\n  /** Size of the briefcase file in bytes  */\n  readonly fileSize: number;\n}\n\n/** Properties for downloading a briefcase to a local file, from iModelHub.\n * @public\n * @extensions\n */\nexport interface RequestNewBriefcaseProps {\n  /** iTwin that the iModel belongs to. */\n  readonly iTwinId: GuidString;\n\n  /** The iModelId for the new briefcase. */\n  readonly iModelId: GuidString;\n\n  /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.\n   * Callers can use this to open the briefcase after the download completes.\n   * @note this member is both an input and an output.\n   */\n  readonly fileName?: LocalFileName;\n\n  /**\n   * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.\n   * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as \"pull only\" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].\n   * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )\n   * when you are done with them.\n   * @note this member is both an input and an output.\n   *\n   */\n  briefcaseId?: BriefcaseId;\n\n  /** Id of the change set of the new briefcase. If undefined, use latest. */\n  asOf?: IModelVersionProps;\n}\n\n/**\n * Arguments to open a Checkpoint directly from its cloud container\n * @beta\n */\nexport interface OpenCheckpointArgs {\n  readonly iTwinId: GuidString;\n\n  /** Id of the iModel */\n  readonly iModelId: GuidString;\n\n  /** changeset for the checkpoint. If undefined, attempt to open the checkpoint for the latest changeset. */\n  readonly changeset?: ChangesetIndexOrId;\n}\n\n/**\n * Manages the download of a briefcase\n * @public\n */\nexport interface BriefcaseDownloader {\n  /** Id of the briefcase being downloaded */\n  readonly briefcaseId: BriefcaseId;\n\n  /** the name of the local file for the briefcase */\n  readonly fileName: LocalFileName;\n\n  /** Promise that resolves when the download completes. await this to complete the download */\n  readonly downloadPromise: Promise<void>;\n\n  /** Request cancellation of the download */\n  readonly requestCancel: () => Promise<boolean>;\n}\n\n/** Option to control the validation and upgrade of domain schemas in the Db\n * @beta\n */\nexport enum DomainOptions {\n  /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\n  CheckRequiredUpgrades = 0,\n\n  /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\n  CheckRecommendedUpgrades = 1,\n\n  /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */\n  Upgrade = 2,\n\n  /** Domain schemas will neither be validated nor be upgraded. Used only internally */\n  SkipCheck = 3,\n}\n\n/** Options that control whether a profile upgrade should be performed when opening a Db\n * @beta\n */\nexport enum ProfileOptions {\n  /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */\n  None = 0,\n\n  /** Profile upgrade will be performed if necessary */\n  Upgrade = 1,\n}\n\n/** Arguments to validate and update the profile and domain schemas when opening a Db\n * @beta\n */\nexport interface UpgradeOptions {\n  /** Option to control the validation and upgrade of domain schemas in the Db */\n  readonly domain?: DomainOptions;\n\n  /** Options that control whether a profile upgrade should be performed when opening a file */\n  readonly profile?: ProfileOptions;\n\n  /** Options that will allow data transform during Profile/Domain schema upgrade */\n  readonly schemaLockHeld?: boolean;\n}\n\n/**\n * The state of the schemas in the Db compared with what the current version of the software expects\n * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.\n * @public\n */\nexport enum SchemaState {\n  /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */\n  UpToDate,\n\n  /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.\n   * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before\n   * it can write data based on that new schema.\n   */\n  UpgradeRequired,\n\n  /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */\n  UpgradeRecommended,\n\n  /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */\n  TooOld,\n\n  /** The schemas in the Db are too new to be opened by the current version of the software */\n  TooNew,\n}\n"]}

package/lib/esm/Camera.js

@@ -12,6 +12,9 @@ import { Angle, Point3d } from "@itwin/core-geometry";
  * @public
  */
 export class Camera {
+    lens;
+    focusDist;
+    eye;
     static isValidLensAngle(val) {
         return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;
     }

package/lib/esm/Camera.js.map

@@ -1 +1 @@
-{"version":3,"file":"Camera.js","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAc,OAAO,EAAoB,MAAM,sBAAsB,CAAC;AAYpF;;;GAGG;AACH,MAAM,OAAO,MAAM;IAKV,MAAM,CAAC,gBAAgB,CAAC,GAAU;QACvC,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,GAAU;QACxC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAC7B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,eAAe,KAAK,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC;IAC9E,gBAAgB,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,gBAAgB,CAAC,IAAY,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,IAAW,WAAW,KAAK,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,YAAY,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,YAAY,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,KAAY,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,CAAC,EAAU,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAa;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG;YAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACM,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,YAAmB,KAAmB;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF","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 Views\r\n */\r\n\r\nimport { JsonUtils } from \"@itwin/core-bentley\";\r\nimport { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\r\n\r\n/** JSON representation of a [[Camera]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CameraProps {\r\n  lens: AngleProps;\r\n  focusDist: number; // NOTE: this is abbreviated, do not change!\r\n  eye: XYZProps;\r\n}\r\n\r\n/** The current position (eyepoint), lens angle, and focus distance of a camera.\r\n * @see [Views]($docs/learning/frontend/Views.md)\r\n * @public\r\n */\r\nexport class Camera implements CameraProps {\r\n  public readonly lens: Angle;\r\n  public focusDist: number;\r\n  public readonly eye: Point3d;\r\n\r\n  public static isValidLensAngle(val: Angle) {\r\n    return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;\r\n  }\r\n\r\n  public static validateLensAngle(val: Angle) {\r\n    if (!this.isValidLensAngle(val))\r\n      val.setRadians(Math.PI / 2.0);\r\n  }\r\n\r\n  public invalidateFocus() { this.focusDist = 0.0; }\r\n  public get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }\r\n  public getFocusDistance() { return this.focusDist; }\r\n  public setFocusDistance(dist: number) { this.focusDist = dist; }\r\n  public get isLensValid() { return Camera.isValidLensAngle(this.lens); }\r\n  public validateLens() { Camera.validateLensAngle(this.lens); }\r\n  public getLensAngle() { return this.lens; }\r\n  public setLensAngle(angle: Angle) { this.lens.setFrom(angle); }\r\n  public getEyePoint() { return this.eye; }\r\n  public setEyePoint(pt: XYAndZ) { this.eye.setFrom(pt); }\r\n  public get isValid() { return this.isLensValid && this.isFocusValid; }\r\n  public equals(other: Camera) {\r\n    return Math.abs(this.lens.radians - other.lens.radians) < .01 &&\r\n      Math.abs(this.focusDist - other.focusDist) < .1 &&\r\n      this.eye.isAlmostEqual(other.eye);\r\n  }\r\n  public clone() { return new Camera(this); }\r\n  public setFrom(rhs: Camera) {\r\n    this.lens.setFrom(rhs.lens);\r\n    this.focusDist = rhs.focusDist;\r\n    this.eye.setFrom(rhs.eye);\r\n  }\r\n\r\n  /** Construct a Camera\r\n   * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.\r\n   */\r\n  public constructor(props?: CameraProps) {\r\n    if (props !== undefined) {\r\n      this.lens = Angle.fromJSON(props.lens);\r\n      this.focusDist = JsonUtils.asDouble(props.focusDist);\r\n      this.eye = Point3d.fromJSON(props.eye);\r\n      return;\r\n    }\r\n    this.lens = Angle.createRadians(Math.PI / 2.0);\r\n    this.focusDist = 1;\r\n    this.eye = new Point3d();\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Camera.js","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAc,OAAO,EAAoB,MAAM,sBAAsB,CAAC;AAYpF;;;GAGG;AACH,MAAM,OAAO,MAAM;IACD,IAAI,CAAQ;IACrB,SAAS,CAAS;IACT,GAAG,CAAU;IAEtB,MAAM,CAAC,gBAAgB,CAAC,GAAU;QACvC,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,GAAU;QACxC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAC7B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,eAAe,KAAK,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC;IAC9E,gBAAgB,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,gBAAgB,CAAC,IAAY,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,IAAW,WAAW,KAAK,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,YAAY,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,YAAY,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,KAAY,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,CAAC,EAAU,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAa;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG;YAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACM,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,YAAmB,KAAmB;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,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 Views\n */\n\nimport { JsonUtils } from \"@itwin/core-bentley\";\nimport { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\n\n/** JSON representation of a [[Camera]].\n * @public\n * @extensions\n */\nexport interface CameraProps {\n  lens: AngleProps;\n  focusDist: number; // NOTE: this is abbreviated, do not change!\n  eye: XYZProps;\n}\n\n/** The current position (eyepoint), lens angle, and focus distance of a camera.\n * @see [Views]($docs/learning/frontend/Views.md)\n * @public\n */\nexport class Camera implements CameraProps {\n  public readonly lens: Angle;\n  public focusDist: number;\n  public readonly eye: Point3d;\n\n  public static isValidLensAngle(val: Angle) {\n    return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;\n  }\n\n  public static validateLensAngle(val: Angle) {\n    if (!this.isValidLensAngle(val))\n      val.setRadians(Math.PI / 2.0);\n  }\n\n  public invalidateFocus() { this.focusDist = 0.0; }\n  public get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }\n  public getFocusDistance() { return this.focusDist; }\n  public setFocusDistance(dist: number) { this.focusDist = dist; }\n  public get isLensValid() { return Camera.isValidLensAngle(this.lens); }\n  public validateLens() { Camera.validateLensAngle(this.lens); }\n  public getLensAngle() { return this.lens; }\n  public setLensAngle(angle: Angle) { this.lens.setFrom(angle); }\n  public getEyePoint() { return this.eye; }\n  public setEyePoint(pt: XYAndZ) { this.eye.setFrom(pt); }\n  public get isValid() { return this.isLensValid && this.isFocusValid; }\n  public equals(other: Camera) {\n    return Math.abs(this.lens.radians - other.lens.radians) < .01 &&\n      Math.abs(this.focusDist - other.focusDist) < .1 &&\n      this.eye.isAlmostEqual(other.eye);\n  }\n  public clone() { return new Camera(this); }\n  public setFrom(rhs: Camera) {\n    this.lens.setFrom(rhs.lens);\n    this.focusDist = rhs.focusDist;\n    this.eye.setFrom(rhs.eye);\n  }\n\n  /** Construct a Camera\n   * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.\n   */\n  public constructor(props?: CameraProps) {\n    if (props !== undefined) {\n      this.lens = Angle.fromJSON(props.lens);\n      this.focusDist = JsonUtils.asDouble(props.focusDist);\n      this.eye = Point3d.fromJSON(props.eye);\n      return;\n    }\n    this.lens = Angle.createRadians(Math.PI / 2.0);\n    this.focusDist = 1;\n    this.eye = new Point3d();\n  }\n}\n"]}

package/lib/esm/CatalogIModel.d.ts

@@ -0,0 +1,152 @@
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { Id64String, ITwinError } from "@itwin/core-bentley";
+import { LocalFileName } from "./ChangesetProps";
+import { IModelConnectionProps, SnapshotOpenOptions } from "./IModel";
+/**
+ * Errors produced by the [[CatalogIModel]] API.
+ * @beta
+ */
+export declare namespace CatalogError {
+    const scope = "itwin-Catalog";
+    type Key = "invalid-seed-catalog" | "manifest-missing";
+    /** Determine whether an error object is a CatalogError */
+    function isError(error: unknown, key?: Key): error is ITwinError;
+    /** Instantiate and throw a CatalogError */
+    function throwError<T extends ITwinError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+}
+/** A "catalog iModel" is an [[IModel]] containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.
+ * They can be stored in [BlobContainer]($backend)s managed by a "reference data service" that uses [semantic versioning](https://semver.org/), much like [WorkspaceDb]($backend)s.
+ * @see [CatalogDb]($backend) to interact with catalog iModels on the backend
+ * @see [CatalogConnection]($frontend) to interact with catalog iModels on the frontend.
+ * @beta
+ */
+export declare namespace CatalogIModel {
+    /** Metadata describing a catalog iModel.
+     * @note Only the [[catalogName]] field is required, and users may add additional fields for their own purposes.
+     * @note The manifest is stored inside of the CatalogIModel, so it is versioned along with the rest of the catalog's contents.
+     * @beta
+     */
+    interface Manifest {
+        /** The iTwinId for the Catalog */
+        readonly iTwinId?: Id64String;
+        /**
+         * The name of the Catalog to be shown in user interfaces. Organizations should attempt to make this name informative enough
+         * so that uses may refer to it in conversations. It should also be unique enough that there's no confusion when it appears in
+         * lists of catalogs.
+         * @note it is possible and valid to change the catalogName between versions of a CatalogIModel (e.g. incorporating a date).
+         */
+        readonly catalogName: string;
+        /** A description of the contents of this catalog to help users understand its purpose and appropriate usage. */
+        readonly description?: string;
+        /** The name of the person to contact with questions about this catalog */
+        readonly contactName?: string;
+        /** The name of the person who last modified this catalog. */
+        lastEditedBy?: string;
+    }
+    /** Arguments for creating a new [BlobContainer]($backend) that holds (versions of) a CatalogIModel. */
+    interface CreateNewContainerArgs {
+        /** supplies the iTwinId for the new container */
+        readonly iTwinId: Id64String;
+        /** metadata stored with the new container */
+        readonly metadata: {
+            /** a "name" for the Catalog container. Should be long enough to be unique, but this is not enforced. */
+            label: string;
+            /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */
+            description?: string;
+            /** optional properties for the container */
+            json?: {
+                [key: string]: any;
+            };
+        };
+        /** The manifest to be stored in the catalog */
+        readonly manifest: Manifest;
+        /** The name for the CatalogIModel database within the container. May not contain a version. Default is "catalog-db" */
+        readonly dbName?: string;
+        /** version for the catalog created [[localCatalogFile]]. Defaults to "0.0.0" */
+        readonly version?: string;
+        /** A filename on the local computer of the "seed" CatalogIModel to be uploaded into the new container */
+        readonly localCatalogFile: LocalFileName;
+    }
+    /** Properties of a newly created container created from [[CatalogIModel.CreateNewContainerArgs]]. Most importantly, this holds the ContainerId of the new container. */
+    interface NewContainerProps {
+        /** The ContainerId of the new container (usually a [Guid]($bentley)). Applications should store this value to access the container via the CatalogIModel apis. */
+        readonly containerId: string;
+        /** the uri of the BlobContainer service where the new container resides. */
+        readonly baseUri: string;
+        /** name of the blob storage provider. */
+        readonly provider: "azure" | "google";
+    }
+    /** Properties to identify a specific CatalogIModel within a container. */
+    interface NameAndVersion {
+        /** The name of the catalog database. Defaults to "catalog-db" for CatalogIModels stored in cloud containers. */
+        readonly dbName?: string;
+        /** The range of acceptable versions of the database of the specified [[dbName]].
+         * If not present, defaults to the newest available version.
+         */
+        readonly version?: VersionRange;
+    }
+    /** Arguments to open an existing version of a CatalogIModel. */
+    interface OpenArgs extends NameAndVersion, SnapshotOpenOptions {
+        /** The ContainerId of the cloud container. If not present, dbName is the name of a file on the local computer. */
+        containerId?: string;
+        /** If true, attempt to synchronize the container with any changes in the cloud. Since this automatically happens the first time a
+         * container is accessed within a session, this is usually not necessary except for tests.
+         */
+        syncWithCloud?: boolean;
+        /** Start a prefetch operation on the CatalogIModel as it is opened. */
+        prefetch?: boolean;
+    }
+    /** Arguments to create a new version of a CatalogIModel from (a copy of) an existing version in a cloud container. */
+    interface CreateNewVersionArgs {
+        /** The id of cloud container. */
+        readonly containerId: string;
+        /** the source version of the CatalogIModel, from which the new version will copied. */
+        readonly fromDb: NameAndVersion;
+        /** The type of version increment to apply to the source version. */
+        readonly versionType: "major" | "minor" | "patch" | "premajor" | "preminor" | "prepatch" | "prerelease";
+        /** For prerelease versions, a string that becomes part of the version name. */
+        readonly identifier?: string;
+    }
+    /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[CatalogIModel]]s,
+     * e.g., ">=1.2.7 <1.3.0".
+     */
+    type VersionRange = string;
+    /** The name of the ipc channel for [[IpcMethods]]
+     * @internal
+     */
+    type IpcChannel = "catalogIModel/ipc";
+    /** @internal */
+    interface IpcMethods {
+        /** create a new container from the BlobContainerService for holding a CatalogIModel. Also uploads the seed file */
+        createNewContainer(args: CreateNewContainerArgs): Promise<NewContainerProps>;
+        /** Acquire the write lock for a CatalogIModel container. */
+        acquireWriteLock(args: {
+            containerId: string;
+            username: string;
+        }): Promise<void>;
+        /** Release the write lock for a CatalogIModel container. */
+        releaseWriteLock(args: {
+            containerId: string;
+            abandon?: true;
+        }): Promise<void>;
+        /** create a new version of a CatalogIModel from an existing version. */
+        createNewVersion(args: CreateNewVersionArgs): Promise<{
+            oldDb: NameAndVersion;
+            newDb: NameAndVersion;
+        }>;
+        /** Attempt to open a CatalogIModel readonly*/
+        openReadonly(args: OpenArgs): Promise<IModelConnectionProps>;
+        /** Attempt to open a CatalogIModel for editing */
+        openEditable(args: OpenArgs): Promise<IModelConnectionProps>;
+        /** Get the manifest and version number for an open CatalogConnection. */
+        getInfo(key: string): Promise<{
+            manifest?: CatalogIModel.Manifest;
+            version: string;
+        }>;
+        /** Update the manifest stored in an open EditableCatalog */
+        updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;
+    }
+}
+//# sourceMappingURL=CatalogIModel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogIModel.d.ts","sourceRoot":"","sources":["../../src/CatalogIModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEtE;;;GAGG;AACH,yBAAiB,YAAY,CAAC;IACrB,MAAM,KAAK,kBAAkB,CAAC;IAErC,KAAY,GAAG,GACb,sBAAsB,GACtB,kBAAkB,CAAC;IAErB,0DAA0D;IAC1D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;IAED,2CAA2C;IAC3C,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;;;GAKG;AACH,yBAAiB,aAAa,CAAC;IAE7B;;;;OAIG;IACH,UAAiB,QAAQ;QACvB,kCAAkC;QAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;QAE9B;;;;;WAKG;QACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,gHAAgH;QAChH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,0EAA0E;QAC1E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,6DAA6D;QAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,uGAAuG;IACvG,UAAiB,sBAAsB;QACrC,iDAAiD;QACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;QAC7B,6CAA6C;QAC7C,QAAQ,CAAC,QAAQ,EAAE;YACjB,wGAAwG;YACxG,KAAK,EAAE,MAAM,CAAC;YACd,kKAAkK;YAClK,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,4CAA4C;YAC5C,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAC;SAC/B,CAAA;QAED,+CAA+C;QAC/C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC5B,uHAAuH;QACvH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAC1B,yGAAyG;QACzG,QAAQ,CAAC,gBAAgB,EAAE,aAAa,CAAC;KAC1C;IAED,wKAAwK;IACxK,UAAiB,iBAAiB;QAChC,kKAAkK;QAClK,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,4EAA4E;QAC5E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,yCAAyC;QACzC,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;KACvC;IAED,0EAA0E;IAC1E,UAAiB,cAAc;QAC7B,gHAAgH;QAChH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;KACjC;IAED,gEAAgE;IAChE,UAAiB,QAAS,SAAQ,cAAc,EAAE,mBAAmB;QACnE,kHAAkH;QAClH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,uEAAuE;QACvE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,sHAAsH;IACtH,UAAiB,oBAAoB;QACnC,iCAAiC;QACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,uFAAuF;QACvF,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC,oEAAoE;QACpE,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;QACxG,+EAA+E;QAC/E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;OAEG;IACH,KAAY,UAAU,GAAG,mBAAmB,CAAC;IAE7C,gBAAgB;IAChB,UAAiB,UAAU;QACzB,mHAAmH;QACnH,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC7E,4DAA4D;QAC5D,gBAAgB,CAAC,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACjF,4DAA4D;QAC5D,gBAAgB,CAAC,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,IAAI,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/E,wEAAwE;QACxE,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC;YAAE,KAAK,EAAE,cAAc,CAAC;YAAC,KAAK,EAAE,cAAc,CAAA;SAAE,CAAC,CAAC;QACxG,8CAA8C;QAC9C,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC7D,kDAAkD;QAClD,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC7D,yEAAyE;QACzE,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;YAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACtF,4DAA4D;QAC5D,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACrF;CACF"}

package/lib/esm/CatalogIModel.js

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { ITwinError } from "@itwin/core-bentley";
+/**
+ * Errors produced by the [[CatalogIModel]] API.
+ * @beta
+ */
+export var CatalogError;
+(function (CatalogError) {
+    CatalogError.scope = "itwin-Catalog";
+    /** Determine whether an error object is a CatalogError */
+    function isError(error, key) {
+        return ITwinError.isError(error, CatalogError.scope, key);
+    }
+    CatalogError.isError = isError;
+    /** Instantiate and throw a CatalogError */
+    function throwError(key, e) {
+        ITwinError.throwError({ ...e, iTwinErrorId: { scope: CatalogError.scope, key } });
+    }
+    CatalogError.throwError = throwError;
+})(CatalogError || (CatalogError = {}));
+//# sourceMappingURL=CatalogIModel.js.map

package/lib/esm/CatalogIModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogIModel.js","sourceRoot":"","sources":["../../src/CatalogIModel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAI7D;;;GAGG;AACH,MAAM,KAAW,YAAY,CAgB5B;AAhBD,WAAiB,YAAY;IACd,kBAAK,GAAG,eAAe,CAAC;IAMrC,0DAA0D;IAC1D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,oBAAO,UAEtB,CAAA;IAED,2CAA2C;IAC3C,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,UAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,uBAAU,aAEzB,CAAA;AACH,CAAC,EAhBgB,YAAY,KAAZ,YAAY,QAgB5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { Id64String, ITwinError } from \"@itwin/core-bentley\";\nimport { LocalFileName } from \"./ChangesetProps\";\nimport { IModelConnectionProps, SnapshotOpenOptions } from \"./IModel\";\n\n/**\n * Errors produced by the [[CatalogIModel]] API.\n * @beta\n */\nexport namespace CatalogError {\n  export const scope = \"itwin-Catalog\";\n\n  export type Key =\n    \"invalid-seed-catalog\" |\n    \"manifest-missing\";\n\n  /** Determine whether an error object is a CatalogError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CatalogError */\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** A \"catalog iModel\" is an [[IModel]] containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.\n * They can be stored in [BlobContainer]($backend)s managed by a \"reference data service\" that uses [semantic versioning](https://semver.org/), much like [WorkspaceDb]($backend)s.\n * @see [CatalogDb]($backend) to interact with catalog iModels on the backend\n * @see [CatalogConnection]($frontend) to interact with catalog iModels on the frontend.\n * @beta\n */\nexport namespace CatalogIModel {\n\n  /** Metadata describing a catalog iModel.\n   * @note Only the [[catalogName]] field is required, and users may add additional fields for their own purposes.\n   * @note The manifest is stored inside of the CatalogIModel, so it is versioned along with the rest of the catalog's contents.\n   * @beta\n   */\n  export interface Manifest {\n    /** The iTwinId for the Catalog */\n    readonly iTwinId?: Id64String;\n\n    /**\n     * The name of the Catalog to be shown in user interfaces. Organizations should attempt to make this name informative enough\n     * so that uses may refer to it in conversations. It should also be unique enough that there's no confusion when it appears in\n     * lists of catalogs.\n     * @note it is possible and valid to change the catalogName between versions of a CatalogIModel (e.g. incorporating a date).\n     */\n    readonly catalogName: string;\n    /** A description of the contents of this catalog to help users understand its purpose and appropriate usage. */\n    readonly description?: string;\n    /** The name of the person to contact with questions about this catalog */\n    readonly contactName?: string;\n    /** The name of the person who last modified this catalog. */\n    lastEditedBy?: string;\n  }\n\n  /** Arguments for creating a new [BlobContainer]($backend) that holds (versions of) a CatalogIModel. */\n  export interface CreateNewContainerArgs {\n    /** supplies the iTwinId for the new container */\n    readonly iTwinId: Id64String;\n    /** metadata stored with the new container */\n    readonly metadata: {\n      /** a \"name\" for the Catalog container. Should be long enough to be unique, but this is not enforced. */\n      label: string;\n      /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n      description?: string;\n      /** optional properties for the container */\n      json?: { [key: string]: any };\n    }\n\n    /** The manifest to be stored in the catalog */\n    readonly manifest: Manifest;\n    /** The name for the CatalogIModel database within the container. May not contain a version. Default is \"catalog-db\" */\n    readonly dbName?: string,\n    /** version for the catalog created [[localCatalogFile]]. Defaults to \"0.0.0\" */\n    readonly version?: string;\n    /** A filename on the local computer of the \"seed\" CatalogIModel to be uploaded into the new container */\n    readonly localCatalogFile: LocalFileName;\n  }\n\n  /** Properties of a newly created container created from [[CatalogIModel.CreateNewContainerArgs]]. Most importantly, this holds the ContainerId of the new container. */\n  export interface NewContainerProps {\n    /** The ContainerId of the new container (usually a [Guid]($bentley)). Applications should store this value to access the container via the CatalogIModel apis. */\n    readonly containerId: string;\n    /** the uri of the BlobContainer service where the new container resides. */\n    readonly baseUri: string;\n    /** name of the blob storage provider. */\n    readonly provider: \"azure\" | \"google\";\n  }\n\n  /** Properties to identify a specific CatalogIModel within a container. */\n  export interface NameAndVersion {\n    /** The name of the catalog database. Defaults to \"catalog-db\" for CatalogIModels stored in cloud containers. */\n    readonly dbName?: string;\n    /** The range of acceptable versions of the database of the specified [[dbName]].\n     * If not present, defaults to the newest available version.\n     */\n    readonly version?: VersionRange;\n  }\n\n  /** Arguments to open an existing version of a CatalogIModel. */\n  export interface OpenArgs extends NameAndVersion, SnapshotOpenOptions {\n    /** The ContainerId of the cloud container. If not present, dbName is the name of a file on the local computer. */\n    containerId?: string;\n    /** If true, attempt to synchronize the container with any changes in the cloud. Since this automatically happens the first time a\n     * container is accessed within a session, this is usually not necessary except for tests.\n     */\n    syncWithCloud?: boolean;\n    /** Start a prefetch operation on the CatalogIModel as it is opened. */\n    prefetch?: boolean;\n  }\n\n  /** Arguments to create a new version of a CatalogIModel from (a copy of) an existing version in a cloud container. */\n  export interface CreateNewVersionArgs {\n    /** The id of cloud container. */\n    readonly containerId: string;\n    /** the source version of the CatalogIModel, from which the new version will copied. */\n    readonly fromDb: NameAndVersion;\n    /** The type of version increment to apply to the source version. */\n    readonly versionType: \"major\" | \"minor\" | \"patch\" | \"premajor\" | \"preminor\" | \"prepatch\" | \"prerelease\";\n    /** For prerelease versions, a string that becomes part of the version name. */\n    readonly identifier?: string;\n  }\n\n  /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[CatalogIModel]]s,\n   * e.g., \">=1.2.7 <1.3.0\".\n   */\n  export type VersionRange = string;\n\n  /** The name of the ipc channel for [[IpcMethods]]\n   * @internal\n   */\n  export type IpcChannel = \"catalogIModel/ipc\";\n\n  /** @internal */\n  export interface IpcMethods {\n    /** create a new container from the BlobContainerService for holding a CatalogIModel. Also uploads the seed file */\n    createNewContainer(args: CreateNewContainerArgs): Promise<NewContainerProps>;\n    /** Acquire the write lock for a CatalogIModel container. */\n    acquireWriteLock(args: { containerId: string, username: string }): Promise<void>;\n    /** Release the write lock for a CatalogIModel container. */\n    releaseWriteLock(args: { containerId: string, abandon?: true }): Promise<void>;\n    /** create a new version of a CatalogIModel from an existing version. */\n    createNewVersion(args: CreateNewVersionArgs): Promise<{ oldDb: NameAndVersion, newDb: NameAndVersion }>;\n    /** Attempt to open a CatalogIModel readonly*/\n    openReadonly(args: OpenArgs): Promise<IModelConnectionProps>;\n    /** Attempt to open a CatalogIModel for editing */\n    openEditable(args: OpenArgs): Promise<IModelConnectionProps>;\n    /** Get the manifest and version number for an open CatalogConnection. */\n    getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }>;\n    /** Update the manifest stored in an open EditableCatalog */\n    updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;\n  }\n}\n"]}

package/lib/esm/CesiumIonAssets.d.ts

@@ -0,0 +1,23 @@
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
+ * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
+ * You may alternatively use the Id of any ion asset to which you have access.
+ * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.
+ * @public
+ */
+export declare enum CesiumTerrainAssetId {
+    /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */
+    Default = "1",
+    /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */
+    Bathymetry = "2426648"
+}
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].
+ * @beta
+ */
+export declare enum CesiumIonAssetId {
+    /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */
+    OSMBuildings = "96188"
+}
+//# sourceMappingURL=CesiumIonAssets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CesiumIonAssets.d.ts","sourceRoot":"","sources":["../../src/CesiumIonAssets.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,yGAAyG;IACzG,OAAO,MAAM;IACb,gJAAgJ;IAChJ,UAAU,YAAY;CACvB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,oGAAoG;IACpG,YAAY,UAAU;CACvB"}

package/lib/esm/CesiumIonAssets.js

@@ -0,0 +1,29 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
+ * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
+ * You may alternatively use the Id of any ion asset to which you have access.
+ * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.
+ * @public
+ */
+export var CesiumTerrainAssetId;
+(function (CesiumTerrainAssetId) {
+    /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */
+    CesiumTerrainAssetId["Default"] = "1";
+    /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */
+    CesiumTerrainAssetId["Bathymetry"] = "2426648";
+})(CesiumTerrainAssetId || (CesiumTerrainAssetId = {}));
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].
+ * @beta
+ */
+export var CesiumIonAssetId;
+(function (CesiumIonAssetId) {
+    /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */
+    CesiumIonAssetId["OSMBuildings"] = "96188";
+})(CesiumIonAssetId || (CesiumIonAssetId = {}));
+//# sourceMappingURL=CesiumIonAssets.js.map

package/lib/esm/CesiumIonAssets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CesiumIonAssets.js","sourceRoot":"","sources":["../../src/CesiumIonAssets.ts"],"names":[],"mappings":"AACA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,yGAAyG;IACzG,qCAAa,CAAA;IACb,gJAAgJ;IAChJ,8CAAsB,CAAA;AACxB,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,oGAAoG;IACpG,0CAAsB,CAAA;AACxB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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 DisplayStyles\n */\n\n/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.\n * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to \"CesiumWorldTerrain\".\n * You may alternatively use the Id of any ion asset to which you have access.\n * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.\n * @public\n */\nexport enum CesiumTerrainAssetId {\n  /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */\n  Default = \"1\",\n  /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */\n  Bathymetry = \"2426648\",\n}\n\n/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].\n * @beta\n */\nexport enum CesiumIonAssetId {\n  /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */\n  OSMBuildings = \"96188\",\n}\n"]}

package/lib/esm/ChangedElements.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangedElements.js","sourceRoot":"","sources":["../../src/ChangedElements.ts"],"names":[],"mappings":"AAWA,uBAAuB;AAEvB;;;GAGG;AACH,MAAM,CAAN,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,kCAAkC;IAClC,uDAAY,CAAA;IACZ,wCAAwC;IACxC,uDAAc,CAAA;IACd,oEAAoE;IACpE,uDAAe,CAAA;IACf,kEAAkE;IAClE,yDAAiB,CAAA;IACjB,qEAAqE;IACrE,uDAAiB,CAAA;IACjB,+CAA+C;IAC/C,oDAAgB,CAAA;IAChB,qDAAqD;IACrD,oDAAiB,CAAA;AACnB,CAAC,EAfW,YAAY,KAAZ,YAAY,QAevB","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/**\r\n * @packageDocumentation\r\n * @module Entities\r\n */\r\nimport { DbOpcode, Id64String } from \"@itwin/core-bentley\";\r\nimport { AxisAlignedBox3dProps } from \"./geometry/Placement\";\r\n\r\n// cspell:ignore bboxes\r\n\r\n/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TypeOfChange {\r\n  /** Element contains no changes */\r\n  NoChange = 0,\r\n  /** A property in the element changed */\r\n  Property = 0b1,\r\n  /** The geometry stream of a [GeometricElement]($backend) changed */\r\n  Geometry = 0b10,\r\n  /** The [[Placement]] of a [GeometricElement]($backend) changed */\r\n  Placement = 0b100,\r\n  /** Indirect change occurred to this element by a related instance */\r\n  Indirect = 0b1000,\r\n  /** Hidden properties of the element changed */\r\n  Hidden = 0b10000,\r\n  /** The top-most parent of the element has changed */\r\n  Parent = 0b100000,\r\n}\r\n\r\n/** Changed elements found in a changeset or between a range of changesets.\r\n * All arrays in this object will have the same number of items.\r\n * Each index for those arrays refer to the same element, e.g. to get the class Id of\r\n * the element given by element Id changedElements.elements[index], you can use changedElements.classIds[index].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangedElements {\r\n  /** Ids of elements that changed */\r\n  elements: Id64String[];\r\n  /** ECClass Ids of elements that changed */\r\n  classIds: Id64String[];\r\n  /** Operation that occurred on the element. Whether the element was inserted, updated or deleted.\r\n   * See [DbOpcode]($core-bentley)\r\n   */\r\n  opcodes: DbOpcode[];\r\n  /** Type of change bitflags, see [[TypeOfChange]] */\r\n  type: TypeOfChange[];\r\n  /** Model Ids of the changed elements\r\n   * This may be undefined if the agent that did the processing job did not export model Ids\r\n   */\r\n  modelIds?: Id64String[];\r\n  /** Property accessor strings of properties that changed, if any, for each changed element\r\n   * This may be undefined if the agent that did the processing job did not export properties\r\n  */\r\n  properties?: string[][];\r\n  /** Before state checksums of the property value\r\n   * Useful to determine if property values have changed\r\n   * between the versions being inspected\r\n   * This may be undefined if the agent that did the processing job did not export checksums\r\n   */\r\n  oldChecksums?: number[][];\r\n  /** After state checksums of the property value\r\n   * Useful to determine if property values have changed\r\n   * between the versions being inspected\r\n   * This may be undefined if the agent that did the processing job did not export checksums\r\n   */\r\n  newChecksums?: number[][];\r\n  /**\r\n   * Parent ids of the changed elements\r\n   * Will be \"0\" if the element has no parent\r\n   * This may be undefined if the agent that did the processing job did not export parent information\r\n   */\r\n  parentIds?: Id64String[];\r\n  /**\r\n   * Parent ECClass Ids of the changed elements\r\n   * Will be \"0\" if the element has no parent\r\n   * This may be undefined if the agent that did the processing job did not export parent information\r\n   */\r\n  parentClassIds?: Id64String[];\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangedModels {\r\n  modelIds: Id64String[];\r\n  bboxes: AxisAlignedBox3dProps[];\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangeData {\r\n  changedElements: ChangedElements;\r\n  changedModels: ChangedModels;\r\n}\r\n"]}
+{"version":3,"file":"ChangedElements.js","sourceRoot":"","sources":["../../src/ChangedElements.ts"],"names":[],"mappings":"AAWA,uBAAuB;AAEvB;;;GAGG;AACH,MAAM,CAAN,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,kCAAkC;IAClC,uDAAY,CAAA;IACZ,wCAAwC;IACxC,uDAAc,CAAA;IACd,oEAAoE;IACpE,uDAAe,CAAA;IACf,kEAAkE;IAClE,yDAAiB,CAAA;IACjB,qEAAqE;IACrE,uDAAiB,CAAA;IACjB,+CAA+C;IAC/C,oDAAgB,CAAA;IAChB,qDAAqD;IACrD,oDAAiB,CAAA;AACnB,CAAC,EAfW,YAAY,KAAZ,YAAY,QAevB","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/**\n * @packageDocumentation\n * @module Entities\n */\nimport { DbOpcode, Id64String } from \"@itwin/core-bentley\";\nimport { AxisAlignedBox3dProps } from \"./geometry/Placement\";\n\n// cspell:ignore bboxes\n\n/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].\n * @public\n * @extensions\n */\nexport enum TypeOfChange {\n  /** Element contains no changes */\n  NoChange = 0,\n  /** A property in the element changed */\n  Property = 0b1,\n  /** The geometry stream of a [GeometricElement]($backend) changed */\n  Geometry = 0b10,\n  /** The [[Placement]] of a [GeometricElement]($backend) changed */\n  Placement = 0b100,\n  /** Indirect change occurred to this element by a related instance */\n  Indirect = 0b1000,\n  /** Hidden properties of the element changed */\n  Hidden = 0b10000,\n  /** The top-most parent of the element has changed */\n  Parent = 0b100000,\n}\n\n/** Changed elements found in a changeset or between a range of changesets.\n * All arrays in this object will have the same number of items.\n * Each index for those arrays refer to the same element, e.g. to get the class Id of\n * the element given by element Id changedElements.elements[index], you can use changedElements.classIds[index].\n * @public\n * @extensions\n */\nexport interface ChangedElements {\n  /** Ids of elements that changed */\n  elements: Id64String[];\n  /** ECClass Ids of elements that changed */\n  classIds: Id64String[];\n  /** Operation that occurred on the element. Whether the element was inserted, updated or deleted.\n   * See [DbOpcode]($core-bentley)\n   */\n  opcodes: DbOpcode[];\n  /** Type of change bitflags, see [[TypeOfChange]] */\n  type: TypeOfChange[];\n  /** Model Ids of the changed elements\n   * This may be undefined if the agent that did the processing job did not export model Ids\n   */\n  modelIds?: Id64String[];\n  /** Property accessor strings of properties that changed, if any, for each changed element\n   * This may be undefined if the agent that did the processing job did not export properties\n  */\n  properties?: string[][];\n  /** Before state checksums of the property value\n   * Useful to determine if property values have changed\n   * between the versions being inspected\n   * This may be undefined if the agent that did the processing job did not export checksums\n   */\n  oldChecksums?: number[][];\n  /** After state checksums of the property value\n   * Useful to determine if property values have changed\n   * between the versions being inspected\n   * This may be undefined if the agent that did the processing job did not export checksums\n   */\n  newChecksums?: number[][];\n  /**\n   * Parent ids of the changed elements\n   * Will be \"0\" if the element has no parent\n   * This may be undefined if the agent that did the processing job did not export parent information\n   */\n  parentIds?: Id64String[];\n  /**\n   * Parent ECClass Ids of the changed elements\n   * Will be \"0\" if the element has no parent\n   * This may be undefined if the agent that did the processing job did not export parent information\n   */\n  parentClassIds?: Id64String[];\n}\n\n/** @internal */\nexport interface ChangedModels {\n  modelIds: Id64String[];\n  bboxes: AxisAlignedBox3dProps[];\n}\n\n/** @internal */\nexport interface ChangeData {\n  changedElements: ChangedElements;\n  changedModels: ChangedModels;\n}\n"]}

package/lib/esm/ChangedEntities.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangedEntities.js","sourceRoot":"","sources":["../../src/ChangedEntities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { CompressedId64Set, Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Describes an [Entity]($backend) and its [ECClass]($docs/bis/guide/references/glossary/#ecclass) by Id.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityIdAndClassId {\r\n  /** The entity's Id. */\r\n  id: Id64String;\r\n  /** The Id of the entity's ECClass. */\r\n  classId: Id64String;\r\n}\r\n\r\n/** JSON representation of the set of [Element]($backend)s or [Model]($backend)s that were changed by a [Txn]($docs/learning/InteractiveEditing.md).\r\n * @see [TxnManager.onElementsChanged]($backend) and [TxnManager.onModelsChanged]($backend).\r\n * @see [BriefcaseTxns.onElementsChanged]($frontend) and [BriefcaseTxns.onModelsChanged]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangedEntities {\r\n  /** The ids of entities that were inserted during the Txn. */\r\n  inserted?: CompressedId64Set;\r\n  /** The ids of entities that were deleted during the Txn. */\r\n  deleted?: CompressedId64Set;\r\n  /** The ids of entities that were modified during the Txn, including any [Element]($backend)s for which one of their [ElementAspect]($backend)s was changed. */\r\n  updated?: CompressedId64Set;\r\n}\r\n\r\n/** A collection of [[EntityIdAndClassId]]s, as used by [TxnChangedEntities]($backend).\r\n * For efficiency, the iterator supplied by this iterable returns **the same `EntityIdAndClassId` object** on each iteration. Therefore the objects must be copied if you\r\n * intend to store references to them. For example, to populate an array from the iterable:\r\n * ```ts\r\n *  function arrayFromIterable(entities: EntityIdAndClassIdIterable): EntityIdAndClassId[] {\r\n *    // NO! return Array.from(entities);\r\n *    const array = [];\r\n *    for (const entity of entities)\r\n *      array.push({...entity});\r\n *\r\n *    return array;\r\n *  }\r\n * ```\r\n * @public\r\n * @extensions\r\n */\r\nexport type EntityIdAndClassIdIterable = Iterable<Readonly<EntityIdAndClassId>>;\r\n"]}
+{"version":3,"file":"ChangedEntities.js","sourceRoot":"","sources":["../../src/ChangedEntities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { CompressedId64Set, Id64String } from \"@itwin/core-bentley\";\n\n/** Describes an [Entity]($backend) and its [ECClass]($docs/bis/guide/references/glossary/#ecclass) by Id.\n * @public\n * @extensions\n */\nexport interface EntityIdAndClassId {\n  /** The entity's Id. */\n  id: Id64String;\n  /** The Id of the entity's ECClass. */\n  classId: Id64String;\n}\n\n/** JSON representation of the set of [Element]($backend)s or [Model]($backend)s that were changed by a [Txn]($docs/learning/InteractiveEditing.md).\n * @see [TxnManager.onElementsChanged]($backend) and [TxnManager.onModelsChanged]($backend).\n * @see [BriefcaseTxns.onElementsChanged]($frontend) and [BriefcaseTxns.onModelsChanged]($frontend).\n * @public\n * @extensions\n */\nexport interface ChangedEntities {\n  /** The ids of entities that were inserted during the Txn. */\n  inserted?: CompressedId64Set;\n  /** The ids of entities that were deleted during the Txn. */\n  deleted?: CompressedId64Set;\n  /** The ids of entities that were modified during the Txn, including any [Element]($backend)s for which one of their [ElementAspect]($backend)s was changed. */\n  updated?: CompressedId64Set;\n}\n\n/** A collection of [[EntityIdAndClassId]]s, as used by [TxnChangedEntities]($backend).\n * For efficiency, the iterator supplied by this iterable returns **the same `EntityIdAndClassId` object** on each iteration. Therefore the objects must be copied if you\n * intend to store references to them. For example, to populate an array from the iterable:\n * ```ts\n *  function arrayFromIterable(entities: EntityIdAndClassIdIterable): EntityIdAndClassId[] {\n *    // NO! return Array.from(entities);\n *    const array = [];\n *    for (const entity of entities)\n *      array.push({...entity});\n *\n *    return array;\n *  }\n * ```\n * @public\n * @extensions\n */\nexport type EntityIdAndClassIdIterable = Iterable<Readonly<EntityIdAndClassId>>;\n"]}

package/lib/esm/ChangesetProps.d.ts

@@ -81,7 +81,7 @@ export interface ChangesetProps {
     size: number;
 }
 /** Properties of a changeset file
- * @internal
+ * @public
  */
 export interface ChangesetFileProps extends ChangesetProps {
     /** The full pathname of the local file holding this changeset. */

package/lib/esm/ChangesetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangesetProps.js","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;;GAGG;AAuCH;;;GAGG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;IACV,gEAAgE;IAChE,8DAAwB,CAAA;AAC1B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB","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/**\r\n * @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\n/** @public */\r\nexport type LocalFileName = string;\r\n/** @public */\r\nexport type LocalDirName = string;\r\n\r\n/** A string that identifies a changeset.\r\n * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ChangesetId = string;\r\n\r\n/** The index of a changeset, assigned by iModelHub.\r\n * @note 0 means \"before the first changeset.\" Values less than 0 are invalid.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ChangesetIndex = number;\r\n\r\n/** Both the index and Id of a changeset\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangesetIndexAndId { readonly index: ChangesetIndex, readonly id: ChangesetId }\r\n\r\n/** The Id and optionally the index of a changeset\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangesetIdWithIndex { readonly index?: ChangesetIndex, readonly id: ChangesetId }\r\n\r\n/** either changeset index, id, or both\r\n* @public\r\n * @extensions\r\n*/\r\nexport type ChangesetIndexOrId = ChangesetIndexAndId | { readonly index: ChangesetIndex, readonly id?: never } | { readonly id: ChangesetId, readonly index?: never };\r\n\r\n/** Value to indicate whether a changeset contains schema changes or not\r\n * @public\r\n * @extensions\r\n */\r\nexport enum ChangesetType {\r\n  /** changeset does *not* contain schema changes. */\r\n  Regular = 0,\r\n  /** changeset *does* contain schema changes. */\r\n  Schema = 1,\r\n  /** Schema changeset pushed by iModel with SchemaSync enabled */\r\n  SchemaSync = Schema | 64,\r\n}\r\n\r\n/** Properties of a changeset\r\n * @public\r\n */\r\nexport interface ChangesetProps {\r\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\r\n  index: ChangesetIndex;\r\n  /** the ChangesetId */\r\n  id: ChangesetId;\r\n  /** the ChangeSetId of the parent changeset of this changeset */\r\n  parentId: ChangesetId;\r\n  /** The type of changeset */\r\n  changesType: ChangesetType;\r\n  /** The user-supplied description of the work this changeset holds */\r\n  description: string;\r\n  /** The BriefcaseId of the briefcase that created this changeset */\r\n  briefcaseId: number;\r\n  /** The date this changeset was uploaded to the hub */\r\n  pushDate: string;\r\n  /** The identity of the user that created this changeset */\r\n  userCreated: string;\r\n  /** The size, in bytes, of this changeset */\r\n  size: number;\r\n}\r\n\r\n/** Properties of a changeset file\r\n * @internal\r\n */\r\nexport interface ChangesetFileProps extends ChangesetProps {\r\n  /** The full pathname of the local file holding this changeset. */\r\n  pathname: LocalFileName;\r\n}\r\n\r\n/**\r\n * A range of changesets\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangesetRange {\r\n  /** index of the first changeset */\r\n  first: ChangesetIndex;\r\n  /** index of last changeset. If undefined, all changesets after first are returned. */\r\n  end?: ChangesetIndex;\r\n}\r\n"]}
+{"version":3,"file":"ChangesetProps.js","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;;GAGG;AAuCH;;;GAGG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;IACV,gEAAgE;IAChE,8DAAwB,CAAA;AAC1B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB","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/**\n * @packageDocumentation\n * @module iModels\n */\n\n/** @public */\nexport type LocalFileName = string;\n/** @public */\nexport type LocalDirName = string;\n\n/** A string that identifies a changeset.\n * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.\n * @public\n * @extensions\n */\nexport type ChangesetId = string;\n\n/** The index of a changeset, assigned by iModelHub.\n * @note 0 means \"before the first changeset.\" Values less than 0 are invalid.\n * @public\n * @extensions\n */\nexport type ChangesetIndex = number;\n\n/** Both the index and Id of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIndexAndId { readonly index: ChangesetIndex, readonly id: ChangesetId }\n\n/** The Id and optionally the index of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIdWithIndex { readonly index?: ChangesetIndex, readonly id: ChangesetId }\n\n/** either changeset index, id, or both\n* @public\n * @extensions\n*/\nexport type ChangesetIndexOrId = ChangesetIndexAndId | { readonly index: ChangesetIndex, readonly id?: never } | { readonly id: ChangesetId, readonly index?: never };\n\n/** Value to indicate whether a changeset contains schema changes or not\n * @public\n * @extensions\n */\nexport enum ChangesetType {\n  /** changeset does *not* contain schema changes. */\n  Regular = 0,\n  /** changeset *does* contain schema changes. */\n  Schema = 1,\n  /** Schema changeset pushed by iModel with SchemaSync enabled */\n  SchemaSync = Schema | 64,\n}\n\n/** Properties of a changeset\n * @public\n */\nexport interface ChangesetProps {\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\n  index: ChangesetIndex;\n  /** the ChangesetId */\n  id: ChangesetId;\n  /** the ChangeSetId of the parent changeset of this changeset */\n  parentId: ChangesetId;\n  /** The type of changeset */\n  changesType: ChangesetType;\n  /** The user-supplied description of the work this changeset holds */\n  description: string;\n  /** The BriefcaseId of the briefcase that created this changeset */\n  briefcaseId: number;\n  /** The date this changeset was uploaded to the hub */\n  pushDate: string;\n  /** The identity of the user that created this changeset */\n  userCreated: string;\n  /** The size, in bytes, of this changeset */\n  size: number;\n}\n\n/** Properties of a changeset file\n * @public\n */\nexport interface ChangesetFileProps extends ChangesetProps {\n  /** The full pathname of the local file holding this changeset. */\n  pathname: LocalFileName;\n}\n\n/**\n * A range of changesets\n * @public\n * @extensions\n */\nexport interface ChangesetRange {\n  /** index of the first changeset */\n  first: ChangesetIndex;\n  /** index of last changeset. If undefined, all changesets after first are returned. */\n  end?: ChangesetIndex;\n}\n"]}

package/lib/esm/ClipStyle.js

@@ -15,6 +15,14 @@ import { ColorDef } from "./ColorDef";
  * @public
  */
 export class CutStyle {
+    /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */
+    viewflags;
+    /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */
+    hiddenLine;
+    /** If defined, overrides aspects of the symbology of the section-cut graphics. */
+    appearance;
+    /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
+    static defaults = new CutStyle();
     constructor(viewflags, hiddenLine, appearance) {
         this.viewflags = viewflags ?? {};
         if (hiddenLine && !hiddenLine.matchesDefaults)
@@ -59,14 +67,16 @@ export class CutStyle {
         return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);
     }
 }
-/** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
-CutStyle.defaults = new CutStyle();
 /** As part of a [[ClipStyle]], describes how to colorize geometry intersecting the clip planes.
  * @note Edges are highlighted only if [[ClipStyle.ClipIntersectionStyle]] is `true`.
  * @public
  * @extensions
  */
 export class ClipIntersectionStyle {
+    /** Color to apply to intersection of geometry and clip planes, default white */
+    color;
+    /** Number of pixels to be considered intersecting the clip plane, default 1 */
+    width;
     constructor(color = RgbColor.fromColorDef(ColorDef.white), width = 1) {
         this.color = color;
         this.width = width;
@@ -77,6 +87,7 @@ export class ClipIntersectionStyle {
             return this.defaults;
         return new ClipIntersectionStyle(color, width);
     }
+    static defaults = new ClipIntersectionStyle();
     static fromJSON(props) {
         if (props === undefined) {
             return ClipIntersectionStyle.defaults;
@@ -103,12 +114,29 @@ export class ClipIntersectionStyle {
         return !this.color && !this.width;
     }
 }
-ClipIntersectionStyle.defaults = new ClipIntersectionStyle();
 /** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
  * @see [[DisplayStyleSettings.clipStyle]].
  * @public
  */
 export class ClipStyle {
+    /** If `true`, geometry will be produced at the clip planes.
+     * - Solids (closed volumes) will produce facets on the clip planes.
+     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
+     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
+     */
+    produceCutGeometry;
+    /** If 'true', intersection of geometry and clip planes will be colorized */
+    colorizeIntersection;
+    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
+    cutStyle;
+    /** If defined, geometry inside the clip planes will be drawn in this color. */
+    insideColor;
+    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
+    outsideColor;
+    /** Controls the style of the intersection of geometry and clip planes */
+    intersectionStyle;
+    /** The default style, which overrides none of the view's settings. */
+    static defaults = new ClipStyle(false, false, CutStyle.defaults, undefined, undefined, undefined);
     constructor(produceCutGeometry, colorizeIntersection, cutStyle, inside, outside, intersectionStyle) {
         this.produceCutGeometry = produceCutGeometry;
         this.colorizeIntersection = colorizeIntersection;
@@ -175,6 +203,4 @@ export class ClipStyle {
         return !this.produceCutGeometry && !this.colorizeIntersection && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults && !this.intersectionStyle;
     }
 }
-/** The default style, which overrides none of the view's settings. */
-ClipStyle.defaults = new ClipStyle(false, false, CutStyle.defaults, undefined, undefined, undefined);
 //# sourceMappingURL=ClipStyle.js.map