@itwin/core-common 3.6.0-dev.54 → 3.6.0-dev.59

package/lib/cjs/ModelGeometryChanges.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkG;AAClG,wDAA6D;AAwE7D;;GAEG;AACH,IAAiB,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,uBAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAiCrC;AAiBD;;;GAGG;AACH,IAAiB,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA8BpC","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 Geometry\n */\n\nimport { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\n\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\n * All of the elements belong to the same model.\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\n * @public\n * @extensions\n */\nexport interface ElementIdsAndRangesProps {\n  /** The Ids of the elements, compressed and sorted in ascending order. */\n  readonly ids: CompressedId64Set;\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\n  readonly ranges: Range3dProps[];\n}\n\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\n * @see [[ModelGeometryChanges]] for a more useful representation.\n * @public\n * @extensions\n */\nexport interface ModelGeometryChangesProps {\n  /** The Id of the model. */\n  readonly id: Id64String;\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\n  readonly range: Range3dProps;\n  /** The geometry GUID of the model. */\n  readonly guid: GuidString;\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\n  readonly inserted?: ElementIdsAndRangesProps;\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\n  readonly updated?: ElementIdsAndRangesProps;\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\n  readonly deleted?: CompressedId64Set;\n}\n\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\n * @see [[ElementGeometryChange]].\n * @public\n * @extensions\n */\nexport interface ExtantElementGeometryChange {\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\n   * Used as discriminant for [[ElementGeometryChange]] union.\n   */\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\n  /** The element's Id. */\n  readonly id: Id64String;\n  /** The element's range. */\n  readonly range: Range3d;\n}\n\n/** Represents the deletion of a [GeometricElement]($backend).\n * @see [[ElementGeometryChange]].\n * @public\n * @extensions\n */\nexport interface DeletedElementGeometryChange {\n  /** Discriminant for [[ElementGeometryChange]] union. */\n  readonly type: DbOpcode.Delete;\n  /** The element's Id. */\n  readonly id: Id64String;\n}\n\n/**\n * @public\n * @extensions\n */\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\n\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\n * @public\n */\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\n    let index = 0;\n    const ids = CompressedId64Set.iterable(props.ids);\n    for (const id of ids) {\n      assert(undefined !== props.ranges[index]);\n      const range = Range3d.fromJSON(props.ranges[index]);\n      index++;\n      yield { type, id, range };\n    }\n  }\n\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\n  }\n\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\n    if (modelChanges.inserted)\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\n\n    if (modelChanges.updated)\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\n\n    if (modelChanges.deleted)\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\n        yield { type: DbOpcode.Delete, id };\n  }\n\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\n  }\n}\n\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\n * @public\n * @extensions\n */\nexport interface ModelGeometryChanges {\n  /** The model's Id. */\n  readonly id: Id64String;\n  /** The model's geometry GUID. */\n  readonly geometryGuid: GuidString;\n  /** The model's range. */\n  readonly range: Range3d;\n  /** The individual geometric element changes. */\n  readonly elements: Iterable<ElementGeometryChange>;\n}\n\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\n * @public\n */\nexport namespace ModelGeometryChanges {\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\n    for (const props of modelChanges)\n      yield fromJSON(props);\n  }\n\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\n  }\n\n  /** Instantiate from wire format. */\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\n    return {\n      id: props.id,\n      geometryGuid: props.guid,\n      range: Range3d.fromJSON(props.range),\n      elements: ElementGeometryChange.iterable(props),\n    };\n  }\n\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\n    for (const change of changes)\n      if (change.id === modelId)\n        return change;\n\n    return undefined;\n  }\n}\n"]}
+{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkG;AAClG,wDAA6D;AAwE7D;;GAEG;AACH,IAAiB,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,uBAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAiCrC;AAiBD;;;GAGG;AACH,IAAiB,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA8BpC","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 Geometry\r\n */\r\n\r\nimport { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\r\n\r\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\r\n * All of the elements belong to the same model.\r\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\r\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\r\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ElementIdsAndRangesProps {\r\n  /** The Ids of the elements, compressed and sorted in ascending order. */\r\n  readonly ids: CompressedId64Set;\r\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\r\n  readonly ranges: Range3dProps[];\r\n}\r\n\r\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\r\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\r\n * @see [[ModelGeometryChanges]] for a more useful representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChangesProps {\r\n  /** The Id of the model. */\r\n  readonly id: Id64String;\r\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\r\n  readonly range: Range3dProps;\r\n  /** The geometry GUID of the model. */\r\n  readonly guid: GuidString;\r\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\r\n  readonly inserted?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\r\n  readonly updated?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\r\n  readonly deleted?: CompressedId64Set;\r\n}\r\n\r\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ExtantElementGeometryChange {\r\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\r\n   * Used as discriminant for [[ElementGeometryChange]] union.\r\n   */\r\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n  /** The element's range. */\r\n  readonly range: Range3d;\r\n}\r\n\r\n/** Represents the deletion of a [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DeletedElementGeometryChange {\r\n  /** Discriminant for [[ElementGeometryChange]] union. */\r\n  readonly type: DbOpcode.Delete;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n}\r\n\r\n/**\r\n * @public\r\n * @extensions\r\n */\r\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\r\n\r\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\r\n * @public\r\n */\r\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\r\n    let index = 0;\r\n    const ids = CompressedId64Set.iterable(props.ids);\r\n    for (const id of ids) {\r\n      assert(undefined !== props.ranges[index]);\r\n      const range = Range3d.fromJSON(props.ranges[index]);\r\n      index++;\r\n      yield { type, id, range };\r\n    }\r\n  }\r\n\r\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\r\n  }\r\n\r\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\r\n    if (modelChanges.inserted)\r\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\r\n\r\n    if (modelChanges.updated)\r\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\r\n\r\n    if (modelChanges.deleted)\r\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\r\n        yield { type: DbOpcode.Delete, id };\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChanges {\r\n  /** The model's Id. */\r\n  readonly id: Id64String;\r\n  /** The model's geometry GUID. */\r\n  readonly geometryGuid: GuidString;\r\n  /** The model's range. */\r\n  readonly range: Range3d;\r\n  /** The individual geometric element changes. */\r\n  readonly elements: Iterable<ElementGeometryChange>;\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\r\n * @public\r\n */\r\nexport namespace ModelGeometryChanges {\r\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\r\n    for (const props of modelChanges)\r\n      yield fromJSON(props);\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n\r\n  /** Instantiate from wire format. */\r\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\r\n    return {\r\n      id: props.id,\r\n      geometryGuid: props.guid,\r\n      range: Range3d.fromJSON(props.range),\r\n      elements: ElementGeometryChange.iterable(props),\r\n    };\r\n  }\r\n\r\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\r\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\r\n    for (const change of changes)\r\n      if (change.id === modelId)\r\n        return change;\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}

