@supersoniks/concorde 5.1.1 → 5.1.3
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.
- package/.agents/skills/concorde-docs/SKILL.md +153 -0
- package/.agents/skills/{concorde-component-docs/template.md → concorde-docs/templates/component.md} +6 -2
- package/.agents/skills/concorde-docs/templates/decorator.md +43 -0
- package/.agents/skills/concorde-docs/templates/guide.md +25 -0
- package/PLAN-DOCS-AGENTS.md +80 -0
- package/README.md +4 -4
- package/ai/README.md +29 -41
- package/ai/skills/concorde/SKILL.md +54 -324
- package/ai/skills/concorde/rules/composition.md +32 -0
- package/ai/skills/concorde/rules/data.md +47 -0
- package/ai/skills/concorde/rules/http.md +25 -0
- package/ai/skills/concorde/rules/lists-forms.md +35 -0
- package/ai/skills/concorde/rules/styling.md +46 -0
- package/ai/skills/concorde/rules/troubleshooting.md +45 -0
- package/build-infos.json +1 -1
- package/concorde-core.bundle.js +21 -21
- package/concorde-core.es.js +977 -980
- package/custom-elements-manifest.public.config.mjs +8 -0
- package/{.tmp-cem/custom-elements.json → custom-elements.json} +11758 -8904
- package/dist/concorde-core.bundle.js +21 -21
- package/dist/concorde-core.es.js +977 -980
- package/dist/docs-mock-api-sw.js +58 -223
- package/dist/docs-mock-api-sw.js.map +4 -4
- package/dist/img/concorde/plane_01.jpg +0 -0
- package/dist/img/concorde/plane_02.jpg +0 -0
- package/dist/img/concorde/plane_03.jpg +0 -0
- package/dist/img/concorde/plane_04.jpg +0 -0
- package/dist/img/concorde/plane_05.jpg +0 -0
- package/dist/img/concorde/plane_06.jpg +0 -0
- package/dist/img/concorde/plane_07.jpg +0 -0
- package/dist/img/concorde/plane_08.jpg +0 -0
- package/dist/img/concorde/plane_09.jpg +0 -0
- package/dist/img/concorde/plane_10.jpg +0 -0
- package/dist/img/concorde/plane_11.jpg +0 -0
- package/dist/img/concorde/plane_12.jpg +0 -0
- package/dist/img/concorde/plane_13.jpg +0 -0
- package/dist/img/og-concorde.jpg +0 -0
- package/dist/robots.txt +11 -10
- package/docs/.htaccess +82 -0
- package/docs/404.html +15 -0
- package/docs/404.md +5 -0
- package/docs/about.html +111 -0
- package/docs/about.md +22 -0
- package/docs/assets/{index-Bb-_LRyY.js → index-6sS76xWj.js} +2625 -3158
- package/docs/assets/index-DkdPbH0F.css +1 -0
- package/docs/core/components/functional/date/date.html +211 -0
- package/docs/core/components/functional/date/date.md +150 -0
- package/docs/core/components/functional/fetch/fetch.html +180 -0
- package/docs/core/components/functional/fetch/fetch.md +108 -0
- package/docs/core/components/functional/if/if.html +65 -0
- package/docs/core/components/functional/if/if.md +34 -0
- package/docs/core/components/functional/jsonata/jsonata.html +110 -0
- package/docs/core/components/functional/jsonata/jsonata.md +61 -0
- package/docs/core/components/functional/list/list.html +200 -0
- package/docs/core/components/functional/list/list.md +125 -0
- package/docs/core/components/functional/mix/mix.html +78 -0
- package/docs/core/components/functional/mix/mix.md +46 -0
- package/docs/core/components/functional/queue/queue.html +155 -0
- package/docs/core/components/functional/queue/queue.md +51 -0
- package/docs/core/components/functional/router/router.html +154 -0
- package/docs/core/components/functional/router/router.md +93 -0
- package/docs/core/components/functional/sdui/sdui-extension-points.html +127 -0
- package/docs/core/components/functional/sdui/sdui-extension-points.md +94 -0
- package/docs/core/components/functional/sdui/sdui.html +397 -0
- package/docs/core/components/functional/sdui/sdui.md +307 -0
- package/docs/core/components/functional/states/states.html +141 -0
- package/docs/core/components/functional/states/states.md +112 -0
- package/docs/core/components/functional/submit/submit.html +178 -0
- package/docs/core/components/functional/submit/submit.md +106 -0
- package/docs/core/components/functional/subscriber/subscriber.html +68 -0
- package/docs/core/components/functional/subscriber/subscriber.md +91 -0
- package/docs/core/components/functional/translation/translation.html +60 -0
- package/docs/core/components/functional/translation/translation.md +38 -0
- package/docs/core/components/functional/value/value.html +81 -0
- package/docs/core/components/functional/value/value.md +47 -0
- package/docs/core/components/ui/alert/alert.html +201 -0
- package/docs/core/components/ui/alert/alert.md +186 -0
- package/docs/core/components/ui/alert-messages/alert-messages.html +132 -0
- package/docs/core/components/ui/alert-messages/alert-messages.md +85 -0
- package/docs/core/components/ui/badge/badge.html +197 -0
- package/docs/core/components/ui/badge/badge.md +181 -0
- package/docs/core/components/ui/button/button.html +309 -0
- package/docs/core/components/ui/button/button.md +216 -0
- package/docs/core/components/ui/captcha/captcha.html +80 -0
- package/docs/core/components/ui/captcha/captcha.md +56 -0
- package/docs/core/components/ui/card/card.html +254 -0
- package/docs/core/components/ui/card/card.md +215 -0
- package/docs/core/components/ui/divider/divider.html +144 -0
- package/docs/core/components/ui/divider/divider.md +126 -0
- package/docs/core/components/ui/form/checkbox/checkbox.html +200 -0
- package/docs/core/components/ui/form/checkbox/checkbox.md +125 -0
- package/docs/core/components/ui/form/fieldset/fieldset.html +238 -0
- package/docs/core/components/ui/form/fieldset/fieldset.md +161 -0
- package/docs/core/components/ui/form/form-actions/form-actions.html +122 -0
- package/docs/core/components/ui/form/form-actions/form-actions.md +98 -0
- package/docs/core/components/ui/form/form-layout/form-layout.html +115 -0
- package/docs/core/components/ui/form/form-layout/form-layout.md +109 -0
- package/docs/core/components/ui/form/input/input.html +235 -0
- package/docs/core/components/ui/form/input/input.md +142 -0
- package/docs/core/components/ui/form/radio/radio.html +144 -0
- package/docs/core/components/ui/form/radio/radio.md +78 -0
- package/docs/core/components/ui/form/select/select.html +178 -0
- package/docs/core/components/ui/form/select/select.md +86 -0
- package/docs/core/components/ui/form/switch/switch.html +146 -0
- package/docs/core/components/ui/form/switch/switch.md +80 -0
- package/docs/core/components/ui/form/textarea/textarea.html +162 -0
- package/docs/core/components/ui/form/textarea/textarea.md +82 -0
- package/docs/core/components/ui/group/group.html +113 -0
- package/docs/core/components/ui/group/group.md +77 -0
- package/docs/core/components/ui/icon/icon.html +223 -0
- package/docs/core/components/ui/icon/icon.md +214 -0
- package/docs/core/components/ui/image/image.html +194 -0
- package/docs/core/components/ui/image/image.md +167 -0
- package/docs/core/components/ui/link/link.html +101 -0
- package/docs/core/components/ui/link/link.md +81 -0
- package/docs/core/components/ui/loader/loader.html +114 -0
- package/docs/core/components/ui/loader/loader.md +87 -0
- package/docs/core/components/ui/menu/menu.html +395 -0
- package/docs/core/components/ui/menu/menu.md +370 -0
- package/docs/core/components/ui/modal/modal.html +324 -0
- package/docs/core/components/ui/modal/modal.md +211 -0
- package/docs/core/components/ui/pop/pop.html +250 -0
- package/docs/core/components/ui/pop/pop.md +216 -0
- package/docs/core/components/ui/progress/progress.html +132 -0
- package/docs/core/components/ui/progress/progress.md +109 -0
- package/docs/core/components/ui/table/table.html +333 -0
- package/docs/core/components/ui/table/table.md +267 -0
- package/docs/core/components/ui/theme/theme.html +116 -0
- package/docs/core/components/ui/theme/theme.md +97 -0
- package/docs/core/components/ui/toast/toast.html +185 -0
- package/docs/core/components/ui/toast/toast.md +147 -0
- package/docs/core/components/ui/tooltip/tooltip.html +112 -0
- package/docs/core/components/ui/tooltip/tooltip.md +89 -0
- package/docs/custom-elements.json +16559 -0
- package/docs/docs/decorators/ancestor-attribute.html +71 -0
- package/docs/docs/decorators/ancestor-attribute.md +59 -0
- package/docs/docs/decorators/auto-subscribe.html +61 -0
- package/docs/docs/decorators/auto-subscribe.md +40 -0
- package/docs/docs/decorators/bind.html +87 -0
- package/docs/docs/decorators/bind.md +76 -0
- package/docs/docs/decorators/get.html +166 -0
- package/docs/docs/decorators/get.md +160 -0
- package/docs/docs/decorators/handle.html +139 -0
- package/docs/docs/decorators/handle.md +119 -0
- package/docs/docs/decorators/on-assign.html +72 -0
- package/docs/docs/decorators/on-assign.md +63 -0
- package/docs/docs/decorators/patch.html +76 -0
- package/docs/docs/decorators/patch.md +44 -0
- package/docs/docs/decorators/post.html +150 -0
- package/docs/docs/decorators/post.md +134 -0
- package/docs/docs/decorators/publish.html +74 -0
- package/docs/docs/decorators/publish.md +56 -0
- package/docs/docs/decorators/put.html +83 -0
- package/docs/docs/decorators/put.md +51 -0
- package/docs/docs/decorators/subscribe.html +91 -0
- package/docs/docs/decorators/subscribe.md +87 -0
- package/docs/docs/decorators/wait-for-ancestors.html +82 -0
- package/docs/docs/decorators/wait-for-ancestors.md +76 -0
- package/docs/docs/directives/sub.html +79 -0
- package/docs/docs/directives/sub.md +75 -0
- package/docs/docs/directives/t.html +91 -0
- package/docs/docs/directives/t.md +73 -0
- package/docs/docs/getting-started/ai-agents.html +130 -0
- package/docs/docs/getting-started/ai-agents.md +50 -0
- package/docs/docs/getting-started/components.html +27 -0
- package/docs/docs/getting-started/create-a-component.html +108 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/create-a-component.md +3 -6
- package/docs/docs/getting-started/dataFlow.html +174 -0
- package/{src/docs/_core-concept → docs/docs/getting-started}/dataFlow.md +18 -19
- package/docs/docs/getting-started/installation.html +69 -0
- package/docs/docs/getting-started/installation.md +36 -0
- package/docs/docs/getting-started/my-first-component.html +180 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/my-first-component.md +5 -14
- package/docs/docs/getting-started/start.html +47 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/start.md +1 -13
- package/docs/docs/getting-started/theming.html +334 -0
- package/docs/docs/index.html +99 -0
- package/docs/docs/misc/api-configuration.html +149 -0
- package/{src/docs/_misc → docs/docs/misc}/api-configuration.md +10 -12
- package/docs/docs/misc/dataProviderKey.html +136 -0
- package/{src/docs/_misc → docs/docs/misc}/dataProviderKey.md +4 -4
- package/docs/docs/misc/docs-mock-api.html +155 -0
- package/{src/docs/_misc → docs/docs/misc}/docs-mock-api.md +12 -13
- package/docs/docs/misc/dynamic-path.html +181 -0
- package/{src/docs/_misc → docs/docs/misc}/dynamic-path.md +8 -8
- package/docs/docs/misc/endpoint.html +51 -0
- package/{src/docs/_misc → docs/docs/misc}/endpoint.md +8 -8
- package/docs/docs/misc/html-integration.html +45 -0
- package/{src/docs/_misc → docs/docs/misc}/html-integration.md +4 -5
- package/docs/docs-mock-api-sw.js +58 -223
- package/docs/docs-mock-api-sw.js.map +4 -4
- package/docs/hubs/decorators.html +438 -0
- package/docs/hubs/form-components.html +404 -0
- package/docs/hubs/remote-data.html +367 -0
- package/docs/img/archive/concorde-001-2cv.webp +0 -0
- package/docs/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
- package/docs/img/archive/concorde-red-arrows-2002.webm +0 -0
- package/docs/img/archive/credits.json +28 -0
- package/docs/img/concorde/plane_01.jpg +0 -0
- package/docs/img/concorde/plane_02.jpg +0 -0
- package/docs/img/concorde/plane_03.jpg +0 -0
- package/docs/img/concorde/plane_04.jpg +0 -0
- package/docs/img/concorde/plane_05.jpg +0 -0
- package/docs/img/concorde/plane_06.jpg +0 -0
- package/docs/img/concorde/plane_07.jpg +0 -0
- package/docs/img/concorde/plane_08.jpg +0 -0
- package/docs/img/concorde/plane_09.jpg +0 -0
- package/docs/img/concorde/plane_10.jpg +0 -0
- package/docs/img/concorde/plane_11.jpg +0 -0
- package/docs/img/concorde/plane_12.jpg +0 -0
- package/docs/img/concorde/plane_13.jpg +0 -0
- package/docs/img/og-concorde.jpg +0 -0
- package/docs/index.html +184 -68
- package/docs/index.md +22 -0
- package/docs/llms-full.txt +5779 -0
- package/docs/llms.txt +108 -0
- package/docs/privacy.html +122 -0
- package/docs/privacy.md +32 -0
- package/docs/robots.txt +11 -10
- package/docs/sitemap.xml +243 -0
- package/docs/src/core/components/functional/date/date.md +150 -0
- package/docs/src/core/components/functional/fetch/fetch.md +108 -0
- package/docs/src/core/components/functional/if/if.md +34 -0
- package/docs/src/core/components/functional/jsonata/jsonata.md +61 -0
- package/docs/src/core/components/functional/list/list.md +125 -0
- package/docs/src/core/components/functional/mix/mix.md +46 -0
- package/docs/src/core/components/functional/queue/queue.md +51 -0
- package/docs/src/core/components/functional/router/router.md +93 -0
- package/docs/src/core/components/functional/sdui/component-catalog.gaps.json +511 -0
- package/docs/src/core/components/functional/sdui/component-catalog.json +3103 -0
- package/docs/src/core/components/functional/sdui/default-library.json +108 -0
- package/docs/src/core/components/functional/sdui/example.json +32 -0
- package/docs/src/core/components/functional/sdui/sdui-extension-points.md +94 -0
- package/docs/src/core/components/functional/sdui/sdui.md +307 -0
- package/docs/src/core/components/functional/states/states.md +112 -0
- package/docs/src/core/components/functional/submit/submit.md +106 -0
- package/docs/src/core/components/functional/subscriber/subscriber.md +91 -0
- package/docs/src/core/components/functional/translation/translation.md +38 -0
- package/docs/src/core/components/functional/value/value.md +47 -0
- package/docs/src/core/components/ui/alert/alert.md +186 -0
- package/docs/src/core/components/ui/alert-messages/alert-messages.md +85 -0
- package/docs/src/core/components/ui/badge/badge.md +181 -0
- package/docs/src/core/components/ui/button/button.md +216 -0
- package/docs/src/core/components/ui/captcha/captcha.md +56 -0
- package/docs/src/core/components/ui/card/card.md +215 -0
- package/docs/src/core/components/ui/divider/divider.md +126 -0
- package/docs/src/core/components/ui/form/checkbox/checkbox.md +125 -0
- package/docs/src/core/components/ui/form/fieldset/fieldset.md +161 -0
- package/docs/src/core/components/ui/form/form-actions/form-actions.md +98 -0
- package/docs/src/core/components/ui/form/form-layout/form-layout.md +109 -0
- package/docs/src/core/components/ui/form/input/input.md +142 -0
- package/docs/src/core/components/ui/form/radio/radio.md +78 -0
- package/docs/src/core/components/ui/form/select/select.md +86 -0
- package/docs/src/core/components/ui/form/switch/switch.md +80 -0
- package/docs/src/core/components/ui/form/textarea/textarea.md +82 -0
- package/docs/src/core/components/ui/group/group.md +77 -0
- package/docs/src/core/components/ui/icon/icon.md +214 -0
- package/docs/src/core/components/ui/icon/icons.json +1 -0
- package/docs/src/core/components/ui/image/image.md +167 -0
- package/docs/src/core/components/ui/link/link.md +81 -0
- package/docs/src/core/components/ui/loader/loader.md +87 -0
- package/docs/src/core/components/ui/menu/menu.md +370 -0
- package/docs/src/core/components/ui/modal/modal.md +211 -0
- package/docs/src/core/components/ui/pop/pop.md +216 -0
- package/docs/src/core/components/ui/progress/progress.md +109 -0
- package/docs/src/core/components/ui/table/table.md +267 -0
- package/docs/src/core/components/ui/theme/theme.md +97 -0
- package/docs/src/core/components/ui/toast/toast.md +147 -0
- package/docs/src/core/components/ui/tooltip/tooltip.md +89 -0
- package/docs/src/docs/decorators/ancestor-attribute.md +59 -0
- package/docs/src/docs/decorators/auto-subscribe.md +40 -0
- package/docs/src/docs/decorators/bind.md +76 -0
- package/docs/src/docs/decorators/get.md +160 -0
- package/docs/src/docs/decorators/handle.md +119 -0
- package/docs/src/docs/decorators/on-assign.md +63 -0
- package/docs/src/docs/decorators/patch.md +44 -0
- package/docs/src/docs/decorators/post.md +134 -0
- package/docs/src/docs/decorators/publish.md +56 -0
- package/docs/src/docs/decorators/put.md +51 -0
- package/docs/src/docs/decorators/subscribe.md +87 -0
- package/docs/src/docs/decorators/wait-for-ancestors.md +76 -0
- package/docs/src/docs/directives/sub.md +75 -0
- package/docs/src/docs/directives/t.md +73 -0
- package/docs/src/docs/getting-started/ai-agents.md +50 -0
- package/docs/src/docs/getting-started/components.md +5 -0
- package/docs/src/docs/getting-started/create-a-component.md +136 -0
- package/docs/src/docs/getting-started/dataFlow.md +87 -0
- package/docs/src/docs/getting-started/installation.md +36 -0
- package/docs/src/docs/getting-started/my-first-component.md +227 -0
- package/docs/src/docs/getting-started/start.md +35 -0
- package/docs/src/docs/getting-started/theming.md +253 -0
- package/docs/src/docs/misc/api-configuration.md +79 -0
- package/docs/src/docs/misc/dataProviderKey.md +168 -0
- package/docs/src/docs/misc/docs-mock-api.md +62 -0
- package/docs/src/docs/misc/dynamic-path.md +71 -0
- package/docs/src/docs/misc/endpoint.md +45 -0
- package/docs/src/docs/misc/html-integration.md +14 -0
- package/docs/src/docs/search/docs-search.json +10332 -0
- package/docs/src/tag-list.json +1 -0
- package/docs/src/tsconfig-model.json +23 -0
- package/docs/src/tsconfig.json +1359 -0
- package/index.html +157 -5
- package/package.json +8 -4
- package/public/docs-mock-api-sw.js +58 -223
- package/public/docs-mock-api-sw.js.map +4 -4
- package/public/img/concorde/plane_01.jpg +0 -0
- package/public/img/concorde/plane_02.jpg +0 -0
- package/public/img/concorde/plane_03.jpg +0 -0
- package/public/img/concorde/plane_04.jpg +0 -0
- package/public/img/concorde/plane_05.jpg +0 -0
- package/public/img/concorde/plane_06.jpg +0 -0
- package/public/img/concorde/plane_07.jpg +0 -0
- package/public/img/concorde/plane_08.jpg +0 -0
- package/public/img/concorde/plane_09.jpg +0 -0
- package/public/img/concorde/plane_10.jpg +0 -0
- package/public/img/concorde/plane_11.jpg +0 -0
- package/public/img/concorde/plane_12.jpg +0 -0
- package/public/img/concorde/plane_13.jpg +0 -0
- package/public/img/og-concorde.jpg +0 -0
- package/public/robots.txt +11 -10
- package/scripts/ai-init.mjs +104 -379
- package/scripts/ai-init.test.mjs +81 -239
- package/scripts/docs-markdown-vite-plugin.ts +43 -0
- package/scripts/docs-public-url.mjs +56 -0
- package/scripts/docs.htaccess +82 -0
- package/scripts/generate-cem.mjs +244 -0
- package/scripts/generate-cem.test.mjs +122 -0
- package/scripts/generate-crawl-docs.mjs +233 -118
- package/scripts/generate-crawl-docs.test.mjs +124 -0
- package/scripts/generate-sdui-catalog.mjs +11 -10
- package/scripts/post-build-docs.js +37 -50
- package/scripts/pre-publish.mjs +2 -1
- package/scripts/site-pages.mjs +212 -0
- package/scripts/site-pages.test.mjs +116 -0
- package/site-pages/about.md +22 -0
- package/site-pages/privacy.md +32 -0
- package/src/core/components/functional/date/date.md +91 -231
- package/src/core/components/functional/fetch/fetch.md +66 -83
- package/src/core/components/functional/if/if.md +28 -3
- package/src/core/components/functional/jsonata/jsonata.md +42 -37
- package/src/core/components/functional/list/list.md +103 -43
- package/src/core/components/functional/mix/mix.md +31 -26
- package/src/core/components/functional/queue/queue.demo.ts +10 -7
- package/src/core/components/functional/queue/queue.md +40 -61
- package/src/core/components/functional/router/router.demo.ts +16 -16
- package/src/core/components/functional/router/router.md +64 -65
- package/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
- package/src/core/components/functional/sdui/component-catalog.json +1 -1
- package/src/core/components/functional/sdui/example.json +19 -86
- package/src/core/components/functional/sdui/sdui-extension-points.md +1 -1
- package/src/core/components/functional/sdui/sdui.md +187 -358
- package/src/core/components/functional/states/states.demo.ts +21 -22
- package/src/core/components/functional/states/states.md +86 -61
- package/src/core/components/functional/states/states.ts +1 -1
- package/src/core/components/functional/submit/submit.md +64 -72
- package/src/core/components/functional/translation/translation.md +38 -0
- package/src/core/components/functional/value/value.md +34 -22
- package/src/core/components/ui/alert/alert.md +48 -58
- package/src/core/components/ui/badge/badge.md +27 -34
- package/src/core/components/ui/button/button.md +139 -106
- package/src/core/components/ui/captcha/captcha.md +17 -32
- package/src/core/components/ui/card/card.md +6 -6
- package/src/core/components/ui/divider/divider.md +8 -11
- package/src/core/components/ui/form/checkbox/checkbox.md +90 -42
- package/src/core/components/ui/form/fieldset/fieldset.md +31 -75
- package/src/core/components/ui/form/form-actions/form-actions.md +14 -16
- package/src/core/components/ui/form/form-layout/form-layout.md +19 -29
- package/src/core/components/ui/form/input/input.md +95 -95
- package/src/core/components/ui/form/radio/radio.md +55 -34
- package/src/core/components/ui/form/select/select.md +60 -45
- package/src/core/components/ui/form/switch/switch.md +57 -34
- package/src/core/components/ui/form/textarea/textarea.md +55 -38
- package/src/core/components/ui/group/group.md +35 -33
- package/src/core/components/ui/icon/icon.md +4 -4
- package/src/core/components/ui/image/image.md +41 -107
- package/src/core/components/ui/link/link.md +6 -6
- package/src/core/components/ui/loader/loader.md +30 -55
- package/src/core/components/ui/menu/menu.md +27 -27
- package/src/core/components/ui/modal/modal.md +72 -96
- package/src/core/components/ui/pop/pop.md +80 -158
- package/src/core/components/ui/progress/progress.md +2 -2
- package/src/core/components/ui/table/table.md +91 -255
- package/src/core/components/ui/theme/theme.md +11 -36
- package/src/core/components/ui/toast/toast.md +48 -117
- package/src/core/components/ui/tooltip/tooltip.md +27 -62
- package/src/core/decorators/subscriber/bind.ts +9 -14
- package/src/core/utils/LocationHandler.spec.ts +80 -0
- package/src/core/utils/LocationHandler.ts +5 -9
- package/src/docs/components/docs-demo-sources.ts +55 -140
- package/src/docs/components/docs-lit-demo.ts +1 -3
- package/src/docs/components/docs-source-link.ts +0 -82
- package/src/docs/decorators/ancestor-attribute.md +59 -0
- package/src/docs/decorators/auto-subscribe.md +40 -0
- package/src/docs/decorators/bind.md +76 -0
- package/src/docs/decorators/get.md +160 -0
- package/src/docs/decorators/handle.md +119 -0
- package/src/docs/decorators/on-assign.md +63 -0
- package/src/docs/decorators/patch.md +44 -0
- package/src/docs/decorators/post.md +134 -0
- package/src/docs/decorators/publish.md +56 -0
- package/src/docs/decorators/put.md +51 -0
- package/src/docs/decorators/subscribe.md +87 -0
- package/src/docs/decorators/wait-for-ancestors.md +76 -0
- package/src/docs/directives/sub.md +75 -0
- package/src/docs/directives/t.md +73 -0
- package/src/docs/docs-location.spec.ts +56 -0
- package/src/docs/docs-location.ts +133 -32
- package/src/docs/docs.ts +1 -2
- package/src/docs/example/decorators-demo-bind-demos.ts +83 -135
- package/src/docs/example/decorators-demo-geo.ts +30 -19
- package/src/docs/example/decorators-demo-post.ts +88 -186
- package/src/docs/example/decorators-demo-subscribe-publish-get-demos.ts +165 -268
- package/src/docs/example/decorators-demo.ts +85 -98
- package/src/docs/example/docs-api-config-demos.ts +19 -20
- package/src/docs/example/docs-flight-demos.ts +147 -0
- package/src/docs/example/docs-jsonata-demos.ts +52 -52
- package/src/docs/example/docs-list-demos.ts +43 -123
- package/src/docs/example/docs-provider-keys.ts +21 -28
- package/src/docs/example/docs-queue-demos.ts +37 -77
- package/src/docs/example/docs-router-demos.ts +20 -25
- package/src/docs/example/docs-submit-demos.ts +48 -48
- package/src/docs/example/docs-toggle-demos.ts +4 -3
- package/src/docs/getting-started/ai-agents.md +50 -0
- package/src/docs/getting-started/components.md +5 -0
- package/src/docs/getting-started/create-a-component.md +136 -0
- package/src/docs/getting-started/dataFlow.md +87 -0
- package/src/docs/getting-started/installation.md +36 -0
- package/src/docs/getting-started/my-first-component.md +227 -0
- package/src/docs/getting-started/start.md +35 -0
- package/src/docs/getting-started/theming.md +253 -0
- package/src/docs/header/header.ts +11 -6
- package/src/docs/home/catalog.ts +1 -1
- package/src/docs/home/home.ts +20 -11
- package/src/docs/layout.ts +12 -13
- package/src/docs/misc/api-configuration.md +79 -0
- package/src/docs/misc/dataProviderKey.md +168 -0
- package/src/docs/misc/docs-mock-api.md +62 -0
- package/src/docs/misc/dynamic-path.md +71 -0
- package/src/docs/misc/endpoint.md +45 -0
- package/src/docs/misc/html-integration.md +14 -0
- package/src/docs/mock-api/api-config-mock.ts +5 -0
- package/src/docs/mock-api/fixtures.ts +0 -278
- package/src/docs/mock-api/flights.ts +89 -0
- package/src/docs/mock-api/router.ts +3 -4
- package/src/docs/mock-api/urls.ts +1 -2
- package/src/docs/navigation/navigation.ts +82 -103
- package/src/docs/navigation/toc.ts +7 -4
- package/src/docs/search/docs-search.json +2804 -5024
- package/src/docs/search/markdown-renderer.ts +31 -8
- package/src/docs/search/page.ts +9 -6
- package/src/docs/search/search.ts +154 -122
- package/src/docs/tailwind/css/docs/content.css +4 -5
- package/src/tsconfig.json +11 -5
- package/src/tsconfig.tsbuildinfo +1 -1
- package/vite.config.mts +11 -2
- package/.agents/skills/concorde-component-docs/SKILL.md +0 -194
- package/ai/AGENTS.md +0 -56
- package/ai/cursor/rules/concorde-menu.mdc +0 -15
- package/ai/cursor/rules/concorde-scope.mdc +0 -14
- package/ai/cursor/rules/concorde-theme.mdc +0 -13
- package/ai/cursor/rules/concorde.mdc +0 -66
- package/ai/jetbrains/rules/concorde.md +0 -53
- package/ai/skills/concorde-get-set-dp/SKILL.md +0 -194
- package/ai/skills/concorde-imports/SKILL.md +0 -78
- package/ai/skills/concorde-menu/SKILL.md +0 -74
- package/ai/skills/concorde-scope/SKILL.md +0 -70
- package/ai/skills/concorde-theme/SKILL.md +0 -57
- package/docs/assets/index-CD4WyL6o.css +0 -1
- package/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +0 -29
- package/src/docs/_core-concept/overview.md +0 -57
- package/src/docs/_core-concept/subscriber.md +0 -75
- package/src/docs/_decorators/ancestor-attribute.md +0 -128
- package/src/docs/_decorators/auto-subscribe.md +0 -202
- package/src/docs/_decorators/bind.md +0 -167
- package/src/docs/_decorators/get.md +0 -162
- package/src/docs/_decorators/handle.md +0 -175
- package/src/docs/_decorators/on-assign.md +0 -390
- package/src/docs/_decorators/patch.md +0 -70
- package/src/docs/_decorators/post.md +0 -146
- package/src/docs/_decorators/publish.md +0 -55
- package/src/docs/_decorators/put.md +0 -70
- package/src/docs/_decorators/subscribe.md +0 -100
- package/src/docs/_decorators/wait-for-ancestors.md +0 -163
- package/src/docs/_directives/sub.md +0 -91
- package/src/docs/_getting-started/ai-agents.md +0 -76
- package/src/docs/_getting-started/concorde-manual-install.md +0 -133
- package/src/docs/_getting-started/concorde-outside.md +0 -33
- package/src/docs/_getting-started/my-first-subscriber.md +0 -120
- package/src/docs/_getting-started/pubsub.md +0 -37
- package/src/docs/_misc/formelement-subscriber-removal.md +0 -115
- package/src/docs/example/docs-input-autocomplete-demos.ts +0 -110
- package/src/docs/example/docs-joke-demos.ts +0 -297
- /package/{src/docs/_getting-started → docs/docs/getting-started}/components.md +0 -0
- /package/{src/docs/_getting-started → docs/docs/getting-started}/theming.md +0 -0
package/src/docs/home/home.ts
CHANGED
|
@@ -5,8 +5,8 @@ import { sectionPages } from "../navigation/components-index";
|
|
|
5
5
|
import { COMPONENT_NOTES } from "./catalog";
|
|
6
6
|
import "./mach-stage";
|
|
7
7
|
|
|
8
|
-
const GET_STARTED = "
|
|
9
|
-
const COMPONENTS_PAGE = "
|
|
8
|
+
const GET_STARTED = "/docs/getting-started/start";
|
|
9
|
+
const COMPONENTS_PAGE = "/docs/getting-started/components";
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
12
|
* Presets for the theming instrument: palette, typeface and radius all come from tokens.
|
|
@@ -125,7 +125,13 @@ const INDEX_TABS = [
|
|
|
125
125
|
{ title: "Functional components", label: "Functional" },
|
|
126
126
|
];
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
/** Components listed in the sidebar, so the count follows the menu (hidden pages excluded). */
|
|
129
|
+
const COMPONENT_COUNT = INDEX_TABS.reduce(
|
|
130
|
+
(total, tab) => total + sectionPages(tab.title).length,
|
|
131
|
+
0,
|
|
132
|
+
);
|
|
133
|
+
|
|
134
|
+
const ARCHIVE = "/img/archive/";
|
|
129
135
|
|
|
130
136
|
/** Credit lines for the archive pictures (CC BY / CC BY-SA, from assets.mjs --credits). */
|
|
131
137
|
const CREDITS = `Film: <a href="https://commons.wikimedia.org/wiki/File:Concorde_%26_Red_Arrows_2002.webm">“Concorde & Red Arrows 2002”</a> by Steve Elliott, <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC BY-SA 2.0</a>, via Wikimedia Commons.`;
|
|
@@ -209,10 +215,10 @@ this.querySelectorAll("[data-reveal]").forEach((el) =>
|
|
|
209
215
|
Web components<br />for every stack.
|
|
210
216
|
</h1>
|
|
211
217
|
<div class="hero-actions hero-in" style="--d:180ms">
|
|
212
|
-
<sonic-button size="lg" type="primary" class="signal-button" href=${GET_STARTED}
|
|
218
|
+
<sonic-button size="lg" type="primary" class="signal-button" pushState href=${GET_STARTED}
|
|
213
219
|
>Open the manual</sonic-button
|
|
214
220
|
>
|
|
215
|
-
<sonic-link href=${COMPONENTS_PAGE} class="text-link"
|
|
221
|
+
<sonic-link pushState href=${COMPONENTS_PAGE} class="text-link"
|
|
216
222
|
>Browse the components</sonic-link
|
|
217
223
|
>
|
|
218
224
|
</div>
|
|
@@ -229,7 +235,7 @@ this.querySelectorAll("[data-reveal]").forEach((el) =>
|
|
|
229
235
|
private renderManifesto() {
|
|
230
236
|
return html`<section class="manifesto" aria-label="What Concorde is">
|
|
231
237
|
<p class="manifesto-text" data-reveal>
|
|
232
|
-
Concorde is a Lit library of
|
|
238
|
+
Concorde is a Lit library of ${COMPONENT_COUNT} web components. They bind data, call
|
|
233
239
|
APIs and theme themselves from plain HTML, in React, Vue, PHP or a
|
|
234
240
|
static page.
|
|
235
241
|
</p>
|
|
@@ -251,7 +257,7 @@ this.querySelectorAll("[data-reveal]").forEach((el) =>
|
|
|
251
257
|
const focus = COMPONENT_NOTES[this.focus] ?? COMPONENT_NOTES[pages[0]?.label];
|
|
252
258
|
return html`<section class="index" aria-labelledby="index-title">
|
|
253
259
|
<div class="index-head" data-reveal>
|
|
254
|
-
<h2 id="index-title" class="section-title"
|
|
260
|
+
<h2 id="index-title" class="section-title">${COMPONENT_COUNT} components,<br />one tag each.</h2>
|
|
255
261
|
<div class="index-filters" role="group" aria-label="Component families" data-ui>
|
|
256
262
|
${INDEX_TABS.map((t, i) => {
|
|
257
263
|
const on = this.families.has(i);
|
|
@@ -268,9 +274,10 @@ this.querySelectorAll("[data-reveal]").forEach((el) =>
|
|
|
268
274
|
</div>
|
|
269
275
|
</div>
|
|
270
276
|
<p class="index-wall">
|
|
271
|
-
|
|
277
|
+
${pages.map(
|
|
272
278
|
(page) => html`<span class="wall-item"
|
|
273
279
|
><sonic-link
|
|
280
|
+
pushState
|
|
274
281
|
href=${page.href}
|
|
275
282
|
class="wall-name ${page.label === this.focus ? "is-focus" : ""}"
|
|
276
283
|
@mouseenter=${() => (this.focus = page.label)}
|
|
@@ -283,7 +290,7 @@ this.querySelectorAll("[data-reveal]").forEach((el) =>
|
|
|
283
290
|
<div class="index-caption" aria-live="polite">
|
|
284
291
|
<code class="index-caption-tag"><${focus?.tag ?? ""}></code>
|
|
285
292
|
<span class="index-caption-note">${focus?.note ?? ""}</span>
|
|
286
|
-
<sonic-link href=${COMPONENTS_PAGE} class="text-link index-caption-all"
|
|
293
|
+
<sonic-link pushState href=${COMPONENTS_PAGE} class="text-link index-caption-all"
|
|
287
294
|
>All components</sonic-link
|
|
288
295
|
>
|
|
289
296
|
</div>
|
|
@@ -489,11 +496,13 @@ this.querySelectorAll("[data-reveal]").forEach((el) =>
|
|
|
489
496
|
<div class="footer-line">
|
|
490
497
|
<span>Concorde, web components by Supersoniks</span>
|
|
491
498
|
<nav class="footer-links" aria-label="Footer">
|
|
492
|
-
<sonic-link href=${GET_STARTED}>Docs</sonic-link>
|
|
493
|
-
<sonic-link href=${COMPONENTS_PAGE}>Components</sonic-link>
|
|
499
|
+
<sonic-link pushState href=${GET_STARTED}>Docs</sonic-link>
|
|
500
|
+
<sonic-link pushState href=${COMPONENTS_PAGE}>Components</sonic-link>
|
|
494
501
|
<sonic-link href="https://www.npmjs.com/package/@supersoniks/concorde" target="_blank"
|
|
495
502
|
>npm</sonic-link
|
|
496
503
|
>
|
|
504
|
+
<sonic-link href="/about">About</sonic-link>
|
|
505
|
+
<sonic-link href="/privacy">Privacy</sonic-link>
|
|
497
506
|
</nav>
|
|
498
507
|
<span class="footer-end">MIT licence · ${new Date().getFullYear()}</span>
|
|
499
508
|
</div>
|
package/src/docs/layout.ts
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import LocationHandler from "@supersoniks/concorde/core/utils/LocationHandler";
|
|
2
|
+
import { parseDocsLocation } from "./docs-location";
|
|
3
|
+
|
|
4
|
+
const onLocationChange = (locationHref: string) => {
|
|
5
|
+
const { url } = parseDocsLocation(locationHref);
|
|
6
|
+
// No markdown path → home.
|
|
7
|
+
if (!url) {
|
|
5
8
|
document.documentElement.setAttribute("data-home", "");
|
|
6
9
|
} else {
|
|
7
10
|
document.documentElement.removeAttribute("data-home");
|
|
8
11
|
}
|
|
9
12
|
};
|
|
10
|
-
const getCurrentLocation = () => document.location;
|
|
11
|
-
const currentLocation: Location = getCurrentLocation();
|
|
12
|
-
onLocationChange(currentLocation);
|
|
13
|
-
window.addEventListener("popstate", (event) => {
|
|
14
|
-
onLocationChange(getCurrentLocation());
|
|
15
|
-
});
|
|
16
13
|
|
|
17
|
-
//
|
|
18
|
-
|
|
19
|
-
|
|
14
|
+
// LocationHandler polls document.location (covers pushState; popstate alone does not).
|
|
15
|
+
LocationHandler.onChange({
|
|
16
|
+
set location(value: string) {
|
|
17
|
+
onLocationChange(value);
|
|
18
|
+
},
|
|
20
19
|
});
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# API configuration
|
|
2
|
+
|
|
3
|
+
`APIConfiguration` is the object built by [`HTML.getApiConfiguration`](../../core/utils/HTML.ts) from **ancestor attributes** on the DOM (or from a typed publisher — see [@get](/docs/decorators/get) / [@post](/docs/decorators/post) configuration key). It is passed to [`API`](../../core/utils/api.ts) by fetchers, **sonic-submit**, the **`wording()`** directive, **`@get`**, **`@post`**, **`@put`**, and **`@patch`**.
|
|
4
|
+
|
|
5
|
+
> **Mock service:** same [Local API demos](/docs/misc/docs-mock-api) Service Worker / Vite middleware. Routes used on this page are listed in the [API config routes](#api-config-routes) section below.
|
|
6
|
+
|
|
7
|
+
## Attribute map
|
|
8
|
+
|
|
9
|
+
| Attribute (ancestor) | `APIConfiguration` field | Role |
|
|
10
|
+
|---------------------|---------------------------|------|
|
|
11
|
+
| `serviceURL` | `serviceURL` | Base URL (e.g. `/docs-mock-api`) |
|
|
12
|
+
| `token` | `token` | Static Bearer sent on REST calls |
|
|
13
|
+
| `userName` / `password` | `userName` / `password` | Basic auth for **tokenProvider** fetch only |
|
|
14
|
+
| `eventsApiToken` | `authToken` | Bearer for **tokenProvider** when no Basic |
|
|
15
|
+
| `tokenProvider` | `tokenProvider` | Path to GET a new token (`{ token }` JSON) |
|
|
16
|
+
| `wordingProvider` | — (read by `wording()`) | Base path + query for label batch GET |
|
|
17
|
+
| `wordingVersionProvider` | — | Publisher id; bump version → reload wordings |
|
|
18
|
+
| `credentials` | `credentials` | `fetch` credentials mode |
|
|
19
|
+
| `addHTTPResponse` | `addHTTPResponse` | Attach `_sonic_http_response_` on result |
|
|
20
|
+
| `cache` | `cache` | `fetch` cache mode |
|
|
21
|
+
| `blockUntilDone` | `blockUntilDone` | Serialize calls per `serviceURL` |
|
|
22
|
+
| `keepAlive` | `keepAlive` | `fetch` keepalive |
|
|
23
|
+
|
|
24
|
+
**Lit / TypeScript:** store the same shape in a publisher and pass `DataProviderKey<APIConfiguration>` as the second argument of `@get` (see [DataProviderKey](/docs/misc/dataProviderKey)).
|
|
25
|
+
|
|
26
|
+
## Bearer token (static)
|
|
27
|
+
|
|
28
|
+
Publisher `docsApiConfBearerKey` (`set(docsApiConfBearerKey, { token: "docs-mock-valid-token", … })`) — mock returns the protected payload.
|
|
29
|
+
|
|
30
|
+
<docs-lit-demo for="docs-api-config-bearer-demo"></docs-lit-demo>
|
|
31
|
+
|
|
32
|
+
## tokenProvider + Basic auth
|
|
33
|
+
|
|
34
|
+
No static `token`: `API.auth()` calls `GET /docs-mock-api/auth/token` with Basic **demo** / **secret**, stores `token`, then calls the protected route.
|
|
35
|
+
|
|
36
|
+
<docs-lit-demo for="docs-api-config-token-provider-demo"></docs-lit-demo>
|
|
37
|
+
|
|
38
|
+
## HTTP 498 — stale token refresh
|
|
39
|
+
|
|
40
|
+
Initial `token="docs-mock-stale-token"` → mock responds **498** → Concorde invalidates the token, runs `auth()` again (same `tokenProvider` + Basic), retries with `docs-mock-fresh-token`.
|
|
41
|
+
|
|
42
|
+
<docs-lit-demo for="docs-api-config-stale-token-demo"></docs-lit-demo>
|
|
43
|
+
|
|
44
|
+
## eventsApiToken
|
|
45
|
+
|
|
46
|
+
Attribute **`eventsApiToken`** on an ancestor maps to **`authToken`** in config (used as Bearer when calling `tokenProvider`, instead of Basic).
|
|
47
|
+
|
|
48
|
+
<docs-lit-demo for="docs-api-config-events-token-demo"></docs-lit-demo>
|
|
49
|
+
|
|
50
|
+
## Wording API
|
|
51
|
+
|
|
52
|
+
`wordingProvider` and `wordingVersionProvider` are read by the translation directive: see [t()](/docs/directives/t).
|
|
53
|
+
|
|
54
|
+
## Scoped attributes (HTML / sonic-scope)
|
|
55
|
+
|
|
56
|
+
Attributes on **`sonic-scope`** (or any ancestor) are visible to descendants via `getAncestorAttributeValue`.
|
|
57
|
+
|
|
58
|
+
<docs-lit-demo for="docs-api-config-scoped-attrs-demo"></docs-lit-demo>
|
|
59
|
+
|
|
60
|
+
## API config routes
|
|
61
|
+
|
|
62
|
+
| Route | Demo |
|
|
63
|
+
|-------|------|
|
|
64
|
+
| `GET /docs-mock-api/auth/token` | tokenProvider, eventsApiToken |
|
|
65
|
+
| `GET /docs-mock-api/api/config/protected` | Bearer / Basic / 498 |
|
|
66
|
+
| `GET /docs-mock-api/wording/labels?labels[]=…&lang=fr` | `wording()` |
|
|
67
|
+
|
|
68
|
+
Mock tokens (doc only): `docs-mock-valid-token`, `docs-mock-stale-token` (498), `docs-mock-fresh-token` (after refresh). Basic: **demo** / **secret**. Events token: `docs-mock-events-token`.
|
|
69
|
+
|
|
70
|
+
Implementation: `src/docs/mock-api/api-config-mock.ts` (bundled in the Service Worker with `router.ts`).
|
|
71
|
+
|
|
72
|
+
## See also
|
|
73
|
+
|
|
74
|
+
- [@get](/docs/decorators/get) — `APIConfiguration` + `Endpoint`
|
|
75
|
+
- [@post](/docs/decorators/post) — same configuration model for POST
|
|
76
|
+
- [@put](/docs/decorators/put) · [@patch](/docs/decorators/patch) — PUT / PATCH
|
|
77
|
+
- [Endpoint](/docs/misc/endpoint) — typed path
|
|
78
|
+
- [Local API demos](/docs/misc/docs-mock-api) — offline `serviceURL`
|
|
79
|
+
- [Fetch](/core/components/functional/fetch) — attribute table (legacy sonic-fetch)
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# DataProviderKey
|
|
2
|
+
|
|
3
|
+
The `DataProviderKey<T>` utility provides type-safe navigation through composite data structures. Each property or index access extends the path, and the final key can be retrieved via `toString()` or the `path` property.
|
|
4
|
+
|
|
5
|
+
For a **single HTTP path string** (no dot-syntax), see [Endpoint](/docs/misc/endpoint). For **`DataProviderKey<APIConfiguration>`**, see [API configuration](/docs/misc/api-configuration).
|
|
6
|
+
|
|
7
|
+
## Principle
|
|
8
|
+
|
|
9
|
+
`DataProviderKey` uses a Proxy to intercept property access and build a cumulative path string. TypeScript infers the nested type at each level, so `myKey.items[0]` is correctly typed as `DataProviderKey<Item>` when `items` is `Item[]`.
|
|
10
|
+
|
|
11
|
+
In Lit demos, bind HTML attributes from a key’s **`.path`** (single source of truth), and use **`get` / `set` / `dp`** instead of `PublisherManager.get("…")`:
|
|
12
|
+
|
|
13
|
+
<sonic-code language="typescript">
|
|
14
|
+
<template>
|
|
15
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
16
|
+
import { get, set } from "@supersoniks/concorde/utils";
|
|
17
|
+
|
|
18
|
+
export const myFormKey = new DataProviderKey<{ email: string }>("myForm");
|
|
19
|
+
set(myFormKey, { email: "a@b.c" });
|
|
20
|
+
|
|
21
|
+
// template: formDataProvider=${myFormKey.path}
|
|
22
|
+
</template>
|
|
23
|
+
</sonic-code>
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
### Import
|
|
28
|
+
|
|
29
|
+
<sonic-code language="typescript">
|
|
30
|
+
<template>
|
|
31
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
32
|
+
</template>
|
|
33
|
+
</sonic-code>
|
|
34
|
+
|
|
35
|
+
### Basic example
|
|
36
|
+
|
|
37
|
+
<sonic-code language="typescript">
|
|
38
|
+
<template>
|
|
39
|
+
type Item = { id: string; name: string };
|
|
40
|
+
//
|
|
41
|
+
type Data = {
|
|
42
|
+
items: Item[];
|
|
43
|
+
count: number;
|
|
44
|
+
};
|
|
45
|
+
//
|
|
46
|
+
const myKey = new DataProviderKey<Data>("data").items[0];
|
|
47
|
+
// Equivalent to: new DataProviderKey<Item>("data.items.0")
|
|
48
|
+
myKey.toString(); // "data.items.0"
|
|
49
|
+
myKey.path; // same value
|
|
50
|
+
// myKey is typed as DataProviderKey<Item>
|
|
51
|
+
</template>
|
|
52
|
+
</sonic-code>
|
|
53
|
+
|
|
54
|
+
### Object property access
|
|
55
|
+
|
|
56
|
+
<sonic-code language="typescript">
|
|
57
|
+
<template>
|
|
58
|
+
const key = new DataProviderKey<Data>("data");
|
|
59
|
+
const countKey = key.count;
|
|
60
|
+
countKey.path; // "data.count"
|
|
61
|
+
countKey.toString(); // "data.count"
|
|
62
|
+
</template>
|
|
63
|
+
</sonic-code>
|
|
64
|
+
|
|
65
|
+
### Array index access
|
|
66
|
+
|
|
67
|
+
<sonic-code language="typescript">
|
|
68
|
+
<template>
|
|
69
|
+
const itemsKey = new DataProviderKey<Data>("data").items;
|
|
70
|
+
itemsKey.path; // "data.items"
|
|
71
|
+
// itemsKey is DataProviderKey<Item[]>
|
|
72
|
+
//
|
|
73
|
+
const firstItem = itemsKey[0];
|
|
74
|
+
firstItem.path; // "data.items.0"
|
|
75
|
+
// firstItem is DataProviderKey<Item>
|
|
76
|
+
</template>
|
|
77
|
+
</sonic-code>
|
|
78
|
+
|
|
79
|
+
### Dynamic paths
|
|
80
|
+
|
|
81
|
+
Use placeholders `${prop}` or `{$prop}` in the path string. The path is resolved at runtime from the component's properties. See [Dynamic path placeholders](/docs/misc/dynamic-path) for resolution rules and `skipEmptyPlaceholder`. The type remains declarative:
|
|
82
|
+
|
|
83
|
+
<sonic-code language="typescript">
|
|
84
|
+
<template>
|
|
85
|
+
type User = { name: string; email: string };
|
|
86
|
+
//
|
|
87
|
+
// Path resolved from component.userIndex at runtime
|
|
88
|
+
@subscribe(new DataProviderKey<User>("users.${userIndex}"))
|
|
89
|
+
@state()
|
|
90
|
+
user: User | null = null;
|
|
91
|
+
</template>
|
|
92
|
+
</sonic-code>
|
|
93
|
+
|
|
94
|
+
Dynamic keys are **not** supported by `get`, `set`, or `dp` — those APIs take a snapshot at call time with no component context. For dynamic paths use decorators (`@subscribe`, `@publish`, `@handle`) or **`sub(key)`** in Lit templates (resolves `${…}` from the host component). See [sub()](/docs/directives/sub).
|
|
95
|
+
|
|
96
|
+
### get / set / dp with static keys
|
|
97
|
+
|
|
98
|
+
For programmatic access, pass a `DataProviderKey` or a static path string. Dynamic placeholders are rejected:
|
|
99
|
+
|
|
100
|
+
<sonic-code language="typescript">
|
|
101
|
+
<template>
|
|
102
|
+
import { dp, get, set } from "@supersoniks/concorde/utils";
|
|
103
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
104
|
+
//
|
|
105
|
+
const counterKey = new DataProviderKey<{ count: number }>("myCounter");
|
|
106
|
+
//
|
|
107
|
+
set(counterKey, { count: 0 });
|
|
108
|
+
dp(counterKey.count).set(1);
|
|
109
|
+
get(counterKey); // snapshot: { count: 1 }
|
|
110
|
+
</template>
|
|
111
|
+
</sonic-code>
|
|
112
|
+
|
|
113
|
+
## Path retrieval
|
|
114
|
+
|
|
115
|
+
The final path is built by concatenating each accessed property with a dot:
|
|
116
|
+
|
|
117
|
+
- `new DataProviderKey<T>("base")` → `"base"`
|
|
118
|
+
- `key.prop` → `"base.prop"`
|
|
119
|
+
- `key.items[0]` → `"base.items.0"`
|
|
120
|
+
|
|
121
|
+
Use `toString()` or `path` to get the full path string:
|
|
122
|
+
|
|
123
|
+
<sonic-code language="typescript">
|
|
124
|
+
<template>
|
|
125
|
+
const key = new DataProviderKey<Data>("data").count;
|
|
126
|
+
const pathString = key.toString(); // "data.count"
|
|
127
|
+
const pathProp = key.path; // "data.count"
|
|
128
|
+
</template>
|
|
129
|
+
</sonic-code>
|
|
130
|
+
|
|
131
|
+
## Use cases
|
|
132
|
+
|
|
133
|
+
- **Type-safe bindings**: paths for `@bind`, `@subscribe`, `@publish`, `@handle`
|
|
134
|
+
- **Dynamic paths**: reusable keys with `${...}` placeholders
|
|
135
|
+
- **Form fields**: form data paths with compile-time checking
|
|
136
|
+
|
|
137
|
+
## Integration with @subscribe, @publish and @handle
|
|
138
|
+
|
|
139
|
+
Use `DataProviderKey` with `@subscribe` (read-only), `@publish` (write-only), or `@handle` (method callback on assign). With `@subscribe` / `@publish`, the decorated property **must** match the key’s value type. With `@handle`, the method receives `(value: T)`.
|
|
140
|
+
|
|
141
|
+
<sonic-code language="typescript">
|
|
142
|
+
<template>
|
|
143
|
+
import { subscribe } from "@supersoniks/concorde/decorators";
|
|
144
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
145
|
+
//
|
|
146
|
+
type FormData = { email: string };
|
|
147
|
+
const formKey = new DataProviderKey<FormData>("formData");
|
|
148
|
+
//
|
|
149
|
+
@customElement("user-form")
|
|
150
|
+
export class UserForm extends LitElement {
|
|
151
|
+
@subscribe(formKey.email)
|
|
152
|
+
@state()
|
|
153
|
+
email = "";
|
|
154
|
+
//
|
|
155
|
+
render() {
|
|
156
|
+
return html`<input .value=${this.email} @input=${(e) => this.email = (e.target as HTMLInputElement).value}>`;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
</template>
|
|
160
|
+
</sonic-code>
|
|
161
|
+
|
|
162
|
+
These decorators support dynamic paths: `"base.${prop}"` in the constructor. A wrong property type (e.g. `number` for `DataProviderKey<string>`) is a TypeScript error. Resolution rules: [Dynamic path placeholders](/docs/misc/dynamic-path). See [@handle](/docs/decorators/handle) for method callbacks.
|
|
163
|
+
|
|
164
|
+
## Notes
|
|
165
|
+
|
|
166
|
+
- Function properties are excluded from navigation (no `key.method()` chaining)
|
|
167
|
+
- Primitives have no navigable properties
|
|
168
|
+
- The `path` property and `toString()` are equivalent for retrieving the key
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Local API demos (offline)
|
|
2
|
+
|
|
3
|
+
The Concorde doc site does not call fragile third-party APIs during `yarn dev`. A **Service Worker** and the Vite dev middleware serve **`/docs-mock-api/*`** on the same origin.
|
|
4
|
+
|
|
5
|
+
## How it works
|
|
6
|
+
|
|
7
|
+
1. On load, `registerDocsMockApiServiceWorker()` registers `/docs-mock-api-sw.js`.
|
|
8
|
+
2. Requests to `/docs-mock-api/...` are handled by the SW (production build) or Vite middleware (dev).
|
|
9
|
+
3. Live examples use `serviceURL="/docs-mock-api"` and relative paths.
|
|
10
|
+
|
|
11
|
+
TypeScript constants: `src/docs/mock-api/urls.ts` (`DOCS_MOCK_REQRES_SERVICE`, `DOCS_MOCK_GEO_SERVICE`, …).
|
|
12
|
+
|
|
13
|
+
## Routes
|
|
14
|
+
|
|
15
|
+
| Path | Used in |
|
|
16
|
+
|------|---------|
|
|
17
|
+
| `/docs-mock-api/api/users` | [My first component](/docs/getting-started/my-first-component) users list |
|
|
18
|
+
| `/docs-mock-api/api/users/:id` | Single user, `docs-user` |
|
|
19
|
+
| `/docs-mock-api/api/space-cats` | Fixtures shared with the jsonata unit tests |
|
|
20
|
+
| `/docs-mock-api/api/coffee-bags` | fixtures / tests jsonata (`?roast=`) |
|
|
21
|
+
| `/docs-mock-api/api/market-order` | Fixtures shared with the jsonata unit tests |
|
|
22
|
+
| `POST /docs-mock-api/api/register` | **sonic-submit** — JSON, `multipart/form-data` (`sendAsFormData`), or `application/x-www-form-urlencoded` (native `<form>`); response includes parsed `email` + `token` |
|
|
23
|
+
| `POST /docs-mock-api/api/register/nested` | Wrapped body `{ data: { id, token } }` for the `submitResultKey` demo |
|
|
24
|
+
| `GET /docs-mock-api/api/register/echo` | Echoes query string (`method="get"` on submit) |
|
|
25
|
+
| `GET /docs-mock-api/auth/token` | [API configuration](/docs/misc/api-configuration) — tokenProvider (Basic or `eventsApiToken`) |
|
|
26
|
+
| `GET /docs-mock-api/api/config/protected` | Bearer / Basic; `docs-mock-stale-token` → **498** |
|
|
27
|
+
| `GET /docs-mock-api/wording/labels` | Wording batch (`labels[]`, `lang`) |
|
|
28
|
+
| `/docs-mock-api/geo/communes` | `@get` demos |
|
|
29
|
+
| `GET /docs-mock-api/flights` | Flight board (`key="flights"`): `sonic-list` · `sonic-fetch` · `sonic-queue` · `sonic-jsonata` · `sonic-states` and the input / select / radio / switch filter demos |
|
|
30
|
+
|
|
31
|
+
### Filters `GET /flights`
|
|
32
|
+
|
|
33
|
+
| Query | Meaning |
|
|
34
|
+
|-------|---------|
|
|
35
|
+
| `direction` | `departures` · `arrivals` |
|
|
36
|
+
| `q` | Substring on flight number, city or airport code |
|
|
37
|
+
| `status` | Comma-separated statuses to keep: `on-time` · `boarding` · `delayed` · `landed` · `cancelled` (`all` = no filter) |
|
|
38
|
+
| `offset` + `limit` | Pagination for **sonic-queue** lazy load |
|
|
39
|
+
|
|
40
|
+
### Pagination `GET /api/users`
|
|
41
|
+
|
|
42
|
+
| Query | Meaning |
|
|
43
|
+
|-------|---------|
|
|
44
|
+
| `offset` + `per_page` | Index-based slice on the filtered set — **sonic-queue** (`offset=$offset&per_page=$limit`) |
|
|
45
|
+
| `page` + `per_page` | 1-based page — static fetch examples (`?page=2`) |
|
|
46
|
+
| `limit` | Alias of `per_page` |
|
|
47
|
+
| `q` | Search on first name, last name, email (optional; **sonic-queue** + `dataFilterProvider`, field `name="q"`) |
|
|
48
|
+
|
|
49
|
+
**ALTCHA** (`sonic-captcha`) is **not** mocked — it still uses the Supersoniks service.
|
|
50
|
+
|
|
51
|
+
In TypeScript demos, import from `src/docs/mock-api/urls.ts` (e.g. `DOCS_MOCK_REQRES_SERVICE` on `serviceURL`).
|
|
52
|
+
|
|
53
|
+
## Source files
|
|
54
|
+
|
|
55
|
+
- `src/docs/mock-api/` — router, fixtures, service worker, `urls.ts`
|
|
56
|
+
- `scripts/docs-mock-api-vite-plugin.ts` — SW build + middleware
|
|
57
|
+
- `public/docs-mock-api-sw.js` — generated on `yarn dev` / `yarn build-docs`
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
yarn dev # mock API on by default
|
|
61
|
+
yarn build-docs # includes SW bundle
|
|
62
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Dynamic path placeholders
|
|
2
|
+
|
|
3
|
+
Decorators and `DataProviderKey` paths can include **placeholders** resolved on the host component at runtime:
|
|
4
|
+
|
|
5
|
+
- `${prop}` or `{$prop}` — e.g. `"users/${userId}"`, `"api/sessions/${sessionId}/sync"`
|
|
6
|
+
- Nested expressions — e.g. `"teams.${teamId}.members"`
|
|
7
|
+
|
|
8
|
+
Resolution is done by [`resolveDynamicPath`](../../core/decorators/subscriber/dynamicPath.ts). The root property names (`userId`, `sessionId`, …) are watched via `requestAnimationFrame` (see `dynamicPropertyWatch.ts`).
|
|
9
|
+
|
|
10
|
+
## Default behaviour (`ready` / `not ready`)
|
|
11
|
+
|
|
12
|
+
| Placeholder value | Path `ready`? | Inserted segment | Notes |
|
|
13
|
+
|-------------------|---------------|------------------|-------|
|
|
14
|
+
| `undefined` | **no** | — | Wait until defined |
|
|
15
|
+
| `null` | **no** | — | Same as undefined |
|
|
16
|
+
| `""` | **yes** | empty string | e.g. `sessions//sync` — request may still run |
|
|
17
|
+
| `0` | **yes** | `"0"` | Not treated as “missing” |
|
|
18
|
+
| `false` | **yes** | `"false"` | |
|
|
19
|
+
| `42`, `"alpha"` | **yes** | `"42"`, `"alpha"` | |
|
|
20
|
+
|
|
21
|
+
When `ready: false`, decorators **do not** call the network (for `@get` / `@post` / `@put` / `@patch`), **unsubscribe** (`@bind` / `@subscribe`), or skip publisher binding (`@publish` / `@handle`). The decorated property is often left unchanged or set to `undefined` (HTTP decorators).
|
|
22
|
+
|
|
23
|
+
When the placeholder later becomes valid, observers run again and behaviour resumes.
|
|
24
|
+
|
|
25
|
+
## `skipEmptyPlaceholder` option
|
|
26
|
+
|
|
27
|
+
Some APIs should not run while an id is still `""`. Opt in per decorator:
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
@get(new Endpoint<User, { userId: string }>("users/${userId}"), {
|
|
31
|
+
skipEmptyPlaceholder: true,
|
|
32
|
+
})
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
| Option | Scope |
|
|
36
|
+
|--------|--------|
|
|
37
|
+
| `skipEmptyPlaceholder?: boolean` | **Only** empty string `''` on a placeholder |
|
|
38
|
+
| Default `false` | `""` is inserted into the path (legacy behaviour) |
|
|
39
|
+
| `true` | `""` → `ready: false`, same as `null` / `undefined` for that segment |
|
|
40
|
+
|
|
41
|
+
Does **not** affect `0`, `false`, `null`, or `undefined` (nullish stays “not ready” regardless).
|
|
42
|
+
|
|
43
|
+
Available on:
|
|
44
|
+
|
|
45
|
+
| API | Where |
|
|
46
|
+
|-----|--------|
|
|
47
|
+
| `@get` | 2nd or 3rd argument (`GetOptions`) |
|
|
48
|
+
| `@post` / `@put` / `@patch` | `PostOptions` / `ApiSendOptions` |
|
|
49
|
+
| `@bind` | `BindOptions` |
|
|
50
|
+
| `@publish` | 2nd argument `PublishOptions` |
|
|
51
|
+
| `@handle` | `HandleOptions` |
|
|
52
|
+
|
|
53
|
+
## Per-decorator summary
|
|
54
|
+
|
|
55
|
+
| Decorator | `ready: false` | `ready: true` |
|
|
56
|
+
|-----------|----------------|---------------|
|
|
57
|
+
| `@get` | No HTTP; `payload` → `undefined` | `ApiResult` assigned |
|
|
58
|
+
| `@post` / `@put` / `@patch` | No HTTP; `payload` → `undefined` | `ApiResult` assigned |
|
|
59
|
+
| `@subscribe` / `@bind` | Unsubscribe; prop keeps last value | Subscribe `onAssign` |
|
|
60
|
+
| `@publish` | Internal publisher `null`; writes ignored | `publisher.set` on assign |
|
|
61
|
+
| `@handle` | No subscription; with `waitForAllDefined`, method not called | Callback on assign |
|
|
62
|
+
|
|
63
|
+
## See also
|
|
64
|
+
|
|
65
|
+
- [DataProviderKey](/docs/misc/dataProviderKey) — path syntax
|
|
66
|
+
- [Endpoint](/docs/misc/endpoint) — HTTP paths + host generic `U`
|
|
67
|
+
- HTTP: [@get](/docs/decorators/get) · [@post](/docs/decorators/post) · [@put](/docs/decorators/put) · [@patch](/docs/decorators/patch)
|
|
68
|
+
- Store: [@subscribe](/docs/decorators/subscribe) · [@bind](/docs/decorators/bind) · [@publish](/docs/decorators/publish) · [@handle](/docs/decorators/handle)
|
|
69
|
+
- Legacy strings: [@onAssign](/docs/decorators/on-assign) (dynamic paths section)
|
|
70
|
+
- Templates: [sub()](/docs/directives/sub) — dynamic paths in Lit (no `skipEmptyPlaceholder` yet)
|
|
71
|
+
- Tutorial: [My first component](/docs/getting-started/my-first-component) — `"${dataProvider}"` scope pattern
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Endpoint
|
|
2
|
+
|
|
3
|
+
`Endpoint<T, U>` describes a single HTTP path (or a path accepted by `API.get`) and carries the expected response type `T`. Unlike [DataProviderKey](/docs/misc/dataProviderKey), there is no dot-navigation: the path is one string.
|
|
4
|
+
|
|
5
|
+
The optional second generic `U` (default `any`) describes host properties used to resolve dynamic segments in the path (`${…}` / `{$…}`), for example with [@get](/docs/decorators/get) or [@post](/docs/decorators/post). See [Dynamic path placeholders](/docs/misc/dynamic-path) for `null` / `undefined` / `""` / `0` and `skipEmptyPlaceholder`.
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
<sonic-code language="typescript">
|
|
10
|
+
<template>
|
|
11
|
+
import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
|
|
12
|
+
</template>
|
|
13
|
+
</sonic-code>
|
|
14
|
+
|
|
15
|
+
## Construction
|
|
16
|
+
|
|
17
|
+
<sonic-code language="typescript">
|
|
18
|
+
<template>
|
|
19
|
+
const users = new Endpoint<User[]>("users?limit=10");
|
|
20
|
+
users.path; // "users?limit=10"
|
|
21
|
+
|
|
22
|
+
const one = new Endpoint<User, { userId: string }>("users/${userId}");
|
|
23
|
+
// `userId` on the host class is observed when used with @get
|
|
24
|
+
</template>
|
|
25
|
+
</sonic-code>
|
|
26
|
+
|
|
27
|
+
## Normalization
|
|
28
|
+
|
|
29
|
+
`Endpoint.normalizePath` trims the string, rejects an empty path, strips leading slashes for paths relative to `serviceURL`, collapses duplicate slashes, and validates absolute `http(s)://` URLs.
|
|
30
|
+
|
|
31
|
+
## Publisher key for payloads
|
|
32
|
+
|
|
33
|
+
`getDataProviderKey()` returns a typed publisher key whose `path` matches the endpoint path (payload typing follows `ApiResult` for this endpoint). Useful when pairing `@get` with `@publish` / `@subscribe` (see [@get](/docs/decorators/get)).
|
|
34
|
+
|
|
35
|
+
## Data-provider paths
|
|
36
|
+
|
|
37
|
+
`Endpoint.looksLikeDataProviderPath(path)` returns true for strings shaped like `dataProvider(id)…`, which `API.get` can resolve without HTTP.
|
|
38
|
+
|
|
39
|
+
## See also
|
|
40
|
+
|
|
41
|
+
- [API configuration](/docs/misc/api-configuration) — `serviceURL`, token, wording (mock demos)
|
|
42
|
+
- [@get](/docs/decorators/get) — GET decorator
|
|
43
|
+
- [@post](/docs/decorators/post) — POST decorator (body from a `DataProviderKey`)
|
|
44
|
+
- [@put](/docs/decorators/put) · [@patch](/docs/decorators/patch) — PUT / PATCH decorators
|
|
45
|
+
- [DataProviderKey](/docs/misc/dataProviderKey) — typed publisher paths (dot notation)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# HTML integration (no Lit)
|
|
2
|
+
|
|
3
|
+
Some hosts (legacy PHP pages, static HTML) embed Concorde components **without** a Lit build step. They can use HTML attributes such as **`data-bind`**, **`dataProvider`**, and **`formDataProvider`** on tags directly in the page.
|
|
4
|
+
|
|
5
|
+
**Form fields** (`sonic-input`, checkbox, select, …) bind only via **`formDataProvider` + `name`**. They do not autofill from ancestor `dataProvider`.
|
|
6
|
+
|
|
7
|
+
That style is **not** what we demonstrate in this doc site: live examples are **Lit components** under `src/docs/example/`, registered once and reused from Markdown via tags like `<docs-flight-search-demo>`.
|
|
8
|
+
|
|
9
|
+
| Goal | Use |
|
|
10
|
+
|------|-----|
|
|
11
|
+
| Learn modern patterns | [My first component](/docs/getting-started/my-first-component), [Data flow](/docs/getting-started/dataFlow) |
|
|
12
|
+
| Author doc examples | `<docs-lit-demo>` + `src/docs/example/*.ts` — see [My first component](/docs/getting-started/my-first-component) |
|
|
13
|
+
|
|
14
|
+
New application code in TypeScript should use **`@subscribe`**, **`formDataProvider` + `name`**, and Lit templates — not HTML `data-bind`.
|
|
@@ -15,6 +15,11 @@ export const DOCS_MOCK_EVENTS_API_TOKEN = "docs-mock-events-token";
|
|
|
15
15
|
const WORDING_CATALOG: Record<string, Record<string, string>> = {
|
|
16
16
|
"api-config.greeting": { fr: "Bonjour", en: "Hello" },
|
|
17
17
|
"api-config.farewell": { fr: "Au revoir", en: "Goodbye" },
|
|
18
|
+
"flight.boarding": { fr: "Embarquement immédiat", en: "Now boarding" },
|
|
19
|
+
"flight.gate": {
|
|
20
|
+
fr: "Rendez-vous porte <strong>B12</strong>",
|
|
21
|
+
en: "Please proceed to gate <strong>B12</strong>",
|
|
22
|
+
},
|
|
18
23
|
"api-config.hint": {
|
|
19
24
|
fr: "Libellés servis par le mock /wording/labels",
|
|
20
25
|
en: "Labels served by mock /wording/labels",
|