@design.estate/wcctools 5.1.0 → 6.1.0

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 (262) hide show
  1. package/.smartconfig.json +7 -3
  2. package/changelog.md +28 -0
  3. package/cli.js +3 -0
  4. package/dist_shell/bundle.js +2970 -0
  5. package/dist_shell/bundle.js.map +1 -0
  6. package/dist_shell/bundle.js.third-party-notices.json +1722 -0
  7. package/dist_shell/bundle.js.third-party-notices.txt +4195 -0
  8. package/dist_shell/index.html +21 -0
  9. package/dist_ts/00_commitinfo_data.d.ts +8 -0
  10. package/dist_ts/00_commitinfo_data.js +9 -0
  11. package/dist_ts/classes.devapi.d.ts +11 -0
  12. package/dist_ts/classes.devapi.js +21 -0
  13. package/dist_ts/classes.devserver.d.ts +49 -0
  14. package/dist_ts/classes.devserver.js +142 -0
  15. package/dist_ts/cli.d.ts +6 -0
  16. package/dist_ts/cli.js +51 -0
  17. package/dist_ts/index.d.ts +3 -0
  18. package/dist_ts/index.js +4 -0
  19. package/dist_ts/paths.d.ts +4 -0
  20. package/dist_ts/paths.js +6 -0
  21. package/dist_ts/plugins.d.ts +20 -0
  22. package/dist_ts/plugins.js +27 -0
  23. package/dist_ts/shellcontent.d.ts +9 -0
  24. package/dist_ts/shellcontent.js +42 -0
  25. package/dist_ts/standards/baselines.d.ts +27 -0
  26. package/dist_ts/standards/baselines.js +83 -0
  27. package/dist_ts/standards/checker.d.ts +21 -0
  28. package/dist_ts/standards/checker.js +88 -0
  29. package/dist_ts/standards/classes.gitrepo.d.ts +13 -0
  30. package/dist_ts/standards/classes.gitrepo.js +43 -0
  31. package/dist_ts/standards/classes.sourceedits.d.ts +15 -0
  32. package/dist_ts/standards/classes.sourceedits.js +54 -0
  33. package/dist_ts/standards/classes.standardfixer.d.ts +40 -0
  34. package/dist_ts/standards/classes.standardfixer.js +210 -0
  35. package/dist_ts/standards/classes.standardproject.d.ts +80 -0
  36. package/dist_ts/standards/classes.standardproject.js +195 -0
  37. package/dist_ts/standards/classes.standardtree.d.ts +56 -0
  38. package/dist_ts/standards/classes.standardtree.js +207 -0
  39. package/dist_ts/standards/cli.d.ts +7 -0
  40. package/dist_ts/standards/cli.js +89 -0
  41. package/dist_ts/standards/config.d.ts +33 -0
  42. package/dist_ts/standards/config.js +139 -0
  43. package/dist_ts/standards/errors.d.ts +9 -0
  44. package/dist_ts/standards/errors.js +17 -0
  45. package/dist_ts/standards/helpers.ast.d.ts +56 -0
  46. package/dist_ts/standards/helpers.ast.js +172 -0
  47. package/dist_ts/standards/helpers.paths.d.ts +36 -0
  48. package/dist_ts/standards/helpers.paths.js +86 -0
  49. package/dist_ts/standards/index.d.ts +14 -0
  50. package/dist_ts/standards/index.js +15 -0
  51. package/dist_ts/standards/output.d.ts +7 -0
  52. package/dist_ts/standards/output.js +57 -0
  53. package/dist_ts/standards/ratchet.d.ts +15 -0
  54. package/dist_ts/standards/ratchet.js +45 -0
  55. package/dist_ts/standards/rule.d.ts +50 -0
  56. package/dist_ts/standards/rule.js +9 -0
  57. package/dist_ts/standards/rules/barrel.element-index.d.ts +7 -0
  58. package/dist_ts/standards/rules/barrel.element-index.js +108 -0
  59. package/dist_ts/standards/rules/barrel.no-demo-export.d.ts +3 -0
  60. package/dist_ts/standards/rules/barrel.no-demo-export.js +29 -0
  61. package/dist_ts/standards/rules/demo.fixture-not-exported.d.ts +3 -0
  62. package/dist_ts/standards/rules/demo.fixture-not-exported.js +29 -0
  63. package/dist_ts/standards/rules/demo.groups.d.ts +6 -0
  64. package/dist_ts/standards/rules/demo.groups.js +72 -0
  65. package/dist_ts/standards/rules/demo.required.d.ts +3 -0
  66. package/dist_ts/standards/rules/demo.required.js +48 -0
  67. package/dist_ts/standards/rules/demo.separate-file.d.ts +3 -0
  68. package/dist_ts/standards/rules/demo.separate-file.js +38 -0
  69. package/dist_ts/standards/rules/demo.shape.d.ts +3 -0
  70. package/dist_ts/standards/rules/demo.shape.js +38 -0
  71. package/dist_ts/standards/rules/docs.component-index.d.ts +8 -0
  72. package/dist_ts/standards/rules/docs.component-index.js +84 -0
  73. package/dist_ts/standards/rules/element.exported.d.ts +3 -0
  74. package/dist_ts/standards/rules/element.exported.js +33 -0
  75. package/dist_ts/standards/rules/element.literal-tag.d.ts +3 -0
  76. package/dist_ts/standards/rules/element.literal-tag.js +30 -0
  77. package/dist_ts/standards/rules/element.reachable.d.ts +3 -0
  78. package/dist_ts/standards/rules/element.reachable.js +48 -0
  79. package/dist_ts/standards/rules/element.tag-map.d.ts +3 -0
  80. package/dist_ts/standards/rules/element.tag-map.js +83 -0
  81. package/dist_ts/standards/rules/i18n.literals.d.ts +3 -0
  82. package/dist_ts/standards/rules/i18n.literals.js +52 -0
  83. package/dist_ts/standards/rules/index.d.ts +12 -0
  84. package/dist_ts/standards/rules/index.js +83 -0
  85. package/dist_ts/standards/rules/layout.element-folder.d.ts +3 -0
  86. package/dist_ts/standards/rules/layout.element-folder.js +47 -0
  87. package/dist_ts/standards/rules/layout.entry-file-name.d.ts +3 -0
  88. package/dist_ts/standards/rules/layout.entry-file-name.js +71 -0
  89. package/dist_ts/standards/rules/layout.entry.d.ts +3 -0
  90. package/dist_ts/standards/rules/layout.entry.js +38 -0
  91. package/dist_ts/standards/rules/layout.group-folder.d.ts +3 -0
  92. package/dist_ts/standards/rules/layout.group-folder.js +22 -0
  93. package/dist_ts/standards/rules/layout.shared-00.d.ts +3 -0
  94. package/dist_ts/standards/rules/layout.shared-00.js +36 -0
  95. package/dist_ts/standards/rules/naming.class-matches-tag.d.ts +3 -0
  96. package/dist_ts/standards/rules/naming.class-matches-tag.js +26 -0
  97. package/dist_ts/standards/rules/naming.lowercase-files.d.ts +3 -0
  98. package/dist_ts/standards/rules/naming.lowercase-files.js +26 -0
  99. package/dist_ts/standards/rules/naming.tag-prefix.d.ts +3 -0
  100. package/dist_ts/standards/rules/naming.tag-prefix.js +23 -0
  101. package/dist_ts/standards/rules/props.accessor.d.ts +3 -0
  102. package/dist_ts/standards/rules/props.accessor.js +35 -0
  103. package/dist_ts/standards/rules/props.object-no-attribute.d.ts +3 -0
  104. package/dist_ts/standards/rules/props.object-no-attribute.js +42 -0
  105. package/dist_ts/standards/rules/props.reflect-primitive.d.ts +5 -0
  106. package/dist_ts/standards/rules/props.reflect-primitive.js +41 -0
  107. package/dist_ts/standards/rules/props.typed.d.ts +6 -0
  108. package/dist_ts/standards/rules/props.typed.js +64 -0
  109. package/dist_ts/standards/rules/shared.d.ts +38 -0
  110. package/dist_ts/standards/rules/shared.js +103 -0
  111. package/dist_ts/standards/rules/style.bdtheme.d.ts +5 -0
  112. package/dist_ts/standards/rules/style.bdtheme.js +28 -0
  113. package/dist_ts_interfaces/bridge.d.ts +88 -0
  114. package/dist_ts_interfaces/bridge.js +2 -0
  115. package/dist_ts_interfaces/catalog.d.ts +32 -0
  116. package/dist_ts_interfaces/catalog.js +6 -0
  117. package/dist_ts_interfaces/index.d.ts +4 -0
  118. package/dist_ts_interfaces/index.js +5 -0
  119. package/dist_ts_interfaces/plugins.d.ts +2 -0
  120. package/dist_ts_interfaces/plugins.js +3 -0
  121. package/dist_ts_interfaces/requests.d.ts +15 -0
  122. package/dist_ts_interfaces/requests.js +2 -0
  123. package/dist_ts_interfaces/standard.d.ts +93 -0
  124. package/dist_ts_interfaces/standard.js +6 -0
  125. package/dist_ts_shared/index.d.ts +1 -0
  126. package/dist_ts_shared/index.js +2 -0
  127. package/dist_ts_shared/plugins.d.ts +2 -0
  128. package/dist_ts_shared/plugins.js +3 -0
  129. package/dist_ts_shared/previewroute.d.ts +18 -0
  130. package/dist_ts_shared/previewroute.js +47 -0
  131. package/{dist_ts_web → dist_ts_shell}/elements/wcc-contextmenu.js +1 -1
  132. package/dist_ts_shell/elements/wcc-preview-frame.d.ts +23 -0
  133. package/dist_ts_shell/elements/wcc-preview-frame.js +197 -0
  134. package/dist_ts_shell/elements/wcc-properties.d.ts +49 -0
  135. package/{dist_ts_web → dist_ts_shell}/elements/wcc-properties.js +149 -216
  136. package/{dist_ts_web → dist_ts_shell}/elements/wcc-record-button.js +1 -1
  137. package/{dist_ts_web → dist_ts_shell}/elements/wcc-recording-panel.d.ts +2 -2
  138. package/{dist_ts_web → dist_ts_shell}/elements/wcc-recording-panel.js +12 -16
  139. package/dist_ts_shell/elements/wcc-shell.d.ts +87 -0
  140. package/dist_ts_shell/elements/wcc-shell.js +524 -0
  141. package/{dist_ts_web → dist_ts_shell}/elements/wcc-sidebar.d.ts +12 -10
  142. package/{dist_ts_web → dist_ts_shell}/elements/wcc-sidebar.js +137 -183
  143. package/dist_ts_shell/index.d.ts +4 -0
  144. package/dist_ts_shell/index.js +5 -0
  145. package/dist_ts_shell/plugins.d.ts +4 -0
  146. package/dist_ts_shell/plugins.js +5 -0
  147. package/dist_ts_shell/previewconnection.d.ts +30 -0
  148. package/dist_ts_shell/previewconnection.js +86 -0
  149. package/dist_ts_shell/services/recorder.service.js +353 -0
  150. package/dist_ts_web/00_commitinfo_data.js +2 -2
  151. package/dist_ts_web/catalog.d.ts +45 -0
  152. package/dist_ts_web/catalog.js +153 -0
  153. package/dist_ts_web/elementproperties.d.ts +15 -0
  154. package/dist_ts_web/elementproperties.js +89 -0
  155. package/dist_ts_web/elements/wcc-preview.d.ts +19 -0
  156. package/dist_ts_web/elements/wcc-preview.js +164 -0
  157. package/dist_ts_web/elements/wcc-standalone-notice.d.ts +14 -0
  158. package/dist_ts_web/elements/wcc-standalone-notice.js +110 -0
  159. package/dist_ts_web/elements/wcctools.helpers.d.ts +2 -6
  160. package/dist_ts_web/elements/wcctools.helpers.js +1 -7
  161. package/dist_ts_web/index.d.ts +2 -5
  162. package/dist_ts_web/index.js +38 -17
  163. package/dist_ts_web/previewbridge.d.ts +39 -0
  164. package/dist_ts_web/previewbridge.js +153 -0
  165. package/dist_ts_web/renderedtree.d.ts +5 -0
  166. package/dist_ts_web/renderedtree.js +37 -0
  167. package/dist_ts_web/wcctools.interfaces.d.ts +3 -6
  168. package/dist_ts_web/wcctools.interfaces.js +1 -1
  169. package/dist_ts_web/wcctools.plugins.d.ts +3 -1
  170. package/dist_ts_web/wcctools.plugins.js +4 -2
  171. package/package.json +17 -7
  172. package/readme.md +93 -28
  173. package/ts/00_commitinfo_data.ts +8 -0
  174. package/ts/classes.devapi.ts +25 -0
  175. package/ts/classes.devserver.ts +161 -0
  176. package/ts/cli.ts +53 -0
  177. package/ts/index.ts +3 -0
  178. package/ts/paths.ts +7 -0
  179. package/ts/plugins.ts +37 -0
  180. package/ts/shellcontent.ts +42 -0
  181. package/ts/standards/baselines.ts +100 -0
  182. package/ts/standards/checker.ts +114 -0
  183. package/ts/standards/classes.gitrepo.ts +48 -0
  184. package/ts/standards/classes.sourceedits.ts +58 -0
  185. package/ts/standards/classes.standardfixer.ts +234 -0
  186. package/ts/standards/classes.standardproject.ts +250 -0
  187. package/ts/standards/classes.standardtree.ts +220 -0
  188. package/ts/standards/cli.ts +86 -0
  189. package/ts/standards/config.ts +160 -0
  190. package/ts/standards/errors.ts +18 -0
  191. package/ts/standards/helpers.ast.ts +208 -0
  192. package/ts/standards/helpers.paths.ts +119 -0
  193. package/ts/standards/index.ts +22 -0
  194. package/ts/standards/output.ts +65 -0
  195. package/ts/standards/ratchet.ts +63 -0
  196. package/ts/standards/rule.ts +58 -0
  197. package/ts/standards/rules/barrel.element-index.ts +112 -0
  198. package/ts/standards/rules/barrel.no-demo-export.ts +30 -0
  199. package/ts/standards/rules/demo.fixture-not-exported.ts +30 -0
  200. package/ts/standards/rules/demo.groups.ts +74 -0
  201. package/ts/standards/rules/demo.required.ts +49 -0
  202. package/ts/standards/rules/demo.separate-file.ts +40 -0
  203. package/ts/standards/rules/demo.shape.ts +42 -0
  204. package/ts/standards/rules/docs.component-index.ts +88 -0
  205. package/ts/standards/rules/element.exported.ts +35 -0
  206. package/ts/standards/rules/element.literal-tag.ts +30 -0
  207. package/ts/standards/rules/element.reachable.ts +49 -0
  208. package/ts/standards/rules/element.tag-map.ts +87 -0
  209. package/ts/standards/rules/i18n.literals.ts +58 -0
  210. package/ts/standards/rules/index.ts +87 -0
  211. package/ts/standards/rules/layout.element-folder.ts +49 -0
  212. package/ts/standards/rules/layout.entry-file-name.ts +73 -0
  213. package/ts/standards/rules/layout.entry.ts +40 -0
  214. package/ts/standards/rules/layout.group-folder.ts +23 -0
  215. package/ts/standards/rules/layout.shared-00.ts +37 -0
  216. package/ts/standards/rules/naming.class-matches-tag.ts +27 -0
  217. package/ts/standards/rules/naming.lowercase-files.ts +27 -0
  218. package/ts/standards/rules/naming.tag-prefix.ts +24 -0
  219. package/ts/standards/rules/props.accessor.ts +37 -0
  220. package/ts/standards/rules/props.object-no-attribute.ts +45 -0
  221. package/ts/standards/rules/props.reflect-primitive.ts +44 -0
  222. package/ts/standards/rules/props.typed.ts +70 -0
  223. package/ts/standards/rules/shared.ts +127 -0
  224. package/ts/standards/rules/style.bdtheme.ts +31 -0
  225. package/ts_web/00_commitinfo_data.ts +1 -1
  226. package/ts_web/catalog.ts +194 -0
  227. package/ts_web/elementproperties.ts +96 -0
  228. package/ts_web/elements/wcc-preview.ts +111 -0
  229. package/ts_web/elements/wcc-standalone-notice.ts +65 -0
  230. package/ts_web/elements/wcctools.helpers.ts +2 -10
  231. package/ts_web/index.ts +38 -19
  232. package/ts_web/previewbridge.ts +189 -0
  233. package/ts_web/readme.md +26 -85
  234. package/ts_web/renderedtree.ts +43 -0
  235. package/ts_web/wcctools.interfaces.ts +4 -7
  236. package/ts_web/wcctools.plugins.ts +6 -1
  237. package/dist_bundle/bundle.js +0 -92419
  238. package/dist_bundle/bundle.js.map +0 -1
  239. package/dist_ts_web/elements/wcc-dashboard.d.ts +0 -119
  240. package/dist_ts_web/elements/wcc-dashboard.js +0 -700
  241. package/dist_ts_web/elements/wcc-frame.d.ts +0 -22
  242. package/dist_ts_web/elements/wcc-frame.js +0 -256
  243. package/dist_ts_web/elements/wcc-properties.d.ts +0 -43
  244. package/dist_ts_web/pages/index.d.ts +0 -1
  245. package/dist_ts_web/pages/index.js +0 -2
  246. package/dist_ts_web/services/recorder.service.js +0 -353
  247. package/ts_web/elements/wcc-contextmenu.ts +0 -291
  248. package/ts_web/elements/wcc-dashboard.ts +0 -672
  249. package/ts_web/elements/wcc-frame.ts +0 -189
  250. package/ts_web/elements/wcc-properties.ts +0 -1089
  251. package/ts_web/elements/wcc-record-button.ts +0 -108
  252. package/ts_web/elements/wcc-recording-panel.ts +0 -1010
  253. package/ts_web/elements/wcc-sidebar.ts +0 -1470
  254. package/ts_web/pages/index.ts +0 -1
  255. package/ts_web/services/recorder.service.ts +0 -451
  256. package/ts_web/types/dom-mediacapture-stub/index.d.ts +0 -12
  257. package/ts_web/types/dom-mediacapture-stub/package.json +0 -6
  258. package/ts_web/types/dom-webcodecs-stub/index.d.ts +0 -2
  259. package/ts_web/types/dom-webcodecs-stub/package.json +0 -6
  260. /package/{dist_ts_web → dist_ts_shell}/elements/wcc-contextmenu.d.ts +0 -0
  261. /package/{dist_ts_web → dist_ts_shell}/elements/wcc-record-button.d.ts +0 -0
  262. /package/{dist_ts_web → dist_ts_shell}/services/recorder.service.d.ts +0 -0
