@itwin/core-common 3.7.0-dev.6 → 3.7.0-dev.8

package/lib/esm/ChangedElements.d.ts

@@ -1,86 +1,86 @@
-/**
- * @packageDocumentation
- * @module Entities
- */
-import { DbOpcode, Id64String } from "@itwin/core-bentley";
-import { AxisAlignedBox3dProps } from "./geometry/Placement";
-/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].
- * @public
- * @extensions
- */
-export declare enum TypeOfChange {
-    /** A property in the element changed */
-    Property = 1,
-    /** The geometry stream of a [GeometricElement]($backend) changed */
-    Geometry = 2,
-    /** The [[Placement]] of a [GeometricElement]($backend) changed */
-    Placement = 4,
-    /** Indirect change occurred to this element by a related instance */
-    Indirect = 8,
-    /** Hidden properties of the element changed */
-    Hidden = 16,
-    /** The top-most parent of the element has changed */
-    Parent = 32
-}
-/** Changed elements found in a changeset or between a range of changesets.
- * All arrays in this object will have the same number of items.
- * Each index for those arrays refer to the same element, e.g. to get the class Id of
- * the element given by element Id changedElements.elements[index], you can use changedElements.classIds[index].
- * @public
- * @extensions
- */
-export interface ChangedElements {
-    /** Ids of elements that changed */
-    elements: Id64String[];
-    /** ECClass Ids of elements that changed */
-    classIds: Id64String[];
-    /** Operation that occurred on the element. Whether the element was inserted, updated or deleted.
-     * See [DbOpcode]($core-bentley)
-     */
-    opcodes: DbOpcode[];
-    /** Type of change bitflags, see [[TypeOfChange]] */
-    type: TypeOfChange[];
-    /** Model Ids of the changed elements
-     * This may be undefined if the agent that did the processing job did not export model Ids
-     */
-    modelIds?: Id64String[];
-    /** Property accessor strings of properties that changed, if any, for each changed element
-     * This may be undefined if the agent that did the processing job did not export properties
-    */
-    properties?: string[][];
-    /** Before state checksums of the property value
-     * Useful to determine if property values have changed
-     * between the versions being inspected
-     * This may be undefined if the agent that did the processing job did not export checksums
-     */
-    oldChecksums?: number[][];
-    /** After state checksums of the property value
-     * Useful to determine if property values have changed
-     * between the versions being inspected
-     * This may be undefined if the agent that did the processing job did not export checksums
-     */
-    newChecksums?: number[][];
-    /**
-     * Parent ids of the changed elements
-     * Will be "0" if the element has no parent
-     * This may be undefined if the agent that did the processing job did not export parent information
-     */
-    parentIds?: Id64String[];
-    /**
-     * Parent ECClass Ids of the changed elements
-     * Will be "0" if the element has no parent
-     * This may be undefined if the agent that did the processing job did not export parent information
-     */
-    parentClassIds?: Id64String[];
-}
-/** @internal */
-export interface ChangedModels {
-    modelIds: Id64String[];
-    bboxes: AxisAlignedBox3dProps[];
-}
-/** @internal */
-export interface ChangeData {
-    changedElements: ChangedElements;
-    changedModels: ChangedModels;
-}
+/**
+ * @packageDocumentation
+ * @module Entities
+ */
+import { DbOpcode, Id64String } from "@itwin/core-bentley";
+import { AxisAlignedBox3dProps } from "./geometry/Placement";
+/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].
+ * @public
+ * @extensions
+ */
+export declare enum TypeOfChange {
+    /** A property in the element changed */
+    Property = 1,
+    /** The geometry stream of a [GeometricElement]($backend) changed */
+    Geometry = 2,
+    /** The [[Placement]] of a [GeometricElement]($backend) changed */
+    Placement = 4,
+    /** Indirect change occurred to this element by a related instance */
+    Indirect = 8,
+    /** Hidden properties of the element changed */
+    Hidden = 16,
+    /** The top-most parent of the element has changed */
+    Parent = 32
+}
+/** Changed elements found in a changeset or between a range of changesets.
+ * All arrays in this object will have the same number of items.
+ * Each index for those arrays refer to the same element, e.g. to get the class Id of
+ * the element given by element Id changedElements.elements[index], you can use changedElements.classIds[index].
+ * @public
+ * @extensions
+ */
+export interface ChangedElements {
+    /** Ids of elements that changed */
+    elements: Id64String[];
+    /** ECClass Ids of elements that changed */
+    classIds: Id64String[];
+    /** Operation that occurred on the element. Whether the element was inserted, updated or deleted.
+     * See [DbOpcode]($core-bentley)
+     */
+    opcodes: DbOpcode[];
+    /** Type of change bitflags, see [[TypeOfChange]] */
+    type: TypeOfChange[];
+    /** Model Ids of the changed elements
+     * This may be undefined if the agent that did the processing job did not export model Ids
+     */
+    modelIds?: Id64String[];
+    /** Property accessor strings of properties that changed, if any, for each changed element
+     * This may be undefined if the agent that did the processing job did not export properties
+    */
+    properties?: string[][];
+    /** Before state checksums of the property value
+     * Useful to determine if property values have changed
+     * between the versions being inspected
+     * This may be undefined if the agent that did the processing job did not export checksums
+     */
+    oldChecksums?: number[][];
+    /** After state checksums of the property value
+     * Useful to determine if property values have changed
+     * between the versions being inspected
+     * This may be undefined if the agent that did the processing job did not export checksums
+     */
+    newChecksums?: number[][];
+    /**
+     * Parent ids of the changed elements
+     * Will be "0" if the element has no parent
+     * This may be undefined if the agent that did the processing job did not export parent information
+     */
+    parentIds?: Id64String[];
+    /**
+     * Parent ECClass Ids of the changed elements
+     * Will be "0" if the element has no parent
+     * This may be undefined if the agent that did the processing job did not export parent information
+     */
+    parentClassIds?: Id64String[];
+}
+/** @internal */
+export interface ChangedModels {
+    modelIds: Id64String[];
+    bboxes: AxisAlignedBox3dProps[];
+}
+/** @internal */
+export interface ChangeData {
+    changedElements: ChangedElements;
+    changedModels: ChangedModels;
+}
 //# sourceMappingURL=ChangedElements.d.ts.map

