@vertigis/viewer-spec 56.24.0 → 56.26.0

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 (268) hide show
  1. package/analytics/AnalyticsContext.d.ts +29 -29
  2. package/analytics/AnalyticsContext.js +1 -1
  3. package/analytics/CommonAction.d.ts +90 -90
  4. package/analytics/CommonAction.js +1 -1
  5. package/analytics/MobileAction.d.ts +113 -113
  6. package/analytics/MobileAction.js +1 -1
  7. package/analytics/WebAction.d.ts +102 -102
  8. package/analytics/WebAction.js +1 -1
  9. package/app-config/AppConfig.d.ts +55 -55
  10. package/app-config/ItemConfig.d.ts +18 -18
  11. package/app-config/common/AnalyticsModelProperties.d.ts +10 -10
  12. package/app-config/common/ApplicationModelProperties.d.ts +15 -15
  13. package/app-config/common/BasemapPickerModelProperties.d.ts +6 -6
  14. package/app-config/common/BookmarksModelProperties.d.ts +17 -17
  15. package/app-config/common/BrandingColors.d.ts +102 -102
  16. package/app-config/common/BrandingModelProperties.d.ts +23 -23
  17. package/app-config/common/BrandingThemeProperties.d.ts +35 -35
  18. package/app-config/common/CompassModelProperties.d.ts +6 -6
  19. package/app-config/common/ComponentModelProperties.d.ts +14 -14
  20. package/app-config/common/CoordinateFormat.d.ts +4 -4
  21. package/app-config/common/CoordinateModelProperties.d.ts +43 -43
  22. package/app-config/common/DialogModelProperties.d.ts +6 -6
  23. package/app-config/common/EventListenerModelProperties.d.ts +44 -44
  24. package/app-config/common/ExpandModelProperties.d.ts +6 -6
  25. package/app-config/common/FeatureDetailsModelProperties.d.ts +27 -27
  26. package/app-config/common/GeolocationModelProperties.d.ts +6 -6
  27. package/app-config/common/HighlightModelProperties.d.ts +68 -68
  28. package/app-config/common/ImageModelProperties.d.ts +14 -14
  29. package/app-config/common/ItemRef.d.ts +4 -4
  30. package/app-config/common/LayerListModelProperties.d.ts +6 -6
  31. package/app-config/common/LayerPresetsModelProperties.d.ts +14 -14
  32. package/app-config/common/LayoutProperties.d.ts +33 -33
  33. package/app-config/common/LegendModelProperties.d.ts +6 -6
  34. package/app-config/common/LicensingModelProperties.d.ts +10 -10
  35. package/app-config/common/MapCoordinatesModelProperties.d.ts +6 -6
  36. package/app-config/common/MapModelProperties.d.ts +7 -7
  37. package/app-config/common/MenuModelProperties.d.ts +13 -13
  38. package/app-config/common/ModelProperties.d.ts +6 -6
  39. package/app-config/common/PanelModelProperties.d.ts +6 -6
  40. package/app-config/common/RegionModelProperties.d.ts +25 -25
  41. package/app-config/common/ResultsModelProperties.d.ts +13 -13
  42. package/app-config/common/ScalebarModelProperties.d.ts +6 -6
  43. package/app-config/common/SearchModelProperties.d.ts +26 -26
  44. package/app-config/common/ServiceModelProperties.d.ts +6 -6
  45. package/app-config/common/SplitModelProperties.d.ts +6 -6
  46. package/app-config/common/StackModelProperties.d.ts +6 -6
  47. package/app-config/common/TextModelProperties.d.ts +10 -10
  48. package/app-config/common/TranslatableText.d.ts +35 -35
  49. package/app-config/common/UserModelProperties.d.ts +6 -6
  50. package/app-config/common/WorkflowEventsProperties.d.ts +11 -11
  51. package/app-config/common/WorkflowModelProperties.d.ts +44 -44
  52. package/app-config/common/ZoomModelProperties.d.ts +6 -6
  53. package/app-config/common/colors.d.ts +6 -6
  54. package/app-config/index.d.ts +2 -2
  55. package/app-config/mobile/AddFeatureModelProperties.d.ts +6 -6
  56. package/app-config/mobile/AddRelatedFeatureModelProperties.d.ts +6 -6
  57. package/app-config/mobile/BasemapModelProperties.d.ts +11 -11
  58. package/app-config/mobile/CoordinateModelProperties.d.ts +10 -10
  59. package/app-config/mobile/FeatureDetailsModelProperties.d.ts +26 -26
  60. package/app-config/mobile/GeometryToolbarModelProperties.d.ts +6 -6
  61. package/app-config/mobile/GnssDeviceSelectionModelProperties.d.ts +6 -6
  62. package/app-config/mobile/GnssDeviceSettingsModelProperties.d.ts +6 -6
  63. package/app-config/mobile/GnssMetadataModelProperties.d.ts +6 -6
  64. package/app-config/mobile/MapModelProperties.d.ts +52 -52
  65. package/app-config/mobile/OfflineModelProperties.d.ts +48 -48
  66. package/app-config/mobile/PortalExtensionSettingsProperties.d.ts +27 -27
  67. package/app-config/mobile/ScrollModelProperties.d.ts +6 -6
  68. package/app-config/mobile/SearchModelProperties.d.ts +14 -14
  69. package/app-config/mobile/SelectLayerSettingsModelProperties.d.ts +11 -11
  70. package/app-config/mobile/TaskbarModelProperties.d.ts +6 -6
  71. package/app-config/mobile/UpdateFeatureModelProperties.d.ts +6 -6
  72. package/app-config/mobile/VertigisMobileModelProperties.d.ts +67 -67
  73. package/app-config/schema/common-app-config.schema.json +1 -1
  74. package/app-config/schema/web-app-config.schema.json +1 -1
  75. package/app-config/web/AddressModelProperties.d.ts +6 -6
  76. package/app-config/web/BasemapModelProperties.d.ts +10 -10
  77. package/app-config/web/BasemapPickerModelProperties.d.ts +7 -7
  78. package/app-config/web/BookmarksModelProperties.d.ts +7 -7
  79. package/app-config/web/BrandingModelProperties.d.ts +14 -14
  80. package/app-config/web/ChartModelProperties.d.ts +58 -58
  81. package/app-config/web/CompassModelProperties.d.ts +7 -7
  82. package/app-config/web/ComponentModelProperties.d.ts +12 -12
  83. package/app-config/web/CoordinateModelProperties.d.ts +50 -50
  84. package/app-config/web/DataLinkSourceProperties.d.ts +15 -15
  85. package/app-config/web/DialogModelProperties.d.ts +7 -7
  86. package/app-config/web/DrawModelProperties.d.ts +94 -94
  87. package/app-config/web/FeatureDetailsModelProperties.d.ts +19 -19
  88. package/app-config/web/FeatureInfoModelProperties.d.ts +38 -38
  89. package/app-config/web/FeatureListProperties.d.ts +12 -12
  90. package/app-config/web/FeatureSetProperties.d.ts +16 -16
  91. package/app-config/web/FeatureSummaryModelProperties.d.ts +27 -27
  92. package/app-config/web/GeolocationModelProperties.d.ts +7 -7
  93. package/app-config/web/GeometryModelProperties.d.ts +27 -27
  94. package/app-config/web/HasVisibilityFilters.d.ts +36 -36
  95. package/app-config/web/ImageModelProperties.d.ts +7 -7
  96. package/app-config/web/KpiCardModelProperties.d.ts +146 -146
  97. package/app-config/web/LayerListModelProperties.d.ts +18 -18
  98. package/app-config/web/LayerPresetsModelProperties.d.ts +7 -7
  99. package/app-config/web/LegendModelProperties.d.ts +7 -7
  100. package/app-config/web/Map3dToggleModelProperties.d.ts +6 -6
  101. package/app-config/web/MapCoordinatesModelProperties.d.ts +50 -50
  102. package/app-config/web/MapModelProperties.d.ts +93 -87
  103. package/app-config/web/MeasurementModelProperties.d.ts +36 -36
  104. package/app-config/web/MenuItemModelProperties.d.ts +7 -7
  105. package/app-config/web/MenuModelProperties.d.ts +13 -13
  106. package/app-config/web/ModelProperties.d.ts +7 -7
  107. package/app-config/web/PanelModelProperties.d.ts +7 -7
  108. package/app-config/web/PortalModelProperties.d.ts +11 -11
  109. package/app-config/web/PrintFormModelProperties.d.ts +42 -42
  110. package/app-config/web/PrintModelProperties.d.ts +11 -11
  111. package/app-config/web/ProjectModelProperties.d.ts +12 -12
  112. package/app-config/web/QueryBuilderModelProperties.d.ts +22 -22
  113. package/app-config/web/ReportModelProperties.d.ts +15 -15
  114. package/app-config/web/ResultsModelProperties.d.ts +101 -101
  115. package/app-config/web/ResultsServiceModelProperties.d.ts +48 -48
  116. package/app-config/web/ScaleInputModelProperties.d.ts +6 -6
  117. package/app-config/web/ScalebarModelProperties.d.ts +22 -22
  118. package/app-config/web/SearchModelProperties.d.ts +22 -22
  119. package/app-config/web/SearchServiceProperties.d.ts +25 -25
  120. package/app-config/web/SharedProjectsModelProperties.d.ts +53 -53
  121. package/app-config/web/SharedStorageModelProperties.d.ts +30 -30
  122. package/app-config/web/SnappingProperties.d.ts +101 -101
  123. package/app-config/web/SplitModelProperties.d.ts +7 -7
  124. package/app-config/web/StackModelProperties.d.ts +7 -7
  125. package/app-config/web/TabsModelProperties.d.ts +6 -6
  126. package/app-config/web/TextModelProperties.d.ts +7 -7
  127. package/app-config/web/TopologyProperties.d.ts +67 -0
  128. package/app-config/web/TopologyProperties.js +1 -0
  129. package/app-config/web/UserModelProperties.d.ts +12 -12
  130. package/app-config/web/UserPreferencesModelProperties.d.ts +10 -10
  131. package/app-config/web/VertigisWebModelProperties.d.ts +74 -74
  132. package/app-config/web/WorkflowModelProperties.d.ts +13 -13
  133. package/app-config/web/ZoomModelProperties.d.ts +7 -7
  134. package/messaging/Command.d.ts +76 -76
  135. package/messaging/CommandRegistry.d.ts +25 -25
  136. package/messaging/CommandRegistry.js +1 -1
  137. package/messaging/DotNetTypes.d.ts +4 -4
  138. package/messaging/Event.d.ts +26 -26
  139. package/messaging/EventRegistry.d.ts +25 -25
  140. package/messaging/EventRegistry.js +1 -1
  141. package/messaging/Message.d.ts +50 -50
  142. package/messaging/MessageBus.d.ts +54 -54
  143. package/messaging/Operation.d.ts +77 -77
  144. package/messaging/OperationRegistry.d.ts +26 -26
  145. package/messaging/OperationRegistry.js +1 -1
  146. package/messaging/common.d.ts +354 -354
  147. package/messaging/mobile.d.ts +6 -6
  148. package/messaging/registry/Commands.d.ts +78 -78
  149. package/messaging/registry/Commands.js +1 -1
  150. package/messaging/registry/Events.d.ts +62 -62
  151. package/messaging/registry/Events.js +1 -1
  152. package/messaging/registry/Operations.d.ts +69 -69
  153. package/messaging/registry/Operations.js +1 -1
  154. package/messaging/registry/app-config.d.ts +12 -12
  155. package/messaging/registry/app-config.js +1 -1
  156. package/messaging/registry/app.d.ts +264 -264
  157. package/messaging/registry/app.js +1 -1
  158. package/messaging/registry/arcade.d.ts +115 -115
  159. package/messaging/registry/arcade.js +1 -1
  160. package/messaging/registry/auth.d.ts +151 -151
  161. package/messaging/registry/auth.js +1 -1
  162. package/messaging/registry/basemap.d.ts +74 -74
  163. package/messaging/registry/basemap.js +1 -1
  164. package/messaging/registry/bookmark.d.ts +42 -42
  165. package/messaging/registry/bookmark.js +1 -1
  166. package/messaging/registry/charts.d.ts +81 -81
  167. package/messaging/registry/charts.js +1 -1
  168. package/messaging/registry/debugConsole.d.ts +26 -26
  169. package/messaging/registry/debugConsole.js +1 -1
  170. package/messaging/registry/device.d.ts +28 -28
  171. package/messaging/registry/device.js +1 -1
  172. package/messaging/registry/display.d.ts +17 -17
  173. package/messaging/registry/display.js +1 -1
  174. package/messaging/registry/drawing.d.ts +149 -149
  175. package/messaging/registry/drawing.js +1 -1
  176. package/messaging/registry/edit.d.ts +371 -371
  177. package/messaging/registry/edit.js +1 -1
  178. package/messaging/registry/file.d.ts +156 -156
  179. package/messaging/registry/file.js +1 -1
  180. package/messaging/registry/filter-builder.d.ts +73 -73
  181. package/messaging/registry/filter-builder.js +1 -1
  182. package/messaging/registry/geocode.d.ts +87 -87
  183. package/messaging/registry/geocode.js +1 -1
  184. package/messaging/registry/geolocation.d.ts +499 -499
  185. package/messaging/registry/geolocation.js +1 -1
  186. package/messaging/registry/geometry-toolbar.d.ts +29 -29
  187. package/messaging/registry/geometry-toolbar.js +1 -1
  188. package/messaging/registry/geometry.d.ts +278 -278
  189. package/messaging/registry/geometry.js +1 -1
  190. package/messaging/registry/highlights.d.ts +86 -86
  191. package/messaging/registry/highlights.js +1 -1
  192. package/messaging/registry/input.d.ts +22 -22
  193. package/messaging/registry/input.js +1 -1
  194. package/messaging/registry/iwtm.d.ts +11 -11
  195. package/messaging/registry/iwtm.js +1 -1
  196. package/messaging/registry/kpi.d.ts +98 -98
  197. package/messaging/registry/kpi.js +1 -1
  198. package/messaging/registry/layer-comparison.d.ts +104 -104
  199. package/messaging/registry/layer-comparison.js +1 -1
  200. package/messaging/registry/layer-presets.d.ts +49 -49
  201. package/messaging/registry/layer-presets.js +1 -1
  202. package/messaging/registry/layers.d.ts +196 -196
  203. package/messaging/registry/layers.js +1 -1
  204. package/messaging/registry/layout.d.ts +49 -49
  205. package/messaging/registry/layout.js +1 -1
  206. package/messaging/registry/licensing.d.ts +38 -38
  207. package/messaging/registry/licensing.js +1 -1
  208. package/messaging/registry/location-marker.d.ts +171 -171
  209. package/messaging/registry/location-marker.js +1 -1
  210. package/messaging/registry/logViewer.d.ts +17 -17
  211. package/messaging/registry/logViewer.js +1 -1
  212. package/messaging/registry/map.d.ts +1275 -1275
  213. package/messaging/registry/map.js +1 -1
  214. package/messaging/registry/measurement.d.ts +168 -168
  215. package/messaging/registry/measurement.js +1 -1
  216. package/messaging/registry/messaging.d.ts +23 -23
  217. package/messaging/registry/messaging.js +1 -1
  218. package/messaging/registry/network.d.ts +46 -46
  219. package/messaging/registry/network.js +1 -1
  220. package/messaging/registry/offline.d.ts +508 -507
  221. package/messaging/registry/offline.js +1 -1
  222. package/messaging/registry/panel.d.ts +115 -115
  223. package/messaging/registry/panel.js +1 -1
  224. package/messaging/registry/photos.d.ts +47 -47
  225. package/messaging/registry/photos.js +1 -1
  226. package/messaging/registry/portal.d.ts +94 -94
  227. package/messaging/registry/portal.js +1 -1
  228. package/messaging/registry/printing.d.ts +166 -166
  229. package/messaging/registry/printing.js +1 -1
  230. package/messaging/registry/project.d.ts +144 -144
  231. package/messaging/registry/project.js +1 -1
  232. package/messaging/registry/query-builder.d.ts +83 -83
  233. package/messaging/registry/query-builder.js +1 -1
  234. package/messaging/registry/region.d.ts +23 -23
  235. package/messaging/registry/region.js +1 -1
  236. package/messaging/registry/reports.d.ts +135 -135
  237. package/messaging/registry/reports.js +1 -1
  238. package/messaging/registry/results.d.ts +671 -671
  239. package/messaging/registry/results.js +1 -1
  240. package/messaging/registry/search.d.ts +74 -74
  241. package/messaging/registry/search.js +1 -1
  242. package/messaging/registry/settings.d.ts +38 -38
  243. package/messaging/registry/settings.js +1 -1
  244. package/messaging/registry/shortcut.d.ts +41 -41
  245. package/messaging/registry/shortcut.js +1 -1
  246. package/messaging/registry/sketching.d.ts +1019 -960
  247. package/messaging/registry/sketching.js +1 -1
  248. package/messaging/registry/studioAnalytics.d.ts +25 -25
  249. package/messaging/registry/studioAnalytics.js +1 -1
  250. package/messaging/registry/system.d.ts +277 -277
  251. package/messaging/registry/system.js +1 -1
  252. package/messaging/registry/tasks.d.ts +323 -323
  253. package/messaging/registry/tasks.js +1 -1
  254. package/messaging/registry/ui.d.ts +518 -518
  255. package/messaging/registry/ui.js +1 -1
  256. package/messaging/registry/viewer.d.ts +145 -145
  257. package/messaging/registry/viewer.js +1 -1
  258. package/messaging/registry/workflow.d.ts +170 -170
  259. package/messaging/registry/workflow.js +1 -1
  260. package/messaging/schema/common-action.schema.json +6437 -12158
  261. package/messaging/schema/common-event.schema.json +107 -803
  262. package/messaging/schema/mobile-action.schema.json +7719 -16138
  263. package/messaging/schema/mobile-event.schema.json +181 -2422
  264. package/messaging/schema/web-action.schema.json +8415 -23272
  265. package/messaging/schema/web-event.schema.json +183 -1937
  266. package/package.json +20 -20
  267. package/version.d.ts +4 -4
  268. package/version.js +4 -4
