@itwin/core-backend 3.5.0-dev.27 → 3.5.0-dev.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (232) hide show
  1. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  2. package/lib/cjs/AliCloudStorageService.js +71 -71
  3. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  4. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  5. package/lib/cjs/BackendHubAccess.js +41 -41
  6. package/lib/cjs/BackendHubAccess.js.map +1 -1
  7. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  8. package/lib/cjs/BackendLoggerCategory.js +99 -99
  9. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  10. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  11. package/lib/cjs/BisCoreSchema.js +60 -60
  12. package/lib/cjs/BisCoreSchema.js.map +1 -1
  13. package/lib/cjs/BriefcaseManager.d.ts +170 -165
  14. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  15. package/lib/cjs/BriefcaseManager.js +413 -405
  16. package/lib/cjs/BriefcaseManager.js.map +1 -1
  17. package/lib/cjs/Category.d.ts +153 -153
  18. package/lib/cjs/Category.js +243 -243
  19. package/lib/cjs/Category.js.map +1 -1
  20. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  21. package/lib/cjs/ChangeSummaryManager.js +445 -445
  22. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  23. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  24. package/lib/cjs/ChangedElementsDb.js +165 -165
  25. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  26. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  27. package/lib/cjs/ChangedElementsManager.js +88 -88
  28. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  29. package/lib/cjs/CheckpointManager.d.ts +120 -120
  30. package/lib/cjs/CheckpointManager.js +343 -343
  31. package/lib/cjs/CheckpointManager.js.map +1 -1
  32. package/lib/cjs/ClassRegistry.d.ts +72 -72
  33. package/lib/cjs/ClassRegistry.js +243 -243
  34. package/lib/cjs/ClassRegistry.js.map +1 -1
  35. package/lib/cjs/CloudSqlite.d.ts +350 -350
  36. package/lib/cjs/CloudSqlite.js +152 -152
  37. package/lib/cjs/CloudSqlite.js.map +1 -1
  38. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  39. package/lib/cjs/CloudStorageBackend.js +173 -173
  40. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  41. package/lib/cjs/CodeService.d.ts +396 -396
  42. package/lib/cjs/CodeService.js +63 -63
  43. package/lib/cjs/CodeService.js.map +1 -1
  44. package/lib/cjs/CodeSpecs.d.ts +50 -50
  45. package/lib/cjs/CodeSpecs.js +112 -112
  46. package/lib/cjs/CodeSpecs.js.map +1 -1
  47. package/lib/cjs/ConcurrentQuery.d.ts +11 -11
  48. package/lib/cjs/ConcurrentQuery.js +30 -30
  49. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  50. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  51. package/lib/cjs/CustomViewState3dCreator.js +81 -81
  52. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  53. package/lib/cjs/DevTools.d.ts +71 -71
  54. package/lib/cjs/DevTools.js +154 -154
  55. package/lib/cjs/DevTools.js.map +1 -1
  56. package/lib/cjs/DisplayStyle.d.ts +106 -106
  57. package/lib/cjs/DisplayStyle.js +256 -256
  58. package/lib/cjs/DisplayStyle.js.map +1 -1
  59. package/lib/cjs/ECDb.d.ts +191 -191
  60. package/lib/cjs/ECDb.js +350 -350
  61. package/lib/cjs/ECDb.js.map +1 -1
  62. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  63. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  64. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  65. package/lib/cjs/ECSqlStatement.d.ts +466 -466
  66. package/lib/cjs/ECSqlStatement.js +791 -791
  67. package/lib/cjs/ECSqlStatement.js.map +1 -1
  68. package/lib/cjs/Element.d.ts +1102 -1102
  69. package/lib/cjs/Element.js +1416 -1416
  70. package/lib/cjs/Element.js.map +1 -1
  71. package/lib/cjs/ElementAspect.d.ts +158 -158
  72. package/lib/cjs/ElementAspect.js +186 -186
  73. package/lib/cjs/ElementAspect.js.map +1 -1
  74. package/lib/cjs/ElementGraphics.d.ts +9 -9
  75. package/lib/cjs/ElementGraphics.js +41 -41
  76. package/lib/cjs/ElementGraphics.js.map +1 -1
  77. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  78. package/lib/cjs/ElementTreeWalker.js +409 -409
  79. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  80. package/lib/cjs/Entity.d.ts +106 -106
  81. package/lib/cjs/Entity.js +134 -134
  82. package/lib/cjs/Entity.js.map +1 -1
  83. package/lib/cjs/EntityReferences.d.ts +49 -49
  84. package/lib/cjs/EntityReferences.js +95 -95
  85. package/lib/cjs/EntityReferences.js.map +1 -1
  86. package/lib/cjs/ExportGraphics.d.ts +317 -317
  87. package/lib/cjs/ExportGraphics.js +208 -208
  88. package/lib/cjs/ExportGraphics.js.map +1 -1
  89. package/lib/cjs/ExternalSource.d.ts +96 -96
  90. package/lib/cjs/ExternalSource.js +131 -131
  91. package/lib/cjs/ExternalSource.js.map +1 -1
  92. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  93. package/lib/cjs/GeoCoordConfig.js +82 -82
  94. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  95. package/lib/cjs/GeometrySummary.d.ts +4 -4
  96. package/lib/cjs/GeometrySummary.js +380 -380
  97. package/lib/cjs/GeometrySummary.js.map +1 -1
  98. package/lib/cjs/HubMock.d.ts +94 -93
  99. package/lib/cjs/HubMock.d.ts.map +1 -1
  100. package/lib/cjs/HubMock.js +222 -190
  101. package/lib/cjs/HubMock.js.map +1 -1
  102. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  103. package/lib/cjs/IModelCloneContext.js +15 -15
  104. package/lib/cjs/IModelCloneContext.js.map +1 -1
  105. package/lib/cjs/IModelDb.d.ts +1183 -1183
  106. package/lib/cjs/IModelDb.js +2374 -2374
  107. package/lib/cjs/IModelDb.js.map +1 -1
  108. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  109. package/lib/cjs/IModelElementCloneContext.js +159 -159
  110. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  111. package/lib/cjs/IModelHost.d.ts +369 -369
  112. package/lib/cjs/IModelHost.js +492 -492
  113. package/lib/cjs/IModelHost.js.map +1 -1
  114. package/lib/cjs/IModelJsFs.d.ts +62 -62
  115. package/lib/cjs/IModelJsFs.js +140 -140
  116. package/lib/cjs/IModelJsFs.js.map +1 -1
  117. package/lib/cjs/IpcHost.d.ts +104 -98
  118. package/lib/cjs/IpcHost.d.ts.map +1 -1
  119. package/lib/cjs/IpcHost.js +278 -234
  120. package/lib/cjs/IpcHost.js.map +1 -1
  121. package/lib/cjs/LineStyle.d.ts +311 -311
  122. package/lib/cjs/LineStyle.js +295 -295
  123. package/lib/cjs/LineStyle.js.map +1 -1
  124. package/lib/cjs/LocalHub.d.ts +162 -162
  125. package/lib/cjs/LocalHub.js +587 -587
  126. package/lib/cjs/LocalHub.js.map +1 -1
  127. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  128. package/lib/cjs/LocalhostIpcHost.js +81 -81
  129. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  130. package/lib/cjs/Material.d.ts +103 -103
  131. package/lib/cjs/Material.js +147 -147
  132. package/lib/cjs/Material.js.map +1 -1
  133. package/lib/cjs/Model.d.ts +392 -392
  134. package/lib/cjs/Model.js +485 -485
  135. package/lib/cjs/Model.js.map +1 -1
  136. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  137. package/lib/cjs/NativeAppStorage.js +202 -202
  138. package/lib/cjs/NativeAppStorage.js.map +1 -1
  139. package/lib/cjs/NativeHost.d.ts +52 -52
  140. package/lib/cjs/NativeHost.d.ts.map +1 -1
  141. package/lib/cjs/NativeHost.js +163 -168
  142. package/lib/cjs/NativeHost.js.map +1 -1
  143. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  144. package/lib/cjs/NavigationRelationship.js +225 -225
  145. package/lib/cjs/NavigationRelationship.js.map +1 -1
  146. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  147. package/lib/cjs/PromiseMemoizer.js +101 -101
  148. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  149. package/lib/cjs/PropertyStore.d.ts +132 -132
  150. package/lib/cjs/PropertyStore.js +11 -11
  151. package/lib/cjs/PropertyStore.js.map +1 -1
  152. package/lib/cjs/Relationship.d.ts +416 -416
  153. package/lib/cjs/Relationship.js +494 -494
  154. package/lib/cjs/Relationship.js.map +1 -1
  155. package/lib/cjs/RpcBackend.d.ts +28 -28
  156. package/lib/cjs/RpcBackend.js +126 -126
  157. package/lib/cjs/RpcBackend.js.map +1 -1
  158. package/lib/cjs/SQLiteDb.d.ts +219 -219
  159. package/lib/cjs/SQLiteDb.js +214 -214
  160. package/lib/cjs/SQLiteDb.js.map +1 -1
  161. package/lib/cjs/Schema.d.ts +55 -55
  162. package/lib/cjs/Schema.js +83 -83
  163. package/lib/cjs/Schema.js.map +1 -1
  164. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  165. package/lib/cjs/ServerBasedLocks.js +168 -168
  166. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  167. package/lib/cjs/SqliteStatement.d.ts +360 -360
  168. package/lib/cjs/SqliteStatement.js +586 -586
  169. package/lib/cjs/SqliteStatement.js.map +1 -1
  170. package/lib/cjs/Texture.d.ts +58 -58
  171. package/lib/cjs/Texture.js +82 -82
  172. package/lib/cjs/Texture.js.map +1 -1
  173. package/lib/cjs/TileStorage.d.ts +18 -18
  174. package/lib/cjs/TileStorage.js +90 -90
  175. package/lib/cjs/TileStorage.js.map +1 -1
  176. package/lib/cjs/TxnManager.d.ts +202 -202
  177. package/lib/cjs/TxnManager.js +356 -356
  178. package/lib/cjs/TxnManager.js.map +1 -1
  179. package/lib/cjs/ViewDefinition.d.ts +439 -439
  180. package/lib/cjs/ViewDefinition.js +646 -646
  181. package/lib/cjs/ViewDefinition.js.map +1 -1
  182. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  183. package/lib/cjs/ViewStateHydrator.js +103 -103
  184. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  185. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  186. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  187. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  188. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  189. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  190. package/lib/cjs/core-backend.d.ts +184 -184
  191. package/lib/cjs/core-backend.js +204 -204
  192. package/lib/cjs/core-backend.js.map +1 -1
  193. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  194. package/lib/cjs/domains/FunctionalElements.js +145 -145
  195. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  196. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  197. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  198. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  199. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  200. package/lib/cjs/domains/GenericElements.js +263 -263
  201. package/lib/cjs/domains/GenericElements.js.map +1 -1
  202. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  203. package/lib/cjs/domains/GenericSchema.js +28 -28
  204. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  205. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  206. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  207. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  208. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +46 -46
  209. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +287 -287
  210. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  211. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  212. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +202 -202
  213. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  214. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  215. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  216. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  217. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  218. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  219. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  220. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  221. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  222. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  223. package/lib/cjs/workspace/Settings.d.ts +186 -186
  224. package/lib/cjs/workspace/Settings.js +155 -155
  225. package/lib/cjs/workspace/Settings.js.map +1 -1
  226. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  227. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  228. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  229. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  230. package/lib/cjs/workspace/Workspace.js +543 -543
  231. package/lib/cjs/workspace/Workspace.js.map +1 -1
  232. package/package.json +12 -12
