iframe-coordinator-cli 6.4.0 → 6.5.1

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 (57) hide show
  1. package/dist/assets/index-DEUCFuke.css +1 -0
  2. package/dist/assets/index-DejhDHus.js +57 -0
  3. package/dist/favicon.svg +1 -0
  4. package/dist/ifc-docs/assets/hierarchy.js +1 -1
  5. package/dist/ifc-docs/assets/highlight.css +130 -91
  6. package/dist/ifc-docs/assets/icons.js +20 -17
  7. package/dist/ifc-docs/assets/icons.svg +1 -1
  8. package/dist/ifc-docs/assets/main.js +2535 -5
  9. package/dist/ifc-docs/assets/navigation.js +2 -1
  10. package/dist/ifc-docs/assets/search.js +2 -1
  11. package/dist/ifc-docs/assets/style.css +1571 -1581
  12. package/dist/ifc-docs/classes/client.Client.html +2388 -99
  13. package/dist/ifc-docs/classes/client.WorkerClient.html +2164 -0
  14. package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
  15. package/dist/ifc-docs/classes/host.WorkerPool.html +879 -0
  16. package/dist/ifc-docs/documents/client-setup.html +579 -75
  17. package/dist/ifc-docs/functions/host.registerCustomElements.html +218 -3
  18. package/dist/ifc-docs/hierarchy.html +168 -1
  19. package/dist/ifc-docs/index.html +432 -31
  20. package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +331 -4
  21. package/dist/ifc-docs/interfaces/client.EventEmitter.html +752 -0
  22. package/dist/ifc-docs/interfaces/host.ClientConfig.html +399 -7
  23. package/dist/ifc-docs/interfaces/host.ClientRegistration.html +580 -24
  24. package/dist/ifc-docs/interfaces/host.RoutingMap.html +211 -4
  25. package/dist/ifc-docs/interfaces/host.WorkerAppData.html +388 -0
  26. package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -0
  27. package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -0
  28. package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -0
  29. package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -0
  30. package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -0
  31. package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -0
  32. package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -0
  33. package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -0
  34. package/dist/ifc-docs/interfaces/messages.Notification.html +435 -0
  35. package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -0
  36. package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -0
  37. package/dist/ifc-docs/interfaces/messages.Publication.html +443 -0
  38. package/dist/ifc-docs/modules/client.html +742 -2
  39. package/dist/ifc-docs/modules/host.html +647 -1
  40. package/dist/ifc-docs/modules/messages.html +462 -0
  41. package/dist/ifc-docs/modules.html +359 -1
  42. package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -5
  43. package/dist/ifc-docs/types/client.EventHandler.html +247 -2
  44. package/dist/index.html +3 -3
  45. package/package.json +3 -4
  46. package/dist/assets/index-BLdxgMq2.css +0 -1
  47. package/dist/assets/index-IcxzuslN.js +0 -49
  48. package/dist/ifc-docs/classes/client.EventEmitter.html +0 -14
  49. package/dist/ifc-docs/interfaces/client.Breadcrumb.html +0 -6
  50. package/dist/ifc-docs/interfaces/client.EnvData.html +0 -11
  51. package/dist/ifc-docs/interfaces/client.KeyData.html +0 -12
  52. package/dist/ifc-docs/interfaces/client.ModalRequest.html +0 -6
  53. package/dist/ifc-docs/interfaces/client.NavRequest.html +0 -9
  54. package/dist/ifc-docs/interfaces/client.Notification.html +0 -9
  55. package/dist/ifc-docs/interfaces/client.PageMetadata.html +0 -8
  56. package/dist/ifc-docs/interfaces/client.PromptOnLeave.html +0 -9
  57. package/dist/ifc-docs/interfaces/client.Publication.html +0 -11