@@ -1,10 +1,7 @@
1
1
  import type { IWccConfig } from './wcctools.interfaces.js';
2
- export { RecorderService, type IRecorderEvents, type IRecordingOptions, type TOutputFormat } from './services/recorder.service.js';
3
- export { WccRecordButton } from './elements/wcc-record-button.js';
4
- export { WccRecordingPanel } from './elements/wcc-recording-panel.js';
5
2
  export type { IWccConfig, IWccSection } from './wcctools.interfaces.js';
6
3
  /**
7
- * Set up the WCC Tools dashboard:
4
+ * Set up the catalog's preview document:
8
5
  * ```typescript
9
6
  * setupWccTools({
10
7
  * sections: [
@@ -14,5 +11,5 @@ export type { IWccConfig, IWccSection } from './wcctools.interfaces.js';
14
11
  * });
15
12
  * ```
16
13
  */
17
- declare const setupWccTools: (config: IWccConfig) => void;
14
+ declare const setupWccTools: (configArg: IWccConfig) => void;
18
15
  export { setupWccTools };
@@ -1,10 +1,30 @@
1
- import { WccDashboard } from './elements/wcc-dashboard.js';
2
- // Export recording components and service
3
- export { RecorderService } from './services/recorder.service.js';
4
- export { WccRecordButton } from './elements/wcc-record-button.js';
5
- export { WccRecordingPanel } from './elements/wcc-recording-panel.js';
1
+ import * as plugins from './wcctools.plugins.js';
2
+ import { WccCatalog } from './catalog.js';
3
+ import { WccPreview } from './elements/wcc-preview.js';
4
+ import { WccStandaloneNotice } from './elements/wcc-standalone-notice.js';
5
+ import { WccPreviewBridge } from './previewbridge.js';
6
6
  /**
7
- * Set up the WCC Tools dashboard:
7
+ * Start the preview document of a catalog. `wcctools dev` loads this document into the shell's
8
+ * preview frame; opened on the preview route it renders the one demo the route names.
9
+ * Opened anywhere else it shows how to start the catalog.
10
+ */
11
+ const startPreview = async (configArg) => {
12
+ const isFramed = window.parent !== window;
13
+ if (!isFramed && window.location.pathname !== plugins.shared.previewRoutePath) {
14
+ document.body.append(new WccStandaloneNotice());
15
+ return;
16
+ }
17
+ const preview = new WccPreview();
18
+ document.body.append(preview);
19
+ const bridge = new WccPreviewBridge(new WccCatalog(configArg), preview);
20
+ await bridge.renderRoute(plugins.shared.parsePreviewQuery(window.location.search));
21
+ window.wccPreview = bridge;
22
+ if (isFramed) {
23
+ window.parent.postMessage(plugins.shared.previewReadyMessage, window.location.origin);
24
+ }
25
+ };
26
+ /**
27
+ * Set up the catalog's preview document:
8
28
  * ```typescript
9
29
  * setupWccTools({
10
30
  * sections: [
@@ -14,17 +34,18 @@ export { WccRecordingPanel } from './elements/wcc-recording-panel.js';
14
34
  * });
15
35
  * ```
16
36
  */
