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,438 @@
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>PageMetadata | 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">PageMetadata</a></li>
84
+ </ul>
85
+ <h1>Interface PageMetadata</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography"><p>The Page metadata</p></div>
89
+ </section>
90
+ <div class="tsd-signature">
91
+ <span class="tsd-signature-keyword">interface</span>
92
+ <span class="tsd-kind-interface">PageMetadata</span>
93
+ <span class="tsd-signature-symbol">{</span><br />    <a
94
+ class="tsd-kind-property"
95
+ href="#breadcrumbs"
96
+ >breadcrumbs</a
97
+ ><span class="tsd-signature-symbol">:</span>
98
+ <a
99
+ href="messages.Breadcrumb.html"
100
+ class="tsd-signature-type tsd-kind-interface"
101
+ >Breadcrumb</a
102
+ ><span class="tsd-signature-symbol">[]</span
103
+ ><span class="tsd-signature-symbol">;</span><br />    <a
104
+ class="tsd-kind-property"
105
+ href="#custom"
106
+ >custom</a
107
+ ><span class="tsd-signature-symbol">?:</span>
108
+ <span class="tsd-signature-type">any</span
109
+ ><span class="tsd-signature-symbol">;</span><br />    <a
110
+ class="tsd-kind-property"
111
+ href="#title"
112
+ >title</a
113
+ ><span class="tsd-signature-symbol">:</span>
114
+ <span class="tsd-signature-type">string</span
115
+ ><span class="tsd-signature-symbol">;</span><br /><span
116
+ class="tsd-signature-symbol"
117
+ >}</span
118
+ >
119
+ </div>
120
+ <aside class="tsd-sources">
121
+ <ul>
122
+ <li>
123
+ Defined in
124
+ <a
125
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/PageMetadata.ts#L15"
126
+ >messages/PageMetadata.ts:15</a
127
+ >
128
+ </li>
129
+ </ul>
130
+ </aside>
131
+ <section class="tsd-panel-group tsd-index-group">
132
+ <section class="tsd-panel tsd-index-panel">
133
+ <details class="tsd-index-content tsd-accordion" open>
134
+ <summary class="tsd-accordion-summary tsd-index-summary">
135
+ <svg
136
+ width="20"
137
+ height="20"
138
+ viewBox="0 0 24 24"
139
+ fill="none"
140
+ aria-hidden="true"
141
+ >
142
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
143
+ </svg>
144
+ <h5 class="tsd-index-heading uppercase">Index</h5>
145
+ </summary>
146
+ <div class="tsd-accordion-details">
147
+ <section class="tsd-index-section">
148
+ <h3 class="tsd-index-heading">Properties</h3>
149
+ <div class="tsd-index-list">
150
+ <a href="#breadcrumbs" class="tsd-index-link"
151
+ ><svg
152
+ class="tsd-kind-icon"
153
+ viewBox="0 0 24 24"
154
+ aria-label="Property"
155
+ >
156
+ <use href="../assets/icons.svg#icon-1024"></use></svg
157
+ ><span>breadcrumbs</span></a
158
+ >
159
+ <a href="#custom" class="tsd-index-link"
160
+ ><svg
161
+ class="tsd-kind-icon"
162
+ viewBox="0 0 24 24"
163
+ aria-label="Property"
164
+ >
165
+ <use href="../assets/icons.svg#icon-1024"></use></svg
166
+ ><span>custom?</span></a
167
+ >
168
+ <a href="#title" class="tsd-index-link"
169
+ ><svg
170
+ class="tsd-kind-icon"
171
+ viewBox="0 0 24 24"
172
+ aria-label="Property"
173
+ >
174
+ <use href="../assets/icons.svg#icon-1024"></use></svg
175
+ ><span>title</span></a
176
+ >
177
+ </div>
178
+ </section>
179
+ </div>
180
+ </details>
181
+ </section>
182
+ </section>
183
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
184
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
185
+ <svg
186
+ width="20"
187
+ height="20"
188
+ viewBox="0 0 24 24"
189
+ fill="none"
190
+ aria-hidden="true"
191
+ >
192
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
193
+ </svg>
194
+ <h2>Properties</h2>
195
+ </summary>
196
+ <section>
197
+ <section class="tsd-panel tsd-member">
198
+ <h3 class="tsd-anchor-link" id="breadcrumbs">
199
+ <span>breadcrumbs</span
200
+ ><a
201
+ href="#breadcrumbs"
202
+ aria-label="Permalink"
203
+ class="tsd-anchor-icon"
204
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
205
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
206
+ ></a>
207
+ </h3>
208
+ <div class="tsd-signature">
209
+ <span class="tsd-kind-property">breadcrumbs</span
210
+ ><span class="tsd-signature-symbol">:</span>
211
+ <a
212
+ href="messages.Breadcrumb.html"
213
+ class="tsd-signature-type tsd-kind-interface"
214
+ >Breadcrumb</a
215
+ ><span class="tsd-signature-symbol">[]</span>
216
+ </div>
217
+ <div class="tsd-comment tsd-typography">
218
+ <p>Breadcrumbs that lead to page</p>
219
+ </div>
220
+ <aside class="tsd-sources">
221
+ <ul>
222
+ <li>
223
+ Defined in
224
+ <a
225
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/PageMetadata.ts#L19"
226
+ >messages/PageMetadata.ts:19</a
227
+ >
228
+ </li>
229
+ </ul>
230
+ </aside>
231
+ </section>
232
+ <section class="tsd-panel tsd-member">
233
+ <h3 class="tsd-anchor-link" id="custom">
234
+ <code class="tsd-tag">Optional</code><span>custom</span
235
+ ><a
236
+ href="#custom"
237
+ aria-label="Permalink"
238
+ class="tsd-anchor-icon"
239
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
240
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
241
+ ></a>
242
+ </h3>
243
+ <div class="tsd-signature">
244
+ <span class="tsd-kind-property">custom</span
245
+ ><span class="tsd-signature-symbol">?:</span>
246
+ <span class="tsd-signature-type">any</span>
247
+ </div>
248
+ <div class="tsd-comment tsd-typography">
249
+ <p>Holder for any custom data client wants to send for page</p>
250
+ </div>
251
+ <aside class="tsd-sources">
252
+ <ul>
253
+ <li>
254
+ Defined in
255
+ <a
256
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/PageMetadata.ts#L21"
257
+ >messages/PageMetadata.ts:21</a
258
+ >
259
+ </li>
260
+ </ul>
261
+ </aside>
262
+ </section>
263
+ <section class="tsd-panel tsd-member">
264
+ <h3 class="tsd-anchor-link" id="title">
265
+ <span>title</span
266
+ ><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"
267
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
268
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
269
+ ></a>
270
+ </h3>
271
+ <div class="tsd-signature">
272
+ <span class="tsd-kind-property">title</span
273
+ ><span class="tsd-signature-symbol">:</span>
274
+ <span class="tsd-signature-type">string</span>
275
+ </div>
276
+ <div class="tsd-comment tsd-typography">
277
+ <p>Title of the Page for the browser</p>
278
+ </div>
279
+ <aside class="tsd-sources">
280
+ <ul>
281
+ <li>
282
+ Defined in
283
+ <a
284
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/messages/PageMetadata.ts#L17"
285
+ >messages/PageMetadata.ts:17</a
286
+ >
287
+ </li>
288
+ </ul>
289
+ </aside>
290
+ </section>
291
+ </section>
292
+ </details>
293
+ </div>
294
+ <div class="col-sidebar">
295
+ <div class="page-menu">
296
+ <div class="tsd-navigation settings">
297
+ <details class="tsd-accordion">
298
+ <summary class="tsd-accordion-summary">
299
+ <svg
300
+ width="20"
301
+ height="20"
302
+ viewBox="0 0 24 24"
303
+ fill="none"
304
+ aria-hidden="true"
305
+ >
306
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
307
+ </svg>
308
+ <h3>Settings</h3>
309
+ </summary>
310
+ <div class="tsd-accordion-details">
311
+ <div class="tsd-filter-visibility">
312
+ <span class="settings-label">Member Visibility</span>
313
+ <ul id="tsd-filter-options">
314
+ <li class="tsd-filter-item">
315
+ <label class="tsd-filter-input"
316
+ ><input
317
+ type="checkbox"
318
+ id="tsd-filter-inherited"
319
+ name="inherited"
320
+ checked
321
+ /><svg
322
+ width="32"
323
+ height="32"
324
+ viewBox="0 0 32 32"
325
+ aria-hidden="true"
326
+ >
327
+ <rect
328
+ class="tsd-checkbox-background"
329
+ width="30"
330
+ height="30"
331
+ x="1"
332
+ y="1"
333
+ rx="6"
334
+ fill="none"
335
+ ></rect>
336
+ <path
337
+ class="tsd-checkbox-checkmark"
338
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
339
+ stroke="none"
340
+ stroke-width="3.5"
341
+ stroke-linejoin="round"
342
+ fill="none"
343
+ ></path></svg
344
+ ><span>Inherited</span></label
345
+ >
346
+ </li>
347
+ </ul>
348
+ </div>
349
+ <div class="tsd-theme-toggle">
350
+ <label class="settings-label" for="tsd-theme">Theme</label
351
+ ><select id="tsd-theme">
352
+ <option value="os">OS</option>
353
+ <option value="light">Light</option>
354
+ <option value="dark">Dark</option>
355
+ </select>
356
+ </div>
357
+ </div>
358
+ </details>
359
+ </div>
360
+ <details open class="tsd-accordion tsd-page-navigation">
361
+ <summary class="tsd-accordion-summary">
362
+ <svg
363
+ width="20"
364
+ height="20"
365
+ viewBox="0 0 24 24"
366
+ fill="none"
367
+ aria-hidden="true"
368
+ >
369
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
370
+ </svg>
371
+ <h3>On This Page</h3>
372
+ </summary>
373
+ <div class="tsd-accordion-details">
374
+ <details open class="tsd-accordion tsd-page-navigation-section">
375
+ <summary
376
+ class="tsd-accordion-summary"
377
+ data-key="section-Properties"
378
+ >
379
+ <svg
380
+ width="20"
381
+ height="20"
382
+ viewBox="0 0 24 24"
383
+ fill="none"
384
+ aria-hidden="true"
385
+ >
386
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
387
+ >Properties
388
+ </summary>
389
+ <div>
390
+ <a href="#breadcrumbs"
391
+ ><svg
392
+ class="tsd-kind-icon"
393
+ viewBox="0 0 24 24"
394
+ aria-label="Property"
395
+ >
396
+ <use href="../assets/icons.svg#icon-1024"></use></svg
397
+ ><span>breadcrumbs</span></a
398
+ ><a href="#custom"
399
+ ><svg
400
+ class="tsd-kind-icon"
401
+ viewBox="0 0 24 24"
402
+ aria-label="Property"
403
+ >
404
+ <use href="../assets/icons.svg#icon-1024"></use></svg
405
+ ><span>custom</span></a
406
+ ><a href="#title"
407
+ ><svg
408
+ class="tsd-kind-icon"
409
+ viewBox="0 0 24 24"
410
+ aria-label="Property"
411
+ >
412
+ <use href="../assets/icons.svg#icon-1024"></use></svg
413
+ ><span>title</span></a
414
+ >
415
+ </div>
416
+ </details>
417
+ </div>
418
+ </details>
419
+ </div>
420
+ <div class="site-menu">
421
+ <nav class="tsd-navigation">
422
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
423
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
424
+ <li>Loading...</li>
425
+ </ul>
426
+ </nav>
427
+ </div>
428
+ </div>
429
+ </div>
430
+ <footer>
431
+ <p class="tsd-generator">
432
+ Generated using
433
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
434
+ </p>
435
+ </footer>
436
+ <div class="overlay"></div>
437
+ </body>
438
+ </html>