@@ -1,166 +1,171 @@
1
- /** @packageDocumentation
2
- * @module iModels
3
- */
4
- import { AccessToken, BeDuration, GuidString } from "@itwin/core-bentley";
5
- import { BriefcaseId, BriefcaseProps, ChangesetIndex, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps, RpcActivity } from "@itwin/core-common";
6
- import { AcquireNewBriefcaseIdArg } from "./BackendHubAccess";
7
- import { ProgressFunction } from "./CheckpointManager";
8
- import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
9
- /** The argument for [[BriefcaseManager.downloadBriefcase]]
10
- * @public
11
- */
12
- export interface RequestNewBriefcaseArg extends TokenArg, RequestNewBriefcaseProps {
13
- /** If present, a function called periodically during the download to indicate progress.
14
- * @note return non-zero from this function to abort the download.
15
- */
16
- onProgress?: ProgressFunction;
17
- }
18
- /**
19
- * Parameters for pushing changesets to iModelHub
20
- * @public
21
- */
22
- export interface PushChangesArgs extends TokenArg {
23
- /** A description of the changes. This is visible on the iModel's timeline. */
24
- description: string;
25
- /** if present, the locks are retained after the operation. Otherwise, *all* locks are released after the changeset is successfully pushed. */
26
- retainLocks?: true;
27
- /** number of times to retry pull/merge if other users are pushing at the same time. Default is 5 */
28
- mergeRetryCount?: number;
29
- /** delay to wait between pull/merge retry attempts. Default is 3 seconds */
30
- mergeRetryDelay?: BeDuration;
31
- /** the number of time to attempt to retry to push the changeset upon failure. Default is 3 */
32
- pushRetryCount?: number;
33
- /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */
34
- pushRetryDelay?: BeDuration;
35
- }
36
- /**
37
- * Specifies a specific index for pulling changes.
38
- * @public
39
- */
40
- export interface ToChangesetArgs extends TokenArg {
41
- /** The last ChangesetIndex to pull. If not present, pull *all* newer changesets. */
42
- toIndex?: ChangesetIndex;
43
- }
44
- /** Arguments for [[BriefcaseManager.pullAndApplyChangesets]]
45
- * @public
46
- */
47
- export declare type PullChangesArgs = ToChangesetArgs;
48
- /** Manages downloading Briefcases and downloading and uploading changesets.
49
- * @public
50
- */
51
- export declare class BriefcaseManager {
52
- /** Get the local path of the folder storing files that are associated with an imodel */
53
- static getIModelPath(iModelId: GuidString): LocalDirName;
54
- /** @internal */
55
- static getChangeSetsPath(iModelId: GuidString): LocalDirName;
56
- /** @internal */
57
- static getChangeCachePathName(iModelId: GuidString): LocalFileName;
58
- /** @internal */
59
- static getChangedElementsPathName(iModelId: GuidString): LocalFileName;
60
- private static _briefcaseSubDir;
61
- /** @internal */
62
- static getBriefcaseBasePath(iModelId: GuidString): LocalDirName;
63
- /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.
64
- * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].
65
- * @param briefcase the iModelId and BriefcaseId for the filename
66
- * @see getIModelPath
67
- */
68
- static getFileName(briefcase: BriefcaseProps): LocalFileName;
69
- private static setupCacheDir;
70
- private static _initialized?;
71
- /** Initialize BriefcaseManager
72
- * @param cacheRootDir The root directory for storing a cache of downloaded briefcase files on the local computer.
73
- * Briefcases are stored relative to this path in sub-folders organized by IModelId.
74
- * @note It is perfectly valid for applications to store briefcases in locations they manage, outside of `cacheRootDir`.
75
- */
76
- static initialize(cacheRootDir: LocalDirName): void;
77
- private static finalize;
78
- /** Get a list of the local briefcase held in the briefcase cache, optionally for a single iModelId
79
- * @param iModelId if present, only briefcases for this iModelId are returned, otherwise all briefcases for all
80
- * iModels in the briefcase cache are returned.
81
- * @note usually there should only be one briefcase per iModel.
82
- */
83
- static getCachedBriefcases(iModelId?: GuidString): LocalBriefcaseProps[];
84
- private static _cacheDir;
85
- /** Get the root directory for the briefcase cache */
86
- static get cacheDir(): LocalDirName;
87
- /** Determine whether the supplied briefcaseId is in the range of assigned BriefcaseIds issued by iModelHub
88
- * @note this does check whether the id was actually acquired by the caller.
89
- */
90
- static isValidBriefcaseId(id: BriefcaseId): boolean;
91
- /** Acquire a new briefcaseId from iModelHub for the supplied iModelId
92
- * @note usually there should only be one briefcase per iModel per user. If a single user acquires more than one briefcaseId,
93
- * it's a good idea to supply different aliases for each of them.
94
- */
95
- static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<BriefcaseId>;
96
- /**
97
- * Download a new briefcase from iModelHub for the supplied iModelId.
98
- *
99
- * Briefcases are local files holding a copy of an iModel.
100
- * Briefcases may either be specific to an individual user (so that it can be modified to create changesets), or it can be readonly so it can accept but not create changesets.
101
- * Every briefcase internally holds its [[BriefcaseId]]. Writeable briefcases have a `BriefcaseId` "assigned" to them by iModelHub. No two users will ever have the same BriefcaseId.
102
- * Readonly briefcases are "unassigned" with the special value [[BriefcaseId.Unassigned]].
103
- *
104
- * Typically a given user will have only one briefcase on their machine for a given iModelId. Rarely, it may be necessary to use more than one
105
- * briefcase to make isolated independent sets of changes, but that is exceedingly complicated and rare.
106
- *
107
- * Callers of this method may supply a BriefcaseId, or if none is supplied, a new one is acquired from iModelHub.
108
- *
109
- * @param arg The arguments that specify the briefcase file to be downloaded.
110
- * @returns The properties of the local briefcase in a Promise that is resolved after the briefcase is fully downloaded and the briefcase file is ready for use via [BriefcaseDb.open]($backend).
111
- * @note The location of the local file to hold the briefcase is arbitrary and may be any valid *local* path on your machine. If you don't supply
112
- * a filename, the local briefcase cache is used by creating a file with the briefcaseId as its name in the `briefcases` folder below the folder named
113
- * for the IModelId.
114
- * @note *It is invalid to edit briefcases on a shared network drive* and that is a sure way to corrupt your briefcase (see https://www.sqlite.org/howtocorrupt.html)
115
- */
116
- static downloadBriefcase(arg: RequestNewBriefcaseArg): Promise<LocalBriefcaseProps>;
117
- /** Deletes change sets of an iModel from local disk
118
- * @internal
119
- */
120
- static deleteChangeSetsFromLocalDisk(iModelId: string): void;
121
- /** Releases a briefcaseId from iModelHub. After this call it is illegal to generate changesets for the released briefcaseId.
122
- * @note generally, this method should not be called directly. Instead use [[deleteBriefcaseFiles]].
123
- * @see deleteBriefcaseFiles
124
- */
125
- static releaseBriefcase(accessToken: AccessToken, briefcase: BriefcaseProps): Promise<void>;
126
- /**
127
- * Delete and clean up a briefcase and all of its associated files. First, this method opens the supplied filename to determine its briefcaseId.
128
- * Then, if a requestContext is supplied, it releases a BriefcaseId from iModelHub. Finally it deletes the local briefcase file and
129
- * associated files (that is, all files in the same directory that start with the briefcase name).
130
- * @param filePath the full file name of the Briefcase to delete
131
- * @param accessToken for releasing the briefcaseId
132
- */
133
- static deleteBriefcaseFiles(filePath: LocalFileName, accessToken?: AccessToken): Promise<void>;
134
- /** Deletes a file
135
- * - Does not throw any error, but logs it instead
136
- * - Returns true if the delete was successful
137
- */
138
- private static deleteFile;
139
- /** Deletes a folder, checking if it's empty
140
- * - Does not throw any error, but logs it instead
141
- * - Returns true if the delete was successful
142
- */
143
- private static deleteFolderIfEmpty;
144
- /** Deletes the contents of a folder, but not the folder itself
145
- * - Does not throw any errors, but logs them.
146
- * - returns true if the delete was successful.
147
- */
148
- private static deleteFolderContents;
149
- /** Deletes a folder and all it's contents.
150
- * - Does not throw any errors, but logs them.
151
- * - returns true if the delete was successful.
152
- */
153
- private static deleteFolderAndContents;
154
- private static applySingleChangeset;
155
- /** @internal */
156
- static pullAndApplyChangesets(db: IModelDb, arg: ToChangesetArgs): Promise<void>;
157
- /** create a changeset from the current changes, and push it to iModelHub */
158
- private static pushChanges;
159
- /** Pull/merge (if necessary), then push all local changes as a changeset. Called by [[BriefcaseDb.pushChanges]]
160
- * @internal
161
- */
162
- static pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void>;
163
- /** @internal */
164
- static logUsage(imodel: IModelDb, activity?: RpcActivity): void;
165
- }
1
+ /** @packageDocumentation
2
+ * @module iModels
3
+ */
4
+ import { AccessToken, BeDuration, GuidString } from "@itwin/core-bentley";
5
+ import { BriefcaseId, BriefcaseProps, ChangesetIndex, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps, RpcActivity } from "@itwin/core-common";
6
+ import { AcquireNewBriefcaseIdArg } from "./BackendHubAccess";
7
+ import { ProgressFunction } from "./CheckpointManager";
8
+ import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
9
+ /** The argument for [[BriefcaseManager.downloadBriefcase]]
10
+ * @public
11
+ */
12
+ export interface RequestNewBriefcaseArg extends TokenArg, RequestNewBriefcaseProps {
13
+ /** If present, a function called periodically during the download to indicate progress.
14
+ * @note return non-zero from this function to abort the download.
15
+ */
16
+ onProgress?: ProgressFunction;
17
+ }
18
+ /**
19
+ * Parameters for pushing changesets to iModelHub
20
+ * @public
21
+ */
22
+ export interface PushChangesArgs extends TokenArg {
23
+ /** A description of the changes. This is visible on the iModel's timeline. */
24
+ description: string;
25
+ /** if present, the locks are retained after the operation. Otherwise, *all* locks are released after the changeset is successfully pushed. */
26
+ retainLocks?: true;
27
+ /** number of times to retry pull/merge if other users are pushing at the same time. Default is 5 */
28
+ mergeRetryCount?: number;
29
+ /** delay to wait between pull/merge retry attempts. Default is 3 seconds */
30
+ mergeRetryDelay?: BeDuration;
31
+ /** the number of time to attempt to retry to push the changeset upon failure. Default is 3 */
32
+ pushRetryCount?: number;
33
+ /** The delay to wait between retry attempts on failed pushes. Default is 3 seconds. */
34
+ pushRetryDelay?: BeDuration;
35
+ }
36
+ /**
37
+ * Specifies a specific index for pulling changes.
38
+ * @public
39
+ */
40
+ export interface ToChangesetArgs extends TokenArg {
41
+ /** The last ChangesetIndex to pull. If not present, pull *all* newer changesets. */
42
+ toIndex?: ChangesetIndex;
43
+ }
44
+ /** Arguments for [[BriefcaseManager.pullAndApplyChangesets]]
45
+ * @public
46
+ */
47
+ export declare type PullChangesArgs = ToChangesetArgs & {
48
+ /** If present, a function called periodically during the download to indicate progress.
49
+ * @note return non-zero from this function to abort the download.
50
+ */
51
+ onProgress?: ProgressFunction;
52
+ };
53
+ /** Manages downloading Briefcases and downloading and uploading changesets.
54
+ * @public
55
+ */
56
+ export declare class BriefcaseManager {
57
+ /** Get the local path of the folder storing files that are associated with an imodel */
58
+ static getIModelPath(iModelId: GuidString): LocalDirName;
59
+ /** @internal */
60
+ static getChangeSetsPath(iModelId: GuidString): LocalDirName;
61
+ /** @internal */
62
+ static getChangeCachePathName(iModelId: GuidString): LocalFileName;
63
+ /** @internal */
64
+ static getChangedElementsPathName(iModelId: GuidString): LocalFileName;
65
+ private static _briefcaseSubDir;
66
+ /** @internal */
67
+ static getBriefcaseBasePath(iModelId: GuidString): LocalDirName;
68
+ /** Get the name of the local file that holds, or will hold, a local briefcase in the briefcase cache.
69
+ * @note The briefcase cache is a local directory established in the call to [[BriefcaseManager.initialize]].
70
+ * @param briefcase the iModelId and BriefcaseId for the filename
71
+ * @see getIModelPath
72
+ */
73
+ static getFileName(briefcase: BriefcaseProps): LocalFileName;
74
+ private static setupCacheDir;
75
+ private static _initialized?;
76
+ /** Initialize BriefcaseManager
77
+ * @param cacheRootDir The root directory for storing a cache of downloaded briefcase files on the local computer.
78
+ * Briefcases are stored relative to this path in sub-folders organized by IModelId.
79
+ * @note It is perfectly valid for applications to store briefcases in locations they manage, outside of `cacheRootDir`.
80
+ */
81
+ static initialize(cacheRootDir: LocalDirName): void;
82
+ private static finalize;
83
+ /** Get a list of the local briefcase held in the briefcase cache, optionally for a single iModelId
84
+ * @param iModelId if present, only briefcases for this iModelId are returned, otherwise all briefcases for all
85
+ * iModels in the briefcase cache are returned.
86
+ * @note usually there should only be one briefcase per iModel.
87
+ */
88
+ static getCachedBriefcases(iModelId?: GuidString): LocalBriefcaseProps[];
89
+ private static _cacheDir;
90
+ /** Get the root directory for the briefcase cache */
91
+ static get cacheDir(): LocalDirName;
92
+ /** Determine whether the supplied briefcaseId is in the range of assigned BriefcaseIds issued by iModelHub
93
+ * @note this does check whether the id was actually acquired by the caller.
94
+ */
95
+ static isValidBriefcaseId(id: BriefcaseId): boolean;
96
+ /** Acquire a new briefcaseId from iModelHub for the supplied iModelId
97
+ * @note usually there should only be one briefcase per iModel per user. If a single user acquires more than one briefcaseId,
98
+ * it's a good idea to supply different aliases for each of them.
99
+ */
100
+ static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<BriefcaseId>;
101
+ /**
102
+ * Download a new briefcase from iModelHub for the supplied iModelId.
103
+ *
104
+ * Briefcases are local files holding a copy of an iModel.
105
+ * Briefcases may either be specific to an individual user (so that it can be modified to create changesets), or it can be readonly so it can accept but not create changesets.
106
+ * Every briefcase internally holds its [[BriefcaseId]]. Writeable briefcases have a `BriefcaseId` "assigned" to them by iModelHub. No two users will ever have the same BriefcaseId.
107
+ * Readonly briefcases are "unassigned" with the special value [[BriefcaseId.Unassigned]].
108
+ *
109
+ * Typically a given user will have only one briefcase on their machine for a given iModelId. Rarely, it may be necessary to use more than one
110
+ * briefcase to make isolated independent sets of changes, but that is exceedingly complicated and rare.
111
+ *
112
+ * Callers of this method may supply a BriefcaseId, or if none is supplied, a new one is acquired from iModelHub.
113
+ *
114
+ * @param arg The arguments that specify the briefcase file to be downloaded.
115
+ * @returns The properties of the local briefcase in a Promise that is resolved after the briefcase is fully downloaded and the briefcase file is ready for use via [BriefcaseDb.open]($backend).
116
+ * @note The location of the local file to hold the briefcase is arbitrary and may be any valid *local* path on your machine. If you don't supply
117
+ * a filename, the local briefcase cache is used by creating a file with the briefcaseId as its name in the `briefcases` folder below the folder named
118
+ * for the IModelId.
119
+ * @note *It is invalid to edit briefcases on a shared network drive* and that is a sure way to corrupt your briefcase (see https://www.sqlite.org/howtocorrupt.html)
120
+ */
121
+ static downloadBriefcase(arg: RequestNewBriefcaseArg): Promise<LocalBriefcaseProps>;
122
+ /** Deletes change sets of an iModel from local disk
123
+ * @internal
124
+ */
125
+ static deleteChangeSetsFromLocalDisk(iModelId: string): void;
126
+ /** Releases a briefcaseId from iModelHub. After this call it is illegal to generate changesets for the released briefcaseId.
127
+ * @note generally, this method should not be called directly. Instead use [[deleteBriefcaseFiles]].
128
+ * @see deleteBriefcaseFiles
129
+ */
130
+ static releaseBriefcase(accessToken: AccessToken, briefcase: BriefcaseProps): Promise<void>;
131
+ /**
132
+ * Delete and clean up a briefcase and all of its associated files. First, this method opens the supplied filename to determine its briefcaseId.
133
+ * Then, if a requestContext is supplied, it releases a BriefcaseId from iModelHub. Finally it deletes the local briefcase file and
134
+ * associated files (that is, all files in the same directory that start with the briefcase name).
135
+ * @param filePath the full file name of the Briefcase to delete
136
+ * @param accessToken for releasing the briefcaseId
137
+ */
138
+ static deleteBriefcaseFiles(filePath: LocalFileName, accessToken?: AccessToken): Promise<void>;
139
+ /** Deletes a file
140
+ * - Does not throw any error, but logs it instead
141
+ * - Returns true if the delete was successful
142
+ */
143
+ private static deleteFile;
144
+ /** Deletes a folder, checking if it's empty
145
+ * - Does not throw any error, but logs it instead
146
+ * - Returns true if the delete was successful
147
+ */
148
+ private static deleteFolderIfEmpty;
149
+ /** Deletes the contents of a folder, but not the folder itself
150
+ * - Does not throw any errors, but logs them.
151
+ * - returns true if the delete was successful.
152
+ */
153
+ private static deleteFolderContents;
154
+ /** Deletes a folder and all it's contents.
155
+ * - Does not throw any errors, but logs them.
156
+ * - returns true if the delete was successful.
157
+ */
158
+ private static deleteFolderAndContents;
159
+ private static applySingleChangeset;
160
+ /** @internal */
161
+ static pullAndApplyChangesets(db: IModelDb, arg: PullChangesArgs): Promise<void>;
162
+ /** create a changeset from the current changes, and push it to iModelHub */
163
+ private static pushChanges;
164
+ /** Pull/merge (if necessary), then push all local changes as a changeset. Called by [[BriefcaseDb.pushChanges]]
165
+ * @internal
166
+ */
167
+ static pullMergePush(db: BriefcaseDb, arg: PushChangesArgs): Promise<void>;
168
+ /** @internal */
169
+ static logUsage(imodel: IModelDb, activity?: RpcActivity): void;
170
+ }
166
171
  //# sourceMappingURL=BriefcaseManager.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,WAAW,EAAE,UAAU,EAAmB,UAAU,EACrD,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EAAoB,cAAc,EAAsB,cAAc,EAA6C,mBAAmB,EACjJ,YAAY,EAAE,aAAa,EAAE,wBAAwB,EAAE,WAAW,EACnE,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,CAAC;AAE9C;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gBAAgB;WACF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA+B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAwChG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B7F,4EAA4E;mBACvD,WAAW;IA0ChC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvF,gBAAgB;WACF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,WAAW;CAmBhE"}
1
+ {"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACL,WAAW,EAAE,UAAU,EAAmB,UAAU,EACrD,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EAAoB,cAAc,EAAsB,cAAc,EAA6C,mBAAmB,EACjJ,YAAY,EAAE,aAAa,EAAE,wBAAwB,EAAE,WAAW,EACnE,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gBAAgB;WACF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA+B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgDhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC7F,4EAA4E;mBACvD,WAAW;IA0ChC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvF,gBAAgB;WACF,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,WAAW;CAmBhE"}