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,435 @@
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>Notification | 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">Notification</a></li>
84
+ </ul>
85
+ <h1>Interface Notification</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ A notification configuration for an interface such as a
91
+ toast-style message displayed by the host application.
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">Notification</span>
98
+ <span class="tsd-signature-symbol">{</span><br />    <a
99
+ class="tsd-kind-property"
100
+ href="#custom"
101
+ >custom</a
102
+ ><span class="tsd-signature-symbol">:</span>
103
+ <span class="tsd-signature-type">any</span
104
+ ><span class="tsd-signature-symbol">;</span><br />    <a
105
+ class="tsd-kind-property"
106
+ href="#message"
107
+ >message</a
108
+ ><span class="tsd-signature-symbol">:</span>
109
+ <span class="tsd-signature-type">string</span
110
+ ><span class="tsd-signature-symbol">;</span><br />    <a
111
+ class="tsd-kind-property"
112
+ href="#title"
113
+ >title</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/Notification.ts#L17"
127
+ >messages/Notification.ts:17</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="#custom" 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>custom</span></a
159
+ >
160
+ <a href="#message" 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>message</span></a
168
+ >
169
+ <a href="#title" 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>title?</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="custom">
200
+ <span>custom</span
201
+ ><a
202
+ href="#custom"
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">custom</span
211
+ ><span class="tsd-signature-symbol">:</span>
212
+ <span class="tsd-signature-type">any</span>
213
+ </div>
214
+ <div class="tsd-comment tsd-typography">
215
+ <p>Additional host-specific options such as severity</p>
216
+ </div>
217
+ <aside class="tsd-sources">
218
+ <ul>
219
+ <li>
220
+ Defined in
221
+ <a
222
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Notification.ts#L23"
223
+ >messages/Notification.ts:23</a
224
+ >
225
+ </li>
226
+ </ul>
227
+ </aside>
228
+ </section>
229
+ <section class="tsd-panel tsd-member">
230
+ <h3 class="tsd-anchor-link" id="message">
231
+ <span>message</span
232
+ ><a
233
+ href="#message"
234
+ aria-label="Permalink"
235
+ class="tsd-anchor-icon"
236
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
237
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
238
+ ></a>
239
+ </h3>
240
+ <div class="tsd-signature">
241
+ <span class="tsd-kind-property">message</span
242
+ ><span class="tsd-signature-symbol">:</span>
243
+ <span class="tsd-signature-type">string</span>
244
+ </div>
245
+ <div class="tsd-comment tsd-typography">
246
+ <p>The notification message</p>
247
+ </div>
248
+ <aside class="tsd-sources">
249
+ <ul>
250
+ <li>
251
+ Defined in
252
+ <a
253
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Notification.ts#L21"
254
+ >messages/Notification.ts:21</a
255
+ >
256
+ </li>
257
+ </ul>
258
+ </aside>
259
+ </section>
260
+ <section class="tsd-panel tsd-member">
261
+ <h3 class="tsd-anchor-link" id="title">
262
+ <code class="tsd-tag">Optional</code><span>title</span
263
+ ><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"
264
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
265
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
266
+ ></a>
267
+ </h3>
268
+ <div class="tsd-signature">
269
+ <span class="tsd-kind-property">title</span
270
+ ><span class="tsd-signature-symbol">?:</span>
271
+ <span class="tsd-signature-type">string</span>
272
+ </div>
273
+ <div class="tsd-comment tsd-typography">
274
+ <p>The title of the notification</p>
275
+ </div>
276
+ <aside class="tsd-sources">
277
+ <ul>
278
+ <li>
279
+ Defined in
280
+ <a
281
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/Notification.ts#L19"
282
+ >messages/Notification.ts:19</a
283
+ >
284
+ </li>
285
+ </ul>
286
+ </aside>
287
+ </section>
288
+ </section>
289
+ </details>
290
+ </div>
291
+ <div class="col-sidebar">
292
+ <div class="page-menu">
293
+ <div class="tsd-navigation settings">
294
+ <details class="tsd-accordion">
295
+ <summary class="tsd-accordion-summary">
296
+ <svg
297
+ width="20"
298
+ height="20"
299
+ viewBox="0 0 24 24"
300
+ fill="none"
301
+ aria-hidden="true"
302
+ >
303
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
304
+ </svg>
305
+ <h3>Settings</h3>
306
+ </summary>
307
+ <div class="tsd-accordion-details">
308
+ <div class="tsd-filter-visibility">
309
+ <span class="settings-label">Member Visibility</span>
310
+ <ul id="tsd-filter-options">
311
+ <li class="tsd-filter-item">
312
+ <label class="tsd-filter-input"
313
+ ><input
314
+ type="checkbox"
315
+ id="tsd-filter-inherited"
316
+ name="inherited"
317
+ checked
318
+ /><svg
319
+ width="32"
320
+ height="32"
321
+ viewBox="0 0 32 32"
322
+ aria-hidden="true"
323
+ >
324
+ <rect
325
+ class="tsd-checkbox-background"
326
+ width="30"
327
+ height="30"
328
+ x="1"
329
+ y="1"
330
+ rx="6"
331
+ fill="none"
332
+ ></rect>
333
+ <path
334
+ class="tsd-checkbox-checkmark"
335
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
336
+ stroke="none"
337
+ stroke-width="3.5"
338
+ stroke-linejoin="round"
339
+ fill="none"
340
+ ></path></svg
341
+ ><span>Inherited</span></label
342
+ >
343
+ </li>
344
+ </ul>
345
+ </div>
346
+ <div class="tsd-theme-toggle">
347
+ <label class="settings-label" for="tsd-theme">Theme</label
348
+ ><select id="tsd-theme">
349
+ <option value="os">OS</option>
350
+ <option value="light">Light</option>
351
+ <option value="dark">Dark</option>
352
+ </select>
353
+ </div>
354
+ </div>
355
+ </details>
356
+ </div>
357
+ <details open class="tsd-accordion tsd-page-navigation">
358
+ <summary class="tsd-accordion-summary">
359
+ <svg
360
+ width="20"
361
+ height="20"
362
+ viewBox="0 0 24 24"
363
+ fill="none"
364
+ aria-hidden="true"
365
+ >
366
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
367
+ </svg>
368
+ <h3>On This Page</h3>
369
+ </summary>
370
+ <div class="tsd-accordion-details">
371
+ <details open class="tsd-accordion tsd-page-navigation-section">
372
+ <summary
373
+ class="tsd-accordion-summary"
374
+ data-key="section-Properties"
375
+ >
376
+ <svg
377
+ width="20"
378
+ height="20"
379
+ viewBox="0 0 24 24"
380
+ fill="none"
381
+ aria-hidden="true"
382
+ >
383
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
384
+ >Properties
385
+ </summary>
386
+ <div>
387
+ <a href="#custom"
388
+ ><svg
389
+ class="tsd-kind-icon"
390
+ viewBox="0 0 24 24"
391
+ aria-label="Property"
392
+ >
393
+ <use href="../assets/icons.svg#icon-1024"></use></svg
394
+ ><span>custom</span></a
395
+ ><a href="#message"
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>message</span></a
403
+ ><a href="#title"
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>title</span></a
411
+ >
412
+ </div>
413
+ </details>
414
+ </div>
415
+ </details>
416
+ </div>
417
+ <div class="site-menu">
418
+ <nav class="tsd-navigation">
419
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
420
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
421
+ <li>Loading...</li>
422
+ </ul>
423
+ </nav>
424
+ </div>
425
+ </div>
426
+ </div>
427
+ <footer>
428
+ <p class="tsd-generator">
429
+ Generated using
430
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
431
+ </p>
432
+ </footer>
433
+ <div class="overlay"></div>
434
+ </body>
435
+ </html>