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