@supersoniks/concorde 5.1.2 → 5.1.3-immutable.2

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 (497) hide show
  1. package/.agents/skills/concorde-docs/SKILL.md +1 -1
  2. package/.claude/skills +1 -0
  3. package/.github/workflows/ci.yml +21 -0
  4. package/.github-export-ignore +30 -0
  5. package/CONTRIBUTING.md +59 -0
  6. package/DEV.md +54 -0
  7. package/LICENSE +21 -0
  8. package/OPEN_SOURCE_CHECKPOINT.md +133 -0
  9. package/README.md +1 -1
  10. package/ai/README.md +29 -41
  11. package/ai/skills/concorde/SKILL.md +54 -324
  12. package/ai/skills/concorde/rules/composition.md +32 -0
  13. package/ai/skills/concorde/rules/data.md +47 -0
  14. package/ai/skills/concorde/rules/http.md +25 -0
  15. package/ai/skills/concorde/rules/lists-forms.md +35 -0
  16. package/ai/skills/concorde/rules/styling.md +46 -0
  17. package/ai/skills/concorde/rules/troubleshooting.md +45 -0
  18. package/build-infos.json +1 -1
  19. package/concorde-core.bundle.js +177 -177
  20. package/concorde-core.es.js +5183 -5018
  21. package/custom-elements-manifest.public.config.mjs +8 -0
  22. package/{.tmp-cem/custom-elements.json → custom-elements.json} +11722 -8868
  23. package/dist/concorde-core.bundle.js +177 -177
  24. package/dist/concorde-core.es.js +5183 -5018
  25. package/dist/docs-mock-api-sw.js +58 -223
  26. package/dist/docs-mock-api-sw.js.map +4 -4
  27. package/dist/img/og-concorde.jpg +0 -0
  28. package/dist/robots.txt +11 -10
  29. package/docs/assets/index-CD4WyL6o.css +1 -0
  30. package/docs/assets/index-D_alEsng.js +12122 -0
  31. package/docs/crawl/core/components/functional/date/date.html +190 -0
  32. package/docs/crawl/core/components/functional/fetch/fetch.html +109 -0
  33. package/docs/crawl/core/components/functional/if/if.html +27 -0
  34. package/docs/crawl/core/components/functional/jsonata/jsonata.html +79 -0
  35. package/docs/crawl/core/components/functional/list/list.html +70 -0
  36. package/docs/crawl/core/components/functional/mix/mix.html +45 -0
  37. package/docs/crawl/core/components/functional/queue/queue.html +96 -0
  38. package/docs/crawl/core/components/functional/router/router.html +106 -0
  39. package/docs/{core → crawl/core}/components/functional/sdui/sdui-extension-points.html +8 -9
  40. package/docs/crawl/core/components/functional/sdui/sdui.html +368 -0
  41. package/docs/crawl/core/components/functional/states/states.html +66 -0
  42. package/docs/crawl/core/components/functional/submit/submit.html +160 -0
  43. package/docs/{core → crawl/core}/components/functional/subscriber/subscriber.html +5 -6
  44. package/docs/crawl/core/components/functional/value/value.html +51 -0
  45. package/docs/{core → crawl/core}/components/ui/alert/alert.html +63 -53
  46. package/docs/{core → crawl/core}/components/ui/alert-messages/alert-messages.html +5 -6
  47. package/docs/{core → crawl/core}/components/ui/badge/badge.html +33 -33
  48. package/docs/crawl/core/components/ui/button/button.html +150 -0
  49. package/docs/crawl/core/components/ui/captcha/captcha.html +112 -0
  50. package/docs/{core → crawl/core}/components/ui/card/card.html +11 -12
  51. package/docs/{core → crawl/core}/components/ui/divider/divider.html +14 -14
  52. package/docs/crawl/core/components/ui/form/checkbox/checkbox.html +73 -0
  53. package/docs/crawl/core/components/ui/form/fieldset/fieldset.html +266 -0
  54. package/docs/{core → crawl/core}/components/ui/form/form-actions/form-actions.html +23 -23
  55. package/docs/crawl/core/components/ui/form/form-layout/form-layout.html +121 -0
  56. package/docs/crawl/core/components/ui/form/input/input.html +109 -0
  57. package/docs/crawl/core/components/ui/form/input-autocomplete/input-autocomplete.html +38 -0
  58. package/docs/crawl/core/components/ui/form/radio/radio.html +56 -0
  59. package/docs/crawl/core/components/ui/form/select/select.html +73 -0
  60. package/docs/crawl/core/components/ui/form/switch/switch.html +56 -0
  61. package/docs/crawl/core/components/ui/form/textarea/textarea.html +59 -0
  62. package/docs/crawl/core/components/ui/group/group.html +104 -0
  63. package/docs/{core → crawl/core}/components/ui/icon/icon.html +9 -10
  64. package/docs/crawl/core/components/ui/image/image.html +298 -0
  65. package/docs/{core → crawl/core}/components/ui/link/link.html +11 -12
  66. package/docs/crawl/core/components/ui/loader/loader.html +124 -0
  67. package/docs/{core → crawl/core}/components/ui/menu/menu.html +33 -34
  68. package/docs/crawl/core/components/ui/modal/modal.html +342 -0
  69. package/docs/crawl/core/components/ui/pop/pop.html +296 -0
  70. package/docs/{core → crawl/core}/components/ui/progress/progress.html +7 -8
  71. package/docs/crawl/core/components/ui/table/table.html +545 -0
  72. package/docs/crawl/core/components/ui/theme/theme.html +131 -0
  73. package/docs/crawl/core/components/ui/toast/toast.html +233 -0
  74. package/docs/crawl/core/components/ui/tooltip/tooltip.html +140 -0
  75. package/docs/{docs/getting-started → crawl/docs/_core-concept}/dataFlow.html +29 -26
  76. package/docs/crawl/docs/_core-concept/overview.html +66 -0
  77. package/docs/crawl/docs/_core-concept/subscriber.html +75 -0
  78. package/docs/crawl/docs/_decorators/ancestor-attribute.html +117 -0
  79. package/docs/crawl/docs/_decorators/auto-subscribe.html +202 -0
  80. package/docs/crawl/docs/_decorators/bind.html +141 -0
  81. package/docs/crawl/docs/_decorators/get.html +149 -0
  82. package/docs/crawl/docs/_decorators/handle.html +165 -0
  83. package/docs/crawl/docs/_decorators/on-assign.html +355 -0
  84. package/docs/crawl/docs/_decorators/patch.html +78 -0
  85. package/docs/crawl/docs/_decorators/post.html +139 -0
  86. package/docs/crawl/docs/_decorators/publish.html +61 -0
  87. package/docs/crawl/docs/_decorators/put.html +78 -0
  88. package/docs/crawl/docs/_decorators/subscribe.html +109 -0
  89. package/docs/crawl/docs/_decorators/wait-for-ancestors.html +137 -0
  90. package/docs/crawl/docs/_directives/sub.html +93 -0
  91. package/docs/{docs/getting-started → crawl/docs/_getting-started}/ai-agents.html +11 -12
  92. package/docs/crawl/docs/_getting-started/concorde-manual-install.html +100 -0
  93. package/docs/crawl/docs/_getting-started/concorde-outside.html +58 -0
  94. package/docs/{docs/getting-started → crawl/docs/_getting-started}/create-a-component.html +14 -11
  95. package/docs/{docs/getting-started → crawl/docs/_getting-started}/my-first-component.html +22 -13
  96. package/docs/crawl/docs/_getting-started/my-first-subscriber.html +110 -0
  97. package/docs/crawl/docs/_getting-started/pubsub.html +62 -0
  98. package/docs/crawl/docs/_getting-started/start.html +76 -0
  99. package/docs/{docs/getting-started → crawl/docs/_getting-started}/theming.html +9 -10
  100. package/docs/{docs/misc → crawl/docs/_misc}/api-configuration.html +18 -18
  101. package/docs/{docs/misc → crawl/docs/_misc}/dataProviderKey.html +11 -12
  102. package/docs/{docs/misc → crawl/docs/_misc}/docs-mock-api.html +28 -25
  103. package/docs/{docs/misc → crawl/docs/_misc}/dynamic-path.html +15 -16
  104. package/docs/{docs/misc → crawl/docs/_misc}/endpoint.html +15 -16
  105. package/docs/crawl/docs/_misc/formelement-subscriber-removal.html +138 -0
  106. package/docs/{docs/misc → crawl/docs/_misc}/html-integration.html +15 -12
  107. package/docs/crawl/hubs/decorators.html +547 -0
  108. package/docs/crawl/hubs/form-components.html +381 -0
  109. package/docs/crawl/hubs/remote-data.html +452 -0
  110. package/docs/crawl/index.html +103 -0
  111. package/docs/docs-mock-api-sw.js +223 -58
  112. package/docs/docs-mock-api-sw.js.map +4 -4
  113. package/docs/index.html +68 -95
  114. package/docs/llms-full.txt +3610 -2231
  115. package/docs/llms.txt +86 -94
  116. package/docs/robots.txt +10 -11
  117. package/docs/sitemap.xml +84 -78
  118. package/docs/src/core/components/functional/date/date.md +231 -91
  119. package/docs/src/core/components/functional/fetch/fetch.md +83 -66
  120. package/docs/src/core/components/functional/if/if.md +3 -28
  121. package/docs/src/core/components/functional/jsonata/jsonata.md +37 -42
  122. package/docs/src/core/components/functional/list/list.md +43 -99
  123. package/docs/src/core/components/functional/mix/mix.md +26 -31
  124. package/docs/src/core/components/functional/queue/queue.md +61 -40
  125. package/docs/src/core/components/functional/router/router.md +65 -64
  126. package/docs/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
  127. package/docs/src/core/components/functional/sdui/component-catalog.json +1 -1
  128. package/docs/src/core/components/functional/sdui/example.json +86 -19
  129. package/docs/src/core/components/functional/sdui/sdui-extension-points.md +1 -1
  130. package/docs/src/core/components/functional/sdui/sdui.md +358 -187
  131. package/docs/src/core/components/functional/states/states.md +61 -86
  132. package/docs/src/core/components/functional/submit/submit.md +72 -64
  133. package/docs/src/core/components/functional/value/value.md +22 -34
  134. package/docs/src/core/components/ui/alert/alert.md +58 -48
  135. package/docs/src/core/components/ui/badge/badge.md +34 -27
  136. package/docs/src/core/components/ui/button/button.md +106 -139
  137. package/docs/src/core/components/ui/captcha/captcha.md +32 -17
  138. package/docs/src/core/components/ui/card/card.md +6 -6
  139. package/docs/src/core/components/ui/divider/divider.md +11 -8
  140. package/docs/src/core/components/ui/form/checkbox/checkbox.md +42 -90
  141. package/docs/src/core/components/ui/form/fieldset/fieldset.md +75 -31
  142. package/docs/src/core/components/ui/form/form-actions/form-actions.md +16 -14
  143. package/docs/src/core/components/ui/form/form-layout/form-layout.md +29 -19
  144. package/docs/src/core/components/ui/form/input/input.md +95 -95
  145. package/docs/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +29 -0
  146. package/docs/src/core/components/ui/form/radio/radio.md +34 -55
  147. package/docs/src/core/components/ui/form/select/select.md +45 -60
  148. package/docs/src/core/components/ui/form/switch/switch.md +34 -57
  149. package/docs/src/core/components/ui/form/textarea/textarea.md +38 -55
  150. package/docs/src/core/components/ui/group/group.md +33 -35
  151. package/docs/src/core/components/ui/icon/icon.md +4 -4
  152. package/docs/src/core/components/ui/image/image.md +107 -41
  153. package/docs/src/core/components/ui/link/link.md +6 -6
  154. package/docs/src/core/components/ui/loader/loader.md +55 -30
  155. package/docs/src/core/components/ui/menu/menu.md +27 -27
  156. package/docs/src/core/components/ui/modal/modal.md +96 -72
  157. package/docs/src/core/components/ui/pop/pop.md +158 -80
  158. package/docs/src/core/components/ui/progress/progress.md +2 -2
  159. package/docs/src/core/components/ui/table/table.md +255 -91
  160. package/docs/src/core/components/ui/theme/theme.md +36 -11
  161. package/docs/src/core/components/ui/toast/toast.md +117 -48
  162. package/docs/src/core/components/ui/tooltip/tooltip.md +62 -27
  163. package/docs/{docs/getting-started → src/docs/_core-concept}/dataFlow.md +18 -17
  164. package/docs/src/docs/_core-concept/overview.md +57 -0
  165. package/docs/src/docs/_core-concept/subscriber.md +75 -0
  166. package/docs/src/docs/_decorators/ancestor-attribute.md +128 -0
  167. package/docs/src/docs/_decorators/auto-subscribe.md +202 -0
  168. package/docs/src/docs/_decorators/bind.md +167 -0
  169. package/docs/src/docs/_decorators/get.md +162 -0
  170. package/docs/src/docs/_decorators/handle.md +175 -0
  171. package/docs/src/docs/_decorators/on-assign.md +390 -0
  172. package/docs/src/docs/_decorators/patch.md +70 -0
  173. package/docs/src/docs/_decorators/post.md +146 -0
  174. package/docs/src/docs/_decorators/publish.md +55 -0
  175. package/docs/src/docs/_decorators/put.md +70 -0
  176. package/docs/src/docs/_decorators/subscribe.md +100 -0
  177. package/docs/src/docs/_decorators/wait-for-ancestors.md +163 -0
  178. package/docs/src/docs/_directives/sub.md +91 -0
  179. package/docs/src/docs/{getting-started → _getting-started}/ai-agents.md +3 -3
  180. package/docs/src/docs/_getting-started/concorde-manual-install.md +133 -0
  181. package/docs/src/docs/_getting-started/concorde-outside.md +33 -0
  182. package/docs/{docs/getting-started → src/docs/_getting-started}/create-a-component.md +6 -3
  183. package/docs/src/docs/{getting-started → _getting-started}/my-first-component.md +14 -5
  184. package/docs/src/docs/_getting-started/my-first-subscriber.md +120 -0
  185. package/docs/src/docs/_getting-started/pubsub.md +37 -0
  186. package/docs/src/docs/{getting-started → _getting-started}/start.md +13 -1
  187. package/docs/src/docs/{getting-started → _getting-started}/theming.md +2 -2
  188. package/docs/src/docs/{misc → _misc}/api-configuration.md +12 -10
  189. package/docs/src/docs/{misc → _misc}/dataProviderKey.md +4 -4
  190. package/docs/{docs/misc → src/docs/_misc}/docs-mock-api.md +13 -12
  191. package/docs/{docs/misc → src/docs/_misc}/dynamic-path.md +8 -8
  192. package/docs/{docs/misc → src/docs/_misc}/endpoint.md +8 -8
  193. package/docs/src/docs/_misc/formelement-subscriber-removal.md +115 -0
  194. package/docs/{docs/misc → src/docs/_misc}/html-integration.md +5 -4
  195. package/docs/src/docs/search/docs-search.json +4375 -2420
  196. package/docs/src/tsconfig.declarations.json +22 -0
  197. package/docs/src/tsconfig.emit.json +23 -0
  198. package/docs/src/tsconfig.json +2 -23
  199. package/gitlab/job_github_mirror.sh +39 -0
  200. package/index.html +89 -0
  201. package/package.json +22 -4
  202. package/public/img/og-concorde.jpg +0 -0
  203. package/scripts/ai-init.mjs +104 -379
  204. package/scripts/ai-init.test.mjs +81 -239
  205. package/scripts/docs-markdown-vite-plugin.ts +11 -5
  206. package/scripts/docs-public-url.mjs +6 -0
  207. package/scripts/docs.htaccess +7 -0
  208. package/scripts/generate-cem.mjs +244 -0
  209. package/scripts/generate-cem.test.mjs +122 -0
  210. package/scripts/generate-crawl-docs.mjs +29 -5
  211. package/scripts/generate-sdui-catalog.mjs +11 -10
  212. package/scripts/github-export.mjs +150 -0
  213. package/scripts/post-build-docs.js +3 -0
  214. package/scripts/post-build.mjs +0 -0
  215. package/scripts/pre-publish.mjs +2 -1
  216. package/scripts/site-pages.mjs +212 -0
  217. package/scripts/site-pages.test.mjs +116 -0
  218. package/site-pages/about.md +22 -0
  219. package/site-pages/privacy.md +32 -0
  220. package/src/core/components/functional/date/date.md +1 -1
  221. package/src/core/components/functional/example/example.ts +3 -1
  222. package/src/core/components/functional/if/if.ts +0 -0
  223. package/src/core/components/functional/list/list.demo.ts +0 -0
  224. package/src/core/components/functional/list/list.md +6 -2
  225. package/src/core/components/functional/list/list.ts +17 -4
  226. package/src/core/components/functional/mix/mix.md +0 -0
  227. package/src/core/components/functional/router/router.demo.ts +0 -0
  228. package/src/core/components/functional/router/router.ts +0 -0
  229. package/src/core/components/functional/sdui/SDUIDescriptorTransformer.ts +0 -0
  230. package/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
  231. package/src/core/components/functional/sdui/component-catalog.json +2 -2
  232. package/src/core/components/functional/sdui/example.json +0 -0
  233. package/src/core/components/functional/sdui/sdui-immutable.spec.ts +74 -0
  234. package/src/core/components/functional/sdui/sdui.ts +33 -8
  235. package/src/core/components/functional/sdui/types.ts +0 -0
  236. package/src/core/components/functional/states/states.ts +0 -0
  237. package/src/core/components/functional/submit/submit.spec.ts +60 -0
  238. package/src/core/components/functional/submit/submit.ts +6 -3
  239. package/src/core/components/functional/subscriber/subscriber.ts +0 -0
  240. package/src/core/components/functional/value/value.md +0 -0
  241. package/src/core/components/functional/value/value.ts +0 -0
  242. package/src/core/components/ui/_css/size.ts +0 -0
  243. package/src/core/components/ui/captcha/altchaStyles.ts +0 -0
  244. package/src/core/components/ui/card/card.md +1 -1
  245. package/src/core/components/ui/form/input/input.md +19 -1
  246. package/src/core/components/ui/form/input/input.ts +8 -2
  247. package/src/core/components/ui/form/radio/radio.md +14 -0
  248. package/src/core/components/ui/image/image.md +17 -17
  249. package/src/core/components/ui/modal/modal.md +2 -2
  250. package/src/core/decorators/subscriber/bind.ts +9 -14
  251. package/src/core/decorators/subscriber/subscribe.ts +15 -9
  252. package/src/core/decorators/subscriber/subscribe.type-test.ts +14 -5
  253. package/src/core/mixins/Subscriber.ts +0 -0
  254. package/src/core/utils/DataBindObserver.ts +0 -0
  255. package/src/core/utils/Objects.ts +0 -0
  256. package/src/core/utils/PublisherProxy.ts +166 -125
  257. package/src/core/utils/deepReadonly.spec.ts +66 -0
  258. package/src/core/utils/deepReadonly.ts +71 -0
  259. package/src/core/utils/immutableValue.spec.ts +58 -0
  260. package/src/core/utils/immutableValue.ts +116 -0
  261. package/src/core/utils/nestedDotForm.spec.ts +88 -0
  262. package/src/core/utils/publisherImmutable.spec.ts +127 -0
  263. package/src/core/utils/route.ts +0 -0
  264. package/src/core/utils/strictGet.spec.ts +61 -0
  265. package/src/core/utils/strictGet.ts +102 -0
  266. package/src/css.d.ts +19 -0
  267. package/src/docs/components/docs-demo-sources.ts +3 -3
  268. package/src/docs/decorators/bind.md +23 -24
  269. package/src/docs/docs-location.spec.ts +10 -0
  270. package/src/docs/docs-location.ts +10 -0
  271. package/src/docs/example/decorators-demo-bind-demos.ts +11 -28
  272. package/src/docs/example/docs-toggle-demos.ts +1 -1
  273. package/src/docs/example/users.ts +0 -0
  274. package/src/docs/getting-started/ai-agents.md +51 -51
  275. package/src/docs/getting-started/dataFlow.md +2 -2
  276. package/src/docs/home/home.ts +3 -1
  277. package/src/docs/misc/publisher-get-immutability-docs-crawl.json +902 -0
  278. package/src/docs/misc/publisher-get-immutability-docs-recheck.json +13 -0
  279. package/src/docs/misc/publisher-get-immutability-study.md +229 -0
  280. package/src/docs/navigation/navigation.ts +5 -1
  281. package/src/docs/search/docs-search.json +358 -58
  282. package/src/docs/search/markdown-renderer.ts +6 -1
  283. package/src/docs/tailwind/css/docs/content.css +4 -5
  284. package/src/tsconfig.declarations.json +22 -0
  285. package/src/tsconfig.emit.json +23 -0
  286. package/src/tsconfig.json +53 -5
  287. package/src/tsconfig.tsbuildinfo +1 -1
  288. package/.taste-skill/after/desktop-fold.jpg +0 -0
  289. package/.taste-skill/after/desktop-page-01.jpg +0 -0
  290. package/.taste-skill/after/desktop-page-02.jpg +0 -0
  291. package/.taste-skill/after/desktop-page-03.jpg +0 -0
  292. package/.taste-skill/after/mobile-fold.jpg +0 -0
  293. package/.taste-skill/after/mobile-page-01.jpg +0 -0
  294. package/.taste-skill/after/report.json +0 -4103
  295. package/.taste-skill/after/tablet-fold.jpg +0 -0
  296. package/.taste-skill/after/tablet-page-01.jpg +0 -0
  297. package/.taste-skill/after/tablet-page-02.jpg +0 -0
  298. package/.taste-skill/before/desktop-fold.jpg +0 -0
  299. package/.taste-skill/before/desktop-page-01.jpg +0 -0
  300. package/.taste-skill/before/desktop-page-02.jpg +0 -0
  301. package/.taste-skill/before/mobile-fold.jpg +0 -0
  302. package/.taste-skill/before/mobile-page-01.jpg +0 -0
  303. package/.taste-skill/before/report.json +0 -2556
  304. package/.taste-skill/before/tablet-fold.jpg +0 -0
  305. package/.taste-skill/before/tablet-page-01.jpg +0 -0
  306. package/.taste-skill/direction.json +0 -510
  307. package/.taste-skill/notes.md +0 -84
  308. package/.taste-skill/prod/desktop-fold.jpg +0 -0
  309. package/.taste-skill/prod/desktop-page-01.jpg +0 -0
  310. package/.taste-skill/prod/desktop-page-02.jpg +0 -0
  311. package/.taste-skill/prod/desktop-page-03.jpg +0 -0
  312. package/.taste-skill/prod/mobile-fold.jpg +0 -0
  313. package/.taste-skill/prod/mobile-page-01.jpg +0 -0
  314. package/.taste-skill/prod/mobile-page-02.jpg +0 -0
  315. package/.taste-skill/prod/report.json +0 -1973
  316. package/.taste-skill/prod/tablet-fold.jpg +0 -0
  317. package/.taste-skill/prod/tablet-page-01.jpg +0 -0
  318. package/.taste-skill/prod/tablet-page-02.jpg +0 -0
  319. package/AUDIT.md +0 -228
  320. package/PLAN-AMELIORATION.md +0 -220
  321. package/PLAN-DOCS-AGENTS.md +0 -80
  322. package/ai/AGENTS.md +0 -56
  323. package/ai/cursor/rules/concorde-menu.mdc +0 -15
  324. package/ai/cursor/rules/concorde-scope.mdc +0 -14
  325. package/ai/cursor/rules/concorde-theme.mdc +0 -13
  326. package/ai/cursor/rules/concorde.mdc +0 -66
  327. package/ai/jetbrains/rules/concorde.md +0 -53
  328. package/ai/skills/concorde-get-set-dp/SKILL.md +0 -194
  329. package/ai/skills/concorde-imports/SKILL.md +0 -78
  330. package/ai/skills/concorde-menu/SKILL.md +0 -74
  331. package/ai/skills/concorde-scope/SKILL.md +0 -70
  332. package/ai/skills/concorde-theme/SKILL.md +0 -57
  333. package/docs/.htaccess +0 -75
  334. package/docs/404.html +0 -15
  335. package/docs/404.md +0 -5
  336. package/docs/assets/index-BgG6FFPt.js +0 -11765
  337. package/docs/assets/index-x89XINSG.css +0 -1
  338. package/docs/core/components/functional/date/date.html +0 -211
  339. package/docs/core/components/functional/date/date.md +0 -150
  340. package/docs/core/components/functional/fetch/fetch.html +0 -180
  341. package/docs/core/components/functional/fetch/fetch.md +0 -108
  342. package/docs/core/components/functional/if/if.html +0 -65
  343. package/docs/core/components/functional/if/if.md +0 -34
  344. package/docs/core/components/functional/jsonata/jsonata.html +0 -110
  345. package/docs/core/components/functional/jsonata/jsonata.md +0 -61
  346. package/docs/core/components/functional/list/list.html +0 -198
  347. package/docs/core/components/functional/list/list.md +0 -121
  348. package/docs/core/components/functional/mix/mix.html +0 -78
  349. package/docs/core/components/functional/mix/mix.md +0 -46
  350. package/docs/core/components/functional/queue/queue.html +0 -155
  351. package/docs/core/components/functional/queue/queue.md +0 -51
  352. package/docs/core/components/functional/router/router.html +0 -154
  353. package/docs/core/components/functional/router/router.md +0 -93
  354. package/docs/core/components/functional/sdui/sdui-extension-points.md +0 -94
  355. package/docs/core/components/functional/sdui/sdui.html +0 -397
  356. package/docs/core/components/functional/sdui/sdui.md +0 -307
  357. package/docs/core/components/functional/states/states.html +0 -141
  358. package/docs/core/components/functional/states/states.md +0 -112
  359. package/docs/core/components/functional/submit/submit.html +0 -178
  360. package/docs/core/components/functional/submit/submit.md +0 -106
  361. package/docs/core/components/functional/subscriber/subscriber.md +0 -91
  362. package/docs/core/components/functional/translation/translation.html +0 -60
  363. package/docs/core/components/functional/translation/translation.md +0 -38
  364. package/docs/core/components/functional/value/value.html +0 -81
  365. package/docs/core/components/functional/value/value.md +0 -47
  366. package/docs/core/components/ui/alert/alert.md +0 -186
  367. package/docs/core/components/ui/alert-messages/alert-messages.md +0 -85
  368. package/docs/core/components/ui/badge/badge.md +0 -181
  369. package/docs/core/components/ui/button/button.html +0 -309
  370. package/docs/core/components/ui/button/button.md +0 -216
  371. package/docs/core/components/ui/captcha/captcha.html +0 -80
  372. package/docs/core/components/ui/captcha/captcha.md +0 -56
  373. package/docs/core/components/ui/card/card.md +0 -215
  374. package/docs/core/components/ui/divider/divider.md +0 -126
  375. package/docs/core/components/ui/form/checkbox/checkbox.html +0 -200
  376. package/docs/core/components/ui/form/checkbox/checkbox.md +0 -125
  377. package/docs/core/components/ui/form/fieldset/fieldset.html +0 -238
  378. package/docs/core/components/ui/form/fieldset/fieldset.md +0 -161
  379. package/docs/core/components/ui/form/form-actions/form-actions.md +0 -98
  380. package/docs/core/components/ui/form/form-layout/form-layout.html +0 -115
  381. package/docs/core/components/ui/form/form-layout/form-layout.md +0 -109
  382. package/docs/core/components/ui/form/input/input.html +0 -235
  383. package/docs/core/components/ui/form/input/input.md +0 -142
  384. package/docs/core/components/ui/form/radio/radio.html +0 -144
  385. package/docs/core/components/ui/form/radio/radio.md +0 -78
  386. package/docs/core/components/ui/form/select/select.html +0 -178
  387. package/docs/core/components/ui/form/select/select.md +0 -86
  388. package/docs/core/components/ui/form/switch/switch.html +0 -146
  389. package/docs/core/components/ui/form/switch/switch.md +0 -80
  390. package/docs/core/components/ui/form/textarea/textarea.html +0 -162
  391. package/docs/core/components/ui/form/textarea/textarea.md +0 -82
  392. package/docs/core/components/ui/group/group.html +0 -113
  393. package/docs/core/components/ui/group/group.md +0 -77
  394. package/docs/core/components/ui/icon/icon.md +0 -214
  395. package/docs/core/components/ui/image/image.html +0 -194
  396. package/docs/core/components/ui/image/image.md +0 -167
  397. package/docs/core/components/ui/link/link.md +0 -81
  398. package/docs/core/components/ui/loader/loader.html +0 -114
  399. package/docs/core/components/ui/loader/loader.md +0 -87
  400. package/docs/core/components/ui/menu/menu.md +0 -370
  401. package/docs/core/components/ui/modal/modal.html +0 -324
  402. package/docs/core/components/ui/modal/modal.md +0 -211
  403. package/docs/core/components/ui/pop/pop.html +0 -250
  404. package/docs/core/components/ui/pop/pop.md +0 -216
  405. package/docs/core/components/ui/progress/progress.md +0 -109
  406. package/docs/core/components/ui/table/table.html +0 -333
  407. package/docs/core/components/ui/table/table.md +0 -267
  408. package/docs/core/components/ui/theme/theme.html +0 -116
  409. package/docs/core/components/ui/theme/theme.md +0 -97
  410. package/docs/core/components/ui/toast/toast.html +0 -185
  411. package/docs/core/components/ui/toast/toast.md +0 -147
  412. package/docs/core/components/ui/tooltip/tooltip.html +0 -112
  413. package/docs/core/components/ui/tooltip/tooltip.md +0 -89
  414. package/docs/docs/decorators/ancestor-attribute.html +0 -71
  415. package/docs/docs/decorators/ancestor-attribute.md +0 -59
  416. package/docs/docs/decorators/auto-subscribe.html +0 -61
  417. package/docs/docs/decorators/auto-subscribe.md +0 -40
  418. package/docs/docs/decorators/bind.html +0 -86
  419. package/docs/docs/decorators/bind.md +0 -77
  420. package/docs/docs/decorators/get.html +0 -166
  421. package/docs/docs/decorators/get.md +0 -160
  422. package/docs/docs/decorators/handle.html +0 -139
  423. package/docs/docs/decorators/handle.md +0 -119
  424. package/docs/docs/decorators/on-assign.html +0 -72
  425. package/docs/docs/decorators/on-assign.md +0 -63
  426. package/docs/docs/decorators/patch.html +0 -76
  427. package/docs/docs/decorators/patch.md +0 -44
  428. package/docs/docs/decorators/post.html +0 -150
  429. package/docs/docs/decorators/post.md +0 -134
  430. package/docs/docs/decorators/publish.html +0 -74
  431. package/docs/docs/decorators/publish.md +0 -56
  432. package/docs/docs/decorators/put.html +0 -83
  433. package/docs/docs/decorators/put.md +0 -51
  434. package/docs/docs/decorators/subscribe.html +0 -91
  435. package/docs/docs/decorators/subscribe.md +0 -87
  436. package/docs/docs/decorators/wait-for-ancestors.html +0 -82
  437. package/docs/docs/decorators/wait-for-ancestors.md +0 -76
  438. package/docs/docs/directives/sub.html +0 -79
  439. package/docs/docs/directives/sub.md +0 -75
  440. package/docs/docs/directives/t.html +0 -91
  441. package/docs/docs/directives/t.md +0 -73
  442. package/docs/docs/getting-started/ai-agents.md +0 -76
  443. package/docs/docs/getting-started/components.html +0 -27
  444. package/docs/docs/getting-started/components.md +0 -5
  445. package/docs/docs/getting-started/installation.html +0 -69
  446. package/docs/docs/getting-started/installation.md +0 -36
  447. package/docs/docs/getting-started/my-first-component.md +0 -227
  448. package/docs/docs/getting-started/start.html +0 -47
  449. package/docs/docs/getting-started/start.md +0 -35
  450. package/docs/docs/getting-started/theming.md +0 -253
  451. package/docs/docs/index.html +0 -99
  452. package/docs/docs/misc/api-configuration.md +0 -79
  453. package/docs/docs/misc/dataProviderKey.md +0 -168
  454. package/docs/hubs/decorators.html +0 -443
  455. package/docs/hubs/form-components.html +0 -404
  456. package/docs/hubs/remote-data.html +0 -371
  457. package/docs/img/archive/concorde-001-2cv.webp +0 -0
  458. package/docs/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
  459. package/docs/img/archive/concorde-red-arrows-2002.webm +0 -0
  460. package/docs/img/archive/credits.json +0 -28
  461. package/docs/index.md +0 -22
  462. package/docs/src/core/components/functional/translation/translation.md +0 -38
  463. package/docs/src/docs/decorators/ancestor-attribute.md +0 -59
  464. package/docs/src/docs/decorators/auto-subscribe.md +0 -40
  465. package/docs/src/docs/decorators/bind.md +0 -77
  466. package/docs/src/docs/decorators/get.md +0 -160
  467. package/docs/src/docs/decorators/handle.md +0 -119
  468. package/docs/src/docs/decorators/on-assign.md +0 -63
  469. package/docs/src/docs/decorators/patch.md +0 -44
  470. package/docs/src/docs/decorators/post.md +0 -134
  471. package/docs/src/docs/decorators/publish.md +0 -56
  472. package/docs/src/docs/decorators/put.md +0 -51
  473. package/docs/src/docs/decorators/subscribe.md +0 -87
  474. package/docs/src/docs/decorators/wait-for-ancestors.md +0 -76
  475. package/docs/src/docs/directives/sub.md +0 -75
  476. package/docs/src/docs/directives/t.md +0 -73
  477. package/docs/src/docs/getting-started/components.md +0 -5
  478. package/docs/src/docs/getting-started/create-a-component.md +0 -136
  479. package/docs/src/docs/getting-started/dataFlow.md +0 -87
  480. package/docs/src/docs/getting-started/installation.md +0 -36
  481. package/docs/src/docs/misc/docs-mock-api.md +0 -62
  482. package/docs/src/docs/misc/dynamic-path.md +0 -71
  483. package/docs/src/docs/misc/endpoint.md +0 -45
  484. package/docs/src/docs/misc/html-integration.md +0 -14
  485. /package/{docs → dist}/img/concorde/plane_01.jpg +0 -0
  486. /package/{docs → dist}/img/concorde/plane_02.jpg +0 -0
  487. /package/{docs → dist}/img/concorde/plane_03.jpg +0 -0
  488. /package/{docs → dist}/img/concorde/plane_04.jpg +0 -0
  489. /package/{docs → dist}/img/concorde/plane_05.jpg +0 -0
  490. /package/{docs → dist}/img/concorde/plane_06.jpg +0 -0
  491. /package/{docs → dist}/img/concorde/plane_07.jpg +0 -0
  492. /package/{docs → dist}/img/concorde/plane_08.jpg +0 -0
  493. /package/{docs → dist}/img/concorde/plane_09.jpg +0 -0
  494. /package/{docs → dist}/img/concorde/plane_10.jpg +0 -0
  495. /package/{docs → dist}/img/concorde/plane_11.jpg +0 -0
  496. /package/{docs → dist}/img/concorde/plane_12.jpg +0 -0
  497. /package/{docs → dist}/img/concorde/plane_13.jpg +0 -0