package/lib/esm/ChangedElements.js

@@ -1,21 +1,21 @@
-// cspell:ignore bboxes
-/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].
- * @public
- * @extensions
- */
-export var TypeOfChange;
-(function (TypeOfChange) {
-    /** A property in the element changed */
-    TypeOfChange[TypeOfChange["Property"] = 1] = "Property";
-    /** The geometry stream of a [GeometricElement]($backend) changed */
-    TypeOfChange[TypeOfChange["Geometry"] = 2] = "Geometry";
-    /** The [[Placement]] of a [GeometricElement]($backend) changed */
-    TypeOfChange[TypeOfChange["Placement"] = 4] = "Placement";
-    /** Indirect change occurred to this element by a related instance */
-    TypeOfChange[TypeOfChange["Indirect"] = 8] = "Indirect";
-    /** Hidden properties of the element changed */
-    TypeOfChange[TypeOfChange["Hidden"] = 16] = "Hidden";
-    /** The top-most parent of the element has changed */
-    TypeOfChange[TypeOfChange["Parent"] = 32] = "Parent";
-})(TypeOfChange || (TypeOfChange = {}));
+// cspell:ignore bboxes
+/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].
+ * @public
+ * @extensions
+ */
+export var TypeOfChange;
+(function (TypeOfChange) {
+    /** A property in the element changed */
+    TypeOfChange[TypeOfChange["Property"] = 1] = "Property";
+    /** The geometry stream of a [GeometricElement]($backend) changed */
+    TypeOfChange[TypeOfChange["Geometry"] = 2] = "Geometry";
+    /** The [[Placement]] of a [GeometricElement]($backend) changed */
+    TypeOfChange[TypeOfChange["Placement"] = 4] = "Placement";
+    /** Indirect change occurred to this element by a related instance */
+    TypeOfChange[TypeOfChange["Indirect"] = 8] = "Indirect";
+    /** Hidden properties of the element changed */
+    TypeOfChange[TypeOfChange["Hidden"] = 16] = "Hidden";
+    /** The top-most parent of the element has changed */
+    TypeOfChange[TypeOfChange["Parent"] = 32] = "Parent";
+})(TypeOfChange || (TypeOfChange = {}));
 //# sourceMappingURL=ChangedElements.js.map

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,YAaX;AAbD,WAAY,YAAY;IACtB,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,EAbW,YAAY,KAAZ,YAAY,QAavB","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  /** 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,YAaX;AAbD,WAAY,YAAY;IACtB,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,EAbW,YAAY,KAAZ,YAAY,QAavB","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  /** 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.d.ts

@@ -1,46 +1,46 @@
-/** @packageDocumentation
- * @module NativeApp
- */
-import { CompressedId64Set, Id64String } from "@itwin/core-bentley";
-/** Describes an [Entity]($backend) and its [ECClass]($docs/bis/guide/references/glossary/#ecclass) by Id.
- * @public
- * @extensions
- */
-export interface EntityIdAndClassId {
-    /** The entity's Id. */
-    id: Id64String;
-    /** The Id of the entity's ECClass. */
-    classId: Id64String;
-}
-/** JSON representation of the set of [Element]($backend)s or [Model]($backend)s that were changed by a [Txn]($docs/learning/InteractiveEditing.md).
- * @see [TxnManager.onElementsChanged]($backend) and [TxnManager.onModelsChanged]($backend).
- * @see [BriefcaseTxns.onElementsChanged]($frontend) and [BriefcaseTxns.onModelsChanged]($frontend).
- * @public
- * @extensions
- */
-export interface ChangedEntities {
-    /** The ids of entities that were inserted during the Txn. */
-    inserted?: CompressedId64Set;
-    /** The ids of entities that were deleted during the Txn. */
-    deleted?: CompressedId64Set;
-    /** 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. */
-    updated?: CompressedId64Set;
-}
-/** A collection of [[EntityIdAndClassId]]s, as used by [TxnChangedEntities]($backend).
- * For efficiency, the iterator supplied by this iterable returns **the same `EntityIdAndClassId` object** on each iteration. Therefore the objects must be copied if you
- * intend to store references to them. For example, to populate an array from the iterable:
- * ```ts
- *  function arrayFromIterable(entities: EntityIdAndClassIdIterable): EntityIdAndClassId[] {
- *    // NO! return Array.from(entities);
- *    const array = [];
- *    for (const entity of entities)
- *      array.push({...entity});
- *
- *    return array;
- *  }
- * ```
- * @public
- * @extensions
- */
-export declare type EntityIdAndClassIdIterable = Iterable<Readonly<EntityIdAndClassId>>;
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { CompressedId64Set, Id64String } from "@itwin/core-bentley";
+/** Describes an [Entity]($backend) and its [ECClass]($docs/bis/guide/references/glossary/#ecclass) by Id.
+ * @public
+ * @extensions
+ */
+export interface EntityIdAndClassId {
+    /** The entity's Id. */
+    id: Id64String;
+    /** The Id of the entity's ECClass. */
+    classId: Id64String;
+}
+/** JSON representation of the set of [Element]($backend)s or [Model]($backend)s that were changed by a [Txn]($docs/learning/InteractiveEditing.md).
+ * @see [TxnManager.onElementsChanged]($backend) and [TxnManager.onModelsChanged]($backend).
+ * @see [BriefcaseTxns.onElementsChanged]($frontend) and [BriefcaseTxns.onModelsChanged]($frontend).
+ * @public
+ * @extensions
+ */
+export interface ChangedEntities {
+    /** The ids of entities that were inserted during the Txn. */
+    inserted?: CompressedId64Set;
+    /** The ids of entities that were deleted during the Txn. */
+    deleted?: CompressedId64Set;
+    /** 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. */
+    updated?: CompressedId64Set;
+}
+/** A collection of [[EntityIdAndClassId]]s, as used by [TxnChangedEntities]($backend).
+ * For efficiency, the iterator supplied by this iterable returns **the same `EntityIdAndClassId` object** on each iteration. Therefore the objects must be copied if you
+ * intend to store references to them. For example, to populate an array from the iterable:
+ * ```ts
+ *  function arrayFromIterable(entities: EntityIdAndClassIdIterable): EntityIdAndClassId[] {
+ *    // NO! return Array.from(entities);
+ *    const array = [];
+ *    for (const entity of entities)
+ *      array.push({...entity});
+ *
+ *    return array;
+ *  }
+ * ```
+ * @public
+ * @extensions
+ */
+export declare type EntityIdAndClassIdIterable = Iterable<Readonly<EntityIdAndClassId>>;
 //# sourceMappingURL=ChangedEntities.d.ts.map

