@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
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# API configuration
|
|
2
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](
|
|
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
4
|
|
|
5
|
-
> **Mock service:** same [Local API demos](
|
|
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
6
|
|
|
7
7
|
## Attribute map
|
|
8
8
|
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
| `blockUntilDone` | `blockUntilDone` | Serialize calls per `serviceURL` |
|
|
22
22
|
| `keepAlive` | `keepAlive` | `fetch` keepalive |
|
|
23
23
|
|
|
24
|
-
**Lit / TypeScript:** store the same shape in a publisher and pass `DataProviderKey<APIConfiguration>` as the second argument of `@get` (see [DataProviderKey](
|
|
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
25
|
|
|
26
26
|
## Bearer token (static)
|
|
27
27
|
|
|
@@ -49,9 +49,7 @@ Attribute **`eventsApiToken`** on an ancestor maps to **`authToken`** in config
|
|
|
49
49
|
|
|
50
50
|
## Wording API
|
|
51
51
|
|
|
52
|
-
`wordingProvider
|
|
53
|
-
|
|
54
|
-
<docs-lit-demo for="docs-api-config-wording-demo"></docs-lit-demo>
|
|
52
|
+
`wordingProvider` and `wordingVersionProvider` are read by the translation directive: see [t()](/docs/directives/t).
|
|
55
53
|
|
|
56
54
|
## Scoped attributes (HTML / sonic-scope)
|
|
57
55
|
|
|
@@ -73,9 +71,9 @@ Implementation: `src/docs/mock-api/api-config-mock.ts` (bundled in the Service W
|
|
|
73
71
|
|
|
74
72
|
## See also
|
|
75
73
|
|
|
76
|
-
- [@get](
|
|
77
|
-
- [@post](
|
|
78
|
-
- [@put](
|
|
79
|
-
- [Endpoint](
|
|
80
|
-
- [Local API demos](
|
|
81
|
-
- [Fetch](
|
|
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,136 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/misc/dataProviderKey" data-doc-id="docs/misc/dataProviderKey">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>DataProviderKey — Concorde by Supersoniks</title>
|
|
7
|
+
<meta name="description" content="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">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/misc/dataProviderKey, dataProviderKey, DataProviderKey, reference, toString(), path, myKey.items[0], items, Item[], .path">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/misc/dataProviderKey">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/docs/misc/dataProviderKey">
|
|
11
|
+
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/misc/dataProviderKey.md">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header>
|
|
15
|
+
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/misc/dataProviderKey">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 reference — DataProviderKey</strong>. 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 <span>Doc ID: <code>docs/misc/dataProviderKey</code>. Keywords: Concorde, supersoniks, docs/misc/dataProviderKey, dataProviderKey, DataProviderKey, reference, toString(), path, myKey.items[0], items, Item[], .path. URL: <a href="https://concorde.supersoniks.org/docs/misc/dataProviderKey">https://concorde.supersoniks.org/docs/misc/dataProviderKey</a>.</span></p>
|
|
20
|
+
<h1 id="dataproviderkey">DataProviderKey</h1>
|
|
21
|
+
<p>The <code>DataProviderKey<T></code> 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 <code>toString()</code> or the <code>path</code> property.</p>
|
|
22
|
+
<p>For a <strong>single HTTP path string</strong> (no dot-syntax), see <a href="/docs/misc/endpoint">Endpoint</a>. For <strong><code>DataProviderKey<APIConfiguration></code></strong>, see <a href="/docs/misc/api-configuration">API configuration</a>.</p>
|
|
23
|
+
<h2 id="principle">Principle</h2>
|
|
24
|
+
<p><code>DataProviderKey</code> uses a Proxy to intercept property access and build a cumulative path string. TypeScript infers the nested type at each level, so <code>myKey.items[0]</code> is correctly typed as <code>DataProviderKey<Item></code> when <code>items</code> is <code>Item[]</code>.</p>
|
|
25
|
+
<p>In Lit demos, bind HTML attributes from a key’s <strong><code>.path</code></strong> (single source of truth), and use <strong><code>get</code> / <code>set</code> / <code>dp</code></strong> instead of <code>PublisherManager.get("…")</code>:</p>
|
|
26
|
+
<pre><code class="language-typescript">import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
27
|
+
import { get, set } from "@supersoniks/concorde/utils";
|
|
28
|
+
|
|
29
|
+
export const myFormKey = new DataProviderKey&lt;{ email: string }&gt;("myForm");
|
|
30
|
+
set(myFormKey, { email: "a@b.c" });
|
|
31
|
+
|
|
32
|
+
// template: formDataProvider=${myFormKey.path}
|
|
33
|
+
</code></pre>
|
|
34
|
+
<h2 id="usage">Usage</h2>
|
|
35
|
+
<h3 id="import">Import</h3>
|
|
36
|
+
<pre><code class="language-typescript">import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
37
|
+
</code></pre>
|
|
38
|
+
<h3 id="basic-example">Basic example</h3>
|
|
39
|
+
<pre><code class="language-typescript">type Item = { id: string; name: string };
|
|
40
|
+
//
|
|
41
|
+
type Data = {
|
|
42
|
+
items: Item[];
|
|
43
|
+
count: number;
|
|
44
|
+
};
|
|
45
|
+
//
|
|
46
|
+
const myKey = new DataProviderKey&lt;Data&gt;("data").items[0];
|
|
47
|
+
// Equivalent to: new DataProviderKey&lt;Item&gt;("data.items.0")
|
|
48
|
+
myKey.toString(); // "data.items.0"
|
|
49
|
+
myKey.path; // same value
|
|
50
|
+
// myKey is typed as DataProviderKey&lt;Item&gt;
|
|
51
|
+
</code></pre>
|
|
52
|
+
<h3 id="object-property-access">Object property access</h3>
|
|
53
|
+
<pre><code class="language-typescript">const key = new DataProviderKey&lt;Data&gt;("data");
|
|
54
|
+
const countKey = key.count;
|
|
55
|
+
countKey.path; // "data.count"
|
|
56
|
+
countKey.toString(); // "data.count"
|
|
57
|
+
</code></pre>
|
|
58
|
+
<h3 id="array-index-access">Array index access</h3>
|
|
59
|
+
<pre><code class="language-typescript">const itemsKey = new DataProviderKey&lt;Data&gt;("data").items;
|
|
60
|
+
itemsKey.path; // "data.items"
|
|
61
|
+
// itemsKey is DataProviderKey&lt;Item[]&gt;
|
|
62
|
+
//
|
|
63
|
+
const firstItem = itemsKey[0];
|
|
64
|
+
firstItem.path; // "data.items.0"
|
|
65
|
+
// firstItem is DataProviderKey&lt;Item&gt;
|
|
66
|
+
</code></pre>
|
|
67
|
+
<h3 id="dynamic-paths">Dynamic paths</h3>
|
|
68
|
+
<p>Use placeholders <code>${prop}</code> or <code>{$prop}</code> in the path string. The path is resolved at runtime from the component's properties. See <a href="/docs/misc/dynamic-path">Dynamic path placeholders</a> for resolution rules and <code>skipEmptyPlaceholder</code>. The type remains declarative:</p>
|
|
69
|
+
<pre><code class="language-typescript">type User = { name: string; email: string };
|
|
70
|
+
//
|
|
71
|
+
// Path resolved from component.userIndex at runtime
|
|
72
|
+
@subscribe(new DataProviderKey&lt;User&gt;("users.${userIndex}"))
|
|
73
|
+
@state()
|
|
74
|
+
user: User | null = null;
|
|
75
|
+
</code></pre>
|
|
76
|
+
<p>Dynamic keys are <strong>not</strong> supported by <code>get</code>, <code>set</code>, or <code>dp</code> — those APIs take a snapshot at call time with no component context. For dynamic paths use decorators (<code>@subscribe</code>, <code>@publish</code>, <code>@handle</code>) or <strong><code>sub(key)</code></strong> in Lit templates (resolves <code>${…}</code> from the host component). See <a href="/docs/directives/sub">sub()</a>.</p>
|
|
77
|
+
<h3 id="get--set--dp-with-static-keys">get / set / dp with static keys</h3>
|
|
78
|
+
<p>For programmatic access, pass a <code>DataProviderKey</code> or a static path string. Dynamic placeholders are rejected:</p>
|
|
79
|
+
<pre><code class="language-typescript">import { dp, get, set } from "@supersoniks/concorde/utils";
|
|
80
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
81
|
+
//
|
|
82
|
+
const counterKey = new DataProviderKey&lt;{ count: number }&gt;("myCounter");
|
|
83
|
+
//
|
|
84
|
+
set(counterKey, { count: 0 });
|
|
85
|
+
dp(counterKey.count).set(1);
|
|
86
|
+
get(counterKey); // snapshot: { count: 1 }
|
|
87
|
+
</code></pre>
|
|
88
|
+
<h2 id="path-retrieval">Path retrieval</h2>
|
|
89
|
+
<p>The final path is built by concatenating each accessed property with a dot:</p>
|
|
90
|
+
<ul>
|
|
91
|
+
<li><code>new DataProviderKey<T>("base")</code> → <code>"base"</code></li>
|
|
92
|
+
<li><code>key.prop</code> → <code>"base.prop"</code></li>
|
|
93
|
+
<li><code>key.items[0]</code> → <code>"base.items.0"</code></li>
|
|
94
|
+
</ul>
|
|
95
|
+
<p>Use <code>toString()</code> or <code>path</code> to get the full path string:</p>
|
|
96
|
+
<pre><code class="language-typescript">const key = new DataProviderKey&lt;Data&gt;("data").count;
|
|
97
|
+
const pathString = key.toString(); // "data.count"
|
|
98
|
+
const pathProp = key.path; // "data.count"
|
|
99
|
+
</code></pre>
|
|
100
|
+
<h2 id="use-cases">Use cases</h2>
|
|
101
|
+
<ul>
|
|
102
|
+
<li><strong>Type-safe bindings</strong>: paths for <code>@bind</code>, <code>@subscribe</code>, <code>@publish</code>, <code>@handle</code></li>
|
|
103
|
+
<li><strong>Dynamic paths</strong>: reusable keys with <code>${...}</code> placeholders</li>
|
|
104
|
+
<li><strong>Form fields</strong>: form data paths with compile-time checking</li>
|
|
105
|
+
</ul>
|
|
106
|
+
<h2 id="integration-with-subscribe-publish-and-handle">Integration with @subscribe, @publish and @handle</h2>
|
|
107
|
+
<p>Use <code>DataProviderKey</code> with <code>@subscribe</code> (read-only), <code>@publish</code> (write-only), or <code>@handle</code> (method callback on assign). With <code>@subscribe</code> / <code>@publish</code>, the decorated property <strong>must</strong> match the key’s value type. With <code>@handle</code>, the method receives <code>(value: T)</code>.</p>
|
|
108
|
+
<pre><code class="language-typescript">import { subscribe } from "@supersoniks/concorde/decorators";
|
|
109
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
110
|
+
//
|
|
111
|
+
type FormData = { email: string };
|
|
112
|
+
const formKey = new DataProviderKey&lt;FormData&gt;("formData");
|
|
113
|
+
//
|
|
114
|
+
@customElement("user-form")
|
|
115
|
+
export class UserForm extends LitElement {
|
|
116
|
+
@subscribe(formKey.email)
|
|
117
|
+
@state()
|
|
118
|
+
email = "";
|
|
119
|
+
//
|
|
120
|
+
render() {
|
|
121
|
+
return html`&lt;input .value=${this.email} @input=${(e) => this.email = (e.target as HTMLInputElement).value}&gt;`;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
</code></pre>
|
|
125
|
+
<p>These decorators support dynamic paths: <code>"base.${prop}"</code> in the constructor. A wrong property type (e.g. <code>number</code> for <code>DataProviderKey<string></code>) is a TypeScript error. Resolution rules: <a href="/docs/misc/dynamic-path">Dynamic path placeholders</a>. See <a href="/docs/decorators/handle">@handle</a> for method callbacks.</p>
|
|
126
|
+
<h2 id="notes">Notes</h2>
|
|
127
|
+
<ul>
|
|
128
|
+
<li>Function properties are excluded from navigation (no <code>key.method()</code> chaining)</li>
|
|
129
|
+
<li>Primitives have no navigable properties</li>
|
|
130
|
+
<li>The <code>path</code> property and <code>toString()</code> are equivalent for retrieving the key</li>
|
|
131
|
+
</ul>
|
|
132
|
+
|
|
133
|
+
</article>
|
|
134
|
+
</main>
|
|
135
|
+
</body>
|
|
136
|
+
</html>
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
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
4
|
|
|
5
|
-
For a **single HTTP path string** (no dot-syntax), see [Endpoint](
|
|
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
6
|
|
|
7
7
|
## Principle
|
|
8
8
|
|
|
@@ -78,7 +78,7 @@ firstItem.path; // "data.items.0"
|
|
|
78
78
|
|
|
79
79
|
### Dynamic paths
|
|
80
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](
|
|
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
82
|
|
|
83
83
|
<sonic-code language="typescript">
|
|
84
84
|
<template>
|
|
@@ -91,7 +91,7 @@ user: User | null = null;
|
|
|
91
91
|
</template>
|
|
92
92
|
</sonic-code>
|
|
93
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()](
|
|
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
95
|
|
|
96
96
|
### get / set / dp with static keys
|
|
97
97
|
|
|
@@ -159,7 +159,7 @@ export class UserForm extends LitElement {
|
|
|
159
159
|
</template>
|
|
160
160
|
</sonic-code>
|
|
161
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](
|
|
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
163
|
|
|
164
164
|
## Notes
|
|
165
165
|
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/misc/docs-mock-api" data-doc-id="docs/misc/docs-mock-api">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Local API demos (offline) — Concorde by Supersoniks</title>
|
|
7
|
+
<meta name="description" content="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.">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/misc/docs-mock-api, docs-mock-api, Local API demos (offline), reference, yarn dev, /docs-mock-api/*, registerDocsMockApiServiceWorker(), /docs-mock-api-sw.js, /docs-mock-api/..., serviceURL="/docs-mock-api", src/docs/mock-api/urls.ts, DOCS_MOCK_REQRES_SERVICE, DOCS_MOCK_GEO_SERVICE, /docs-mock-api/api/users">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/misc/docs-mock-api">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/docs/misc/docs-mock-api">
|
|
11
|
+
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/misc/docs-mock-api.md">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header>
|
|
15
|
+
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/misc/docs-mock-api">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 reference — Local API demos (offline)</strong>. 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. <span>Doc ID: <code>docs/misc/docs-mock-api</code>. Keywords: Concorde, supersoniks, docs/misc/docs-mock-api, docs-mock-api, Local API demos (offline), reference, yarn dev, /docs-mock-api/*, registerDocsMockApiServiceWorker(), /docs-mock-api-sw.js, /docs-mock-api/..., serviceURL="/docs-mock-api", src/docs/mock-api/urls.ts, DOCS_MOCK_REQRES_SERVICE, DOCS_MOCK_GEO_SERVICE, /docs-mock-api/api/users. URL: <a href="https://concorde.supersoniks.org/docs/misc/docs-mock-api">https://concorde.supersoniks.org/docs/misc/docs-mock-api</a>.</span></p>
|
|
20
|
+
<h1 id="local-api-demos-offline">Local API demos (offline)</h1>
|
|
21
|
+
<p>The Concorde doc site does not call fragile third-party APIs during <code>yarn dev</code>. A <strong>Service Worker</strong> and the Vite dev middleware serve <strong><code>/docs-mock-api/*</code></strong> on the same origin.</p>
|
|
22
|
+
<h2 id="how-it-works">How it works</h2>
|
|
23
|
+
<ol>
|
|
24
|
+
<li>On load, <code>registerDocsMockApiServiceWorker()</code> registers <code>/docs-mock-api-sw.js</code>.</li>
|
|
25
|
+
<li>Requests to <code>/docs-mock-api/...</code> are handled by the SW (production build) or Vite middleware (dev).</li>
|
|
26
|
+
<li>Live examples use <code>serviceURL="/docs-mock-api"</code> and relative paths.</li>
|
|
27
|
+
</ol>
|
|
28
|
+
<p>TypeScript constants: <code>src/docs/mock-api/urls.ts</code> (<code>DOCS_MOCK_REQRES_SERVICE</code>, <code>DOCS_MOCK_GEO_SERVICE</code>, …).</p>
|
|
29
|
+
<h2 id="routes">Routes</h2>
|
|
30
|
+
<table>
|
|
31
|
+
<thead>
|
|
32
|
+
<tr>
|
|
33
|
+
<th>Path</th>
|
|
34
|
+
<th>Used in</th>
|
|
35
|
+
</tr>
|
|
36
|
+
</thead>
|
|
37
|
+
<tbody><tr>
|
|
38
|
+
<td><code>/docs-mock-api/api/users</code></td>
|
|
39
|
+
<td><a href="/docs/getting-started/my-first-component">My first component</a> users list</td>
|
|
40
|
+
</tr>
|
|
41
|
+
<tr>
|
|
42
|
+
<td><code>/docs-mock-api/api/users/:id</code></td>
|
|
43
|
+
<td>Single user, <code>docs-user</code></td>
|
|
44
|
+
</tr>
|
|
45
|
+
<tr>
|
|
46
|
+
<td><code>/docs-mock-api/api/space-cats</code></td>
|
|
47
|
+
<td>Fixtures shared with the jsonata unit tests</td>
|
|
48
|
+
</tr>
|
|
49
|
+
<tr>
|
|
50
|
+
<td><code>/docs-mock-api/api/coffee-bags</code></td>
|
|
51
|
+
<td>fixtures / tests jsonata (<code>?roast=</code>)</td>
|
|
52
|
+
</tr>
|
|
53
|
+
<tr>
|
|
54
|
+
<td><code>/docs-mock-api/api/market-order</code></td>
|
|
55
|
+
<td>Fixtures shared with the jsonata unit tests</td>
|
|
56
|
+
</tr>
|
|
57
|
+
<tr>
|
|
58
|
+
<td><code>POST /docs-mock-api/api/register</code></td>
|
|
59
|
+
<td><strong>sonic-submit</strong> — JSON, <code>multipart/form-data</code> (<code>sendAsFormData</code>), or <code>application/x-www-form-urlencoded</code> (native <code><form></code>); response includes parsed <code>email</code> + <code>token</code></td>
|
|
60
|
+
</tr>
|
|
61
|
+
<tr>
|
|
62
|
+
<td><code>POST /docs-mock-api/api/register/nested</code></td>
|
|
63
|
+
<td>Wrapped body <code>{ data: { id, token } }</code> for the <code>submitResultKey</code> demo</td>
|
|
64
|
+
</tr>
|
|
65
|
+
<tr>
|
|
66
|
+
<td><code>GET /docs-mock-api/api/register/echo</code></td>
|
|
67
|
+
<td>Echoes query string (<code>method="get"</code> on submit)</td>
|
|
68
|
+
</tr>
|
|
69
|
+
<tr>
|
|
70
|
+
<td><code>GET /docs-mock-api/auth/token</code></td>
|
|
71
|
+
<td><a href="/docs/misc/api-configuration">API configuration</a> — tokenProvider (Basic or <code>eventsApiToken</code>)</td>
|
|
72
|
+
</tr>
|
|
73
|
+
<tr>
|
|
74
|
+
<td><code>GET /docs-mock-api/api/config/protected</code></td>
|
|
75
|
+
<td>Bearer / Basic; <code>docs-mock-stale-token</code> → <strong>498</strong></td>
|
|
76
|
+
</tr>
|
|
77
|
+
<tr>
|
|
78
|
+
<td><code>GET /docs-mock-api/wording/labels</code></td>
|
|
79
|
+
<td>Wording batch (<code>labels[]</code>, <code>lang</code>)</td>
|
|
80
|
+
</tr>
|
|
81
|
+
<tr>
|
|
82
|
+
<td><code>/docs-mock-api/geo/communes</code></td>
|
|
83
|
+
<td><code>@get</code> demos</td>
|
|
84
|
+
</tr>
|
|
85
|
+
<tr>
|
|
86
|
+
<td><code>GET /docs-mock-api/flights</code></td>
|
|
87
|
+
<td>Flight board (<code>key="flights"</code>): <code>sonic-list</code> · <code>sonic-fetch</code> · <code>sonic-queue</code> · <code>sonic-jsonata</code> · <code>sonic-states</code> and the input / select / radio / switch filter demos</td>
|
|
88
|
+
</tr>
|
|
89
|
+
</tbody></table>
|
|
90
|
+
<h3 id="filters-get-flights">Filters <code>GET /flights</code></h3>
|
|
91
|
+
<table>
|
|
92
|
+
<thead>
|
|
93
|
+
<tr>
|
|
94
|
+
<th>Query</th>
|
|
95
|
+
<th>Meaning</th>
|
|
96
|
+
</tr>
|
|
97
|
+
</thead>
|
|
98
|
+
<tbody><tr>
|
|
99
|
+
<td><code>direction</code></td>
|
|
100
|
+
<td><code>departures</code> · <code>arrivals</code></td>
|
|
101
|
+
</tr>
|
|
102
|
+
<tr>
|
|
103
|
+
<td><code>q</code></td>
|
|
104
|
+
<td>Substring on flight number, city or airport code</td>
|
|
105
|
+
</tr>
|
|
106
|
+
<tr>
|
|
107
|
+
<td><code>status</code></td>
|
|
108
|
+
<td>Comma-separated statuses to keep: <code>on-time</code> · <code>boarding</code> · <code>delayed</code> · <code>landed</code> · <code>cancelled</code> (<code>all</code> = no filter)</td>
|
|
109
|
+
</tr>
|
|
110
|
+
<tr>
|
|
111
|
+
<td><code>offset</code> + <code>limit</code></td>
|
|
112
|
+
<td>Pagination for <strong>sonic-queue</strong> lazy load</td>
|
|
113
|
+
</tr>
|
|
114
|
+
</tbody></table>
|
|
115
|
+
<h3 id="pagination-get-apiusers">Pagination <code>GET /api/users</code></h3>
|
|
116
|
+
<table>
|
|
117
|
+
<thead>
|
|
118
|
+
<tr>
|
|
119
|
+
<th>Query</th>
|
|
120
|
+
<th>Meaning</th>
|
|
121
|
+
</tr>
|
|
122
|
+
</thead>
|
|
123
|
+
<tbody><tr>
|
|
124
|
+
<td><code>offset</code> + <code>per_page</code></td>
|
|
125
|
+
<td>Index-based slice on the filtered set — <strong>sonic-queue</strong> (<code>offset=$offset&per_page=$limit</code>)</td>
|
|
126
|
+
</tr>
|
|
127
|
+
<tr>
|
|
128
|
+
<td><code>page</code> + <code>per_page</code></td>
|
|
129
|
+
<td>1-based page — static fetch examples (<code>?page=2</code>)</td>
|
|
130
|
+
</tr>
|
|
131
|
+
<tr>
|
|
132
|
+
<td><code>limit</code></td>
|
|
133
|
+
<td>Alias of <code>per_page</code></td>
|
|
134
|
+
</tr>
|
|
135
|
+
<tr>
|
|
136
|
+
<td><code>q</code></td>
|
|
137
|
+
<td>Search on first name, last name, email (optional; <strong>sonic-queue</strong> + <code>dataFilterProvider</code>, field <code>name="q"</code>)</td>
|
|
138
|
+
</tr>
|
|
139
|
+
</tbody></table>
|
|
140
|
+
<p><strong>ALTCHA</strong> (<code>sonic-captcha</code>) is <strong>not</strong> mocked — it still uses the Supersoniks service.</p>
|
|
141
|
+
<p>In TypeScript demos, import from <code>src/docs/mock-api/urls.ts</code> (e.g. <code>DOCS_MOCK_REQRES_SERVICE</code> on <code>serviceURL</code>).</p>
|
|
142
|
+
<h2 id="source-files">Source files</h2>
|
|
143
|
+
<ul>
|
|
144
|
+
<li><code>src/docs/mock-api/</code> — router, fixtures, service worker, <code>urls.ts</code></li>
|
|
145
|
+
<li><code>scripts/docs-mock-api-vite-plugin.ts</code> — SW build + middleware</li>
|
|
146
|
+
<li><code>public/docs-mock-api-sw.js</code> — generated on <code>yarn dev</code> / <code>yarn build-docs</code></li>
|
|
147
|
+
</ul>
|
|
148
|
+
<pre><code class="language-bash">yarn dev # mock API on by default
|
|
149
|
+
yarn build-docs # includes SW bundle
|
|
150
|
+
</code></pre>
|
|
151
|
+
|
|
152
|
+
</article>
|
|
153
|
+
</main>
|
|
154
|
+
</body>
|
|
155
|
+
</html>
|
|
@@ -14,29 +14,28 @@ TypeScript constants: `src/docs/mock-api/urls.ts` (`DOCS_MOCK_REQRES_SERVICE`, `
|
|
|
14
14
|
|
|
15
15
|
| Path | Used in |
|
|
16
16
|
|------|---------|
|
|
17
|
-
| `/docs-mock-api/api/users` |
|
|
17
|
+
| `/docs-mock-api/api/users` | [My first component](/docs/getting-started/my-first-component) users list |
|
|
18
18
|
| `/docs-mock-api/api/users/:id` | Single user, `docs-user` |
|
|
19
|
-
| `/docs-mock-api/api/space-cats` |
|
|
19
|
+
| `/docs-mock-api/api/space-cats` | Fixtures shared with the jsonata unit tests |
|
|
20
20
|
| `/docs-mock-api/api/coffee-bags` | fixtures / tests jsonata (`?roast=`) |
|
|
21
|
-
| `/docs-mock-api/api/market-order` |
|
|
21
|
+
| `/docs-mock-api/api/market-order` | Fixtures shared with the jsonata unit tests |
|
|
22
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 `
|
|
23
|
+
| `POST /docs-mock-api/api/register/nested` | Wrapped body `{ data: { id, token } }` for the `submitResultKey` demo |
|
|
24
24
|
| `GET /docs-mock-api/api/register/echo` | Echoes query string (`method="get"` on submit) |
|
|
25
|
-
| `GET /docs-mock-api/auth/token` | [API configuration](
|
|
25
|
+
| `GET /docs-mock-api/auth/token` | [API configuration](/docs/misc/api-configuration) — tokenProvider (Basic or `eventsApiToken`) |
|
|
26
26
|
| `GET /docs-mock-api/api/config/protected` | Bearer / Basic; `docs-mock-stale-token` → **498** |
|
|
27
27
|
| `GET /docs-mock-api/wording/labels` | Wording batch (`labels[]`, `lang`) |
|
|
28
|
-
| `/docs-mock-api/geo/communes` |
|
|
29
|
-
|
|
|
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
30
|
|
|
31
|
-
###
|
|
31
|
+
### Filters `GET /flights`
|
|
32
32
|
|
|
33
33
|
| Query | Meaning |
|
|
34
34
|
|-------|---------|
|
|
35
|
-
| `
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `blacklistFlags` | Comma-separated flags to **exclude** (`nsfw`, `religious`, `political`, `racist`, `sexist`, `explicit`) — checkbox/radio/switch « Remove following jokes » demos; each joke has matching `flags` in fixtures |
|
|
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 |
|
|
40
39
|
|
|
41
40
|
### Pagination `GET /api/users`
|
|
42
41
|
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/misc/dynamic-path" data-doc-id="docs/misc/dynamic-path">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Dynamic path placeholders — Concorde by Supersoniks</title>
|
|
7
|
+
<meta name="description" content="Decorators and DataProviderKey paths can include placeholders resolved on the host component at runtime:">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/misc/dynamic-path, dynamic-path, Dynamic path placeholders, reference, DataProviderKey, ${prop}, {$prop}, "users/${userId}", "api/sessions/${sessionId}/sync", "teams.${teamId}.members", resolveDynamicPath, userId, sessionId, requestAnimationFrame">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/misc/dynamic-path">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/docs/misc/dynamic-path">
|
|
11
|
+
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/misc/dynamic-path.md">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header>
|
|
15
|
+
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/misc/dynamic-path">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 reference — Dynamic path placeholders</strong>. Decorators and DataProviderKey paths can include placeholders resolved on the host component at runtime: <span>Doc ID: <code>docs/misc/dynamic-path</code>. Keywords: Concorde, supersoniks, docs/misc/dynamic-path, dynamic-path, Dynamic path placeholders, reference, DataProviderKey, ${prop}, {$prop}, "users/${userId}", "api/sessions/${sessionId}/sync", "teams.${teamId}.members", resolveDynamicPath, userId, sessionId, requestAnimationFrame. URL: <a href="https://concorde.supersoniks.org/docs/misc/dynamic-path">https://concorde.supersoniks.org/docs/misc/dynamic-path</a>.</span></p>
|
|
20
|
+
<h1 id="dynamic-path-placeholders">Dynamic path placeholders</h1>
|
|
21
|
+
<p>Decorators and <code>DataProviderKey</code> paths can include <strong>placeholders</strong> resolved on the host component at runtime:</p>
|
|
22
|
+
<ul>
|
|
23
|
+
<li><code>${prop}</code> or <code>{$prop}</code> — e.g. <code>"users/${userId}"</code>, <code>"api/sessions/${sessionId}/sync"</code></li>
|
|
24
|
+
<li>Nested expressions — e.g. <code>"teams.${teamId}.members"</code></li>
|
|
25
|
+
</ul>
|
|
26
|
+
<p>Resolution is done by <a href="../../core/decorators/subscriber/dynamicPath.ts"><code>resolveDynamicPath</code></a>. The root property names (<code>userId</code>, <code>sessionId</code>, …) are watched via <code>requestAnimationFrame</code> (see <code>dynamicPropertyWatch.ts</code>).</p>
|
|
27
|
+
<h2 id="default-behaviour-ready--not-ready">Default behaviour (<code>ready</code> / <code>not ready</code>)</h2>
|
|
28
|
+
<table>
|
|
29
|
+
<thead>
|
|
30
|
+
<tr>
|
|
31
|
+
<th>Placeholder value</th>
|
|
32
|
+
<th>Path <code>ready</code>?</th>
|
|
33
|
+
<th>Inserted segment</th>
|
|
34
|
+
<th>Notes</th>
|
|
35
|
+
</tr>
|
|
36
|
+
</thead>
|
|
37
|
+
<tbody><tr>
|
|
38
|
+
<td><code>undefined</code></td>
|
|
39
|
+
<td><strong>no</strong></td>
|
|
40
|
+
<td>—</td>
|
|
41
|
+
<td>Wait until defined</td>
|
|
42
|
+
</tr>
|
|
43
|
+
<tr>
|
|
44
|
+
<td><code>null</code></td>
|
|
45
|
+
<td><strong>no</strong></td>
|
|
46
|
+
<td>—</td>
|
|
47
|
+
<td>Same as undefined</td>
|
|
48
|
+
</tr>
|
|
49
|
+
<tr>
|
|
50
|
+
<td><code>""</code></td>
|
|
51
|
+
<td><strong>yes</strong></td>
|
|
52
|
+
<td>empty string</td>
|
|
53
|
+
<td>e.g. <code>sessions//sync</code> — request may still run</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr>
|
|
56
|
+
<td><code>0</code></td>
|
|
57
|
+
<td><strong>yes</strong></td>
|
|
58
|
+
<td><code>"0"</code></td>
|
|
59
|
+
<td>Not treated as “missing”</td>
|
|
60
|
+
</tr>
|
|
61
|
+
<tr>
|
|
62
|
+
<td><code>false</code></td>
|
|
63
|
+
<td><strong>yes</strong></td>
|
|
64
|
+
<td><code>"false"</code></td>
|
|
65
|
+
<td></td>
|
|
66
|
+
</tr>
|
|
67
|
+
<tr>
|
|
68
|
+
<td><code>42</code>, <code>"alpha"</code></td>
|
|
69
|
+
<td><strong>yes</strong></td>
|
|
70
|
+
<td><code>"42"</code>, <code>"alpha"</code></td>
|
|
71
|
+
<td></td>
|
|
72
|
+
</tr>
|
|
73
|
+
</tbody></table>
|
|
74
|
+
<p>When <code>ready: false</code>, decorators <strong>do not</strong> call the network (for <code>@get</code> / <code>@post</code> / <code>@put</code> / <code>@patch</code>), <strong>unsubscribe</strong> (<code>@bind</code> / <code>@subscribe</code>), or skip publisher binding (<code>@publish</code> / <code>@handle</code>). The decorated property is often left unchanged or set to <code>undefined</code> (HTTP decorators).</p>
|
|
75
|
+
<p>When the placeholder later becomes valid, observers run again and behaviour resumes.</p>
|
|
76
|
+
<h2 id="skipemptyplaceholder-option"><code>skipEmptyPlaceholder</code> option</h2>
|
|
77
|
+
<p>Some APIs should not run while an id is still <code>""</code>. Opt in per decorator:</p>
|
|
78
|
+
<pre><code class="language-typescript">@get(new Endpoint<User, { userId: string }>("users/${userId}"), {
|
|
79
|
+
skipEmptyPlaceholder: true,
|
|
80
|
+
})
|
|
81
|
+
</code></pre>
|
|
82
|
+
<table>
|
|
83
|
+
<thead>
|
|
84
|
+
<tr>
|
|
85
|
+
<th>Option</th>
|
|
86
|
+
<th>Scope</th>
|
|
87
|
+
</tr>
|
|
88
|
+
</thead>
|
|
89
|
+
<tbody><tr>
|
|
90
|
+
<td><code>skipEmptyPlaceholder?: boolean</code></td>
|
|
91
|
+
<td><strong>Only</strong> empty string <code>''</code> on a placeholder</td>
|
|
92
|
+
</tr>
|
|
93
|
+
<tr>
|
|
94
|
+
<td>Default <code>false</code></td>
|
|
95
|
+
<td><code>""</code> is inserted into the path (legacy behaviour)</td>
|
|
96
|
+
</tr>
|
|
97
|
+
<tr>
|
|
98
|
+
<td><code>true</code></td>
|
|
99
|
+
<td><code>""</code> → <code>ready: false</code>, same as <code>null</code> / <code>undefined</code> for that segment</td>
|
|
100
|
+
</tr>
|
|
101
|
+
</tbody></table>
|
|
102
|
+
<p>Does <strong>not</strong> affect <code>0</code>, <code>false</code>, <code>null</code>, or <code>undefined</code> (nullish stays “not ready” regardless).</p>
|
|
103
|
+
<p>Available on:</p>
|
|
104
|
+
<table>
|
|
105
|
+
<thead>
|
|
106
|
+
<tr>
|
|
107
|
+
<th>API</th>
|
|
108
|
+
<th>Where</th>
|
|
109
|
+
</tr>
|
|
110
|
+
</thead>
|
|
111
|
+
<tbody><tr>
|
|
112
|
+
<td><code>@get</code></td>
|
|
113
|
+
<td>2nd or 3rd argument (<code>GetOptions</code>)</td>
|
|
114
|
+
</tr>
|
|
115
|
+
<tr>
|
|
116
|
+
<td><code>@post</code> / <code>@put</code> / <code>@patch</code></td>
|
|
117
|
+
<td><code>PostOptions</code> / <code>ApiSendOptions</code></td>
|
|
118
|
+
</tr>
|
|
119
|
+
<tr>
|
|
120
|
+
<td><code>@bind</code></td>
|
|
121
|
+
<td><code>BindOptions</code></td>
|
|
122
|
+
</tr>
|
|
123
|
+
<tr>
|
|
124
|
+
<td><code>@publish</code></td>
|
|
125
|
+
<td>2nd argument <code>PublishOptions</code></td>
|
|
126
|
+
</tr>
|
|
127
|
+
<tr>
|
|
128
|
+
<td><code>@handle</code></td>
|
|
129
|
+
<td><code>HandleOptions</code></td>
|
|
130
|
+
</tr>
|
|
131
|
+
</tbody></table>
|
|
132
|
+
<h2 id="per-decorator-summary">Per-decorator summary</h2>
|
|
133
|
+
<table>
|
|
134
|
+
<thead>
|
|
135
|
+
<tr>
|
|
136
|
+
<th>Decorator</th>
|
|
137
|
+
<th><code>ready: false</code></th>
|
|
138
|
+
<th><code>ready: true</code></th>
|
|
139
|
+
</tr>
|
|
140
|
+
</thead>
|
|
141
|
+
<tbody><tr>
|
|
142
|
+
<td><code>@get</code></td>
|
|
143
|
+
<td>No HTTP; <code>payload</code> → <code>undefined</code></td>
|
|
144
|
+
<td><code>ApiResult</code> assigned</td>
|
|
145
|
+
</tr>
|
|
146
|
+
<tr>
|
|
147
|
+
<td><code>@post</code> / <code>@put</code> / <code>@patch</code></td>
|
|
148
|
+
<td>No HTTP; <code>payload</code> → <code>undefined</code></td>
|
|
149
|
+
<td><code>ApiResult</code> assigned</td>
|
|
150
|
+
</tr>
|
|
151
|
+
<tr>
|
|
152
|
+
<td><code>@subscribe</code> / <code>@bind</code></td>
|
|
153
|
+
<td>Unsubscribe; prop keeps last value</td>
|
|
154
|
+
<td>Subscribe <code>onAssign</code></td>
|
|
155
|
+
</tr>
|
|
156
|
+
<tr>
|
|
157
|
+
<td><code>@publish</code></td>
|
|
158
|
+
<td>Internal publisher <code>null</code>; writes ignored</td>
|
|
159
|
+
<td><code>publisher.set</code> on assign</td>
|
|
160
|
+
</tr>
|
|
161
|
+
<tr>
|
|
162
|
+
<td><code>@handle</code></td>
|
|
163
|
+
<td>No subscription; with <code>waitForAllDefined</code>, method not called</td>
|
|
164
|
+
<td>Callback on assign</td>
|
|
165
|
+
</tr>
|
|
166
|
+
</tbody></table>
|
|
167
|
+
<h2 id="see-also">See also</h2>
|
|
168
|
+
<ul>
|
|
169
|
+
<li><a href="/docs/misc/dataProviderKey">DataProviderKey</a> — path syntax</li>
|
|
170
|
+
<li><a href="/docs/misc/endpoint">Endpoint</a> — HTTP paths + host generic <code>U</code></li>
|
|
171
|
+
<li>HTTP: <a href="/docs/decorators/get">@get</a> · <a href="/docs/decorators/post">@post</a> · <a href="/docs/decorators/put">@put</a> · <a href="/docs/decorators/patch">@patch</a></li>
|
|
172
|
+
<li>Store: <a href="/docs/decorators/subscribe">@subscribe</a> · <a href="/docs/decorators/bind">@bind</a> · <a href="/docs/decorators/publish">@publish</a> · <a href="/docs/decorators/handle">@handle</a></li>
|
|
173
|
+
<li>Legacy strings: <a href="/docs/decorators/on-assign">@onAssign</a> (dynamic paths section)</li>
|
|
174
|
+
<li>Templates: <a href="/docs/directives/sub">sub()</a> — dynamic paths in Lit (no <code>skipEmptyPlaceholder</code> yet)</li>
|
|
175
|
+
<li>Tutorial: <a href="/docs/getting-started/my-first-component">My first component</a> — <code>"${dataProvider}"</code> scope pattern</li>
|
|
176
|
+
</ul>
|
|
177
|
+
|
|
178
|
+
</article>
|
|
179
|
+
</main>
|
|
180
|
+
</body>
|
|
181
|
+
</html>
|