@@ -0,0 +1,443 @@
1
+ <!doctype html>
2
+ <html class="default" lang="en" data-base="../">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
6
+ <title>Publication | iframe-coordinator - v6.5.1</title>
7
+ <meta name="description" content="Documentation for iframe-coordinator" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ window.app
24
+ ? app.showPage()
25
+ : document.body.style.removeProperty("display"),
26
+ 500,
27
+ );
28
+ </script>
29
+ <header class="tsd-page-toolbar">
30
+ <div class="tsd-toolbar-contents container">
31
+ <a href="../index.html" class="title">iframe-coordinator - v6.5.1</a>
32
+ <div id="tsd-toolbar-links"></div>
33
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
34
+ <svg
35
+ width="16"
36
+ height="16"
37
+ viewBox="0 0 16 16"
38
+ fill="none"
39
+ aria-hidden="true"
40
+ >
41
+ <use href="../assets/icons.svg#icon-search"></use>
42
+ </svg>
43
+ </button>
44
+ <dialog id="tsd-search" aria-label="Search">
45
+ <input
46
+ role="combobox"
47
+ id="tsd-search-input"
48
+ aria-controls="tsd-search-results"
49
+ aria-autocomplete="list"
50
+ aria-expanded="true"
51
+ autocapitalize="off"
52
+ autocomplete="off"
53
+ placeholder="Search the docs"
54
+ maxlength="100"
55
+ />
56
+ <ul role="listbox" id="tsd-search-results"></ul>
57
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
58
+ <div>Preparing search index...</div>
59
+ </div>
60
+ </dialog>
61
+ <a
62
+ href="#"
63
+ class="tsd-widget menu"
64
+ id="tsd-toolbar-menu-trigger"
65
+ data-toggle="menu"
66
+ aria-label="Menu"
67
+ ><svg
68
+ width="16"
69
+ height="16"
70
+ viewBox="0 0 16 16"
71
+ fill="none"
72
+ aria-hidden="true"
73
+ >
74
+ <use href="../assets/icons.svg#icon-menu"></use></svg
75
+ ></a>
76
+ </div>
77
+ </header>
78
+ <div class="container container-main">
79
+ <div class="col-content">
80
+ <div class="tsd-page-title">
81
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
82
+ <li><a href="../modules/messages.html">messages</a></li>
83
+ <li><a href="" aria-current="page">Publication</a></li>
84
+ </ul>
85
+ <h1>Interface Publication</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ A pub-sub message for general-purpose messaging between hosts and
91
+ clients.
92
+ </p>
93
+ </div>
94
+ </section>
95
+ <div class="tsd-signature">
96
+ <span class="tsd-signature-keyword">interface</span>
97
+ <span class="tsd-kind-interface">Publication</span>
98
+ <span class="tsd-signature-symbol">{</span><br />    <a
99
+ class="tsd-kind-property"
100
+ href="#clientid"
101
+ >clientId</a
102
+ ><span class="tsd-signature-symbol">?:</span>
103
+ <span class="tsd-signature-type">string</span
104
+ ><span class="tsd-signature-symbol">;</span><br />    <a
105
+ class="tsd-kind-property"
106
+ href="#payload"
107
+ >payload</a
108
+ ><span class="tsd-signature-symbol">:</span>
109
+ <span class="tsd-signature-type">any</span
110
+ ><span class="tsd-signature-symbol">;</span><br />    <a
111
+ class="tsd-kind-property"
112
+ href="#topic"
113
+ >topic</a
114
+ ><span class="tsd-signature-symbol">:</span>
115
+ <span class="tsd-signature-type">string</span
116
+ ><span class="tsd-signature-symbol">;</span><br /><span
117
+ class="tsd-signature-symbol"
118
+ >}</span
119
+ >
120
+ </div>
121
+ <aside class="tsd-sources">
122
+ <ul>
123
+ <li>
124
+ Defined in
125
+ <a
126
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Publication.ts#L15"
127
+ >messages/Publication.ts:15</a
128
+ >
129
+ </li>
130
+ </ul>
131
+ </aside>
132
+ <section class="tsd-panel-group tsd-index-group">
133
+ <section class="tsd-panel tsd-index-panel">
134
+ <details class="tsd-index-content tsd-accordion" open>
135
+ <summary class="tsd-accordion-summary tsd-index-summary">
136
+ <svg
137
+ width="20"
138
+ height="20"
139
+ viewBox="0 0 24 24"
140
+ fill="none"
141
+ aria-hidden="true"
142
+ >
143
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
144
+ </svg>
145
+ <h5 class="tsd-index-heading uppercase">Index</h5>
146
+ </summary>
147
+ <div class="tsd-accordion-details">
148
+ <section class="tsd-index-section">
149
+ <h3 class="tsd-index-heading">Properties</h3>
150
+ <div class="tsd-index-list">
151
+ <a href="#clientid" class="tsd-index-link"
152
+ ><svg
153
+ class="tsd-kind-icon"
154
+ viewBox="0 0 24 24"
155
+ aria-label="Property"
156
+ >
157
+ <use href="../assets/icons.svg#icon-1024"></use></svg
158
+ ><span>client<wbr />Id?</span></a
159
+ >
160
+ <a href="#payload" class="tsd-index-link"
161
+ ><svg
162
+ class="tsd-kind-icon"
163
+ viewBox="0 0 24 24"
164
+ aria-label="Property"
165
+ >
166
+ <use href="../assets/icons.svg#icon-1024"></use></svg
167
+ ><span>payload</span></a
168
+ >
169
+ <a href="#topic" class="tsd-index-link"
170
+ ><svg
171
+ class="tsd-kind-icon"
172
+ viewBox="0 0 24 24"
173
+ aria-label="Property"
174
+ >
175
+ <use href="../assets/icons.svg#icon-1024"></use></svg
176
+ ><span>topic</span></a
177
+ >
178
+ </div>
179
+ </section>
180
+ </div>
181
+ </details>
182
+ </section>
183
+ </section>
184
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
185
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
186
+ <svg
187
+ width="20"
188
+ height="20"
189
+ viewBox="0 0 24 24"
190
+ fill="none"
191
+ aria-hidden="true"
192
+ >
193
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
194
+ </svg>
195
+ <h2>Properties</h2>
196
+ </summary>
197
+ <section>
198
+ <section class="tsd-panel tsd-member">
199
+ <h3 class="tsd-anchor-link" id="clientid">
200
+ <code class="tsd-tag">Optional</code><span>client<wbr />Id</span
201
+ ><a
202
+ href="#clientid"
203
+ aria-label="Permalink"
204
+ class="tsd-anchor-icon"
205
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
206
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
207
+ ></a>
208
+ </h3>
209
+ <div class="tsd-signature">
210
+ <span class="tsd-kind-property">clientId</span
211
+ ><span class="tsd-signature-symbol">?:</span>
212
+ <span class="tsd-signature-type">string</span>
213
+ </div>
214
+ <div class="tsd-comment tsd-typography">
215
+ <p>
216
+ Client the message originates from. This should not be
217
+ provided when calling client methods. The value will be
218
+ ignored and the library will replace it when delivering the
219
+ message to the host.
220
+ </p>
221
+ </div>
222
+ <aside class="tsd-sources">
223
+ <ul>
224
+ <li>
225
+ Defined in
226
+ <a
227
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Publication.ts#L28"
228
+ >messages/Publication.ts:28</a
229
+ >
230
+ </li>
231
+ </ul>
232
+ </aside>
233
+ </section>
234
+ <section class="tsd-panel tsd-member">
235
+ <h3 class="tsd-anchor-link" id="payload">
236
+ <span>payload</span
237
+ ><a
238
+ href="#payload"
239
+ aria-label="Permalink"
240
+ class="tsd-anchor-icon"
241
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
242
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
243
+ ></a>
244
+ </h3>
245
+ <div class="tsd-signature">
246
+ <span class="tsd-kind-property">payload</span
247
+ ><span class="tsd-signature-symbol">:</span>
248
+ <span class="tsd-signature-type">any</span>
249
+ </div>
250
+ <div class="tsd-comment tsd-typography">
251
+ <p>Data to publish</p>
252
+ </div>
253
+ <aside class="tsd-sources">
254
+ <ul>
255
+ <li>
256
+ Defined in
257
+ <a
258
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Publication.ts#L22"
259
+ >messages/Publication.ts:22</a
260
+ >
261
+ </li>
262
+ </ul>
263
+ </aside>
264
+ </section>
265
+ <section class="tsd-panel tsd-member">
266
+ <h3 class="tsd-anchor-link" id="topic">
267
+ <span>topic</span
268
+ ><a href="#topic" aria-label="Permalink" class="tsd-anchor-icon"
269
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
270
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
271
+ ></a>
272
+ </h3>
273
+ <div class="tsd-signature">
274
+ <span class="tsd-kind-property">topic</span
275
+ ><span class="tsd-signature-symbol">:</span>
276
+ <span class="tsd-signature-type">string</span>
277
+ </div>
278
+ <div class="tsd-comment tsd-typography">
279
+ <p>
280
+ The topic to publish on. The host application must be
281
+ subscribed to the topic in order to receive the message.
282
+ </p>
283
+ </div>
284
+ <aside class="tsd-sources">
285
+ <ul>
286
+ <li>
287
+ Defined in
288
+ <a
289
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Publication.ts#L20"
290
+ >messages/Publication.ts:20</a
291
+ >
292
+ </li>
293
+ </ul>
294
+ </aside>
295
+ </section>
296
+ </section>
297
+ </details>
298
+ </div>
299
+ <div class="col-sidebar">
300
+ <div class="page-menu">
301
+ <div class="tsd-navigation settings">
302
+ <details class="tsd-accordion">
303
+ <summary class="tsd-accordion-summary">
304
+ <svg
305
+ width="20"
306
+ height="20"
307
+ viewBox="0 0 24 24"
308
+ fill="none"
309
+ aria-hidden="true"
310
+ >
311
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
312
+ </svg>
313
+ <h3>Settings</h3>
314
+ </summary>
315
+ <div class="tsd-accordion-details">
316
+ <div class="tsd-filter-visibility">
317
+ <span class="settings-label">Member Visibility</span>
318
+ <ul id="tsd-filter-options">
319
+ <li class="tsd-filter-item">
320
+ <label class="tsd-filter-input"
321
+ ><input
322
+ type="checkbox"
323
+ id="tsd-filter-inherited"
324
+ name="inherited"
325
+ checked
326
+ /><svg
327
+ width="32"
328
+ height="32"
329
+ viewBox="0 0 32 32"
330
+ aria-hidden="true"
331
+ >
332
+ <rect
333
+ class="tsd-checkbox-background"
334
+ width="30"
335
+ height="30"
336
+ x="1"
337
+ y="1"
338
+ rx="6"
339
+ fill="none"
340
+ ></rect>
341
+ <path
342
+ class="tsd-checkbox-checkmark"
343
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
344
+ stroke="none"
345
+ stroke-width="3.5"
346
+ stroke-linejoin="round"
347
+ fill="none"
348
+ ></path></svg
349
+ ><span>Inherited</span></label
350
+ >
351
+ </li>
352
+ </ul>
353
+ </div>
354
+ <div class="tsd-theme-toggle">
355
+ <label class="settings-label" for="tsd-theme">Theme</label
356
+ ><select id="tsd-theme">
357
+ <option value="os">OS</option>
358
+ <option value="light">Light</option>
359
+ <option value="dark">Dark</option>
360
+ </select>
361
+ </div>
362
+ </div>
363
+ </details>
364
+ </div>
365
+ <details open class="tsd-accordion tsd-page-navigation">
366
+ <summary class="tsd-accordion-summary">
367
+ <svg
368
+ width="20"
369
+ height="20"
370
+ viewBox="0 0 24 24"
371
+ fill="none"
372
+ aria-hidden="true"
373
+ >
374
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
375
+ </svg>
376
+ <h3>On This Page</h3>
377
+ </summary>
378
+ <div class="tsd-accordion-details">
379
+ <details open class="tsd-accordion tsd-page-navigation-section">
380
+ <summary
381
+ class="tsd-accordion-summary"
382
+ data-key="section-Properties"
383
+ >
384
+ <svg
385
+ width="20"
386
+ height="20"
387
+ viewBox="0 0 24 24"
388
+ fill="none"
389
+ aria-hidden="true"
390
+ >
391
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
392
+ >Properties
393
+ </summary>
394
+ <div>
395
+ <a href="#clientid"
396
+ ><svg
397
+ class="tsd-kind-icon"
398
+ viewBox="0 0 24 24"
399
+ aria-label="Property"
400
+ >
401
+ <use href="../assets/icons.svg#icon-1024"></use></svg
402
+ ><span>client<wbr />Id</span></a
403
+ ><a href="#payload"
404
+ ><svg
405
+ class="tsd-kind-icon"
406
+ viewBox="0 0 24 24"
407
+ aria-label="Property"
408
+ >
409
+ <use href="../assets/icons.svg#icon-1024"></use></svg
410
+ ><span>payload</span></a
411
+ ><a href="#topic"
412
+ ><svg
413
+ class="tsd-kind-icon"
414
+ viewBox="0 0 24 24"
415
+ aria-label="Property"
416
+ >
417
+ <use href="../assets/icons.svg#icon-1024"></use></svg
418
+ ><span>topic</span></a
419
+ >
420
+ </div>
421
+ </details>
422
+ </div>
423
+ </details>
424
+ </div>
425
+ <div class="site-menu">
426
+ <nav class="tsd-navigation">
427
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
428
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
429
+ <li>Loading...</li>
430
+ </ul>
431
+ </nav>
432
+ </div>
433
+ </div>
434
+ </div>
435
+ <footer>
436
+ <p class="tsd-generator">
437
+ Generated using
438
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
439
+ </p>
440
+ </footer>
441
+ <div class="overlay"></div>
442
+ </body>
443
+ </html>