package/lib/cjs/ModelProps.d.ts

@@ -1,68 +1,68 @@
-/** @packageDocumentation
- * @module Entities
- */
-import { GuidString, Id64String } from "@itwin/core-bentley";
-import { XYProps } from "@itwin/core-geometry";
-import { CodeProps } from "./Code";
-import { RelatedElementProps } from "./ElementProps";
-import { EntityProps, EntityQueryParams } from "./EntityProps";
-/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)
- * @public
- * @extensions
- */
-export interface ModelProps extends EntityProps {
-    modeledElement: RelatedElementProps;
-    name?: string;
-    /** @note must always match the model of the [[ModelProps.modeledElement]] */
-    parentModel?: Id64String;
-    isPrivate?: boolean;
-    isTemplate?: boolean;
-    jsonProperties?: any;
-}
-/** Properties that specify what model should be loaded.
- * @public
- * @extensions
- */
-export interface ModelLoadProps {
-    id?: Id64String;
-    code?: CodeProps;
-}
-/** Parameters for performing a query on [Model]($backend) classes.
- * @public
- * @extensions
- */
-export interface ModelQueryParams extends EntityQueryParams {
-    wantTemplate?: boolean;
-    wantPrivate?: boolean;
-}
-/** Properties that describe a [GeometricModel]($backend)
- * @public
- * @extensions
- */
-export interface GeometricModelProps extends ModelProps {
-    /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model
-     * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can
-     * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)
-     * If undefined, the state of the geometry is unknown.
-     */
-    geometryGuid?: GuidString;
-}
-/** Properties that define a [GeometricModel2d]($backend)
- * @public
- * @extensions
- */
-export interface GeometricModel2dProps extends GeometricModelProps {
-    /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
-    globalOrigin?: XYProps;
-}
-/** Properties that define a [GeometricModel3d]($backend)
- * @public
- * @extensions
- */
-export interface GeometricModel3dProps extends GeometricModelProps {
-    /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */
-    isNotSpatiallyLocated?: boolean;
-    /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */
-    isPlanProjection?: boolean;
-}
+/** @packageDocumentation
+ * @module Entities
+ */
+import { GuidString, Id64String } from "@itwin/core-bentley";
+import { XYProps } from "@itwin/core-geometry";
+import { CodeProps } from "./Code";
+import { RelatedElementProps } from "./ElementProps";
+import { EntityProps, EntityQueryParams } from "./EntityProps";
+/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)
+ * @public
+ * @extensions
+ */
+export interface ModelProps extends EntityProps {
+    modeledElement: RelatedElementProps;
+    name?: string;
+    /** @note must always match the model of the [[ModelProps.modeledElement]] */
+    parentModel?: Id64String;
+    isPrivate?: boolean;
+    isTemplate?: boolean;
+    jsonProperties?: any;
+}
+/** Properties that specify what model should be loaded.
+ * @public
+ * @extensions
+ */
+export interface ModelLoadProps {
+    id?: Id64String;
+    code?: CodeProps;
+}
+/** Parameters for performing a query on [Model]($backend) classes.
+ * @public
+ * @extensions
+ */
+export interface ModelQueryParams extends EntityQueryParams {
+    wantTemplate?: boolean;
+    wantPrivate?: boolean;
+}
+/** Properties that describe a [GeometricModel]($backend)
+ * @public
+ * @extensions
+ */
+export interface GeometricModelProps extends ModelProps {
+    /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model
+     * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can
+     * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)
+     * If undefined, the state of the geometry is unknown.
+     */
+    geometryGuid?: GuidString;
+}
+/** Properties that define a [GeometricModel2d]($backend)
+ * @public
+ * @extensions
+ */
+export interface GeometricModel2dProps extends GeometricModelProps {
+    /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
+    globalOrigin?: XYProps;
+}
+/** Properties that define a [GeometricModel3d]($backend)
+ * @public
+ * @extensions
+ */
+export interface GeometricModel3dProps extends GeometricModelProps {
+    /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */
+    isNotSpatiallyLocated?: boolean;
+    /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */
+    isPlanProjection?: boolean;
+}
 //# sourceMappingURL=ModelProps.d.ts.map

