@itwin/core-common 4.0.0-dev.10 → 4.0.0-dev.101

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 type LocalFileName = string;
+/** @public */
+export 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 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 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 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
+ * @public
+ */
+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
+ * @internal
+ */
+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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChangesetProps.d.ts","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAIA;;;GAGG;AAEH,cAAc;AACd,oBAAY,aAAa,GAAG,MAAM,CAAC;AACnC,cAAc;AACd,oBAAY,YAAY,GAAG,MAAM,CAAC;AAElC;;;;GAIG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;GAIG;AACH,oBAAY,cAAc,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAAG,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEjG;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEnG;;;EAGE;AACF,oBAAY,kBAAkB,GAAG,mBAAmB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEtK;;;GAGG;AACH,oBAAY,aAAa;IACvB,mDAAmD;IACnD,OAAO,IAAI;IACX,+CAA+C;IAC/C,MAAM,IAAI;CACX;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4GAA4G;IAC5G,KAAK,EAAE,cAAc,CAAC;IACtB,sBAAsB;IACtB,EAAE,EAAE,WAAW,CAAC;IAChB,gEAAgE;IAChE,QAAQ,EAAE,WAAW,CAAC;IACtB,4BAA4B;IAC5B,WAAW,EAAE,aAAa,CAAC;IAC3B,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,kEAAkE;IAClE,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,KAAK,EAAE,cAAc,CAAC;IACtB,sFAAsF;IACtF,GAAG,CAAC,EAAE,cAAc,CAAC;CACtB"}
+{"version":3,"file":"ChangesetProps.d.ts","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAIA;;;GAGG;AAEH,cAAc;AACd,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,cAAc;AACd,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAAG,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEjG;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAA;CAAE;AAEnG;;;EAGE;AACF,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEtK;;;GAGG;AACH,oBAAY,aAAa;IACvB,mDAAmD;IACnD,OAAO,IAAI;IACX,+CAA+C;IAC/C,MAAM,IAAI;CACX;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4GAA4G;IAC5G,KAAK,EAAE,cAAc,CAAC;IACtB,sBAAsB;IACtB,EAAE,EAAE,WAAW,CAAC;IAChB,gEAAgE;IAChE,QAAQ,EAAE,WAAW,CAAC;IACtB,4BAA4B;IAC5B,WAAW,EAAE,aAAa,CAAC;IAC3B,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,kEAAkE;IAClE,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,KAAK,EAAE,cAAc,CAAC;IACtB,sFAAsF;IACtF,GAAG,CAAC,EAAE,cAAc,CAAC;CACtB"}

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 * @public\n */\nexport interface ChangesetProps {\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\n  index: ChangesetIndex;\n  /** the ChangesetId */\n  id: ChangesetId;\n  /** the ChangeSetId of the parent changeset of this changeset */\n  parentId: ChangesetId;\n  /** The type of changeset */\n  changesType: ChangesetType;\n  /** The user-supplied description of the work this changeset holds */\n  description: string;\n  /** The BriefcaseId of the briefcase that created this changeset */\n  briefcaseId: number;\n  /** The date this changeset was uploaded to the hub */\n  pushDate: string;\n  /** The identity of the user that created this changeset */\n  userCreated: string;\n  /** The size, in bytes, of this changeset */\n  size: number;\n}\n\n/** Properties of a changeset file\n * @internal\n */\nexport interface ChangesetFileProps extends ChangesetProps {\n  /** The full pathname of the local file holding this changeset. */\n  pathname: LocalFileName;\n}\n\n/**\n * A range of changesets\n * @public\n * @extensions\n */\nexport interface ChangesetRange {\n  /** index of the first changeset */\n  first: ChangesetIndex;\n  /** index of last changeset. If undefined, all changesets after first are returned. */\n  end?: ChangesetIndex;\n}\n"]}

package/lib/esm/ClipStyle.d.ts