package/lib/esm/ChangedEntities.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=ChangedEntities.js.map

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

@@ -1,99 +1,99 @@
-/**
- * @packageDocumentation
- * @module iModels
- */
-/** @public */
-export declare type LocalFileName = string;
-/** @public */
-export declare type LocalDirName = string;
-/** A string that identifies a changeset.
- * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.
- * @public
- * @extensions
- */
-export declare type ChangesetId = string;
-/** The index of a changeset, assigned by iModelHub.
- * @note 0 means "before the first changeset." Values less than 0 are invalid.
- * @public
- * @extensions
- */
-export declare type ChangesetIndex = number;
-/** Both the index and Id of a changeset
- * @public
- * @extensions
- */
-export interface ChangesetIndexAndId {
-    readonly index: ChangesetIndex;
-    readonly id: ChangesetId;
-}
-/** The Id and optionally the index of a changeset
- * @public
- * @extensions
- */
-export interface ChangesetIdWithIndex {
-    readonly index?: ChangesetIndex;
-    readonly id: ChangesetId;
-}
-/** either changeset index, id, or both
-* @public
- * @extensions
-*/
-export declare type ChangesetIndexOrId = ChangesetIndexAndId | {
-    readonly index: ChangesetIndex;
-    readonly id?: never;
-} | {
-    readonly id: ChangesetId;
-    readonly index?: never;
-};
-/** Value to indicate whether a changeset contains schema changes or not
- * @public
- * @extensions
- */
-export declare enum ChangesetType {
-    /** changeset does *not* contain schema changes. */
-    Regular = 0,
-    /** changeset *does* contain schema changes. */
-    Schema = 1
-}
-/** Properties of a changeset
- * @beta
- */
-export interface ChangesetProps {
-    /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */
-    index: ChangesetIndex;
-    /** the ChangesetId */
-    id: ChangesetId;
-    /** the ChangeSetId of the parent changeset of this changeset */
-    parentId: ChangesetId;
-    /** The type of changeset */
-    changesType: ChangesetType;
-    /** The user-supplied description of the work this changeset holds */
-    description: string;
-    /** The BriefcaseId of the briefcase that created this changeset */
-    briefcaseId: number;
-    /** The date this changeset was uploaded to the hub */
-    pushDate: string;
-    /** The identity of the user that created this changeset */
-    userCreated: string;
-    /** The size, in bytes, of this changeset */
-    size?: number;
-}
-/** Properties of a changeset file
- * @beta
- */
-export interface ChangesetFileProps extends ChangesetProps {
-    /** The full pathname of the local file holding this changeset. */
-    pathname: LocalFileName;
-}
-/**
- * A range of changesets
- * @public
- * @extensions
- */
-export interface ChangesetRange {
-    /** index of the first changeset */
-    first: ChangesetIndex;
-    /** index of last changeset. If undefined, all changesets after first are returned. */
-    end?: ChangesetIndex;
-}
+/**
+ * @packageDocumentation
+ * @module iModels
+ */
+/** @public */
+export declare type LocalFileName = string;
+/** @public */
+export declare type LocalDirName = string;
+/** A string that identifies a changeset.
+ * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.
+ * @public
+ * @extensions
+ */
+export declare type ChangesetId = string;
+/** The index of a changeset, assigned by iModelHub.
+ * @note 0 means "before the first changeset." Values less than 0 are invalid.
+ * @public
+ * @extensions
+ */
+export declare type ChangesetIndex = number;
+/** Both the index and Id of a changeset
+ * @public
+ * @extensions
+ */
+export interface ChangesetIndexAndId {
+    readonly index: ChangesetIndex;
+    readonly id: ChangesetId;
+}
+/** The Id and optionally the index of a changeset
+ * @public
+ * @extensions
+ */
+export interface ChangesetIdWithIndex {
+    readonly index?: ChangesetIndex;
+    readonly id: ChangesetId;
+}
+/** either changeset index, id, or both
+* @public
+ * @extensions
+*/
+export declare type ChangesetIndexOrId = ChangesetIndexAndId | {
+    readonly index: ChangesetIndex;
+    readonly id?: never;
+} | {
+    readonly id: ChangesetId;
+    readonly index?: never;
+};
+/** Value to indicate whether a changeset contains schema changes or not
+ * @public
+ * @extensions
+ */
+export declare enum ChangesetType {
+    /** changeset does *not* contain schema changes. */
+    Regular = 0,
+    /** changeset *does* contain schema changes. */
+    Schema = 1
+}
+/** Properties of a changeset
+ * @beta
+ */
+export interface ChangesetProps {
+    /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */
+    index: ChangesetIndex;
+    /** the ChangesetId */
+    id: ChangesetId;
+    /** the ChangeSetId of the parent changeset of this changeset */
+    parentId: ChangesetId;
+    /** The type of changeset */
+    changesType: ChangesetType;
+    /** The user-supplied description of the work this changeset holds */
+    description: string;
+    /** The BriefcaseId of the briefcase that created this changeset */
+    briefcaseId: number;
+    /** The date this changeset was uploaded to the hub */
+    pushDate: string;
+    /** The identity of the user that created this changeset */
+    userCreated: string;
+    /** The size, in bytes, of this changeset */
+    size?: number;
+}
+/** Properties of a changeset file
+ * @beta
+ */
+export interface ChangesetFileProps extends ChangesetProps {
+    /** The full pathname of the local file holding this changeset. */
+    pathname: LocalFileName;
+}
+/**
+ * A range of changesets
+ * @public
+ * @extensions
+ */
+export interface ChangesetRange {
+    /** index of the first changeset */
+    first: ChangesetIndex;
+    /** index of last changeset. If undefined, all changesets after first are returned. */
+    end?: ChangesetIndex;
+}
 //# sourceMappingURL=ChangesetProps.d.ts.map