package/lib/cjs/ModelProps.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Entities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Entities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ModelProps.js.map

package/lib/cjs/ModelProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelProps.js","sourceRoot":"","sources":["../../src/ModelProps.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 Entities\n */\n\nimport { GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { XYProps } from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { RelatedElementProps } from \"./ElementProps\";\nimport { EntityProps, EntityQueryParams } from \"./EntityProps\";\n\n/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)\n * @public\n * @extensions\n */\nexport interface ModelProps extends EntityProps {\n  modeledElement: RelatedElementProps;\n  name?: string;\n  /** @note must always match the model of the [[ModelProps.modeledElement]] */\n  parentModel?: Id64String;\n  isPrivate?: boolean;\n  isTemplate?: boolean;\n  jsonProperties?: any;\n}\n\n/** Properties that specify what model should be loaded.\n * @public\n * @extensions\n */\nexport interface ModelLoadProps {\n  id?: Id64String;\n  code?: CodeProps;\n}\n\n/** Parameters for performing a query on [Model]($backend) classes.\n * @public\n * @extensions\n */\nexport interface ModelQueryParams extends EntityQueryParams {\n  wantTemplate?: boolean;\n  wantPrivate?: boolean;\n}\n\n/** Properties that describe a [GeometricModel]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModelProps extends ModelProps {\n  /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model\n   * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can\n   * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)\n   * If undefined, the state of the geometry is unknown.\n   */\n  geometryGuid?: GuidString;\n}\n\n/** Properties that define a [GeometricModel2d]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModel2dProps extends GeometricModelProps {\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\n  globalOrigin?: XYProps;\n}\n\n/** Properties that define a [GeometricModel3d]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModel3dProps extends GeometricModelProps {\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */\n  isNotSpatiallyLocated?: boolean;\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */\n  isPlanProjection?: boolean;\n}\n"]}
+{"version":3,"file":"ModelProps.js","sourceRoot":"","sources":["../../src/ModelProps.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 Entities\r\n */\r\n\r\nimport { GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { XYProps } from \"@itwin/core-geometry\";\r\nimport { CodeProps } from \"./Code\";\r\nimport { RelatedElementProps } from \"./ElementProps\";\r\nimport { EntityProps, EntityQueryParams } from \"./EntityProps\";\r\n\r\n/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelProps extends EntityProps {\r\n  modeledElement: RelatedElementProps;\r\n  name?: string;\r\n  /** @note must always match the model of the [[ModelProps.modeledElement]] */\r\n  parentModel?: Id64String;\r\n  isPrivate?: boolean;\r\n  isTemplate?: boolean;\r\n  jsonProperties?: any;\r\n}\r\n\r\n/** Properties that specify what model should be loaded.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelLoadProps {\r\n  id?: Id64String;\r\n  code?: CodeProps;\r\n}\r\n\r\n/** Parameters for performing a query on [Model]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelQueryParams extends EntityQueryParams {\r\n  wantTemplate?: boolean;\r\n  wantPrivate?: boolean;\r\n}\r\n\r\n/** Properties that describe a [GeometricModel]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModelProps extends ModelProps {\r\n  /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model\r\n   * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can\r\n   * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)\r\n   * If undefined, the state of the geometry is unknown.\r\n   */\r\n  geometryGuid?: GuidString;\r\n}\r\n\r\n/** Properties that define a [GeometricModel2d]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModel2dProps extends GeometricModelProps {\r\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\r\n  globalOrigin?: XYProps;\r\n}\r\n\r\n/** Properties that define a [GeometricModel3d]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModel3dProps extends GeometricModelProps {\r\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */\r\n  isNotSpatiallyLocated?: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */\r\n  isPlanProjection?: boolean;\r\n}\r\n"]}