@@ -1,54 +1,54 @@
1
- import type { Action } from "@vertigis/arcgis-extensions/support/Action";
2
- import type { Command } from "./Command.js";
3
- import type { Event } from "./Event.js";
4
- import type { Operation } from "./Operation.js";
5
- /**
6
- * Handles messaging between parts of an application.
7
- */
8
- export interface MessageBus {
9
- /**
10
- * Retrieves a command.
11
- *
12
- * @param action The command specification. Either the name of a command, or
13
- * a list of commands and/or operations to run in sequence.
14
- */
15
- command<T = void>(action: Action): Command<T>;
16
- /**
17
- * Retrieves an event.
18
- *
19
- * @param name Name of the event.
20
- */
21
- event<T = void>(name: string): Event<T>;
22
- /**
23
- * Retrieves an operation.
24
- *
25
- * @param name Name of the operation.
26
- */
27
- operation<T = void, TResult = undefined>(action: Action): Operation<T, TResult>;
28
- /**
29
- * Determines whether a command with the given name exists.
30
- *
31
- * @param name Name of the command.
32
- */
33
- hasCommand(name: string): boolean;
34
- /**
35
- * Determines whether an event with the given name exists.
36
- *
37
- * @param name Name of the event.
38
- */
39
- hasEvent(name: string): boolean;
40
- /**
41
- * Determines whether an operation with the given name exists.
42
- *
43
- * @param name Name of the operation.
44
- */
45
- hasOperation(name: string): boolean;
46
- /**
47
- * Returns all registered commands.
48
- */
49
- allCommands(): IterableIterator<Command>;
50
- /**
51
- * Returns all registered operations.
52
- */
53
- allOperations(): IterableIterator<Operation>;
54
- }
1
+ import type { Action } from "@vertigis/arcgis-extensions/support/Action";
2
+ import type { Command } from "./Command.js";
3
+ import type { Event } from "./Event.js";
4
+ import type { Operation } from "./Operation.js";
5
+ /**
6
+ * Handles messaging between parts of an application.
7
+ */
8
+ export interface MessageBus {
9
+ /**
10
+ * Retrieves a command.
11
+ *
12
+ * @param action The command specification. Either the name of a command, or
13
+ * a list of commands and/or operations to run in sequence.
14
+ */
15
+ command<T = void>(action: Action): Command<T>;
16
+ /**
17
+ * Retrieves an event.
18
+ *
19
+ * @param name Name of the event.
20
+ */
21
+ event<T = void>(name: string): Event<T>;
22
+ /**
23
+ * Retrieves an operation.
24
+ *
25
+ * @param name Name of the operation.
26
+ */
27
+ operation<T = void, TResult = undefined>(action: Action): Operation<T, TResult>;
28
+ /**
29
+ * Determines whether a command with the given name exists.
30
+ *
31
+ * @param name Name of the command.
32
+ */
33
+ hasCommand(name: string): boolean;
34
+ /**
35
+ * Determines whether an event with the given name exists.
36
+ *
37
+ * @param name Name of the event.
38
+ */
39
+ hasEvent(name: string): boolean;
40
+ /**
41
+ * Determines whether an operation with the given name exists.
42
+ *
43
+ * @param name Name of the operation.
44
+ */
45
+ hasOperation(name: string): boolean;
46
+ /**
47
+ * Returns all registered commands.
48
+ */
49
+ allCommands(): IterableIterator<Command>;
50
+ /**
51
+ * Returns all registered operations.
52
+ */
53
+ allOperations(): IterableIterator<Operation>;
54
+ }
@@ -1,77 +1,77 @@
1
- import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
2
- import type { AnalyticsContext } from "../analytics/AnalyticsContext.js";
3
- import type { Event } from "./Event.js";
4
- import type { Message, MessageExecuteOptions } from "./Message.js";
5
- /**
6
- * A named operation. Operations compute a value, but don't generally alter the
7
- * state of an application.
8
- */
9
- export interface Operation<T = void, TResult = undefined> extends Message {
10
- /**
11
- * The name of the operation.
12
- */
13
- name: string;
14
- /**
15
- * An event that is published whenever canExecute might return a new value.
16
- * Implementations are responsible for calling publish() as appropriate.
17
- */
18
- readonly canExecuteChanged: Event;
19
- /**
20
- * Indicates whether the operation has been initialized.
21
- */
22
- readonly isInitialized: boolean;
23
- /**
24
- * Executes the operation and returns its result.
25
- *
26
- * @param argument The argument to the operation.
27
- * @param options CancelToken or options to apply to the Operation execute
28
- * behavior.
29
- */
30
- execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
31
- /**
32
- * Determines whether the operation can execute with the given arguments.
33
- *
34
- * @param argument The operation arguments.
35
- */
36
- canExecute(argument?: T): boolean;
37
- /**
38
- * Initializes the operation if it is not already initialized. Attempting to
39
- * execute an operation will automatically initialize it, however calling
40
- * canExecute() will always return false until the operation is
41
- * initialized.
42
- */
43
- initialize(): Promise<void>;
44
- }
45
- /**
46
- * Context that will be passed in to each behavior for an operation.
47
- */
48
- export interface OperationContext<T = void, TResult = undefined> extends AnalyticsContext {
49
- /**
50
- * The name of the operation that is currently executing.
51
- */
52
- readonly name: string;
53
- /**
54
- * The result of the previous behavior (undefined if the current behavior is
55
- * the first one).
56
- */
57
- result?: TResult;
58
- /**
59
- * Enables cancelling the operation (see Cancellable).
60
- */
61
- cancelToken?: CancelToken;
62
- /**
63
- * Used to determine if the operation was executed from a trusted source.
64
- */
65
- trusted?: boolean;
66
- /**
67
- * Invokes the next behavior in the chain. If it isn't invoked explicitly,
68
- * then the next behavior will run after the current one is finished.
69
- */
70
- next: (argument?: T, result?: TResult) => Promise<TResult>;
71
- /**
72
- * Indicates that no more behaviors should run after the current one is
73
- * complete. The result from the current behavior will be the final result
74
- * of the operation.
75
- */
76
- finish: () => void;
77
- }
1
+ import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
2
+ import type { AnalyticsContext } from "../analytics/AnalyticsContext.js";
3
+ import type { Event } from "./Event.js";
4
+ import type { Message, MessageExecuteOptions } from "./Message.js";
5
+ /**
6
+ * A named operation. Operations compute a value, but don't generally alter the
7
+ * state of an application.
8
+ */
9
+ export interface Operation<T = void, TResult = undefined> extends Message {
10
+ /**
11
+ * The name of the operation.
12
+ */
13
+ name: string;
14
+ /**
15
+ * An event that is published whenever canExecute might return a new value.
16
+ * Implementations are responsible for calling publish() as appropriate.
17
+ */
18
+ readonly canExecuteChanged: Event;
19
+ /**
20
+ * Indicates whether the operation has been initialized.
21
+ */
22
+ readonly isInitialized: boolean;
23
+ /**
24
+ * Executes the operation and returns its result.
25
+ *
26
+ * @param argument The argument to the operation.
27
+ * @param options CancelToken or options to apply to the Operation execute
28
+ * behavior.
29
+ */
30
+ execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
31
+ /**
32
+ * Determines whether the operation can execute with the given arguments.
33
+ *
34
+ * @param argument The operation arguments.
35
+ */
36
+ canExecute(argument?: T): boolean;
37
+ /**
38
+ * Initializes the operation if it is not already initialized. Attempting to
39
+ * execute an operation will automatically initialize it, however calling
40
+ * canExecute() will always return false until the operation is
41
+ * initialized.
42
+ */
43
+ initialize(): Promise<void>;
44
+ }
45
+ /**
46
+ * Context that will be passed in to each behavior for an operation.
47
+ */
48
+ export interface OperationContext<T = void, TResult = undefined> extends AnalyticsContext {
49
+ /**
50
+ * The name of the operation that is currently executing.
51
+ */
52
+ readonly name: string;
53
+ /**
54
+ * The result of the previous behavior (undefined if the current behavior is
55
+ * the first one).
56
+ */
57
+ result?: TResult;
58
+ /**
59
+ * Enables cancelling the operation (see Cancellable).
60
+ */
61
+ cancelToken?: CancelToken;
62
+ /**
63
+ * Used to determine if the operation was executed from a trusted source.
64
+ */
65
+ trusted?: boolean;
66
+ /**
67
+ * Invokes the next behavior in the chain. If it isn't invoked explicitly,
68
+ * then the next behavior will run after the current one is finished.
69
+ */
70
+ next: (argument?: T, result?: TResult) => Promise<TResult>;
71
+ /**
72
+ * Indicates that no more behaviors should run after the current one is
73
+ * complete. The result from the current behavior will be the final result
74
+ * of the operation.
75
+ */
76
+ finish: () => void;
77
+ }
@@ -1,26 +1,26 @@
1
- import type { MessageBus } from "./MessageBus.js";
2
- import type { Operation } from "./Operation.js";
3
- /**
4
- * A registry of well-known operations.
5
- */
6
- export declare abstract class OperationRegistry {
7
- protected readonly _messages: MessageBus;
8
- /**
9
- * Operation name prefix that will be added to all operations in this
10
- * registry.
11
- */
12
- protected abstract readonly _prefix: string;
13
- /**
14
- * Creates a registry.
15
- *
16
- * @param messages The message bus to use.
17
- */
18
- constructor(messages: MessageBus);
19
- /**
20
- * Returns the operation corresponding to the given unqualified name.
21
- *
22
- * @param name The name of the operation without the common prefix
23
- * associated with this registry.
24
- */
25
- protected _get<T = void, TResult = undefined>(name: string): Operation<T, TResult>;
26
- }
1
+ import type { MessageBus } from "./MessageBus.js";
2
+ import type { Operation } from "./Operation.js";
3
+ /**
4
+ * A registry of well-known operations.
5
+ */
6
+ export declare abstract class OperationRegistry {
7
+ protected readonly _messages: MessageBus;
8
+ /**
9
+ * Operation name prefix that will be added to all operations in this
10
+ * registry.
11
+ */
12
+ protected abstract readonly _prefix: string;
13
+ /**
14
+ * Creates a registry.
15
+ *
16
+ * @param messages The message bus to use.
17
+ */
18
+ constructor(messages: MessageBus);
19
+ /**
20
+ * Returns the operation corresponding to the given unqualified name.
21
+ *
22
+ * @param name The name of the operation without the common prefix
23
+ * associated with this registry.
24
+ */
25
+ protected _get<T = void, TResult = undefined>(name: string): Operation<T, TResult>;
26
+ }
@@ -1 +1 @@
1
- export class OperationRegistry{constructor(s){this._messages=s}_get(s){return this._messages.operation(this._prefix?`${this._prefix}.${s}`:s)}}
1
+ export class OperationRegistry{_messages;constructor(s){this._messages=s}_get(s){return this._messages.operation(this._prefix?`${this._prefix}.${s}`:s)}}