package/lib/esm/ChangesetProps.js

@@ -1,20 +1,20 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/**
- * @packageDocumentation
- * @module iModels
- */
-/** Value to indicate whether a changeset contains schema changes or not
- * @public
- * @extensions
- */
-export var ChangesetType;
-(function (ChangesetType) {
-    /** changeset does *not* contain schema changes. */
-    ChangesetType[ChangesetType["Regular"] = 0] = "Regular";
-    /** changeset *does* contain schema changes. */
-    ChangesetType[ChangesetType["Schema"] = 1] = "Schema";
-})(ChangesetType || (ChangesetType = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module iModels
+ */
+/** Value to indicate whether a changeset contains schema changes or not
+ * @public
+ * @extensions
+ */
+export var ChangesetType;
+(function (ChangesetType) {
+    /** changeset does *not* contain schema changes. */
+    ChangesetType[ChangesetType["Regular"] = 0] = "Regular";
+    /** changeset *does* contain schema changes. */
+    ChangesetType[ChangesetType["Schema"] = 1] = "Schema";
+})(ChangesetType || (ChangesetType = {}));
 //# sourceMappingURL=ChangesetProps.js.map

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,aAKX;AALD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;AACZ,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB","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}\r\n\r\n/** Properties of a changeset\r\n * @beta\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 * @beta\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,aAKX;AALD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;AACZ,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB","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}\n\n/** Properties of a changeset\n * @beta\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 * @beta\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"]}