package/lib/cjs/NativeAppProps.d.ts

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

package/lib/cjs/NativeAppProps.js

@@ -1,31 +1,31 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module NativeApp
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OverriddenBy = exports.InternetConnectivityStatus = exports.nativeAppNotify = exports.nativeAppChannel = void 0;
-/** @internal */
-exports.nativeAppChannel = "nativeApp";
-/** @internal */
-exports.nativeAppNotify = "nativeApp-notify";
-/** Indicates whether or not the computer is currently connected to the internet.
- * @beta
- */
-var InternetConnectivityStatus;
-(function (InternetConnectivityStatus) {
-    InternetConnectivityStatus[InternetConnectivityStatus["Online"] = 0] = "Online";
-    InternetConnectivityStatus[InternetConnectivityStatus["Offline"] = 1] = "Offline";
-})(InternetConnectivityStatus = exports.InternetConnectivityStatus || (exports.InternetConnectivityStatus = {}));
-/** Describes whether the user or the browser overrode the internet connectivity status.
- * @beta
- */
-var OverriddenBy;
-(function (OverriddenBy) {
-    OverriddenBy[OverriddenBy["Browser"] = 0] = "Browser";
-    OverriddenBy[OverriddenBy["User"] = 1] = "User";
-})(OverriddenBy = exports.OverriddenBy || (exports.OverriddenBy = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module NativeApp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OverriddenBy = exports.InternetConnectivityStatus = exports.nativeAppNotify = exports.nativeAppChannel = void 0;
+/** @internal */
+exports.nativeAppChannel = "nativeApp";
+/** @internal */
+exports.nativeAppNotify = "nativeApp-notify";
+/** Indicates whether or not the computer is currently connected to the internet.
+ * @beta
+ */
+var InternetConnectivityStatus;
+(function (InternetConnectivityStatus) {
+    InternetConnectivityStatus[InternetConnectivityStatus["Online"] = 0] = "Online";
+    InternetConnectivityStatus[InternetConnectivityStatus["Offline"] = 1] = "Offline";
+})(InternetConnectivityStatus = exports.InternetConnectivityStatus || (exports.InternetConnectivityStatus = {}));
+/** Describes whether the user or the browser overrode the internet connectivity status.
+ * @beta
+ */
+var OverriddenBy;
+(function (OverriddenBy) {
+    OverriddenBy[OverriddenBy["Browser"] = 0] = "Browser";
+    OverriddenBy[OverriddenBy["User"] = 1] = "User";
+})(OverriddenBy = exports.OverriddenBy || (exports.OverriddenBy = {}));
 //# sourceMappingURL=NativeAppProps.js.map

package/lib/cjs/NativeAppProps.js.map

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