package/docs/docs/decorators/get.html DELETED
@@ -1,166 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/get" data-doc-id="docs/decorators/get">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>@get — Concorde by Supersoniks</title>
7
- <meta name="description" content="@get(endpoint) runs an HTTP GET on an Endpoint and stores the full ApiResult&lt;T&gt; in a property, or passes it to a method. It runs again when the endpoint's placeholders or the API configuration change,">
8
- <meta name="keywords" content="Concorde, supersoniks, docs/decorators/get, get, @get, decorator, @get(endpoint), ApiResult, refetch, undefined, result, ), , (the HTTP response) and , . It is reset to , serviceURL">
9
- <meta name="concorde-doc-id" content="docs/decorators/get">
10
- <link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/get">
11
- <link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/get.md">
12
- </head>
13
- <body>
14
- <header>
15
- <p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/get">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
16
- </header>
17
- <main>
18
- <article>
19
- <p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @get</strong>. @get(endpoint) runs an HTTP GET on an Endpoint and stores the full ApiResult&lt;T&gt; in a property, or passes it to a method. It runs again when the endpoint's placeholders or the API configuration change, <span>Doc ID: <code>docs/decorators/get</code>. Keywords: Concorde, supersoniks, docs/decorators/get, get, @get, decorator, @get(endpoint), ApiResult, refetch, undefined, result, ), , (the HTTP response) and , . It is reset to , serviceURL. URL: <a href="https://concorde.supersoniks.org/docs/decorators/get">https://concorde.supersoniks.org/docs/decorators/get</a>.</span></p>
20
- <h1 id="get">@get</h1>
21
- <p><code>@get(endpoint)</code> runs an HTTP GET on an <a href="/docs/misc/endpoint">Endpoint</a> and stores the full <code>ApiResult&lt;T&gt;</code> in a property, or passes it to a method. It runs again when the endpoint&#39;s placeholders or the API configuration change, and on demand through <code>refetch</code>. For writes, see <a href="/docs/decorators/post">@post</a>, <a href="/docs/decorators/put">@put</a> and <a href="/docs/decorators/patch">@patch</a>.</p>
22
- <h2 id="import">Import</h2>
23
- <pre><code class="language-typescript">import { get, Endpoint, type ApiResult } from &quot;@supersoniks/concorde/decorators&quot;;
24
-
25
- type FlightBoard = { flights: Flight[] };
26
- const departuresEndpoint = new Endpoint&amp;lt;FlightBoard&amp;gt;(&quot;flights?direction=departures&quot;);
27
-
28
- @get(departuresEndpoint)
29
- @state()
30
- departures?: ApiResult&amp;lt;FlightBoard&amp;gt;;
31
- </code></pre>
32
- <h2 id="property">Property</h2>
33
- <p>The property is <code>undefined</code> until the first response, then holds <code>result</code> (typed <code>T</code>), <code>response</code> (the HTTP response) and <code>request</code>. It is reset to <code>undefined</code> when the component disconnects.</p>
34
- <p>Without a configuration key, <code>serviceURL</code> and the token are read from the HTML scope: place the component under an element that sets them (see <a href="/docs/misc/api-configuration">API configuration</a>). The GET waits until <code>serviceURL</code> is available.</p>
35
- <pre><code>&lt;docs-demo-sources for=&quot;demo-api-get&quot;&gt;&lt;/docs-demo-sources&gt;
36
- &lt;demo-api-get&gt;&lt;/demo-api-get&gt;
37
- </code></pre>
38
- <h2 id="method">Method</h2>
39
- <p>Decorate a method to receive the <code>ApiResult&lt;T&gt;</code> after each GET instead of storing it.</p>
40
- <pre><code class="language-typescript">@get(departuresEndpoint)
41
- onDepartures(payload?: ApiResult&amp;lt;FlightBoard&amp;gt;) {
42
- this.boarding = payload?.result?.flights.filter((f) =&amp;gt; f.status === &quot;boarding&quot;) ?? [];
43
- }
44
- </code></pre>
45
- <pre><code>&lt;docs-demo-sources for=&quot;demo-api-get-method&quot;&gt;&lt;/docs-demo-sources&gt;
46
- &lt;demo-api-get-method&gt;&lt;/demo-api-get-method&gt;
47
- </code></pre>
48
- <h2 id="configuration-key">Configuration key</h2>
49
- <p>Pass a <code>DataProviderKey&lt;APIConfiguration&gt;</code> as the second argument to read the configuration from the store instead of the HTML scope. Any change to that publisher runs the GET again.</p>
50
- <pre><code class="language-typescript">import { DataProviderKey } from &quot;@supersoniks/concorde/dataProviderKey&quot;;
51
- import type { APIConfiguration } from &quot;@supersoniks/concorde/utils/api&quot;;
52
-
53
- const flightsApi = new DataProviderKey&amp;lt;APIConfiguration&amp;gt;(&quot;flightsApi&quot;);
54
-
55
- @get(departuresEndpoint, flightsApi)
56
- @state()
57
- departures?: ApiResult&amp;lt;FlightBoard&amp;gt;;
58
- </code></pre>
59
- <h2 id="dynamic-endpoint">Dynamic endpoint</h2>
60
- <p><code>${prop}</code> placeholders in the endpoint resolve from properties of the same component; each change runs a new GET. While a placeholder is <code>null</code> or <code>undefined</code>, no request is sent and the property is <code>undefined</code>. Rules: <a href="/docs/misc/dynamic-path">Dynamic paths</a>.</p>
61
- <pre><code class="language-typescript">const boardEndpoint = new Endpoint&amp;lt;FlightBoard, { direction: string }&amp;gt;(
62
- &quot;flights?direction=${direction}&quot;,
63
- );
64
-
65
- @property() direction = &quot;departures&quot;;
66
-
67
- @get(boardEndpoint, flightsApi)
68
- @state()
69
- board?: ApiResult&amp;lt;FlightBoard&amp;gt;;
70
- </code></pre>
71
- <pre><code>&lt;docs-demo-sources for=&quot;demo-api-get-configuration-key&quot;&gt;&lt;/docs-demo-sources&gt;
72
- &lt;demo-api-get-configuration-key&gt;&lt;/demo-api-get-configuration-key&gt;
73
- </code></pre>
74
- <h2 id="refetch">Refetch</h2>
75
- <p>Keep the decorator in a constant to reuse it. <code>refetch(component)</code> runs the GET for that instance only and resolves with the new <code>ApiResult&lt;T&gt;</code> (or <code>undefined</code>).</p>
76
- <pre><code class="language-typescript">const departuresGet = get(departuresEndpoint);
77
-
78
- @departuresGet
79
- @state()
80
- departures?: ApiResult&amp;lt;FlightBoard&amp;gt;;
81
-
82
- async refresh() {
83
- await departuresGet.refetch(this);
84
- }
85
- </code></pre>
86
- <p><code>@refetch(handle)</code> does the same around a method. By default the GET runs <strong>after</strong> the method (and after its Promise, if it returns one); use <code>{ when: &quot;before&quot; }</code> to run it first. The method call resolves once the GET is done.</p>
87
- <pre><code class="language-typescript">import { refetch } from &quot;@supersoniks/concorde/decorators&quot;;
88
-
89
- @refetch(departuresGet)
90
- async showArrivals() {
91
- this.direction = &quot;arrivals&quot;;
92
- }
93
- </code></pre>
94
- <h2 id="polling-and-triggers">Polling and triggers</h2>
95
- <p><code>refetchEveryMs</code> runs the GET again that many milliseconds after each response (default <code>0</code>: off). <code>triggerKey</code> runs it whenever another component calls <code>invalidate()</code> on that publisher.</p>
96
- <pre><code class="language-typescript">import { dp } from &quot;@supersoniks/concorde/utils&quot;;
97
-
98
- const boardRefresh = new DataProviderKey&amp;lt;number&amp;gt;(&quot;boardRefresh&quot;);
99
-
100
- @get(departuresEndpoint, { refetchEveryMs: 30000, triggerKey: boardRefresh })
101
- @state()
102
- departures?: ApiResult&amp;lt;FlightBoard&amp;gt;;
103
-
104
- // anywhere else
105
- dp(boardRefresh).invalidate();
106
- </code></pre>
107
- <h2 id="api-reference">API reference</h2>
108
- <table>
109
- <thead>
110
- <tr>
111
- <th>Argument</th>
112
- <th>Type</th>
113
- <th>Description</th>
114
- </tr>
115
- </thead>
116
- <tbody><tr>
117
- <td><code>endpoint</code></td>
118
- <td><code>Endpoint&lt;T, U&gt;</code></td>
119
- <td>Path relative to <code>serviceURL</code>. <code>U</code> lists the host properties used by <code>${…}</code> placeholders</td>
120
- </tr>
121
- <tr>
122
- <td><code>configurationKey</code></td>
123
- <td><code>DataProviderKey&lt;APIConfiguration&gt;</code> (optional)</td>
124
- <td>Read the configuration from the store instead of the HTML scope</td>
125
- </tr>
126
- <tr>
127
- <td><code>options.refetchEveryMs</code></td>
128
- <td><code>number</code> (default <code>0</code>)</td>
129
- <td>Polling interval after each response; <code>0</code> disables it</td>
130
- </tr>
131
- <tr>
132
- <td><code>options.triggerKey</code></td>
133
- <td><code>DataProviderKey&lt;unknown&gt;</code></td>
134
- <td>Publisher whose <code>invalidate()</code> runs the GET again</td>
135
- </tr>
136
- <tr>
137
- <td><code>options.skipEmptyPlaceholder</code></td>
138
- <td><code>boolean</code> (default <code>false</code>)</td>
139
- <td>Treat a placeholder resolved to <code>&quot;&quot;</code> as not ready</td>
140
- </tr>
141
- </tbody></table>
142
- <p><code>options</code> is the second argument, or the third when a <code>configurationKey</code> is passed. The returned decorator exposes <code>refetch(component): Promise&lt;ApiResult&lt;T&gt; | undefined&gt;</code>.</p>
143
- <table>
144
- <thead>
145
- <tr>
146
- <th><code>@refetch</code> argument</th>
147
- <th>Type</th>
148
- <th>Description</th>
149
- </tr>
150
- </thead>
151
- <tbody><tr>
152
- <td><code>handle</code></td>
153
- <td>value returned by <code>get(…)</code></td>
154
- <td>GET to run</td>
155
- </tr>
156
- <tr>
157
- <td><code>options.when</code></td>
158
- <td><code>&quot;before&quot;</code> or <code>&quot;after&quot;</code> (default <code>&quot;after&quot;</code>)</td>
159
- <td>Run the GET before or after the method</td>
160
- </tr>
161
- </tbody></table>
162
-
163
- </article>
164
- </main>
165
- </body>
166
- </html>
package/docs/docs/decorators/get.md DELETED
@@ -1,160 +0,0 @@
1
- # @get
2
-
3
- `@get(endpoint)` runs an HTTP GET on an [Endpoint](/docs/misc/endpoint) and stores the full `ApiResult<T>` in a property, or passes it to a method. It runs again when the endpoint's placeholders or the API configuration change, and on demand through `refetch`. For writes, see [@post](/docs/decorators/post), [@put](/docs/decorators/put) and [@patch](/docs/decorators/patch).
4
-
5
- ## Import
6
-
7
- <sonic-code language="typescript">
8
- <template>
9
- import { get, Endpoint, type ApiResult } from "@supersoniks/concorde/decorators";
10
-
11
- type FlightBoard = { flights: Flight[] };
12
- const departuresEndpoint = new Endpoint&lt;FlightBoard&gt;("flights?direction=departures");
13
-
14
- @get(departuresEndpoint)
15
- @state()
16
- departures?: ApiResult&lt;FlightBoard&gt;;
17
- </template>
18
- </sonic-code>
19
-
20
- ## Property
21
-
22
- The property is `undefined` until the first response, then holds `result` (typed `T`), `response` (the HTTP response) and `request`. It is reset to `undefined` when the component disconnects.
23
-
24
- Without a configuration key, `serviceURL` and the token are read from the HTML scope: place the component under an element that sets them (see [API configuration](/docs/misc/api-configuration)). The GET waits until `serviceURL` is available.
25
-
26
- <sonic-code>
27
- <template>
28
- <docs-demo-sources for="demo-api-get"></docs-demo-sources>
29
- <demo-api-get></demo-api-get>
30
- </template>
31
- </sonic-code>
32
-
33
- ## Method
34
-
35
- Decorate a method to receive the `ApiResult<T>` after each GET instead of storing it.
36
-
37
- <sonic-code language="typescript">
38
- <template>
39
- @get(departuresEndpoint)
40
- onDepartures(payload?: ApiResult&lt;FlightBoard&gt;) {
41
- this.boarding = payload?.result?.flights.filter((f) =&gt; f.status === "boarding") ?? [];
42
- }
43
- </template>
44
- </sonic-code>
45
-
46
- <sonic-code>
47
- <template>
48
- <docs-demo-sources for="demo-api-get-method"></docs-demo-sources>
49
- <demo-api-get-method></demo-api-get-method>
50
- </template>
51
- </sonic-code>
52
-
53
- ## Configuration key
54
-
55
- Pass a `DataProviderKey<APIConfiguration>` as the second argument to read the configuration from the store instead of the HTML scope. Any change to that publisher runs the GET again.
56
-
57
- <sonic-code language="typescript">
58
- <template>
59
- import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
60
- import type { APIConfiguration } from "@supersoniks/concorde/utils/api";
61
-
62
- const flightsApi = new DataProviderKey&lt;APIConfiguration&gt;("flightsApi");
63
-
64
- @get(departuresEndpoint, flightsApi)
65
- @state()
66
- departures?: ApiResult&lt;FlightBoard&gt;;
67
- </template>
68
- </sonic-code>
69
-
70
- ## Dynamic endpoint
71
-
72
- `${prop}` placeholders in the endpoint resolve from properties of the same component; each change runs a new GET. While a placeholder is `null` or `undefined`, no request is sent and the property is `undefined`. Rules: [Dynamic paths](/docs/misc/dynamic-path).
73
-
74
- <sonic-code language="typescript">
75
- <template>
76
- const boardEndpoint = new Endpoint&lt;FlightBoard, { direction: string }&gt;(
77
- "flights?direction=${direction}",
78
- );
79
-
80
- @property() direction = "departures";
81
-
82
- @get(boardEndpoint, flightsApi)
83
- @state()
84
- board?: ApiResult&lt;FlightBoard&gt;;
85
- </template>
86
- </sonic-code>
87
-
88
- <sonic-code>
89
- <template>
90
- <docs-demo-sources for="demo-api-get-configuration-key"></docs-demo-sources>
91
- <demo-api-get-configuration-key></demo-api-get-configuration-key>
92
- </template>
93
- </sonic-code>
94
-
95
- ## Refetch
96
-
97
- Keep the decorator in a constant to reuse it. `refetch(component)` runs the GET for that instance only and resolves with the new `ApiResult<T>` (or `undefined`).
98
-
99
- <sonic-code language="typescript">
100
- <template>
101
- const departuresGet = get(departuresEndpoint);
102
-
103
- @departuresGet
104
- @state()
105
- departures?: ApiResult&lt;FlightBoard&gt;;
106
-
107
- async refresh() {
108
- await departuresGet.refetch(this);
109
- }
110
- </template>
111
- </sonic-code>
112
-
113
- `@refetch(handle)` does the same around a method. By default the GET runs **after** the method (and after its Promise, if it returns one); use `{ when: "before" }` to run it first. The method call resolves once the GET is done.
114
-
115
- <sonic-code language="typescript">
116
- <template>
117
- import { refetch } from "@supersoniks/concorde/decorators";
118
-
119
- @refetch(departuresGet)
120
- async showArrivals() {
121
- this.direction = "arrivals";
122
- }
123
- </template>
124
- </sonic-code>
125
-
126
- ## Polling and triggers
127
-
128
- `refetchEveryMs` runs the GET again that many milliseconds after each response (default `0`: off). `triggerKey` runs it whenever another component calls `invalidate()` on that publisher.
129
-
130
- <sonic-code language="typescript">
131
- <template>
132
- import { dp } from "@supersoniks/concorde/utils";
133
-
134
- const boardRefresh = new DataProviderKey&lt;number&gt;("boardRefresh");
135
-
136
- @get(departuresEndpoint, { refetchEveryMs: 30000, triggerKey: boardRefresh })
137
- @state()
138
- departures?: ApiResult&lt;FlightBoard&gt;;
139
-
140
- // anywhere else
141
- dp(boardRefresh).invalidate();
142
- </template>
143
- </sonic-code>
144
-
145
- ## API reference
146
-
147
- | Argument | Type | Description |
148
- |----------|------|-------------|
149
- | `endpoint` | `Endpoint<T, U>` | Path relative to `serviceURL`. `U` lists the host properties used by `${…}` placeholders |
150
- | `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | Read the configuration from the store instead of the HTML scope |
151
- | `options.refetchEveryMs` | `number` (default `0`) | Polling interval after each response; `0` disables it |
152
- | `options.triggerKey` | `DataProviderKey<unknown>` | Publisher whose `invalidate()` runs the GET again |
153
- | `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
154
-
155
- `options` is the second argument, or the third when a `configurationKey` is passed. The returned decorator exposes `refetch(component): Promise<ApiResult<T> | undefined>`.
156
-
157
- | `@refetch` argument | Type | Description |
158
- |---------------------|------|-------------|
159
- | `handle` | value returned by `get(…)` | GET to run |
160
- | `options.when` | `"before"` or `"after"` (default `"after"`) | Run the GET before or after the method |
package/docs/docs/decorators/handle.html DELETED
@@ -1,139 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/handle" data-doc-id="docs/decorators/handle">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>@handle — Concorde by Supersoniks</title>
7
- <meta name="description" content="@handle(...keys) calls the decorated method each time a publisher assigns one of up to three store paths, with one typed argument per key. Nothing is stored on the component: use it for derived values">
8
- <meta name="keywords" content="Concorde, supersoniks, docs/decorators/handle, handle, @handle, decorator, @handle(...keys), null, undefined, ${prop}, waitForAllDefined: true, ${name}, please proceed to gate ${gate}., skip">
9
- <meta name="concorde-doc-id" content="docs/decorators/handle">
10
- <link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/handle">
11
- <link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/handle.md">
12
- </head>
13
- <body>
14
- <header>
15
- <p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/handle">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
16
- </header>
17
- <main>
18
- <article>
19
- <p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @handle</strong>. @handle(...keys) calls the decorated method each time a publisher assigns one of up to three store paths, with one typed argument per key. Nothing is stored on the component: use it for derived values <span>Doc ID: <code>docs/decorators/handle</code>. Keywords: Concorde, supersoniks, docs/decorators/handle, handle, @handle, decorator, @handle(...keys), null, undefined, ${prop}, waitForAllDefined: true, ${name}, please proceed to gate ${gate}., skip. URL: <a href="https://concorde.supersoniks.org/docs/decorators/handle">https://concorde.supersoniks.org/docs/decorators/handle</a>.</span></p>
20
- <h1 id="handle">@handle</h1>
21
- <p><code>@handle(...keys)</code> calls the decorated method each time a publisher assigns one of up to three store paths, with one typed argument per key. Nothing is stored on the component: use it for derived values and side effects, and <a href="/docs/decorators/subscribe">@subscribe</a> when you only need the value. See <a href="/docs/getting-started/dataFlow">Data flow</a> for the overall model.</p>
22
- <h2 id="import">Import</h2>
23
- <pre><code class="language-typescript">import { handle, Skip } from &quot;@supersoniks/concorde/decorators&quot;;
24
- import { DataProviderKey } from &quot;@supersoniks/concorde/dataProviderKey&quot;;
25
-
26
- const cockpitKey = new DataProviderKey&amp;lt;{ altitude: number }&amp;gt;(&quot;cockpit&quot;);
27
-
28
- @handle(cockpitKey.altitude)
29
- onAltitude(feet: number) {
30
- this.meters = Math.round(feet * 0.3048);
31
- }
32
- </code></pre>
33
- <h2 id="basic-usage">Basic usage</h2>
34
- <p>The method runs once with the current value when the component connects, then on <strong>every</strong> assignment, including <code>null</code> and <code>undefined</code>. Below, each climb assigns a new altitude and the method derives meters and flight level.</p>
35
- <pre><code>&lt;docs-demo-sources for=&quot;demo-handle&quot;&gt;&lt;/docs-demo-sources&gt;
36
- &lt;demo-handle&gt;&lt;/demo-handle&gt;
37
- </code></pre>
38
- <h2 id="dynamic-path">Dynamic path</h2>
39
- <p><code>${prop}</code> placeholders resolve from properties of the same component; when one changes, the method is called with the value at the new path. Rules: <a href="/docs/misc/dynamic-path">Dynamic paths</a>.</p>
40
- <pre><code class="language-typescript">const personKey = new DataProviderKey&amp;lt;OnBoard, { seatIndex: number }&amp;gt;(
41
- &quot;demoOnBoard.${seatIndex}&quot;,
42
- );
43
-
44
- @property({ type: Number }) seatIndex = 0;
45
-
46
- @handle(personKey)
47
- onPerson(person: OnBoard | null) {
48
- this.announcement = person ? `${person.name}, please proceed to gate B12.` : &quot;&quot;;
49
- }
50
- </code></pre>
51
- <pre><code>&lt;docs-demo-sources for=&quot;demo-handle-dynamic&quot;&gt;&lt;/docs-demo-sources&gt;
52
- &lt;demo-handle-dynamic&gt;&lt;/demo-handle-dynamic&gt;
53
- </code></pre>
54
- <h2 id="multiple-keys">Multiple keys</h2>
55
- <p>Pass up to three <a href="/docs/misc/dataProviderKey">DataProviderKey</a> values; the method receives one argument per key, in the same order. Any assignment to any key calls it, so other arguments may still be <code>null</code>.</p>
56
- <pre><code class="language-typescript">const flightKey = new DataProviderKey&amp;lt;{ status: string; gate: string }&amp;gt;(&quot;flight&quot;);
57
- const weatherKey = new DataProviderKey&amp;lt;{ turbulence: boolean }&amp;gt;(&quot;weather&quot;);
58
-
59
- @handle(flightKey.status, weatherKey.turbulence)
60
- onConditions(status: string, turbulence: boolean) {
61
- this.seatbeltSign = status === &quot;boarding&quot; || turbulence === true;
62
- }
63
- </code></pre>
64
- <h2 id="wait-for-all-values">Wait for all values</h2>
65
- <p>With <code>waitForAllDefined: true</code>, the method runs only once every key holds a value other than <code>null</code> or <code>undefined</code>.</p>
66
- <pre><code class="language-typescript">@handle(flightKey.gate, passengerKey.name, { waitForAllDefined: true })
67
- announce(gate: string, name: string) {
68
- this.message = `${name}, please proceed to gate ${gate}.`;
69
- }
70
- </code></pre>
71
- <h2 id="skip-values">Skip values</h2>
72
- <p><code>skip</code> lists categories of values that must not call the method. A category is a named test, not a value to compare.</p>
73
- <table>
74
- <thead>
75
- <tr>
76
- <th>Category</th>
77
- <th>Matches</th>
78
- </tr>
79
- </thead>
80
- <tbody><tr>
81
- <td><code>Skip.Nullish</code></td>
82
- <td><code>null</code> or <code>undefined</code></td>
83
- </tr>
84
- <tr>
85
- <td><code>Skip.EmptyString</code></td>
86
- <td><code>&quot;&quot;</code></td>
87
- </tr>
88
- <tr>
89
- <td><code>Skip.EmptyObject</code></td>
90
- <td><code>{}</code> (arrays excluded)</td>
91
- </tr>
92
- <tr>
93
- <td><code>Skip.EmptyArray</code></td>
94
- <td><code>[]</code></td>
95
- </tr>
96
- </tbody></table>
97
- <pre><code class="language-typescript">@handle(passengerKey, { skip: [Skip.Nullish, Skip.EmptyObject] })
98
- onPassenger(passenger: Passenger) {
99
- // not called while the publisher still holds {} (not loaded yet)
100
- this.displayName = passenger.name;
101
- }
102
- </code></pre>
103
- <p>To reject a specific value, return early inside the method.</p>
104
- <h2 id="api-reference">API reference</h2>
105
- <table>
106
- <thead>
107
- <tr>
108
- <th>Argument</th>
109
- <th>Type</th>
110
- <th>Description</th>
111
- </tr>
112
- </thead>
113
- <tbody><tr>
114
- <td><code>key</code> (1 to 3)</td>
115
- <td><code>DataProviderKey&lt;T, U&gt;</code></td>
116
- <td>Paths to watch; the method receives one value per key, in order</td>
117
- </tr>
118
- <tr>
119
- <td><code>options.waitForAllDefined</code></td>
120
- <td><code>boolean</code> (default <code>false</code>)</td>
121
- <td>Call the method only when no value is <code>null</code> or <code>undefined</code></td>
122
- </tr>
123
- <tr>
124
- <td><code>options.skip</code></td>
125
- <td><code>Skip[]</code> (default none)</td>
126
- <td>Do not call the method when any value matches one of these categories</td>
127
- </tr>
128
- <tr>
129
- <td><code>options.skipEmptyPlaceholder</code></td>
130
- <td><code>boolean</code> (default <code>false</code>)</td>
131
- <td>Treat a placeholder resolved to <code>&quot;&quot;</code> as not ready</td>
132
- </tr>
133
- </tbody></table>
134
- <p><code>options</code>, if present, is the last argument. <code>@handle</code> replaces the deprecated <a href="/docs/decorators/on-assign">@onAssign</a>: <code>@onAssign(&quot;a&quot;, &quot;b&quot;)</code> is <code>@handle(keyA, keyB, { waitForAllDefined: true })</code>.</p>
135
-
136
- </article>
137
- </main>
138
- </body>
139
- </html>
package/docs/docs/decorators/handle.md DELETED
@@ -1,119 +0,0 @@
1
- # @handle
2
-
3
- `@handle(...keys)` calls the decorated method each time a publisher assigns one of up to three store paths, with one typed argument per key. Nothing is stored on the component: use it for derived values and side effects, and [@subscribe](/docs/decorators/subscribe) when you only need the value. See [Data flow](/docs/getting-started/dataFlow) for the overall model.
4
-
5
- ## Import
6
-
7
- <sonic-code language="typescript">
8
- <template>
9
- import { handle, Skip } from "@supersoniks/concorde/decorators";
10
- import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
11
-
12
- const cockpitKey = new DataProviderKey&lt;{ altitude: number }&gt;("cockpit");
13
-
14
- @handle(cockpitKey.altitude)
15
- onAltitude(feet: number) {
16
- this.meters = Math.round(feet * 0.3048);
17
- }
18
- </template>
19
- </sonic-code>
20
-
21
- ## Basic usage
22
-
23
- The method runs once with the current value when the component connects, then on **every** assignment, including `null` and `undefined`. Below, each climb assigns a new altitude and the method derives meters and flight level.
24
-
25
- <sonic-code>
26
- <template>
27
- <docs-demo-sources for="demo-handle"></docs-demo-sources>
28
- <demo-handle></demo-handle>
29
- </template>
30
- </sonic-code>
31
-
32
- ## Dynamic path
33
-
34
- `${prop}` placeholders resolve from properties of the same component; when one changes, the method is called with the value at the new path. Rules: [Dynamic paths](/docs/misc/dynamic-path).
35
-
36
- <sonic-code language="typescript">
37
- <template>
38
- const personKey = new DataProviderKey&lt;OnBoard, { seatIndex: number }&gt;(
39
- "demoOnBoard.${seatIndex}",
40
- );
41
-
42
- @property({ type: Number }) seatIndex = 0;
43
-
44
- @handle(personKey)
45
- onPerson(person: OnBoard | null) {
46
- this.announcement = person ? `${person.name}, please proceed to gate B12.` : "";
47
- }
48
- </template>
49
- </sonic-code>
50
-
51
- <sonic-code>
52
- <template>
53
- <docs-demo-sources for="demo-handle-dynamic"></docs-demo-sources>
54
- <demo-handle-dynamic></demo-handle-dynamic>
55
- </template>
56
- </sonic-code>
57
-
58
- ## Multiple keys
59
-
60
- Pass up to three [DataProviderKey](/docs/misc/dataProviderKey) values; the method receives one argument per key, in the same order. Any assignment to any key calls it, so other arguments may still be `null`.
61
-
62
- <sonic-code language="typescript">
63
- <template>
64
- const flightKey = new DataProviderKey&lt;{ status: string; gate: string }&gt;("flight");
65
- const weatherKey = new DataProviderKey&lt;{ turbulence: boolean }&gt;("weather");
66
-
67
- @handle(flightKey.status, weatherKey.turbulence)
68
- onConditions(status: string, turbulence: boolean) {
69
- this.seatbeltSign = status === "boarding" || turbulence === true;
70
- }
71
- </template>
72
- </sonic-code>
73
-
74
- ## Wait for all values
75
-
76
- With `waitForAllDefined: true`, the method runs only once every key holds a value other than `null` or `undefined`.
77
-
78
- <sonic-code language="typescript">
79
- <template>
80
- @handle(flightKey.gate, passengerKey.name, { waitForAllDefined: true })
81
- announce(gate: string, name: string) {
82
- this.message = `${name}, please proceed to gate ${gate}.`;
83
- }
84
- </template>
85
- </sonic-code>
86
-
87
- ## Skip values
88
-
89
- `skip` lists categories of values that must not call the method. A category is a named test, not a value to compare.
90
-
91
- | Category | Matches |
92
- |----------|---------|
93
- | `Skip.Nullish` | `null` or `undefined` |
94
- | `Skip.EmptyString` | `""` |
95
- | `Skip.EmptyObject` | `{}` (arrays excluded) |
96
- | `Skip.EmptyArray` | `[]` |
97
-
98
- <sonic-code language="typescript">
99
- <template>
100
- @handle(passengerKey, { skip: [Skip.Nullish, Skip.EmptyObject] })
101
- onPassenger(passenger: Passenger) {
102
- // not called while the publisher still holds {} (not loaded yet)
103
- this.displayName = passenger.name;
104
- }
105
- </template>
106
- </sonic-code>
107
-
108
- To reject a specific value, return early inside the method.
109
-
110
- ## API reference
111
-
112
- | Argument | Type | Description |
113
- |----------|------|-------------|
114
- | `key` (1 to 3) | `DataProviderKey<T, U>` | Paths to watch; the method receives one value per key, in order |
115
- | `options.waitForAllDefined` | `boolean` (default `false`) | Call the method only when no value is `null` or `undefined` |
116
- | `options.skip` | `Skip[]` (default none) | Do not call the method when any value matches one of these categories |
117
- | `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
118
-
119
- `options`, if present, is the last argument. `@handle` replaces the deprecated [@onAssign](/docs/decorators/on-assign): `@onAssign("a", "b")` is `@handle(keyA, keyB, { waitForAllDefined: true })`.