@openfin/core 33.76.31 → 33.76.38

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 (269) hide show
  1. package/OpenFin.d.ts +1 -1
  2. package/README.md +29 -4
  3. package/fin.d.ts +2 -2
  4. package/{src → out}/GlobalOpenFin.d.ts +1 -1
  5. package/out/mock-alpha.d.ts +16112 -0
  6. package/out/mock-beta.d.ts +16112 -0
  7. package/out/mock-public.d.ts +16112 -0
  8. package/out/mock.d.ts +16797 -0
  9. package/out/mock.js +17104 -0
  10. package/package.json +30 -23
  11. package/LICENSE +0 -13
  12. package/NOTICE +0 -16
  13. package/openfin-core-33.76.31.tgz +0 -0
  14. package/src/OpenFin.d.ts +0 -3080
  15. package/src/OpenFin.js +0 -2
  16. package/src/api/api-exposer/api-consumer.d.ts +0 -28
  17. package/src/api/api-exposer/api-consumer.js +0 -28
  18. package/src/api/api-exposer/api-exposer.d.ts +0 -35
  19. package/src/api/api-exposer/api-exposer.js +0 -38
  20. package/src/api/api-exposer/decorators.d.ts +0 -10
  21. package/src/api/api-exposer/decorators.js +0 -18
  22. package/src/api/api-exposer/index.d.ts +0 -4
  23. package/src/api/api-exposer/index.js +0 -20
  24. package/src/api/api-exposer/strategies/index.d.ts +0 -1
  25. package/src/api/api-exposer/strategies/index.js +0 -17
  26. package/src/api/api-exposer/strategies/openfin-channels/channels-consumer.d.ts +0 -14
  27. package/src/api/api-exposer/strategies/openfin-channels/channels-consumer.js +0 -20
  28. package/src/api/api-exposer/strategies/openfin-channels/channels-exposer.d.ts +0 -20
  29. package/src/api/api-exposer/strategies/openfin-channels/channels-exposer.js +0 -23
  30. package/src/api/api-exposer/strategies/openfin-channels/index.d.ts +0 -2
  31. package/src/api/api-exposer/strategies/openfin-channels/index.js +0 -18
  32. package/src/api/application/Factory.d.ts +0 -148
  33. package/src/api/application/Factory.js +0 -230
  34. package/src/api/application/Instance.d.ts +0 -321
  35. package/src/api/application/Instance.js +0 -453
  36. package/src/api/application/index.d.ts +0 -3
  37. package/src/api/application/index.js +0 -19
  38. package/src/api/base.d.ts +0 -48
  39. package/src/api/base.js +0 -177
  40. package/src/api/clipboard/index.d.ts +0 -92
  41. package/src/api/clipboard/index.js +0 -120
  42. package/src/api/events/application.d.ts +0 -146
  43. package/src/api/events/application.js +0 -2
  44. package/src/api/events/base.d.ts +0 -42
  45. package/src/api/events/base.js +0 -2
  46. package/src/api/events/channel.d.ts +0 -30
  47. package/src/api/events/channel.js +0 -2
  48. package/src/api/events/emitterMap.d.ts +0 -11
  49. package/src/api/events/emitterMap.js +0 -35
  50. package/src/api/events/eventAggregator.d.ts +0 -5
  51. package/src/api/events/eventAggregator.js +0 -35
  52. package/src/api/events/externalApplication.d.ts +0 -19
  53. package/src/api/events/externalApplication.js +0 -2
  54. package/src/api/events/frame.d.ts +0 -30
  55. package/src/api/events/frame.js +0 -2
  56. package/src/api/events/globalHotkey.d.ts +0 -20
  57. package/src/api/events/globalHotkey.js +0 -2
  58. package/src/api/events/platform.d.ts +0 -26
  59. package/src/api/events/platform.js +0 -2
  60. package/src/api/events/system.d.ts +0 -113
  61. package/src/api/events/system.js +0 -2
  62. package/src/api/events/typedEventEmitter.d.ts +0 -20
  63. package/src/api/events/typedEventEmitter.js +0 -2
  64. package/src/api/events/view.d.ts +0 -82
  65. package/src/api/events/view.js +0 -2
  66. package/src/api/events/webcontents.d.ts +0 -266
  67. package/src/api/events/webcontents.js +0 -2
  68. package/src/api/events/window.d.ts +0 -352
  69. package/src/api/events/window.js +0 -2
  70. package/src/api/external-application/Factory.d.ts +0 -27
  71. package/src/api/external-application/Factory.js +0 -40
  72. package/src/api/external-application/Instance.d.ts +0 -102
  73. package/src/api/external-application/Instance.js +0 -109
  74. package/src/api/external-application/index.d.ts +0 -3
  75. package/src/api/external-application/index.js +0 -19
  76. package/src/api/fin.d.ts +0 -51
  77. package/src/api/fin.js +0 -42
  78. package/src/api/frame/Factory.d.ts +0 -37
  79. package/src/api/frame/Factory.js +0 -69
  80. package/src/api/frame/Instance.d.ts +0 -123
  81. package/src/api/frame/Instance.js +0 -130
  82. package/src/api/frame/index.d.ts +0 -3
  83. package/src/api/frame/index.js +0 -19
  84. package/src/api/global-hotkey/index.d.ts +0 -38
  85. package/src/api/global-hotkey/index.js +0 -64
  86. package/src/api/interappbus/channel/channel.d.ts +0 -28
  87. package/src/api/interappbus/channel/channel.js +0 -77
  88. package/src/api/interappbus/channel/channels-docs.d.ts +0 -340
  89. package/src/api/interappbus/channel/channels-docs.js +0 -398
  90. package/src/api/interappbus/channel/client.d.ts +0 -24
  91. package/src/api/interappbus/channel/client.js +0 -89
  92. package/src/api/interappbus/channel/connection-manager.d.ts +0 -29
  93. package/src/api/interappbus/channel/connection-manager.js +0 -246
  94. package/src/api/interappbus/channel/index.d.ts +0 -25
  95. package/src/api/interappbus/channel/index.js +0 -169
  96. package/src/api/interappbus/channel/protocols/classic/message-receiver.d.ts +0 -13
  97. package/src/api/interappbus/channel/protocols/classic/message-receiver.js +0 -73
  98. package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +0 -24
  99. package/src/api/interappbus/channel/protocols/classic/strategy.js +0 -101
  100. package/src/api/interappbus/channel/protocols/combined/strategy.d.ts +0 -20
  101. package/src/api/interappbus/channel/protocols/combined/strategy.js +0 -58
  102. package/src/api/interappbus/channel/protocols/index.d.ts +0 -47
  103. package/src/api/interappbus/channel/protocols/index.js +0 -2
  104. package/src/api/interappbus/channel/protocols/protocol-manager.d.ts +0 -10
  105. package/src/api/interappbus/channel/protocols/protocol-manager.js +0 -43
  106. package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts +0 -25
  107. package/src/api/interappbus/channel/protocols/rtc/endpoint.js +0 -141
  108. package/src/api/interappbus/channel/protocols/rtc/ice-manager.d.ts +0 -30
  109. package/src/api/interappbus/channel/protocols/rtc/ice-manager.js +0 -130
  110. package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts +0 -24
  111. package/src/api/interappbus/channel/protocols/rtc/strategy.js +0 -85
  112. package/src/api/interappbus/channel/protocols/strategy-types.d.ts +0 -13
  113. package/src/api/interappbus/channel/protocols/strategy-types.js +0 -2
  114. package/src/api/interappbus/channel/protocols/strategy.d.ts +0 -17
  115. package/src/api/interappbus/channel/protocols/strategy.js +0 -2
  116. package/src/api/interappbus/channel/provider.d.ts +0 -34
  117. package/src/api/interappbus/channel/provider.js +0 -166
  118. package/src/api/interappbus/index.d.ts +0 -85
  119. package/src/api/interappbus/index.js +0 -175
  120. package/src/api/interop/Factory.d.ts +0 -37
  121. package/src/api/interop/Factory.js +0 -76
  122. package/src/api/interop/InteropBroker.d.ts +0 -437
  123. package/src/api/interop/InteropBroker.js +0 -1085
  124. package/src/api/interop/InteropClient.d.ts +0 -278
  125. package/src/api/interop/InteropClient.js +0 -459
  126. package/src/api/interop/SessionContextGroupBroker.d.ts +0 -27
  127. package/src/api/interop/SessionContextGroupBroker.js +0 -108
  128. package/src/api/interop/SessionContextGroupClient.d.ts +0 -21
  129. package/src/api/interop/SessionContextGroupClient.js +0 -86
  130. package/src/api/interop/fdc3/PrivateChannelClient.d.ts +0 -20
  131. package/src/api/interop/fdc3/PrivateChannelClient.js +0 -90
  132. package/src/api/interop/fdc3/PrivateChannelProvider.d.ts +0 -55
  133. package/src/api/interop/fdc3/PrivateChannelProvider.js +0 -276
  134. package/src/api/interop/fdc3/fdc3-1.2.d.ts +0 -208
  135. package/src/api/interop/fdc3/fdc3-1.2.js +0 -438
  136. package/src/api/interop/fdc3/fdc3-2.0.d.ts +0 -301
  137. package/src/api/interop/fdc3/fdc3-2.0.js +0 -482
  138. package/src/api/interop/fdc3/fdc3.d.ts +0 -12
  139. package/src/api/interop/fdc3/fdc3.js +0 -35
  140. package/src/api/interop/fdc3/overrideCheck.d.ts +0 -4
  141. package/src/api/interop/fdc3/overrideCheck.js +0 -32
  142. package/src/api/interop/fdc3/shapes/fdc3v1.d.ts +0 -53
  143. package/src/api/interop/fdc3/shapes/fdc3v1.js +0 -4
  144. package/src/api/interop/fdc3/shapes/fdc3v2.d.ts +0 -75
  145. package/src/api/interop/fdc3/shapes/fdc3v2.js +0 -2
  146. package/src/api/interop/fdc3/utils.d.ts +0 -45
  147. package/src/api/interop/fdc3/utils.js +0 -239
  148. package/src/api/interop/fdc3/versions.d.ts +0 -1
  149. package/src/api/interop/fdc3/versions.js +0 -2
  150. package/src/api/interop/index.d.ts +0 -4
  151. package/src/api/interop/index.js +0 -20
  152. package/src/api/interop/utils.d.ts +0 -18
  153. package/src/api/interop/utils.js +0 -61
  154. package/src/api/me.d.ts +0 -40
  155. package/src/api/me.js +0 -134
  156. package/src/api/platform/Factory.d.ts +0 -115
  157. package/src/api/platform/Factory.js +0 -184
  158. package/src/api/platform/Instance.d.ts +0 -150
  159. package/src/api/platform/Instance.js +0 -332
  160. package/src/api/platform/common-utils.d.ts +0 -7
  161. package/src/api/platform/common-utils.js +0 -16
  162. package/src/api/platform/index.d.ts +0 -3
  163. package/src/api/platform/index.js +0 -19
  164. package/src/api/platform/layout/Factory.d.ts +0 -114
  165. package/src/api/platform/layout/Factory.js +0 -174
  166. package/src/api/platform/layout/Instance.d.ts +0 -57
  167. package/src/api/platform/layout/Instance.js +0 -126
  168. package/src/api/platform/layout/controllers/layout-content-cache.d.ts +0 -9
  169. package/src/api/platform/layout/controllers/layout-content-cache.js +0 -54
  170. package/src/api/platform/layout/controllers/layout-entities-controller.d.ts +0 -119
  171. package/src/api/platform/layout/controllers/layout-entities-controller.js +0 -287
  172. package/src/api/platform/layout/entities/layout-entities.d.ts +0 -235
  173. package/src/api/platform/layout/entities/layout-entities.js +0 -312
  174. package/src/api/platform/layout/entities/shapes.d.ts +0 -6
  175. package/src/api/platform/layout/entities/shapes.js +0 -2
  176. package/src/api/platform/layout/index.d.ts +0 -2
  177. package/src/api/platform/layout/index.js +0 -18
  178. package/src/api/platform/layout/layout.constants.d.ts +0 -1
  179. package/src/api/platform/layout/layout.constants.js +0 -4
  180. package/src/api/platform/layout/shapes.d.ts +0 -16
  181. package/src/api/platform/layout/shapes.js +0 -2
  182. package/src/api/platform/layout/utils/layout-traversal.d.ts +0 -4
  183. package/src/api/platform/layout/utils/layout-traversal.js +0 -65
  184. package/src/api/platform/provider.d.ts +0 -163
  185. package/src/api/platform/provider.js +0 -2
  186. package/src/api/snapshot-source/Factory.d.ts +0 -38
  187. package/src/api/snapshot-source/Factory.js +0 -66
  188. package/src/api/snapshot-source/Instance.d.ts +0 -31
  189. package/src/api/snapshot-source/Instance.js +0 -132
  190. package/src/api/snapshot-source/index.d.ts +0 -3
  191. package/src/api/snapshot-source/index.js +0 -19
  192. package/src/api/snapshot-source/utils.d.ts +0 -2
  193. package/src/api/snapshot-source/utils.js +0 -6
  194. package/src/api/system/index.d.ts +0 -517
  195. package/src/api/system/index.js +0 -895
  196. package/src/api/view/Factory.d.ts +0 -50
  197. package/src/api/view/Factory.js +0 -103
  198. package/src/api/view/Instance.d.ts +0 -487
  199. package/src/api/view/Instance.js +0 -557
  200. package/src/api/view/index.d.ts +0 -3
  201. package/src/api/view/index.js +0 -19
  202. package/src/api/webcontents/main.d.ts +0 -32
  203. package/src/api/webcontents/main.js +0 -156
  204. package/src/api/window/Factory.d.ts +0 -45
  205. package/src/api/window/Factory.js +0 -91
  206. package/src/api/window/Instance.d.ts +0 -1090
  207. package/src/api/window/Instance.js +0 -1349
  208. package/src/api/window/index.d.ts +0 -3
  209. package/src/api/window/index.js +0 -19
  210. package/src/browser.d.ts +0 -10
  211. package/src/browser.js +0 -36
  212. package/src/environment/browser.d.ts +0 -29
  213. package/src/environment/browser.js +0 -60
  214. package/src/environment/environment.d.ts +0 -33
  215. package/src/environment/environment.js +0 -4
  216. package/src/environment/mockEnvironment.d.ts +0 -27
  217. package/src/environment/mockEnvironment.js +0 -61
  218. package/src/environment/node-env.d.ts +0 -29
  219. package/src/environment/node-env.js +0 -72
  220. package/src/fdc3.d.ts +0 -3
  221. package/src/fdc3.js +0 -9
  222. package/src/mock.d.ts +0 -3
  223. package/src/mock.js +0 -18
  224. package/src/namespaces.d.ts +0 -21
  225. package/src/namespaces.js +0 -24
  226. package/src/shapes/ERROR_BOX_TYPES.d.ts +0 -1
  227. package/src/shapes/ERROR_BOX_TYPES.js +0 -2
  228. package/src/shapes/WebOptions.d.ts +0 -13
  229. package/src/shapes/WebOptions.js +0 -2
  230. package/src/shapes/WindowOptions.d.ts +0 -43
  231. package/src/shapes/WindowOptions.js +0 -2
  232. package/src/shapes/protocol.d.ts +0 -200
  233. package/src/shapes/protocol.js +0 -2
  234. package/src/transport/mockWire.d.ts +0 -11
  235. package/src/transport/mockWire.js +0 -26
  236. package/src/transport/transport-errors.d.ts +0 -31
  237. package/src/transport/transport-errors.js +0 -79
  238. package/src/transport/transport.d.ts +0 -73
  239. package/src/transport/transport.js +0 -219
  240. package/src/transport/wire.d.ts +0 -77
  241. package/src/transport/wire.js +0 -36
  242. package/src/util/asyncFilter.d.ts +0 -1
  243. package/src/util/asyncFilter.js +0 -7
  244. package/src/util/channel-api-relay.d.ts +0 -13
  245. package/src/util/channel-api-relay.js +0 -47
  246. package/src/util/errors.d.ts +0 -10
  247. package/src/util/errors.js +0 -12
  248. package/src/util/exhaustive.d.ts +0 -1
  249. package/src/util/exhaustive.js +0 -7
  250. package/src/util/http.d.ts +0 -11
  251. package/src/util/http.js +0 -90
  252. package/src/util/inaccessibleObject.d.ts +0 -2
  253. package/src/util/inaccessibleObject.js +0 -49
  254. package/src/util/lazy.d.ts +0 -34
  255. package/src/util/lazy.js +0 -54
  256. package/src/util/normalize-config.d.ts +0 -3
  257. package/src/util/normalize-config.js +0 -52
  258. package/src/util/promises.d.ts +0 -5
  259. package/src/util/promises.js +0 -27
  260. package/src/util/ref-counter.d.ts +0 -7
  261. package/src/util/ref-counter.js +0 -52
  262. package/src/util/reversible-map.d.ts +0 -11
  263. package/src/util/reversible-map.js +0 -49
  264. package/src/util/runtimeVersioning.d.ts +0 -3
  265. package/src/util/runtimeVersioning.js +0 -25
  266. package/src/util/utilTypes.d.ts +0 -8
  267. package/src/util/utilTypes.js +0 -2
  268. package/src/util/validate.d.ts +0 -3
  269. package/src/util/validate.js +0 -11