17
- const setupWccTools = (config) => {
18
- let hasRun = false;
19
- const runWccToolsSetup = async () => {
20
- if (document.readyState === 'complete' && !hasRun) {
21
- hasRun = true;
22
- const wccTools = new WccDashboard(config);
23
- document.querySelector('body').append(wccTools);
24
- }
37
+ const setupWccTools = (configArg) => {
38
+ const start = () => {
39
+ startPreview(configArg).catch((error) => {
40
+ console.error('wcctools: the preview failed to start', error);
41
+ });
25
42
  };
26
- document.addEventListener('readystatechange', runWccToolsSetup);
27
- runWccToolsSetup();
43
+ if (document.readyState === 'complete') {
44
+ start();
45
+ }
46
+ else {
47
+ window.addEventListener('load', start, { once: true });
48
+ }
28
49
  };
29
50
  export { setupWccTools };
30
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90c193ZWIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBRzNELDBDQUEwQztBQUMxQyxPQUFPLEVBQUUsZUFBZSxFQUFvRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ25JLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUNsRSxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSxtQ0FBbUMsQ0FBQztBQUt0RTs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBTSxhQUFhLEdBQUcsQ0FBQyxNQUFrQixFQUFFLEVBQUU7SUFDM0MsSUFBSSxNQUFNLEdBQUcsS0FBSyxDQUFDO0lBQ25CLE1BQU0sZ0JBQWdCLEdBQUcsS0FBSyxJQUFJLEVBQUU7UUFDbEMsSUFBSSxRQUFRLENBQUMsVUFBVSxLQUFLLFVBQVUsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ2xELE1BQU0sR0FBRyxJQUFJLENBQUM7WUFDZCxNQUFNLFFBQVEsR0FBRyxJQUFJLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUMxQyxRQUFRLENBQUMsYUFBYSxDQUFDLE1BQU0sQ0FBQyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUNsRCxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBQ0YsUUFBUSxDQUFDLGdCQUFnQixDQUFDLGtCQUFrQixFQUFFLGdCQUFnQixDQUFDLENBQUM7SUFDaEUsZ0JBQWdCLEVBQUUsQ0FBQztBQUNyQixDQUFDLENBQUM7QUFFRixPQUFPLEVBQ0wsYUFBYSxFQUNkLENBQUMifQ==
51
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c193ZWIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSx1QkFBdUIsQ0FBQztBQUNqRCxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBQzFDLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSwyQkFBMkIsQ0FBQztBQUN2RCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxxQ0FBcUMsQ0FBQztBQUMxRSxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUt0RDs7OztHQUlHO0FBQ0gsTUFBTSxZQUFZLEdBQUcsS0FBSyxFQUFFLFNBQXFCLEVBQUUsRUFBRTtJQUNuRCxNQUFNLFFBQVEsR0FBRyxNQUFNLENBQUMsTUFBTSxLQUFLLE1BQU0sQ0FBQztJQUMxQyxJQUFJLENBQUMsUUFBUSxJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsUUFBUSxLQUFLLE9BQU8sQ0FBQyxNQUFNLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQztRQUM5RSxRQUFRLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLG1CQUFtQixFQUFFLENBQUMsQ0FBQztRQUNoRCxPQUFPO0lBQ1QsQ0FBQztJQUNELE1BQU0sT0FBTyxHQUFHLElBQUksVUFBVSxFQUFFLENBQUM7SUFDakMsUUFBUSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDOUIsTUFBTSxNQUFNLEdBQUcsSUFBSSxnQkFBZ0IsQ0FBQyxJQUFJLFVBQVUsQ0FBQyxTQUFTLENBQUMsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUN4RSxNQUFNLE1BQU0sQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxpQkFBaUIsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFDbkYsTUFBTSxDQUFDLFVBQVUsR0FBRyxNQUFNLENBQUM7SUFDM0IsSUFBSSxRQUFRLEVBQUUsQ0FBQztRQUNiLE1BQU0sQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsbUJBQW1CLEVBQUUsTUFBTSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN4RixDQUFDO0FBQ0gsQ0FBQyxDQUFDO0FBRUY7Ozs7Ozs7Ozs7R0FVRztBQUNILE1BQU0sYUFBYSxHQUFHLENBQUMsU0FBcUIsRUFBRSxFQUFFO0lBQzlDLE1BQU0sS0FBSyxHQUFHLEdBQUcsRUFBRTtRQUNqQixZQUFZLENBQUMsU0FBUyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsS0FBSyxFQUFFLEVBQUU7WUFDdEMsT0FBTyxDQUFDLEtBQUssQ0FBQyx1Q0FBdUMsRUFBRSxLQUFLLENBQUMsQ0FBQztRQUNoRSxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUMsQ0FBQztJQUNGLElBQUksUUFBUSxDQUFDLFVBQVUsS0FBSyxVQUFVLEVBQUUsQ0FBQztRQUN2QyxLQUFLLEVBQUUsQ0FBQztJQUNWLENBQUM7U0FBTSxDQUFDO1FBQ04sTUFBTSxDQUFDLGdCQUFnQixDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztJQUN6RCxDQUFDO0FBQ0gsQ0FBQyxDQUFDO0FBRUYsT0FBTyxFQUNMLGFBQWEsRUFDZCxDQUFDIn0=
@@ -0,0 +1,39 @@
1
+ import * as plugins from './wcctools.plugins.js';
2
+ import type { WccCatalog } from './catalog.js';
3
+ import type { WccPreview } from './elements/wcc-preview.js';
4
+ type TPreviewEvent = plugins.interfaces.TWccPreviewEvent;
5
+ /**
6
+ * The preview document's side of the shell bridge: renders the catalog's demos and pages into
7
+ * the preview surface, switches its theme and reads and edits the rendered element's properties.
8
+ */
9
+ export declare class WccPreviewBridge implements plugins.interfaces.IWccPreviewBridge {
10
+ private readonly catalog;
11
+ private readonly preview;
12
+ private readonly listeners;
13
+ private theme;
14
+ private rendered;
15
+ private renderGeneration;
16
+ /** Settles when the latest render, including its elements' first updates, has finished. */
17
+ private renderPromise;
18
+ constructor(catalog: WccCatalog, preview: WccPreview);
19
+ getManifest(): plugins.interfaces.IWccCatalogManifest;
20
+ getSelection(): plugins.interfaces.IWccSelection | null;
21
+ getTheme(): plugins.interfaces.TWccTheme;
22
+ /** Render the preview route the document was loaded with. */
23
+ renderRoute(routeArg: plugins.shared.IWccPreviewRoute): Promise<void>;
24
+ render(selectionArg: plugins.interfaces.IWccSelection): Promise<plugins.interfaces.TWccRenderOutcome>;
25
+ setTheme(themeArg: plugins.interfaces.TWccTheme): Promise<void>;
26
+ getProperties(): Promise<plugins.interfaces.TWccPropertyListing>;
27
+ setProperty(nameArg: string, valueArg: plugins.interfaces.TWccPropertyScalar): plugins.interfaces.TWccPropertyEditResult;
28
+ setPropertyJson(nameArg: string, jsonArg: string): plugins.interfaces.TWccPropertyEditResult;
29
+ findRenderedInstance(): HTMLElement | null;
30
+ subscribe(listenerArg: (eventArg: TPreviewEvent) => void): () => void;
31
+ private getRenderedProperties;
32
+ private renderSelection;
33
+ private renderTarget;
34
+ private showEmptyState;
35
+ /** Keep the document's URL on what it shows, so a live reload comes back to it. */
36
+ private writeRoute;
37
+ private emit;
38
+ }
39
+ export {};
@@ -0,0 +1,153 @@
1
+ import { html, render } from '@design.estate/dees-element';
2
+ import * as plugins from './wcctools.plugins.js';
3
+ import { WccElementProperties } from './elementproperties.js';
4
+ import { findElementInstance, resolveTemplateFactory } from './elements/wcctools.helpers.js';
5
+ import { waitForRenderedTree } from './renderedtree.js';
6
+ /**
7
+ * The preview document's side of the shell bridge: renders the catalog's demos and pages into
8
+ * the preview surface, switches its theme and reads and edits the rendered element's properties.
9
+ */
10
+ export class WccPreviewBridge {
11
+ catalog;
12
+ preview;
13
+ listeners = new Set();
14
+ theme = 'dark';
15
+ rendered = null;
16
+ renderGeneration = 0;
17
+ /** Settles when the latest render, including its elements' first updates, has finished. */
18
+ renderPromise = Promise.resolve();
19
+ constructor(catalog, preview) {
20
+ this.catalog = catalog;
21
+ this.preview = preview;
22
+ }
23
+ getManifest() {
24
+ return this.catalog.getManifest();
25
+ }
26
+ getSelection() {
27
+ return this.rendered?.selection ? { ...this.rendered.selection } : null;
28
+ }
29
+ getTheme() {
30
+ return this.theme;
31
+ }
32
+ /** Render the preview route the document was loaded with. */
33
+ async renderRoute(routeArg) {
34
+ await this.setTheme(routeArg.theme);
35
+ await this.renderSelection(routeArg.selection);
36
+ }
37
+ async render(selectionArg) {
38
+ const { sectionName, itemName, demoIndex } = selectionArg;
39
+ return this.renderSelection({ sectionName, itemName, demoIndex });
40
+ }
41
+ async setTheme(themeArg) {
42
+ this.theme = themeArg === 'bright' ? 'bright' : 'dark';
43
+ const domtools = await plugins.deesDomtools.elementBasic.setup();
44
+ this.theme === 'bright' ? domtools.themeManager.goBright() : domtools.themeManager.goDark();
45
+ this.writeRoute();
46
+ }
47
+ async getProperties() {
48
+ await this.renderPromise;
49
+ const rendered = this.rendered;
50
+ if (!rendered?.selection || rendered.outcome.kind !== 'rendered') {
51
+ return { kind: 'unavailable', reason: 'Nothing is rendered.' };
52
+ }
53
+ if (rendered.outcome.type === 'page') {
54
+ return { kind: 'unavailable', reason: 'You selected a page.' };
55
+ }
56
+ const instance = this.findRenderedInstance();
57
+ if (!instance) {
58
+ return { kind: 'unavailable', reason: `The demo of ${rendered.selection.itemName} renders no <${customElements.getName(rendered.elementClass) ?? rendered.selection.itemName}> instance.` };
59
+ }
60
+ const properties = new WccElementProperties(rendered.elementClass, instance).describe();
61
+ if (!properties) {
62
+ return { kind: 'unavailable', reason: `${rendered.selection.itemName} does not expose element properties.` };
63
+ }
64
+ return { kind: 'properties', elementName: rendered.selection.itemName, properties };
65
+ }
66
+ setProperty(nameArg, valueArg) {
67
+ const properties = this.getRenderedProperties();
68
+ return properties ? properties.set(nameArg, valueArg) : { ok: false, error: 'No element is rendered.' };
69
+ }
70
+ setPropertyJson(nameArg, jsonArg) {
71
+ const properties = this.getRenderedProperties();
72
+ return properties ? properties.setJson(nameArg, jsonArg) : { ok: false, error: 'No element is rendered.' };
73
+ }
74
+ findRenderedInstance() {
75
+ const elementClass = this.rendered?.elementClass;
76
+ const viewport = this.preview.shadowRoot?.querySelector('.viewport');
77
+ if (!elementClass || !viewport) {
78
+ return null;
79
+ }
80
+ return findElementInstance(viewport, elementClass);
81
+ }
82
+ subscribe(listenerArg) {
83
+ this.listeners.add(listenerArg);
84
+ return () => {
85
+ this.listeners.delete(listenerArg);
86
+ };
87
+ }
88
+ getRenderedProperties() {
89
+ const instance = this.findRenderedInstance();
90
+ return instance ? new WccElementProperties(this.rendered.elementClass, instance) : null;
91
+ }
92
+ async renderSelection(selectionArg) {
93
+ const generation = ++this.renderGeneration;
94
+ const target = this.catalog.resolve(selectionArg);
95
+ const renderPromise = this.renderTarget(target, selectionArg?.itemName ?? '', generation);
96
+ this.renderPromise = renderPromise.catch(() => undefined);
97
+ const outcome = await renderPromise;
98
+ if (generation === this.renderGeneration) {
99
+ this.rendered = {
100
+ selection: selectionArg ? { ...selectionArg } : null,
101
+ elementClass: target.kind === 'element' ? target.elementClass : null,
102
+ outcome,
103
+ };
104
+ this.writeRoute();
105
+ this.emit({ type: 'rendered', selection: this.getSelection(), outcome });
106
+ }
107
+ return outcome;
108
+ }
109
+ async renderTarget(targetArg, itemNameArg, generationArg) {
110
+ const viewport = await this.preview.getViewportElement();
111
+ if (targetArg.kind === 'empty') {
112
+ this.showEmptyState(viewport, targetArg.emptyState, generationArg);
113
+ return { kind: 'empty', reason: targetArg.reason, emptyState: targetArg.emptyState };
114
+ }
115
+ try {
116
+ const template = await resolveTemplateFactory(targetArg.factory);
117
+ if (generationArg !== this.renderGeneration) {
118
+ return { kind: 'rendered', type: targetArg.kind };
119
+ }
120
+ render(template, viewport);
121
+ this.preview.emptyState = null;
122
+ await waitForRenderedTree(viewport);
123
+ return { kind: 'rendered', type: targetArg.kind };
124
+ }
125
+ catch (error) {
126
+ console.error(`wcctools: rendering "${itemNameArg}" failed`, error);
127
+ const emptyState = {
128
+ title: `${itemNameArg} failed to render`,
129
+ detail: error instanceof Error ? error.message : String(error),
130
+ };
131
+ this.showEmptyState(viewport, emptyState, generationArg);
132
+ return { kind: 'empty', reason: 'failed', emptyState };
133
+ }
134
+ }
135
+ showEmptyState(viewportArg, emptyStateArg, generationArg) {
136
+ if (generationArg !== this.renderGeneration) {
137
+ return;
138
+ }
139
+ render(html ``, viewportArg);
140
+ this.preview.emptyState = emptyStateArg;
141
+ }
142
+ /** Keep the document's URL on what it shows, so a live reload comes back to it. */
143
+ writeRoute() {
144
+ const query = plugins.shared.formatPreviewQuery({ selection: this.rendered?.selection ?? null, theme: this.theme });
145
+ window.history.replaceState(window.history.state, '', `${window.location.pathname}${query}`);
146
+ }
147
+ emit(eventArg) {
148
+ for (const listener of this.listeners) {
149
+ listener(eventArg);
150
+ }
151
+ }
152
+ }
153
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"previewbridge.js","sourceRoot":"","sources":["../../ts_web/previewbridge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAEjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAmC,MAAM,gCAAgC,CAAC;AAE9H,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAWxD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IASR;IACA;IATF,SAAS,GAAG,IAAI,GAAG,EAAqC,CAAC;IAClE,KAAK,GAAiC,MAAM,CAAC;IAC7C,QAAQ,GAA0B,IAAI,CAAC;IACvC,gBAAgB,GAAG,CAAC,CAAC;IAC7B,2FAA2F;IACnF,aAAa,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE5D,YACmB,OAAmB,EACnB,OAAmB;QADnB,YAAO,GAAP,OAAO,CAAY;QACnB,YAAO,GAAP,OAAO,CAAY;IACnC,CAAC;IAEG,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1E,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,6DAA6D;IACtD,KAAK,CAAC,WAAW,CAAC,QAAyC;QAChE,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,YAA8C;QAChE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC;QAC1D,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,QAAsC;QAC1D,IAAI,CAAC,KAAK,GAAG,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QACjE,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAC5F,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,aAAa;QACxB,MAAM,IAAI,CAAC,aAAa,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,SAAS,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACjE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC;QACjE,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACrC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC;QACjE,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC7C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,QAAQ,CAAC,SAAS,CAAC,QAAQ,gBAAgB,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,aAAa,EAAE,CAAC;QAC9L,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,oBAAoB,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,sCAAsC,EAAE,CAAC;QAC/G,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC;IACtF,CAAC;IAEM,WAAW,CAAC,OAAe,EAAE,QAA+C;QACjF,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAChD,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC;IAC1G,CAAC;IAEM,eAAe,CAAC,OAAe,EAAE,OAAe;QACrD,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAChD,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC;IAC7G,CAAC;IAEM,oBAAoB;QACzB,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;QACrE,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,mBAAmB,CAAC,QAAQ,EAAE,YAAgD,CAAC,CAAC;IACzF,CAAC;IAEM,SAAS,CAAC,WAA8C;QAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC,CAAC;IACJ,CAAC;IAEO,qBAAqB;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC7C,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1F,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,YAAqD;QAErD,MAAM,UAAU,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;QAC1F,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;QACpC,IAAI,UAAU,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzC,IAAI,CAAC,QAAQ,GAAG;gBACd,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI;gBACpD,YAAY,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;gBACpE,OAAO;aACR,CAAC;YACF,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,YAAY,CACxB,SAA4B,EAC5B,WAAmB,EACnB,aAAqB;QAErB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACzD,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YACnE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC;QACvF,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACjE,IAAI,aAAa,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC5C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;YAC/B,MAAM,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,WAAW,UAAU,EAAE,KAAK,CAAC,CAAC;YACpE,MAAM,UAAU,GAAG;gBACjB,KAAK,EAAE,GAAG,WAAW,mBAAmB;gBACxC,MAAM,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC/D,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;YACzD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACzD,CAAC;IACH,CAAC;IAEO,cAAc,CACpB,WAAwB,EACxB,aAAgD,EAChD,aAAqB;QAErB,IAAI,aAAa,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;QACD,MAAM,CAAC,IAAI,CAAA,EAAE,EAAE,WAAW,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC;IAC1C,CAAC;IAED,mFAAmF;IAC3E,UAAU;QAChB,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,IAAI,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACpH,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,GAAG,KAAK,EAAE,CAAC,CAAC;IAC/F,CAAC;IAEO,IAAI,CAAC,QAAuB;QAClC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Resolves once every Lit element below the root, including the ones their updates create,
3
+ * has completed its pending update.
4
+ */
5
+ export declare const waitForRenderedTree: (rootArg: Element | ShadowRoot) => Promise<void>;
@@ -0,0 +1,37 @@
1
+ const isUpdatingElement = (elementArg) => {
2
+ const updateComplete = elementArg.updateComplete;
3
+ return typeof updateComplete?.then === 'function';
4
+ };
5
+ const collectUpdatingElements = (rootArg) => {
6
+ const result = [];
7
+ const pending = Array.from(rootArg.children);
8
+ for (let index = 0; index < pending.length; index++) {
9
+ const element = pending[index];
10
+ if (isUpdatingElement(element)) {
11
+ result.push(element);
12
+ }
13
+ pending.push(...element.children);
14
+ if (element.shadowRoot) {
15
+ pending.push(...element.shadowRoot.children);
16
+ }
17
+ }
18
+ return result;
19
+ };
20
+ /**
21
+ * Resolves once every Lit element below the root, including the ones their updates create,
22
+ * has completed its pending update.
23
+ */
24
+ export const waitForRenderedTree = async (rootArg) => {
25
+ const settled = new Set();
26
+ for (;;) {
27
+ const pending = collectUpdatingElements(rootArg).filter((elementArg) => !settled.has(elementArg));
28
+ if (pending.length === 0) {
29
+ return;
30
+ }
31
+ await Promise.all(pending.map((elementArg) => elementArg.updateComplete));
32
+ for (const element of pending) {
33
+ settled.add(element);
34
+ }
35
+ }
36
+ };
37
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVuZGVyZWR0cmVlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHNfd2ViL3JlbmRlcmVkdHJlZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFLQSxNQUFNLGlCQUFpQixHQUFHLENBQUMsVUFBbUIsRUFBa0MsRUFBRTtJQUNoRixNQUFNLGNBQWMsR0FBSSxVQUF3QyxDQUFDLGNBQWMsQ0FBQztJQUNoRixPQUFPLE9BQU8sY0FBYyxFQUFFLElBQUksS0FBSyxVQUFVLENBQUM7QUFDcEQsQ0FBQyxDQUFDO0FBRUYsTUFBTSx1QkFBdUIsR0FBRyxDQUFDLE9BQTZCLEVBQXNCLEVBQUU7SUFDcEYsTUFBTSxNQUFNLEdBQXVCLEVBQUUsQ0FBQztJQUN0QyxNQUFNLE9BQU8sR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUM3QyxLQUFLLElBQUksS0FBSyxHQUFHLENBQUMsRUFBRSxLQUFLLEdBQUcsT0FBTyxDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsRUFBRSxDQUFDO1FBQ3BELE1BQU0sT0FBTyxHQUFHLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUMvQixJQUFJLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7WUFDL0IsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUN2QixDQUFDO1FBQ0QsT0FBTyxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUNsQyxJQUFJLE9BQU8sQ0FBQyxVQUFVLEVBQUUsQ0FBQztZQUN2QixPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUMvQyxDQUFDO0lBQ0gsQ0FBQztJQUNELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQztBQUVGOzs7R0FHRztBQUNILE1BQU0sQ0FBQyxNQUFNLG1CQUFtQixHQUFHLEtBQUssRUFBRSxPQUE2QixFQUFpQixFQUFFO0lBQ3hGLE1BQU0sT0FBTyxHQUFHLElBQUksR0FBRyxFQUFXLENBQUM7SUFDbkMsU0FBUyxDQUFDO1FBQ1IsTUFBTSxPQUFPLEdBQUcsdUJBQXVCLENBQUMsT0FBTyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsVUFBVSxFQUFFLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztRQUNsRyxJQUFJLE9BQU8sQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDekIsT0FBTztRQUNULENBQUM7UUFDRCxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDLFVBQVUsRUFBRSxFQUFFLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUM7UUFDMUUsS0FBSyxNQUFNLE9BQU8sSUFBSSxPQUFPLEVBQUUsQ0FBQztZQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3ZCLENBQUM7SUFDSCxDQUFDO0FBQ0gsQ0FBQyxDQUFDIn0=
@@ -1,11 +1,12 @@
1
+ import type { TWccSectionType } from '../dist_ts_interfaces/index.js';
1
2
  /**
2
- * Configuration for a section in the WCC Tools sidebar
3
+ * Configuration for a section of the catalog
3
4
  */
4
5
  export interface IWccSection {
5
6
  /** Display name for the section header */
6
7
  name: string;
7
8
  /** How items in this section are rendered - 'elements' show demos, 'pages' render directly */
8
- type: 'elements' | 'pages';
9
+ type: TWccSectionType;
9
10
  /** The items in this section - either element classes or page factory functions */
10
11
  items: Record<string, any>;
11
12
  /** Optional filter function to include/exclude items */
@@ -23,7 +24,3 @@ export interface IWccSection {
23
24
  export interface IWccConfig {
24
25
  sections: IWccSection[];
25
26
  }
26
- /**
27
- * Type for element selection types - now section-based
28
- */
29
- export type TElementType = 'element' | 'page';
@@ -1,2 +1,2 @@
1
1
  export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2NjdG9vbHMuaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzX3dlYi93Y2N0b29scy5pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2NjdG9vbHMuaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX3dlYi93Y2N0b29scy5pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==
@@ -1,2 +1,4 @@
1
1
  import * as deesDomtools from '@design.estate/dees-domtools';
2
- export { deesDomtools };
2
+ import * as interfaces from '../dist_ts_interfaces/index.js';
3
+ import * as shared from '../dist_ts_shared/index.js';
4
+ export { deesDomtools, interfaces, shared, };
@@ -1,3 +1,5 @@
1
1
  import * as deesDomtools from '@design.estate/dees-domtools';
2
- export { deesDomtools };
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2NjdG9vbHMucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzX3dlYi93Y2N0b29scy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxZQUFZLE1BQU0sOEJBQThCLENBQUM7QUFFN0QsT0FBTyxFQUNMLFlBQVksRUFDYixDQUFDIn0=
2
+ import * as interfaces from '../dist_ts_interfaces/index.js';
3
+ import * as shared from '../dist_ts_shared/index.js';
4
+ export { deesDomtools, interfaces, shared, };
5
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2NjdG9vbHMucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX3dlYi93Y2N0b29scy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxZQUFZLE1BQU0sOEJBQThCLENBQUM7QUFFN0QsT0FBTyxLQUFLLFVBQVUsTUFBTSwyQkFBMkIsQ0FBQztBQUN4RCxPQUFPLEtBQUssTUFBTSxNQUFNLHVCQUF1QixDQUFDO0FBRWhELE9BQU8sRUFDTCxZQUFZLEVBQ1osVUFBVSxFQUNWLE1BQU0sR0FDUCxDQUFDIn0=
package/package.json CHANGED
@@ -1,30 +1,40 @@
1
1
  {
2
2
  "name": "@design.estate/wcctools",
3
- "version": "5.1.0",
3
+ "version": "6.1.0",
4
4
  "private": false,
5
5
  "description": "A set of web component tools for creating element catalogues, enabling the structured development and documentation of custom elements and pages.",
6
+ "bin": {
7
+ "wcctools": "./cli.js"
8
+ },
6
9
  "exports": {
7
- ".": "./dist_ts_web/index.js"
10
+ ".": "./dist_ts_web/index.js",
11
+ "./interfaces": "./dist_ts_interfaces/index.js"
8
12
  },
9
13
  "type": "module",
10
14
  "author": "Lossless GmbH",
11
15
  "license": "MIT",
12
16
  "dependencies": {
17
+ "@api.global/typedrequest": "^8.2.0",
18
+ "@api.global/typedrequest-interfaces": "^7.1.0",
19
+ "@api.global/typedserver": "^14.2.1",
13
20
  "@design.estate/dees-domtools": "^5.0.0",
14
21
  "@design.estate/dees-element": "^4.0.0",
22
+ "@git.zone/tswatch": "^6.0.1",
23
+ "@push.rocks/smartconfig": "^6.3.0",
24
+ "@push.rocks/smartconsole": "^2.1.0",
25
+ "@push.rocks/smartexit": "^2.2.0",
15
26
  "lit": "^3.3.2",
16
- "mediabunny": "^1.40.1"
27
+ "typescript": "~6.0.3"
17
28
  },
18
29
  "devDependencies": {
19
- "@api.global/typedserver": "^8.4.7",
20
30
  "@git.zone/tsbuild": "^5.1.2",
21
31
  "@git.zone/tsbundle": "^3.1.3",
22
32
  "@git.zone/tsdoc": "^3.0.2",
23
33
  "@git.zone/tsrun": "^3.0.2",
24
34
  "@git.zone/tstest": "^7.1.0",
25
- "@git.zone/tswatch": "^6.0.1",
26
35
  "@push.rocks/projectinfo": "^5.1.0",
27
- "@types/node": "^26.6.3"
36
+ "@types/node": "^26.6.3",
37
+ "mediabunny": "^1.40.1"
28
38
  },
29
39
  "files": [
30
40
  "ts/**/*",
@@ -58,7 +68,7 @@
58
68
  "scripts": {
59
69
  "test": "pnpm run build && tstest \"test/test.*.*.ts\" --verbose --logfile",
60
70
  "build": "(tsbuild tsfolders --allowimplicitany && tsbundle)",
61
- "watch": "tswatch",
71
+ "watch": "pnpm run build && node ./cli.ts.js dev",
62
72
  "buildDocs": "tsdoc"
63
73
  }
64
74
  }