@@ -1,90 +1,90 @@
-/** @packageDocumentation
- * @module Views
- */
-import { ViewFlagOverrides } from "./ViewFlags";
-import { RgbColor, RgbColorProps } from "./RgbColor";
-import { HiddenLine } from "./HiddenLine";
-import { FeatureAppearance, FeatureAppearanceProps } from "./FeatureSymbology";
-/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).
- * @see [[ClipStyleProps.cutStyle]].
- * @public
- * @extensions
- */
-export interface CutStyleProps {
-    /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */
-    viewflags?: ViewFlagOverrides;
-    /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */
-    hiddenLine?: HiddenLine.SettingsProps;
-    /** If defined, overrides aspects of the cut geometry's symbology. */
-    appearance?: FeatureAppearanceProps;
-}
-/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.
- * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.
- * @public
- */
-export declare class CutStyle {
-    /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */
-    readonly viewflags: Readonly<ViewFlagOverrides>;
-    /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */
-    readonly hiddenLine?: HiddenLine.Settings;
-    /** If defined, overrides aspects of the symbology of the section-cut graphics. */
-    readonly appearance?: FeatureAppearance;
-    /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
-    static readonly defaults: CutStyle;
-    private constructor();
-    /** Create a CutStyle from its components. */
-    static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle;
-    static fromJSON(props?: CutStyleProps): CutStyle;
-    /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
-    toJSON(): CutStyleProps | undefined;
-    /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */
-    get matchesDefaults(): boolean;
-}
-/** Wire format describing a [[ClipStyle]].
- * @see [[DisplayStyleSettingsProps.clipStyle]].
- * @public
- * @extensions
- */
-export interface ClipStyleProps {
-    /** If `true`, geometry will be produced at the clip planes in a 3d view.
-     * - Solids (closed volumes) will produce facets on the clip planes.
-     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
-     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
-     */
-    produceCutGeometry?: boolean;
-    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
-    cutStyle?: CutStyleProps;
-    /** If defined, geometry inside the clip planes will be drawn in this color. */
-    insideColor?: RgbColorProps;
-    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
-    outsideColor?: RgbColorProps;
-}
-/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
- * @see [[DisplayStyleSettings.clipStyle]].
- * @public
- */
-export declare class ClipStyle {
-    /** If `true`, geometry will be produced at the clip planes.
-     * - Solids (closed volumes) will produce facets on the clip planes.
-     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
-     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
-     */
-    readonly produceCutGeometry: boolean;
-    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
-    readonly cutStyle: CutStyle;
-    /** If defined, geometry inside the clip planes will be drawn in this color. */
-    readonly insideColor?: RgbColor;
-    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
-    readonly outsideColor?: RgbColor;
-    /** The default style, which overrides none of the view's settings. */
-    static readonly defaults: ClipStyle;
-    private constructor();
-    /** Create a style from its components. */
-    static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;
-    static fromJSON(props?: ClipStyleProps): ClipStyle;
-    /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */
-    toJSON(): ClipStyleProps | undefined;
-    /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */
-    get matchesDefaults(): boolean;
-}
+/** @packageDocumentation
+ * @module Views
+ */
+import { ViewFlagOverrides } from "./ViewFlags";
+import { RgbColor, RgbColorProps } from "./RgbColor";
+import { HiddenLine } from "./HiddenLine";
+import { FeatureAppearance, FeatureAppearanceProps } from "./FeatureSymbology";
+/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).
+ * @see [[ClipStyleProps.cutStyle]].
+ * @public
+ * @extensions
+ */
+export interface CutStyleProps {
+    /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */
+    viewflags?: ViewFlagOverrides;
+    /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */
+    hiddenLine?: HiddenLine.SettingsProps;
+    /** If defined, overrides aspects of the cut geometry's symbology. */
+    appearance?: FeatureAppearanceProps;
+}
+/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.
+ * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.
+ * @public
+ */
+export declare class CutStyle {
+    /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */
+    readonly viewflags: Readonly<ViewFlagOverrides>;
+    /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */
+    readonly hiddenLine?: HiddenLine.Settings;
+    /** If defined, overrides aspects of the symbology of the section-cut graphics. */
+    readonly appearance?: FeatureAppearance;
+    /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
+    static readonly defaults: CutStyle;
+    private constructor();
+    /** Create a CutStyle from its components. */
+    static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle;
+    static fromJSON(props?: CutStyleProps): CutStyle;
+    /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
+    toJSON(): CutStyleProps | undefined;
+    /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */
+    get matchesDefaults(): boolean;
+}
+/** Wire format describing a [[ClipStyle]].
+ * @see [[DisplayStyleSettingsProps.clipStyle]].
+ * @public
+ * @extensions
+ */
+export interface ClipStyleProps {
+    /** If `true`, geometry will be produced at the clip planes in a 3d view.
+     * - Solids (closed volumes) will produce facets on the clip planes.
+     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
+     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
+     */
+    produceCutGeometry?: boolean;
+    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
+    cutStyle?: CutStyleProps;
+    /** If defined, geometry inside the clip planes will be drawn in this color. */
+    insideColor?: RgbColorProps;
+    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
+    outsideColor?: RgbColorProps;
+}
+/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
+ * @see [[DisplayStyleSettings.clipStyle]].
+ * @public
+ */
+export declare class ClipStyle {
+    /** If `true`, geometry will be produced at the clip planes.
+     * - Solids (closed volumes) will produce facets on the clip planes.
+     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
+     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
+     */
+    readonly produceCutGeometry: boolean;
+    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
+    readonly cutStyle: CutStyle;
+    /** If defined, geometry inside the clip planes will be drawn in this color. */
+    readonly insideColor?: RgbColor;
+    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
+    readonly outsideColor?: RgbColor;
+    /** The default style, which overrides none of the view's settings. */
+    static readonly defaults: ClipStyle;
+    private constructor();
+    /** Create a style from its components. */
+    static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;
+    static fromJSON(props?: ClipStyleProps): ClipStyle;
+    /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */
+    toJSON(): ClipStyleProps | undefined;
+    /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */
+    get matchesDefaults(): boolean;
+}
 //# sourceMappingURL=ClipStyle.d.ts.map