@@ -1,235 +0,0 @@
1
- import type * as OpenFin from '../../../../OpenFin';
2
- import { LayoutEntitiesClient } from '../shapes';
3
- /**
4
- * @ignore
5
- * @internal
6
- * Supplies an ApiClient for {@link LayoutEntitiesController} and helper methods
7
- * for the entities {@link TabStack} AND {@link ColumnOrRow} to use.
8
- */
9
- export declare abstract class LayoutNode {
10
- #private;
11
- /**
12
- * @internal
13
- * @ignore
14
- */
15
- protected constructor(client: LayoutEntitiesClient, entityId: string);
16
- abstract readonly type: OpenFin.LayoutEntityTypes;
17
- /**
18
- * @internal
19
- * @ignore
20
- * This instance's unique id used when calling the layout-entities-controller api client
21
- */
22
- protected readonly entityId: string;
23
- /**
24
- * @ignore
25
- * @internal
26
- * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
27
- * @param client
28
- * @param controllerId
29
- * @param identity
30
- * @returns a new instance of {@link LayoutEntitiesClient} with bound to the controllerId
31
- */
32
- static newLayoutEntitiesClient: (client: OpenFin.ChannelClient, controllerId: string, identity: OpenFin.Identity) => Promise<LayoutEntitiesClient>;
33
- static getEntity: (definition: OpenFin.LayoutEntityDefinition, client: LayoutEntitiesClient) => ColumnOrRow | TabStack;
34
- isRoot: () => Promise<boolean>;
35
- exists: () => Promise<boolean>;
36
- getParent: () => Promise<ColumnOrRow | TabStack | undefined>;
37
- createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
38
- position?: OpenFin.LayoutPosition;
39
- }) => Promise<TabStack>;
40
- getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
41
- }
42
- /**
43
- * @typedef {string} LayoutPosition
44
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
45
- */
46
- /**
47
- * @typedef {object} StackCreationOptions
48
- * @summary Stack creation options.
49
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
50
- */
51
- /**
52
- * @typedef {object} TabStack~AddViewOptions
53
- * @summary Options to use when adding a view to a {@link TabStack}
54
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
55
- */
56
- /**
57
- * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
58
- */
59
- export declare class TabStack extends LayoutNode {
60
- #private;
61
- /**
62
- * Determines if this {@link TabStack} is the top level content item in the current layout.
63
- * @function isRoot
64
- * @memberof TabStack
65
- * @instance
66
- * @tutorial TabStack.isRoot
67
- * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
68
- */
69
- /**
70
- * Determines if this {@link TabStack} exists.
71
- * @function exists
72
- * @instance
73
- * @memberof TabStack
74
- * @tutorial TabStack.exists
75
- * @return {Promise<boolean>} Resolves true if this is the TabStack exists, or false if it has been destroyed.
76
- */
77
- /**
78
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
79
- * @function getParent
80
- * @instance
81
- * @memberof TabStack
82
- * @tutorial TabStack.getParent
83
- * @return {Promise<ColumnOrRow | TabStack | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link TabStack} is the root content item or does not exist.
84
- */
85
- /**
86
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
87
- * @function getAdjacentStacks
88
- * @instance
89
- * @memberof TabStack
90
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
91
- * @returns {Promise<TabStack[]>}
92
- * @tutorial TabStack.getAdjacentStacks
93
- */
94
- /**
95
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
96
- *
97
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
98
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
99
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
100
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
101
- *
102
- * @function createAdjacentStack
103
- * @instance
104
- * @memberof TabStack
105
- * @param {View~options} views - List of identities or view creation options of the views to include in the stack
106
- * @param {StackCreationOptions} options - Creation options.
107
- * @returns {Promise<TabStack>} The created TabStack.
108
- * @tutorial TabStack.createAdjacentStack
109
- * @experimental
110
- */
111
- /** @internal */
112
- constructor(client: LayoutEntitiesClient, entityId: string);
113
- /**
114
- * Type of the content item. Always stack, but useful for distinguishing between a {@link TabStack} and {@link ColumnOrRow}.
115
- */
116
- readonly type = "stack";
117
- /**
118
- * Retrieves a list of all views belonging to this {@link TabStack}.
119
- *
120
- * Known Issue: If adding a view overflows the tab-container width, the added view will be set as active
121
- * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
122
- * If that happens and then getViews() is called, it will return the identities in a different order than
123
- * than the currently rendered tab order.
124
- *
125
- * @returns {Promise<Identity[]>} Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
126
- * @throws If the {@link TabStack} has been destroyed.
127
- * @tutorial TabStack.getViews
128
- * @experimental
129
- */
130
- getViews: () => Promise<OpenFin.Identity[]>;
131
- /**
132
- * Adds or creates a view in this {@link TabStack}.
133
- *
134
- * Known Issue: If adding a view overflows the tab-container, the added view will be set as active
135
- * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
136
- *
137
- * @param {View~options} view The identity of an existing view to add, or options to create a view.
138
- * @param {TabStack~AddViewOptions} options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
139
- * @returns {Promise<identity>} Resolves with the {@link OpenFin.Identity identity} of the added view.
140
- * @throws If the view does not exist or fails to create.
141
- * @throws If the {@link TabStack} has been destroyed.
142
- * @tutorial TabStack.addView
143
- * @experimental
144
- */
145
- addView: (view: OpenFin.Identity | OpenFin.PlatformViewCreationOptions, options?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
146
- /**
147
- * Removes a view from this {@link TabStack}.
148
- * @param {Identity} view - Identity of the view to remove.
149
- * @throws If the view does not exist or does not belong to the stack.
150
- * @throws If the {@link TabStack} has been destroyed.
151
- * @return {Promise<void>}
152
- * @tutorial TabStack.removeView
153
- */
154
- removeView: (view: OpenFin.Identity) => Promise<void>;
155
- /**
156
- * Sets the active view of the {@link TabStack} without focusing it.
157
- * @param {Identity} view - Identity of the view to activate.
158
- * @returns {Promise<void>} Promise which resolves with void once the view has been activated.
159
- * @throws If the {@link TabStack} has been destroyed.
160
- * @throws If the view does not exist.
161
- * @tutorial TabStack.setActiveView
162
- * @experimental
163
- */
164
- setActiveView: (view: OpenFin.Identity) => Promise<void>;
165
- }
166
- /**
167
- * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
168
- */
169
- export declare class ColumnOrRow extends LayoutNode {
170
- #private;
171
- /**
172
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
173
- * @function isRoot
174
- * @memberof ColumnOrRow
175
- * @instance
176
- * @tutorial ColumnOrRow.isRoot
177
- * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
178
- */
179
- /**
180
- * Determines if this {@link ColumnOrRow} exists.
181
- * @function exists
182
- * @instance
183
- * @memberof ColumnOrRow
184
- * @tutorial ColumnOrRow.exists
185
- * @return {Promise<boolean>} Resolves true if the TabStack exists, or false if it has been destroyed.
186
- */
187
- /**
188
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
189
- * @function getParent
190
- * @instance
191
- * @memberof ColumnOrRow
192
- * @tutorial ColumnOrRow.getParent
193
- * @return {Promise<ColumnOrRow | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link ColumnOrRow} does not exist or is the root content item.
194
- */
195
- /**
196
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
197
- * @function getAdjacentStacks
198
- * @instance
199
- * @memberof ColumnOrRow
200
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
201
- * @returns {Promise<TabStack[]>}
202
- * @tutorial ColumnOrRow.getAdjacentStacks
203
- */
204
- /**
205
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
206
- *
207
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
208
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
209
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
210
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
211
- *
212
- * @function createAdjacentStack
213
- * @instance
214
- * @memberof ColumnOrRow
215
- * @param {View~options} views - List of identities or view creation options of the views to include in the stack
216
- * @param {StackCreationOptions} options - Creation options.
217
- * @returns {Promise<TabStack>} The created TabStack
218
- * @tutorial ColumnOrRow.createAdjacentStack
219
- * @experimental
220
- */
221
- /**
222
- * @internal
223
- */
224
- constructor(client: LayoutEntitiesClient, entityId: string, type: 'row' | 'column');
225
- /**
226
- * The type of this {@link ColumnOrRow}. Either 'row' or 'column'.
227
- */
228
- readonly type: 'column' | 'row';
229
- /**
230
- * Retrieves a list of all content items belonging to this {@link ColumnOrRow} in order of appearance.
231
- * @returns {Promise<Array<ColumnOrRow | TabStack>>} Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
232
- * @tutorial ColumnOrRow.getContent
233
- */
234
- getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
235
- }
@@ -1,312 +0,0 @@
1
- "use strict";
2
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
3
- if (kind === "m") throw new TypeError("Private method is not writable");
4
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
5
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
6
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
7
- };
8
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
9
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
10
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
11
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
12
- };
13
- var _a, _LayoutNode_client, _TabStack_client, _ColumnOrRow_client;
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.ColumnOrRow = exports.TabStack = exports.LayoutNode = void 0;
16
- const api_exposer_1 = require("../../../api-exposer");
17
- const channel_api_relay_1 = require("../../../../util/channel-api-relay");
18
- /*
19
- This file includes LayoutNode, ColumnOrRow and TabStack classes, which are all closely
20
- intertwined, and share members via parent abstract class LayoutNode. To prevent circular
21
- refs, we define and export all the classes here.
22
- */
23
- /**
24
- * @ignore
25
- * @internal
26
- * Supplies an ApiClient for {@link LayoutEntitiesController} and helper methods
27
- * for the entities {@link TabStack} AND {@link ColumnOrRow} to use.
28
- */
29
- class LayoutNode {
30
- /**
31
- * @internal
32
- * @ignore
33
- */
34
- constructor(client, entityId) {
35
- /**
36
- * @ignore
37
- * @internal
38
- * ApiClient for {@link LayoutEntitiesController}
39
- */
40
- _LayoutNode_client.set(this, void 0);
41
- this.isRoot = () => __classPrivateFieldGet(this, _LayoutNode_client, "f").isRoot(this.entityId);
42
- this.exists = () => __classPrivateFieldGet(this, _LayoutNode_client, "f").exists(this.entityId);
43
- this.getParent = async () => {
44
- const parent = await __classPrivateFieldGet(this, _LayoutNode_client, "f").getParent(this.entityId);
45
- if (!parent) {
46
- return undefined;
47
- }
48
- return LayoutNode.getEntity(parent, __classPrivateFieldGet(this, _LayoutNode_client, "f"));
49
- };
50
- this.createAdjacentStack = async (views, options) => {
51
- const entityId = await __classPrivateFieldGet(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
52
- return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet(this, _LayoutNode_client, "f"));
53
- };
54
- this.getAdjacentStacks = async (edge) => {
55
- const adjacentStacks = await __classPrivateFieldGet(this, _LayoutNode_client, "f").getAdjacentStacks({
56
- targetId: this.entityId,
57
- edge
58
- });
59
- return adjacentStacks.map((stack) => LayoutNode.getEntity({
60
- type: 'stack',
61
- entityId: stack.entityId
62
- }, __classPrivateFieldGet(this, _LayoutNode_client, "f")));
63
- };
64
- __classPrivateFieldSet(this, _LayoutNode_client, client, "f");
65
- this.entityId = entityId;
66
- }
67
- }
68
- exports.LayoutNode = LayoutNode;
69
- _a = LayoutNode, _LayoutNode_client = new WeakMap();
70
- /**
71
- * @ignore
72
- * @internal
73
- * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
74
- * @param client
75
- * @param controllerId
76
- * @param identity
77
- * @returns a new instance of {@link LayoutEntitiesClient} with bound to the controllerId
78
- */
79
- LayoutNode.newLayoutEntitiesClient = async (client, controllerId, identity) => {
80
- const dispatch = (0, channel_api_relay_1.createRelayedDispatch)(client, identity, 'layout-relay', 'You are trying to interact with a layout component on a window that has been destroyed.');
81
- const consumer = new api_exposer_1.ApiConsumer(new api_exposer_1.ChannelsConsumer({ dispatch }));
82
- return consumer.consume({ id: controllerId });
83
- };
84
- LayoutNode.getEntity = (definition, client) => {
85
- const { entityId, type } = definition;
86
- switch (type) {
87
- case 'column':
88
- case 'row':
89
- return new ColumnOrRow(client, entityId, type);
90
- case 'stack':
91
- return new TabStack(client, entityId);
92
- default:
93
- throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
94
- }
95
- };
96
- /**
97
- * @typedef {string} LayoutPosition
98
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
99
- */
100
- /**
101
- * @typedef {object} StackCreationOptions
102
- * @summary Stack creation options.
103
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
104
- */
105
- /**
106
- * @typedef {object} TabStack~AddViewOptions
107
- * @summary Options to use when adding a view to a {@link TabStack}
108
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
109
- */
110
- /**
111
- * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
112
- */
113
- class TabStack extends LayoutNode {
114
- /**
115
- * Determines if this {@link TabStack} is the top level content item in the current layout.
116
- * @function isRoot
117
- * @memberof TabStack
118
- * @instance
119
- * @tutorial TabStack.isRoot
120
- * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
121
- */
122
- /**
123
- * Determines if this {@link TabStack} exists.
124
- * @function exists
125
- * @instance
126
- * @memberof TabStack
127
- * @tutorial TabStack.exists
128
- * @return {Promise<boolean>} Resolves true if this is the TabStack exists, or false if it has been destroyed.
129
- */
130
- /**
131
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
132
- * @function getParent
133
- * @instance
134
- * @memberof TabStack
135
- * @tutorial TabStack.getParent
136
- * @return {Promise<ColumnOrRow | TabStack | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link TabStack} is the root content item or does not exist.
137
- */
138
- /**
139
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
140
- * @function getAdjacentStacks
141
- * @instance
142
- * @memberof TabStack
143
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
144
- * @returns {Promise<TabStack[]>}
145
- * @tutorial TabStack.getAdjacentStacks
146
- */
147
- /**
148
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
149
- *
150
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
151
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
152
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
153
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
154
- *
155
- * @function createAdjacentStack
156
- * @instance
157
- * @memberof TabStack
158
- * @param {View~options} views - List of identities or view creation options of the views to include in the stack
159
- * @param {StackCreationOptions} options - Creation options.
160
- * @returns {Promise<TabStack>} The created TabStack.
161
- * @tutorial TabStack.createAdjacentStack
162
- * @experimental
163
- */
164
- /** @internal */
165
- constructor(client, entityId) {
166
- super(client, entityId);
167
- /**
168
- * @internal
169
- * ApiClient for {@link LayoutEntitiesController}
170
- */
171
- _TabStack_client.set(this, void 0);
172
- /**
173
- * Type of the content item. Always stack, but useful for distinguishing between a {@link TabStack} and {@link ColumnOrRow}.
174
- */
175
- this.type = 'stack';
176
- /**
177
- * Retrieves a list of all views belonging to this {@link TabStack}.
178
- *
179
- * Known Issue: If adding a view overflows the tab-container width, the added view will be set as active
180
- * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
181
- * If that happens and then getViews() is called, it will return the identities in a different order than
182
- * than the currently rendered tab order.
183
- *
184
- * @returns {Promise<Identity[]>} Resolves with a list containing the {@link OpenFin.Identity identities} of each view belonging to the {@link TabStack}.
185
- * @throws If the {@link TabStack} has been destroyed.
186
- * @tutorial TabStack.getViews
187
- * @experimental
188
- */
189
- this.getViews = () => __classPrivateFieldGet(this, _TabStack_client, "f").getStackViews(this.entityId);
190
- /**
191
- * Adds or creates a view in this {@link TabStack}.
192
- *
193
- * Known Issue: If adding a view overflows the tab-container, the added view will be set as active
194
- * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
195
- *
196
- * @param {View~options} view The identity of an existing view to add, or options to create a view.
197
- * @param {TabStack~AddViewOptions} options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
198
- * @returns {Promise<identity>} Resolves with the {@link OpenFin.Identity identity} of the added view.
199
- * @throws If the view does not exist or fails to create.
200
- * @throws If the {@link TabStack} has been destroyed.
201
- * @tutorial TabStack.addView
202
- * @experimental
203
- */
204
- this.addView = async (view, options = { index: 0 }) => __classPrivateFieldGet(this, _TabStack_client, "f").addViewToStack(this.entityId, view, options);
205
- /**
206
- * Removes a view from this {@link TabStack}.
207
- * @param {Identity} view - Identity of the view to remove.
208
- * @throws If the view does not exist or does not belong to the stack.
209
- * @throws If the {@link TabStack} has been destroyed.
210
- * @return {Promise<void>}
211
- * @tutorial TabStack.removeView
212
- */
213
- this.removeView = async (view) => {
214
- await __classPrivateFieldGet(this, _TabStack_client, "f").removeViewFromStack(this.entityId, view);
215
- };
216
- /**
217
- * Sets the active view of the {@link TabStack} without focusing it.
218
- * @param {Identity} view - Identity of the view to activate.
219
- * @returns {Promise<void>} Promise which resolves with void once the view has been activated.
220
- * @throws If the {@link TabStack} has been destroyed.
221
- * @throws If the view does not exist.
222
- * @tutorial TabStack.setActiveView
223
- * @experimental
224
- */
225
- this.setActiveView = async (view) => {
226
- await __classPrivateFieldGet(this, _TabStack_client, "f").setStackActiveView(this.entityId, view);
227
- };
228
- __classPrivateFieldSet(this, _TabStack_client, client, "f");
229
- }
230
- }
231
- exports.TabStack = TabStack;
232
- _TabStack_client = new WeakMap();
233
- /**
234
- * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
235
- */
236
- class ColumnOrRow extends LayoutNode {
237
- /**
238
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
239
- * @function isRoot
240
- * @memberof ColumnOrRow
241
- * @instance
242
- * @tutorial ColumnOrRow.isRoot
243
- * @return {Promise<boolean>} Resolves true if this TabStack is the top level content item, or false if it is not.
244
- */
245
- /**
246
- * Determines if this {@link ColumnOrRow} exists.
247
- * @function exists
248
- * @instance
249
- * @memberof ColumnOrRow
250
- * @tutorial ColumnOrRow.exists
251
- * @return {Promise<boolean>} Resolves true if the TabStack exists, or false if it has been destroyed.
252
- */
253
- /**
254
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
255
- * @function getParent
256
- * @instance
257
- * @memberof ColumnOrRow
258
- * @tutorial ColumnOrRow.getParent
259
- * @return {Promise<ColumnOrRow | undefined>} Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if this {@link ColumnOrRow} does not exist or is the root content item.
260
- */
261
- /**
262
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
263
- * @function getAdjacentStacks
264
- * @instance
265
- * @memberof ColumnOrRow
266
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
267
- * @returns {Promise<TabStack[]>}
268
- * @tutorial ColumnOrRow.getAdjacentStacks
269
- */
270
- /**
271
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
272
- *
273
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
274
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
275
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
276
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
277
- *
278
- * @function createAdjacentStack
279
- * @instance
280
- * @memberof ColumnOrRow
281
- * @param {View~options} views - List of identities or view creation options of the views to include in the stack
282
- * @param {StackCreationOptions} options - Creation options.
283
- * @returns {Promise<TabStack>} The created TabStack
284
- * @tutorial ColumnOrRow.createAdjacentStack
285
- * @experimental
286
- */
287
- /**
288
- * @internal
289
- */
290
- constructor(client, entityId, type) {
291
- super(client, entityId);
292
- /**
293
- * @ignore
294
- * @internal
295
- * ApiClient for {@link LayoutEntitiesController}
296
- */
297
- _ColumnOrRow_client.set(this, void 0);
298
- /**
299
- * Retrieves a list of all content items belonging to this {@link ColumnOrRow} in order of appearance.
300
- * @returns {Promise<Array<ColumnOrRow | TabStack>>} Resolves with a list containing {@link ColumnOrRow} and {@link TabStack} items belonging to this {@link ColumnOrRow}.
301
- * @tutorial ColumnOrRow.getContent
302
- */
303
- this.getContent = async () => {
304
- const contentItemEntities = await __classPrivateFieldGet(this, _ColumnOrRow_client, "f").getContent(this.entityId);
305
- return contentItemEntities.map((entity) => LayoutNode.getEntity(entity, __classPrivateFieldGet(this, _ColumnOrRow_client, "f")));
306
- };
307
- __classPrivateFieldSet(this, _ColumnOrRow_client, client, "f");
308
- this.type = type;
309
- }
310
- }
311
- exports.ColumnOrRow = ColumnOrRow;
312
- _ColumnOrRow_client = new WeakMap();
@@ -1,6 +0,0 @@
1
- export type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
2
- export type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
3
- export type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes = LayoutEntityTypes> = {
4
- type: TLayoutEntityType;
5
- entityId: string;
6
- };
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,2 +0,0 @@
1
- export * from './Factory';
2
- export * from './Instance';
@@ -1,18 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./Factory"), exports);
18
- __exportStar(require("./Instance"), exports);
@@ -1 +0,0 @@
1
- export declare const LAYOUT_CONTROLLER_ID = "layout-entities";
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.LAYOUT_CONTROLLER_ID = void 0;
4
- exports.LAYOUT_CONTROLLER_ID = 'layout-entities';
@@ -1,16 +0,0 @@
1
- import { ApiClient } from '../../api-exposer';
2
- import type * as OpenFin from '../../../OpenFin';
3
- import { LayoutEntitiesController } from './controllers/layout-entities-controller';
4
- type LayoutPresetType = OpenFin.LayoutPresetType;
5
- export interface InitLayoutOptions {
6
- containerId?: string;
7
- }
8
- export interface PresetLayoutOptions {
9
- presetType: LayoutPresetType;
10
- }
11
- export interface DragPayload {
12
- 'view-config': OpenFin.ViewCreationOptions;
13
- 'view-identity': [string, string, string];
14
- }
15
- export type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
16
- export {};
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +0,0 @@
1
- import type * as OpenFin from '../../../../OpenFin';
2
- export declare const getAdjacentItem: (component: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => GoldenLayout.ContentItem | undefined;
3
- export declare const doShareEdge: (from: GoldenLayout.ContentItem, to: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => boolean;
4
- export declare const getAdjacentStacks: (item: GoldenLayout.ContentItem, edge: OpenFin.LayoutPosition) => GoldenLayout.ContentItem[];