@supersoniks/concorde 5.1.2 → 5.1.3-immutable.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/skills/concorde-docs/SKILL.md +1 -1
- package/.claude/skills +1 -0
- package/.github/workflows/ci.yml +21 -0
- package/.github-export-ignore +30 -0
- package/CONTRIBUTING.md +59 -0
- package/DEV.md +54 -0
- package/LICENSE +21 -0
- package/OPEN_SOURCE_CHECKPOINT.md +133 -0
- package/README.md +1 -1
- 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 +177 -177
- package/concorde-core.es.js +5183 -5018
- package/custom-elements-manifest.public.config.mjs +8 -0
- package/{.tmp-cem/custom-elements.json → custom-elements.json} +11722 -8868
- package/dist/concorde-core.bundle.js +177 -177
- package/dist/concorde-core.es.js +5183 -5018
- package/dist/docs-mock-api-sw.js +58 -223
- package/dist/docs-mock-api-sw.js.map +4 -4
- package/dist/img/og-concorde.jpg +0 -0
- package/dist/robots.txt +11 -10
- package/docs/assets/index-CD4WyL6o.css +1 -0
- package/docs/assets/index-D_alEsng.js +12122 -0
- package/docs/crawl/core/components/functional/date/date.html +190 -0
- package/docs/crawl/core/components/functional/fetch/fetch.html +109 -0
- package/docs/crawl/core/components/functional/if/if.html +27 -0
- package/docs/crawl/core/components/functional/jsonata/jsonata.html +79 -0
- package/docs/crawl/core/components/functional/list/list.html +70 -0
- package/docs/crawl/core/components/functional/mix/mix.html +45 -0
- package/docs/crawl/core/components/functional/queue/queue.html +96 -0
- package/docs/crawl/core/components/functional/router/router.html +106 -0
- package/docs/{core → crawl/core}/components/functional/sdui/sdui-extension-points.html +8 -9
- package/docs/crawl/core/components/functional/sdui/sdui.html +368 -0
- package/docs/crawl/core/components/functional/states/states.html +66 -0
- package/docs/crawl/core/components/functional/submit/submit.html +160 -0
- package/docs/{core → crawl/core}/components/functional/subscriber/subscriber.html +5 -6
- package/docs/crawl/core/components/functional/value/value.html +51 -0
- package/docs/{core → crawl/core}/components/ui/alert/alert.html +63 -53
- package/docs/{core → crawl/core}/components/ui/alert-messages/alert-messages.html +5 -6
- package/docs/{core → crawl/core}/components/ui/badge/badge.html +33 -33
- package/docs/crawl/core/components/ui/button/button.html +150 -0
- package/docs/crawl/core/components/ui/captcha/captcha.html +112 -0
- package/docs/{core → crawl/core}/components/ui/card/card.html +11 -12
- package/docs/{core → crawl/core}/components/ui/divider/divider.html +14 -14
- package/docs/crawl/core/components/ui/form/checkbox/checkbox.html +73 -0
- package/docs/crawl/core/components/ui/form/fieldset/fieldset.html +266 -0
- package/docs/{core → crawl/core}/components/ui/form/form-actions/form-actions.html +23 -23
- package/docs/crawl/core/components/ui/form/form-layout/form-layout.html +121 -0
- package/docs/crawl/core/components/ui/form/input/input.html +109 -0
- package/docs/crawl/core/components/ui/form/input-autocomplete/input-autocomplete.html +38 -0
- package/docs/crawl/core/components/ui/form/radio/radio.html +56 -0
- package/docs/crawl/core/components/ui/form/select/select.html +73 -0
- package/docs/crawl/core/components/ui/form/switch/switch.html +56 -0
- package/docs/crawl/core/components/ui/form/textarea/textarea.html +59 -0
- package/docs/crawl/core/components/ui/group/group.html +104 -0
- package/docs/{core → crawl/core}/components/ui/icon/icon.html +9 -10
- package/docs/crawl/core/components/ui/image/image.html +298 -0
- package/docs/{core → crawl/core}/components/ui/link/link.html +11 -12
- package/docs/crawl/core/components/ui/loader/loader.html +124 -0
- package/docs/{core → crawl/core}/components/ui/menu/menu.html +33 -34
- package/docs/crawl/core/components/ui/modal/modal.html +342 -0
- package/docs/crawl/core/components/ui/pop/pop.html +296 -0
- package/docs/{core → crawl/core}/components/ui/progress/progress.html +7 -8
- package/docs/crawl/core/components/ui/table/table.html +545 -0
- package/docs/crawl/core/components/ui/theme/theme.html +131 -0
- package/docs/crawl/core/components/ui/toast/toast.html +233 -0
- package/docs/crawl/core/components/ui/tooltip/tooltip.html +140 -0
- package/docs/{docs/getting-started → crawl/docs/_core-concept}/dataFlow.html +29 -26
- package/docs/crawl/docs/_core-concept/overview.html +66 -0
- package/docs/crawl/docs/_core-concept/subscriber.html +75 -0
- package/docs/crawl/docs/_decorators/ancestor-attribute.html +117 -0
- package/docs/crawl/docs/_decorators/auto-subscribe.html +202 -0
- package/docs/crawl/docs/_decorators/bind.html +141 -0
- package/docs/crawl/docs/_decorators/get.html +149 -0
- package/docs/crawl/docs/_decorators/handle.html +165 -0
- package/docs/crawl/docs/_decorators/on-assign.html +355 -0
- package/docs/crawl/docs/_decorators/patch.html +78 -0
- package/docs/crawl/docs/_decorators/post.html +139 -0
- package/docs/crawl/docs/_decorators/publish.html +61 -0
- package/docs/crawl/docs/_decorators/put.html +78 -0
- package/docs/crawl/docs/_decorators/subscribe.html +109 -0
- package/docs/crawl/docs/_decorators/wait-for-ancestors.html +137 -0
- package/docs/crawl/docs/_directives/sub.html +93 -0
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/ai-agents.html +11 -12
- package/docs/crawl/docs/_getting-started/concorde-manual-install.html +100 -0
- package/docs/crawl/docs/_getting-started/concorde-outside.html +58 -0
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/create-a-component.html +14 -11
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/my-first-component.html +22 -13
- package/docs/crawl/docs/_getting-started/my-first-subscriber.html +110 -0
- package/docs/crawl/docs/_getting-started/pubsub.html +62 -0
- package/docs/crawl/docs/_getting-started/start.html +76 -0
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/theming.html +9 -10
- package/docs/{docs/misc → crawl/docs/_misc}/api-configuration.html +18 -18
- package/docs/{docs/misc → crawl/docs/_misc}/dataProviderKey.html +11 -12
- package/docs/{docs/misc → crawl/docs/_misc}/docs-mock-api.html +28 -25
- package/docs/{docs/misc → crawl/docs/_misc}/dynamic-path.html +15 -16
- package/docs/{docs/misc → crawl/docs/_misc}/endpoint.html +15 -16
- package/docs/crawl/docs/_misc/formelement-subscriber-removal.html +138 -0
- package/docs/{docs/misc → crawl/docs/_misc}/html-integration.html +15 -12
- package/docs/crawl/hubs/decorators.html +547 -0
- package/docs/crawl/hubs/form-components.html +381 -0
- package/docs/crawl/hubs/remote-data.html +452 -0
- package/docs/crawl/index.html +103 -0
- package/docs/docs-mock-api-sw.js +223 -58
- package/docs/docs-mock-api-sw.js.map +4 -4
- package/docs/index.html +68 -95
- package/docs/llms-full.txt +3610 -2231
- package/docs/llms.txt +86 -94
- package/docs/robots.txt +10 -11
- package/docs/sitemap.xml +84 -78
- package/docs/src/core/components/functional/date/date.md +231 -91
- package/docs/src/core/components/functional/fetch/fetch.md +83 -66
- package/docs/src/core/components/functional/if/if.md +3 -28
- package/docs/src/core/components/functional/jsonata/jsonata.md +37 -42
- package/docs/src/core/components/functional/list/list.md +43 -99
- package/docs/src/core/components/functional/mix/mix.md +26 -31
- package/docs/src/core/components/functional/queue/queue.md +61 -40
- package/docs/src/core/components/functional/router/router.md +65 -64
- package/docs/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
- package/docs/src/core/components/functional/sdui/component-catalog.json +1 -1
- package/docs/src/core/components/functional/sdui/example.json +86 -19
- package/docs/src/core/components/functional/sdui/sdui-extension-points.md +1 -1
- package/docs/src/core/components/functional/sdui/sdui.md +358 -187
- package/docs/src/core/components/functional/states/states.md +61 -86
- package/docs/src/core/components/functional/submit/submit.md +72 -64
- package/docs/src/core/components/functional/value/value.md +22 -34
- package/docs/src/core/components/ui/alert/alert.md +58 -48
- package/docs/src/core/components/ui/badge/badge.md +34 -27
- package/docs/src/core/components/ui/button/button.md +106 -139
- package/docs/src/core/components/ui/captcha/captcha.md +32 -17
- package/docs/src/core/components/ui/card/card.md +6 -6
- package/docs/src/core/components/ui/divider/divider.md +11 -8
- package/docs/src/core/components/ui/form/checkbox/checkbox.md +42 -90
- package/docs/src/core/components/ui/form/fieldset/fieldset.md +75 -31
- package/docs/src/core/components/ui/form/form-actions/form-actions.md +16 -14
- package/docs/src/core/components/ui/form/form-layout/form-layout.md +29 -19
- package/docs/src/core/components/ui/form/input/input.md +95 -95
- package/docs/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +29 -0
- package/docs/src/core/components/ui/form/radio/radio.md +34 -55
- package/docs/src/core/components/ui/form/select/select.md +45 -60
- package/docs/src/core/components/ui/form/switch/switch.md +34 -57
- package/docs/src/core/components/ui/form/textarea/textarea.md +38 -55
- package/docs/src/core/components/ui/group/group.md +33 -35
- package/docs/src/core/components/ui/icon/icon.md +4 -4
- package/docs/src/core/components/ui/image/image.md +107 -41
- package/docs/src/core/components/ui/link/link.md +6 -6
- package/docs/src/core/components/ui/loader/loader.md +55 -30
- package/docs/src/core/components/ui/menu/menu.md +27 -27
- package/docs/src/core/components/ui/modal/modal.md +96 -72
- package/docs/src/core/components/ui/pop/pop.md +158 -80
- package/docs/src/core/components/ui/progress/progress.md +2 -2
- package/docs/src/core/components/ui/table/table.md +255 -91
- package/docs/src/core/components/ui/theme/theme.md +36 -11
- package/docs/src/core/components/ui/toast/toast.md +117 -48
- package/docs/src/core/components/ui/tooltip/tooltip.md +62 -27
- package/docs/{docs/getting-started → src/docs/_core-concept}/dataFlow.md +18 -17
- package/docs/src/docs/_core-concept/overview.md +57 -0
- package/docs/src/docs/_core-concept/subscriber.md +75 -0
- package/docs/src/docs/_decorators/ancestor-attribute.md +128 -0
- package/docs/src/docs/_decorators/auto-subscribe.md +202 -0
- package/docs/src/docs/_decorators/bind.md +167 -0
- package/docs/src/docs/_decorators/get.md +162 -0
- package/docs/src/docs/_decorators/handle.md +175 -0
- package/docs/src/docs/_decorators/on-assign.md +390 -0
- package/docs/src/docs/_decorators/patch.md +70 -0
- package/docs/src/docs/_decorators/post.md +146 -0
- package/docs/src/docs/_decorators/publish.md +55 -0
- package/docs/src/docs/_decorators/put.md +70 -0
- package/docs/src/docs/_decorators/subscribe.md +100 -0
- package/docs/src/docs/_decorators/wait-for-ancestors.md +163 -0
- package/docs/src/docs/_directives/sub.md +91 -0
- package/docs/src/docs/{getting-started → _getting-started}/ai-agents.md +3 -3
- package/docs/src/docs/_getting-started/concorde-manual-install.md +133 -0
- package/docs/src/docs/_getting-started/concorde-outside.md +33 -0
- package/docs/{docs/getting-started → src/docs/_getting-started}/create-a-component.md +6 -3
- package/docs/src/docs/{getting-started → _getting-started}/my-first-component.md +14 -5
- package/docs/src/docs/_getting-started/my-first-subscriber.md +120 -0
- package/docs/src/docs/_getting-started/pubsub.md +37 -0
- package/docs/src/docs/{getting-started → _getting-started}/start.md +13 -1
- package/docs/src/docs/{getting-started → _getting-started}/theming.md +2 -2
- package/docs/src/docs/{misc → _misc}/api-configuration.md +12 -10
- package/docs/src/docs/{misc → _misc}/dataProviderKey.md +4 -4
- package/docs/{docs/misc → src/docs/_misc}/docs-mock-api.md +13 -12
- package/docs/{docs/misc → src/docs/_misc}/dynamic-path.md +8 -8
- package/docs/{docs/misc → src/docs/_misc}/endpoint.md +8 -8
- package/docs/src/docs/_misc/formelement-subscriber-removal.md +115 -0
- package/docs/{docs/misc → src/docs/_misc}/html-integration.md +5 -4
- package/docs/src/docs/search/docs-search.json +4375 -2420
- package/docs/src/tsconfig.declarations.json +22 -0
- package/docs/src/tsconfig.emit.json +23 -0
- package/docs/src/tsconfig.json +2 -23
- package/gitlab/job_github_mirror.sh +39 -0
- package/index.html +89 -0
- package/package.json +22 -4
- package/public/img/og-concorde.jpg +0 -0
- package/scripts/ai-init.mjs +104 -379
- package/scripts/ai-init.test.mjs +81 -239
- package/scripts/docs-markdown-vite-plugin.ts +11 -5
- package/scripts/docs-public-url.mjs +6 -0
- package/scripts/docs.htaccess +7 -0
- package/scripts/generate-cem.mjs +244 -0
- package/scripts/generate-cem.test.mjs +122 -0
- package/scripts/generate-crawl-docs.mjs +29 -5
- package/scripts/generate-sdui-catalog.mjs +11 -10
- package/scripts/github-export.mjs +150 -0
- package/scripts/post-build-docs.js +3 -0
- package/scripts/post-build.mjs +0 -0
- 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 +1 -1
- package/src/core/components/functional/example/example.ts +3 -1
- package/src/core/components/functional/if/if.ts +0 -0
- package/src/core/components/functional/list/list.demo.ts +0 -0
- package/src/core/components/functional/list/list.md +6 -2
- package/src/core/components/functional/list/list.ts +17 -4
- package/src/core/components/functional/mix/mix.md +0 -0
- package/src/core/components/functional/router/router.demo.ts +0 -0
- package/src/core/components/functional/router/router.ts +0 -0
- package/src/core/components/functional/sdui/SDUIDescriptorTransformer.ts +0 -0
- package/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
- package/src/core/components/functional/sdui/component-catalog.json +2 -2
- package/src/core/components/functional/sdui/example.json +0 -0
- package/src/core/components/functional/sdui/sdui-immutable.spec.ts +74 -0
- package/src/core/components/functional/sdui/sdui.ts +33 -8
- package/src/core/components/functional/sdui/types.ts +0 -0
- package/src/core/components/functional/states/states.ts +0 -0
- package/src/core/components/functional/submit/submit.spec.ts +60 -0
- package/src/core/components/functional/submit/submit.ts +6 -3
- package/src/core/components/functional/subscriber/subscriber.ts +0 -0
- package/src/core/components/functional/value/value.md +0 -0
- package/src/core/components/functional/value/value.ts +0 -0
- package/src/core/components/ui/_css/size.ts +0 -0
- package/src/core/components/ui/captcha/altchaStyles.ts +0 -0
- package/src/core/components/ui/card/card.md +1 -1
- package/src/core/components/ui/form/input/input.md +19 -1
- package/src/core/components/ui/form/input/input.ts +8 -2
- package/src/core/components/ui/form/radio/radio.md +14 -0
- package/src/core/components/ui/image/image.md +17 -17
- package/src/core/components/ui/modal/modal.md +2 -2
- package/src/core/decorators/subscriber/bind.ts +9 -14
- package/src/core/decorators/subscriber/subscribe.ts +15 -9
- package/src/core/decorators/subscriber/subscribe.type-test.ts +14 -5
- package/src/core/mixins/Subscriber.ts +0 -0
- package/src/core/utils/DataBindObserver.ts +0 -0
- package/src/core/utils/Objects.ts +0 -0
- package/src/core/utils/PublisherProxy.ts +166 -125
- package/src/core/utils/deepReadonly.spec.ts +66 -0
- package/src/core/utils/deepReadonly.ts +71 -0
- package/src/core/utils/immutableValue.spec.ts +58 -0
- package/src/core/utils/immutableValue.ts +116 -0
- package/src/core/utils/nestedDotForm.spec.ts +88 -0
- package/src/core/utils/publisherImmutable.spec.ts +127 -0
- package/src/core/utils/route.ts +0 -0
- package/src/core/utils/strictGet.spec.ts +61 -0
- package/src/core/utils/strictGet.ts +102 -0
- package/src/css.d.ts +19 -0
- package/src/docs/components/docs-demo-sources.ts +3 -3
- package/src/docs/decorators/bind.md +23 -24
- package/src/docs/docs-location.spec.ts +10 -0
- package/src/docs/docs-location.ts +10 -0
- package/src/docs/example/decorators-demo-bind-demos.ts +11 -28
- package/src/docs/example/docs-toggle-demos.ts +1 -1
- package/src/docs/example/users.ts +0 -0
- package/src/docs/getting-started/ai-agents.md +51 -51
- package/src/docs/getting-started/dataFlow.md +2 -2
- package/src/docs/home/home.ts +3 -1
- package/src/docs/misc/publisher-get-immutability-docs-crawl.json +902 -0
- package/src/docs/misc/publisher-get-immutability-docs-recheck.json +13 -0
- package/src/docs/misc/publisher-get-immutability-study.md +229 -0
- package/src/docs/navigation/navigation.ts +5 -1
- package/src/docs/search/docs-search.json +358 -58
- package/src/docs/search/markdown-renderer.ts +6 -1
- package/src/docs/tailwind/css/docs/content.css +4 -5
- package/src/tsconfig.declarations.json +22 -0
- package/src/tsconfig.emit.json +23 -0
- package/src/tsconfig.json +53 -5
- package/src/tsconfig.tsbuildinfo +1 -1
- package/.taste-skill/after/desktop-fold.jpg +0 -0
- package/.taste-skill/after/desktop-page-01.jpg +0 -0
- package/.taste-skill/after/desktop-page-02.jpg +0 -0
- package/.taste-skill/after/desktop-page-03.jpg +0 -0
- package/.taste-skill/after/mobile-fold.jpg +0 -0
- package/.taste-skill/after/mobile-page-01.jpg +0 -0
- package/.taste-skill/after/report.json +0 -4103
- package/.taste-skill/after/tablet-fold.jpg +0 -0
- package/.taste-skill/after/tablet-page-01.jpg +0 -0
- package/.taste-skill/after/tablet-page-02.jpg +0 -0
- package/.taste-skill/before/desktop-fold.jpg +0 -0
- package/.taste-skill/before/desktop-page-01.jpg +0 -0
- package/.taste-skill/before/desktop-page-02.jpg +0 -0
- package/.taste-skill/before/mobile-fold.jpg +0 -0
- package/.taste-skill/before/mobile-page-01.jpg +0 -0
- package/.taste-skill/before/report.json +0 -2556
- package/.taste-skill/before/tablet-fold.jpg +0 -0
- package/.taste-skill/before/tablet-page-01.jpg +0 -0
- package/.taste-skill/direction.json +0 -510
- package/.taste-skill/notes.md +0 -84
- package/.taste-skill/prod/desktop-fold.jpg +0 -0
- package/.taste-skill/prod/desktop-page-01.jpg +0 -0
- package/.taste-skill/prod/desktop-page-02.jpg +0 -0
- package/.taste-skill/prod/desktop-page-03.jpg +0 -0
- package/.taste-skill/prod/mobile-fold.jpg +0 -0
- package/.taste-skill/prod/mobile-page-01.jpg +0 -0
- package/.taste-skill/prod/mobile-page-02.jpg +0 -0
- package/.taste-skill/prod/report.json +0 -1973
- package/.taste-skill/prod/tablet-fold.jpg +0 -0
- package/.taste-skill/prod/tablet-page-01.jpg +0 -0
- package/.taste-skill/prod/tablet-page-02.jpg +0 -0
- package/AUDIT.md +0 -228
- package/PLAN-AMELIORATION.md +0 -220
- package/PLAN-DOCS-AGENTS.md +0 -80
- 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/.htaccess +0 -75
- package/docs/404.html +0 -15
- package/docs/404.md +0 -5
- package/docs/assets/index-BgG6FFPt.js +0 -11765
- package/docs/assets/index-x89XINSG.css +0 -1
- package/docs/core/components/functional/date/date.html +0 -211
- package/docs/core/components/functional/date/date.md +0 -150
- package/docs/core/components/functional/fetch/fetch.html +0 -180
- package/docs/core/components/functional/fetch/fetch.md +0 -108
- package/docs/core/components/functional/if/if.html +0 -65
- package/docs/core/components/functional/if/if.md +0 -34
- package/docs/core/components/functional/jsonata/jsonata.html +0 -110
- package/docs/core/components/functional/jsonata/jsonata.md +0 -61
- package/docs/core/components/functional/list/list.html +0 -198
- package/docs/core/components/functional/list/list.md +0 -121
- package/docs/core/components/functional/mix/mix.html +0 -78
- package/docs/core/components/functional/mix/mix.md +0 -46
- package/docs/core/components/functional/queue/queue.html +0 -155
- package/docs/core/components/functional/queue/queue.md +0 -51
- package/docs/core/components/functional/router/router.html +0 -154
- package/docs/core/components/functional/router/router.md +0 -93
- package/docs/core/components/functional/sdui/sdui-extension-points.md +0 -94
- package/docs/core/components/functional/sdui/sdui.html +0 -397
- package/docs/core/components/functional/sdui/sdui.md +0 -307
- package/docs/core/components/functional/states/states.html +0 -141
- package/docs/core/components/functional/states/states.md +0 -112
- package/docs/core/components/functional/submit/submit.html +0 -178
- package/docs/core/components/functional/submit/submit.md +0 -106
- package/docs/core/components/functional/subscriber/subscriber.md +0 -91
- package/docs/core/components/functional/translation/translation.html +0 -60
- package/docs/core/components/functional/translation/translation.md +0 -38
- package/docs/core/components/functional/value/value.html +0 -81
- package/docs/core/components/functional/value/value.md +0 -47
- package/docs/core/components/ui/alert/alert.md +0 -186
- package/docs/core/components/ui/alert-messages/alert-messages.md +0 -85
- package/docs/core/components/ui/badge/badge.md +0 -181
- package/docs/core/components/ui/button/button.html +0 -309
- package/docs/core/components/ui/button/button.md +0 -216
- package/docs/core/components/ui/captcha/captcha.html +0 -80
- package/docs/core/components/ui/captcha/captcha.md +0 -56
- package/docs/core/components/ui/card/card.md +0 -215
- package/docs/core/components/ui/divider/divider.md +0 -126
- package/docs/core/components/ui/form/checkbox/checkbox.html +0 -200
- package/docs/core/components/ui/form/checkbox/checkbox.md +0 -125
- package/docs/core/components/ui/form/fieldset/fieldset.html +0 -238
- package/docs/core/components/ui/form/fieldset/fieldset.md +0 -161
- package/docs/core/components/ui/form/form-actions/form-actions.md +0 -98
- package/docs/core/components/ui/form/form-layout/form-layout.html +0 -115
- package/docs/core/components/ui/form/form-layout/form-layout.md +0 -109
- package/docs/core/components/ui/form/input/input.html +0 -235
- package/docs/core/components/ui/form/input/input.md +0 -142
- package/docs/core/components/ui/form/radio/radio.html +0 -144
- package/docs/core/components/ui/form/radio/radio.md +0 -78
- package/docs/core/components/ui/form/select/select.html +0 -178
- package/docs/core/components/ui/form/select/select.md +0 -86
- package/docs/core/components/ui/form/switch/switch.html +0 -146
- package/docs/core/components/ui/form/switch/switch.md +0 -80
- package/docs/core/components/ui/form/textarea/textarea.html +0 -162
- package/docs/core/components/ui/form/textarea/textarea.md +0 -82
- package/docs/core/components/ui/group/group.html +0 -113
- package/docs/core/components/ui/group/group.md +0 -77
- package/docs/core/components/ui/icon/icon.md +0 -214
- package/docs/core/components/ui/image/image.html +0 -194
- package/docs/core/components/ui/image/image.md +0 -167
- package/docs/core/components/ui/link/link.md +0 -81
- package/docs/core/components/ui/loader/loader.html +0 -114
- package/docs/core/components/ui/loader/loader.md +0 -87
- package/docs/core/components/ui/menu/menu.md +0 -370
- package/docs/core/components/ui/modal/modal.html +0 -324
- package/docs/core/components/ui/modal/modal.md +0 -211
- package/docs/core/components/ui/pop/pop.html +0 -250
- package/docs/core/components/ui/pop/pop.md +0 -216
- package/docs/core/components/ui/progress/progress.md +0 -109
- package/docs/core/components/ui/table/table.html +0 -333
- package/docs/core/components/ui/table/table.md +0 -267
- package/docs/core/components/ui/theme/theme.html +0 -116
- package/docs/core/components/ui/theme/theme.md +0 -97
- package/docs/core/components/ui/toast/toast.html +0 -185
- package/docs/core/components/ui/toast/toast.md +0 -147
- package/docs/core/components/ui/tooltip/tooltip.html +0 -112
- package/docs/core/components/ui/tooltip/tooltip.md +0 -89
- package/docs/docs/decorators/ancestor-attribute.html +0 -71
- package/docs/docs/decorators/ancestor-attribute.md +0 -59
- package/docs/docs/decorators/auto-subscribe.html +0 -61
- package/docs/docs/decorators/auto-subscribe.md +0 -40
- package/docs/docs/decorators/bind.html +0 -86
- package/docs/docs/decorators/bind.md +0 -77
- package/docs/docs/decorators/get.html +0 -166
- package/docs/docs/decorators/get.md +0 -160
- package/docs/docs/decorators/handle.html +0 -139
- package/docs/docs/decorators/handle.md +0 -119
- package/docs/docs/decorators/on-assign.html +0 -72
- package/docs/docs/decorators/on-assign.md +0 -63
- package/docs/docs/decorators/patch.html +0 -76
- package/docs/docs/decorators/patch.md +0 -44
- package/docs/docs/decorators/post.html +0 -150
- package/docs/docs/decorators/post.md +0 -134
- package/docs/docs/decorators/publish.html +0 -74
- package/docs/docs/decorators/publish.md +0 -56
- package/docs/docs/decorators/put.html +0 -83
- package/docs/docs/decorators/put.md +0 -51
- package/docs/docs/decorators/subscribe.html +0 -91
- package/docs/docs/decorators/subscribe.md +0 -87
- package/docs/docs/decorators/wait-for-ancestors.html +0 -82
- package/docs/docs/decorators/wait-for-ancestors.md +0 -76
- package/docs/docs/directives/sub.html +0 -79
- package/docs/docs/directives/sub.md +0 -75
- package/docs/docs/directives/t.html +0 -91
- package/docs/docs/directives/t.md +0 -73
- package/docs/docs/getting-started/ai-agents.md +0 -76
- package/docs/docs/getting-started/components.html +0 -27
- package/docs/docs/getting-started/components.md +0 -5
- package/docs/docs/getting-started/installation.html +0 -69
- package/docs/docs/getting-started/installation.md +0 -36
- package/docs/docs/getting-started/my-first-component.md +0 -227
- package/docs/docs/getting-started/start.html +0 -47
- package/docs/docs/getting-started/start.md +0 -35
- package/docs/docs/getting-started/theming.md +0 -253
- package/docs/docs/index.html +0 -99
- package/docs/docs/misc/api-configuration.md +0 -79
- package/docs/docs/misc/dataProviderKey.md +0 -168
- package/docs/hubs/decorators.html +0 -443
- package/docs/hubs/form-components.html +0 -404
- package/docs/hubs/remote-data.html +0 -371
- 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 +0 -28
- package/docs/index.md +0 -22
- package/docs/src/core/components/functional/translation/translation.md +0 -38
- package/docs/src/docs/decorators/ancestor-attribute.md +0 -59
- package/docs/src/docs/decorators/auto-subscribe.md +0 -40
- package/docs/src/docs/decorators/bind.md +0 -77
- package/docs/src/docs/decorators/get.md +0 -160
- package/docs/src/docs/decorators/handle.md +0 -119
- package/docs/src/docs/decorators/on-assign.md +0 -63
- package/docs/src/docs/decorators/patch.md +0 -44
- package/docs/src/docs/decorators/post.md +0 -134
- package/docs/src/docs/decorators/publish.md +0 -56
- package/docs/src/docs/decorators/put.md +0 -51
- package/docs/src/docs/decorators/subscribe.md +0 -87
- package/docs/src/docs/decorators/wait-for-ancestors.md +0 -76
- package/docs/src/docs/directives/sub.md +0 -75
- package/docs/src/docs/directives/t.md +0 -73
- package/docs/src/docs/getting-started/components.md +0 -5
- package/docs/src/docs/getting-started/create-a-component.md +0 -136
- package/docs/src/docs/getting-started/dataFlow.md +0 -87
- package/docs/src/docs/getting-started/installation.md +0 -36
- package/docs/src/docs/misc/docs-mock-api.md +0 -62
- package/docs/src/docs/misc/dynamic-path.md +0 -71
- package/docs/src/docs/misc/endpoint.md +0 -45
- package/docs/src/docs/misc/html-integration.md +0 -14
- /package/{docs → dist}/img/concorde/plane_01.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_02.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_03.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_04.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_05.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_06.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_07.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_08.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_09.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_10.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_11.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_12.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_13.jpg +0 -0
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/on-assign" data-doc-id="docs/decorators/on-assign">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>@onAssign — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="Legacy decorator that calls a method with the values at one or more string paths of the store, once all of them are defined. For new code, use @handle with { waitForAllDefined: true }: same behaviour,">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/on-assign, on-assign, @onAssign, decorator, onAssign, { waitForAllDefined: true }, DataProviderKey, null, undefined, connectedCallback, disconnectedCallback, ${prop}, @handle">
|
|
9
|
-
<meta name="concorde-doc-id" content="docs/decorators/on-assign">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/on-assign">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/on-assign.md">
|
|
12
|
-
</head>
|
|
13
|
-
<body>
|
|
14
|
-
<header>
|
|
15
|
-
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/on-assign">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
-
</header>
|
|
17
|
-
<main>
|
|
18
|
-
<article>
|
|
19
|
-
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @onAssign</strong>. Legacy decorator that calls a method with the values at one or more string paths of the store, once all of them are defined. For new code, use @handle with { waitForAllDefined: true }: same behaviour, <span>Doc ID: <code>docs/decorators/on-assign</code>. Keywords: Concorde, supersoniks, docs/decorators/on-assign, on-assign, @onAssign, decorator, onAssign, { waitForAllDefined: true }, DataProviderKey, null, undefined, connectedCallback, disconnectedCallback, ${prop}, @handle. URL: <a href="https://concorde.supersoniks.org/docs/decorators/on-assign">https://concorde.supersoniks.org/docs/decorators/on-assign</a>.</span></p>
|
|
20
|
-
<h1 id="onassign">@onAssign</h1>
|
|
21
|
-
<p>Legacy decorator that calls a method with the values at one or more string paths of the store, once all of them are defined. For new code, use <a href="/docs/decorators/handle">@handle</a> with <code>{ waitForAllDefined: true }</code>: same behaviour, with typed <code>DataProviderKey</code> paths.</p>
|
|
22
|
-
<h2 id="import">Import</h2>
|
|
23
|
-
<pre><code class="language-typescript">import { onAssign } from "@supersoniks/concorde/decorators";
|
|
24
|
-
|
|
25
|
-
@onAssign("passenger", "passengerSettings")
|
|
26
|
-
onReady(passenger: Passenger, settings: Settings) {}
|
|
27
|
-
</code></pre>
|
|
28
|
-
<h2 id="wait-for-every-path">Wait for every path</h2>
|
|
29
|
-
<p>The method is called only when every path holds a value other than <code>null</code> or <code>undefined</code>, with the values in the order of the paths. After that, each assignment calls it again with the latest values. Subscriptions start after <code>connectedCallback</code> and stop in <code>disconnectedCallback</code>.</p>
|
|
30
|
-
<pre><code><docs-demo-sources for="demo-on-assign"></docs-demo-sources>
|
|
31
|
-
<demo-on-assign></demo-on-assign>
|
|
32
|
-
</code></pre>
|
|
33
|
-
<h2 id="dynamic-path">Dynamic path</h2>
|
|
34
|
-
<p>Paths accept <code>${prop}</code> placeholders resolved on the host. While a placeholder is <code>null</code> or <code>undefined</code>, that path is unsubscribed. Write the paths as plain strings, not template literals. Rules: <a href="/docs/misc/dynamic-path">Dynamic path placeholders</a>.</p>
|
|
35
|
-
<pre><code class="language-typescript">@property({ type: Number }) seat = 0;
|
|
36
|
-
|
|
37
|
-
@onAssign("passengers.${seat}", "passengerSettings.${seat}")
|
|
38
|
-
onSeat(passenger: Passenger, settings: Settings) {}
|
|
39
|
-
</code></pre>
|
|
40
|
-
<h2 id="migrate-to-handle">Migrate to @handle</h2>
|
|
41
|
-
<pre><code class="language-typescript">// Before
|
|
42
|
-
@onAssign("passenger", "passengerSettings")
|
|
43
|
-
onReady(passenger: any, settings: any) {}
|
|
44
|
-
|
|
45
|
-
// After
|
|
46
|
-
const passengerKey = new DataProviderKey&lt;Passenger&gt;("passenger");
|
|
47
|
-
const settingsKey = new DataProviderKey&lt;Settings&gt;("passengerSettings");
|
|
48
|
-
|
|
49
|
-
@handle(passengerKey, settingsKey, { waitForAllDefined: true })
|
|
50
|
-
onReady(passenger: Passenger, settings: Settings) {}
|
|
51
|
-
</code></pre>
|
|
52
|
-
<p><code>@handle</code> accepts up to three keys. For more paths, keep <code>@onAssign</code> or split the logic into several <code>@handle</code> methods.</p>
|
|
53
|
-
<h2 id="api-reference">API reference</h2>
|
|
54
|
-
<table>
|
|
55
|
-
<thead>
|
|
56
|
-
<tr>
|
|
57
|
-
<th>Argument</th>
|
|
58
|
-
<th>Type</th>
|
|
59
|
-
<th>Description</th>
|
|
60
|
-
</tr>
|
|
61
|
-
</thead>
|
|
62
|
-
<tbody><tr>
|
|
63
|
-
<td><code>...paths</code></td>
|
|
64
|
-
<td><code>string[]</code></td>
|
|
65
|
-
<td>Dot paths in the store (<code>"flights.0.status"</code>), optionally with <code>${prop}</code> placeholders; the method receives one argument per path, in order</td>
|
|
66
|
-
</tr>
|
|
67
|
-
</tbody></table>
|
|
68
|
-
|
|
69
|
-
</article>
|
|
70
|
-
</main>
|
|
71
|
-
</body>
|
|
72
|
-
</html>
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# @onAssign
|
|
2
|
-
|
|
3
|
-
Legacy decorator that calls a method with the values at one or more string paths of the store, once all of them are defined. For new code, use [@handle](/docs/decorators/handle) with `{ waitForAllDefined: true }`: same behaviour, with typed `DataProviderKey` paths.
|
|
4
|
-
|
|
5
|
-
## Import
|
|
6
|
-
|
|
7
|
-
<sonic-code language="typescript">
|
|
8
|
-
<template>
|
|
9
|
-
import { onAssign } from "@supersoniks/concorde/decorators";
|
|
10
|
-
|
|
11
|
-
@onAssign("passenger", "passengerSettings")
|
|
12
|
-
onReady(passenger: Passenger, settings: Settings) {}
|
|
13
|
-
</template>
|
|
14
|
-
</sonic-code>
|
|
15
|
-
|
|
16
|
-
## Wait for every path
|
|
17
|
-
|
|
18
|
-
The method is called only when every path holds a value other than `null` or `undefined`, with the values in the order of the paths. After that, each assignment calls it again with the latest values. Subscriptions start after `connectedCallback` and stop in `disconnectedCallback`.
|
|
19
|
-
|
|
20
|
-
<sonic-code>
|
|
21
|
-
<template>
|
|
22
|
-
<docs-demo-sources for="demo-on-assign"></docs-demo-sources>
|
|
23
|
-
<demo-on-assign></demo-on-assign>
|
|
24
|
-
</template>
|
|
25
|
-
</sonic-code>
|
|
26
|
-
|
|
27
|
-
## Dynamic path
|
|
28
|
-
|
|
29
|
-
Paths accept `${prop}` placeholders resolved on the host. While a placeholder is `null` or `undefined`, that path is unsubscribed. Write the paths as plain strings, not template literals. Rules: [Dynamic path placeholders](/docs/misc/dynamic-path).
|
|
30
|
-
|
|
31
|
-
<sonic-code language="typescript">
|
|
32
|
-
<template>
|
|
33
|
-
@property({ type: Number }) seat = 0;
|
|
34
|
-
|
|
35
|
-
@onAssign("passengers.${seat}", "passengerSettings.${seat}")
|
|
36
|
-
onSeat(passenger: Passenger, settings: Settings) {}
|
|
37
|
-
</template>
|
|
38
|
-
</sonic-code>
|
|
39
|
-
|
|
40
|
-
## Migrate to @handle
|
|
41
|
-
|
|
42
|
-
<sonic-code language="typescript">
|
|
43
|
-
<template>
|
|
44
|
-
// Before
|
|
45
|
-
@onAssign("passenger", "passengerSettings")
|
|
46
|
-
onReady(passenger: any, settings: any) {}
|
|
47
|
-
|
|
48
|
-
// After
|
|
49
|
-
const passengerKey = new DataProviderKey<Passenger>("passenger");
|
|
50
|
-
const settingsKey = new DataProviderKey<Settings>("passengerSettings");
|
|
51
|
-
|
|
52
|
-
@handle(passengerKey, settingsKey, { waitForAllDefined: true })
|
|
53
|
-
onReady(passenger: Passenger, settings: Settings) {}
|
|
54
|
-
</template>
|
|
55
|
-
</sonic-code>
|
|
56
|
-
|
|
57
|
-
`@handle` accepts up to three keys. For more paths, keep `@onAssign` or split the logic into several `@handle` methods.
|
|
58
|
-
|
|
59
|
-
## API reference
|
|
60
|
-
|
|
61
|
-
| Argument | Type | Description |
|
|
62
|
-
|----------|------|-------------|
|
|
63
|
-
| `...paths` | `string[]` | Dot paths in the store (`"flights.0.status"`), optionally with `${prop}` placeholders; the method receives one argument per path, in order |
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/patch" data-doc-id="docs/decorators/patch">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>@patch — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="Sends the value of a publisher as the body of a PATCH request, to update part of a resource, and stores the response in an ApiResult<T> property. It takes the same arguments, options and send(componen">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/patch, patch, @patch, decorator, PATCH, ApiResult, send(component), send, endpoint, Endpoint, bodyKey, DataProviderKey, configurationKey">
|
|
9
|
-
<meta name="concorde-doc-id" content="docs/decorators/patch">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/patch">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/patch.md">
|
|
12
|
-
</head>
|
|
13
|
-
<body>
|
|
14
|
-
<header>
|
|
15
|
-
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/patch">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
-
</header>
|
|
17
|
-
<main>
|
|
18
|
-
<article>
|
|
19
|
-
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @patch</strong>. Sends the value of a publisher as the body of a PATCH request, to update part of a resource, and stores the response in an ApiResult<T> property. It takes the same arguments, options and send(componen <span>Doc ID: <code>docs/decorators/patch</code>. Keywords: Concorde, supersoniks, docs/decorators/patch, patch, @patch, decorator, PATCH, ApiResult, send(component), send, endpoint, Endpoint, bodyKey, DataProviderKey, configurationKey. URL: <a href="https://concorde.supersoniks.org/docs/decorators/patch">https://concorde.supersoniks.org/docs/decorators/patch</a>.</span></p>
|
|
20
|
-
<h1 id="patch">@patch</h1>
|
|
21
|
-
<p>Sends the value of a publisher as the body of a <code>PATCH</code> request, to update part of a resource, and stores the response in an <code>ApiResult<T></code> property. It takes the same arguments, options and <code>send(component)</code> handle as <a href="/docs/decorators/post">@post</a>; only the HTTP method differs.</p>
|
|
22
|
-
<h2 id="import">Import</h2>
|
|
23
|
-
<pre><code class="language-typescript">import { patch, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
24
|
-
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
25
|
-
import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
|
|
26
|
-
</code></pre>
|
|
27
|
-
<h2 id="basic-usage">Basic usage</h2>
|
|
28
|
-
<p>The body holds only the fields to change, here a gate change for flight CN 001.</p>
|
|
29
|
-
<pre><code class="language-typescript">type Flight = { flight: string; route: string; gate: string };
|
|
30
|
-
|
|
31
|
-
const gateChangeKey = new DataProviderKey&lt;Partial&lt;Flight&gt;&gt;("gateChange");
|
|
32
|
-
|
|
33
|
-
@patch(new Endpoint&lt;Flight&gt;("flights/CN001"), gateChangeKey)
|
|
34
|
-
@state()
|
|
35
|
-
payload?: ApiResult&lt;Flight&gt;;
|
|
36
|
-
|
|
37
|
-
moveToB12() {
|
|
38
|
-
set(gateChangeKey, { gate: "B12" }); // sends the PATCH
|
|
39
|
-
}
|
|
40
|
-
</code></pre>
|
|
41
|
-
<p>Triggers, the <code>send</code> method decorator and every option are described on <a href="/docs/decorators/post">@post</a>.</p>
|
|
42
|
-
<h2 id="api-reference">API reference</h2>
|
|
43
|
-
<table>
|
|
44
|
-
<thead>
|
|
45
|
-
<tr>
|
|
46
|
-
<th>Argument</th>
|
|
47
|
-
<th>Type</th>
|
|
48
|
-
<th>Description</th>
|
|
49
|
-
</tr>
|
|
50
|
-
</thead>
|
|
51
|
-
<tbody><tr>
|
|
52
|
-
<td><code>endpoint</code></td>
|
|
53
|
-
<td><code>Endpoint<T></code></td>
|
|
54
|
-
<td>Resource path and response type</td>
|
|
55
|
-
</tr>
|
|
56
|
-
<tr>
|
|
57
|
-
<td><code>bodyKey</code></td>
|
|
58
|
-
<td><code>DataProviderKey<B></code></td>
|
|
59
|
-
<td>Publisher read as the partial body</td>
|
|
60
|
-
</tr>
|
|
61
|
-
<tr>
|
|
62
|
-
<td><code>configurationKey</code></td>
|
|
63
|
-
<td><code>DataProviderKey<APIConfiguration></code> (optional)</td>
|
|
64
|
-
<td>API configuration publisher. Default: HTML scope</td>
|
|
65
|
-
</tr>
|
|
66
|
-
<tr>
|
|
67
|
-
<td><code>options</code></td>
|
|
68
|
-
<td><code>PatchOptions</code></td>
|
|
69
|
-
<td>Same as <a href="/docs/decorators/post">@post options</a></td>
|
|
70
|
-
</tr>
|
|
71
|
-
</tbody></table>
|
|
72
|
-
|
|
73
|
-
</article>
|
|
74
|
-
</main>
|
|
75
|
-
</body>
|
|
76
|
-
</html>
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# @patch
|
|
2
|
-
|
|
3
|
-
Sends the value of a publisher as the body of a `PATCH` request, to update part of a resource, and stores the response in an `ApiResult<T>` property. It takes the same arguments, options and `send(component)` handle as [@post](/docs/decorators/post); only the HTTP method differs.
|
|
4
|
-
|
|
5
|
-
## Import
|
|
6
|
-
|
|
7
|
-
<sonic-code language="typescript">
|
|
8
|
-
<template>
|
|
9
|
-
import { patch, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
10
|
-
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
11
|
-
import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
|
|
12
|
-
</template>
|
|
13
|
-
</sonic-code>
|
|
14
|
-
|
|
15
|
-
## Basic usage
|
|
16
|
-
|
|
17
|
-
The body holds only the fields to change, here a gate change for flight CN 001.
|
|
18
|
-
|
|
19
|
-
<sonic-code language="typescript">
|
|
20
|
-
<template>
|
|
21
|
-
type Flight = { flight: string; route: string; gate: string };
|
|
22
|
-
|
|
23
|
-
const gateChangeKey = new DataProviderKey<Partial<Flight>>("gateChange");
|
|
24
|
-
|
|
25
|
-
@patch(new Endpoint<Flight>("flights/CN001"), gateChangeKey)
|
|
26
|
-
@state()
|
|
27
|
-
payload?: ApiResult<Flight>;
|
|
28
|
-
|
|
29
|
-
moveToB12() {
|
|
30
|
-
set(gateChangeKey, { gate: "B12" }); // sends the PATCH
|
|
31
|
-
}
|
|
32
|
-
</template>
|
|
33
|
-
</sonic-code>
|
|
34
|
-
|
|
35
|
-
Triggers, the `send` method decorator and every option are described on [@post](/docs/decorators/post).
|
|
36
|
-
|
|
37
|
-
## API reference
|
|
38
|
-
|
|
39
|
-
| Argument | Type | Description |
|
|
40
|
-
|----------|------|-------------|
|
|
41
|
-
| `endpoint` | `Endpoint<T>` | Resource path and response type |
|
|
42
|
-
| `bodyKey` | `DataProviderKey<B>` | Publisher read as the partial body |
|
|
43
|
-
| `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | API configuration publisher. Default: HTML scope |
|
|
44
|
-
| `options` | `PatchOptions` | Same as [@post options](/docs/decorators/post) |
|
|
@@ -1,150 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/post" data-doc-id="docs/decorators/post">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>@post — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="Sends the value of a publisher as the body of a POST request and stores the response in an ApiResult<T> property. Pass an Endpoint and a DataProviderKey for the body; the request runs on connect and a">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/post, post, @post, decorator, POST, ApiResult, undefined, request, response, result, POST /docs-mock-api/api/register, send(component), Promise | undefined>">
|
|
9
|
-
<meta name="concorde-doc-id" content="docs/decorators/post">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/post">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/post.md">
|
|
12
|
-
</head>
|
|
13
|
-
<body>
|
|
14
|
-
<header>
|
|
15
|
-
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/post">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
-
</header>
|
|
17
|
-
<main>
|
|
18
|
-
<article>
|
|
19
|
-
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @post</strong>. Sends the value of a publisher as the body of a POST request and stores the response in an ApiResult<T> property. Pass an Endpoint and a DataProviderKey for the body; the request runs on connect and a <span>Doc ID: <code>docs/decorators/post</code>. Keywords: Concorde, supersoniks, docs/decorators/post, post, @post, decorator, POST, ApiResult, undefined, request, response, result, POST /docs-mock-api/api/register, send(component), Promise | undefined>. URL: <a href="https://concorde.supersoniks.org/docs/decorators/post">https://concorde.supersoniks.org/docs/decorators/post</a>.</span></p>
|
|
20
|
-
<h1 id="post">@post</h1>
|
|
21
|
-
<p>Sends the value of a publisher as the body of a <code>POST</code> request and stores the response in an <code>ApiResult<T></code> property. Pass an <a href="/docs/misc/endpoint">Endpoint</a> and a <a href="/docs/misc/dataProviderKey">DataProviderKey</a> for the body; the request runs on connect and again whenever the body changes. <a href="/docs/decorators/put">@put</a> and <a href="/docs/decorators/patch">@patch</a> work the same way.</p>
|
|
22
|
-
<h2 id="import">Import</h2>
|
|
23
|
-
<pre><code class="language-typescript">import { post, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
24
|
-
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
25
|
-
import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
|
|
26
|
-
|
|
27
|
-
type SignUp = { email: string; password: string };
|
|
28
|
-
type CrewMember = { id: number; email: string };
|
|
29
|
-
|
|
30
|
-
const signUpKey = new DataProviderKey&lt;SignUp&gt;("crewSignUp");
|
|
31
|
-
|
|
32
|
-
@post(new Endpoint&lt;CrewMember&gt;("api/register"), signUpKey)
|
|
33
|
-
@state()
|
|
34
|
-
payload?: ApiResult&lt;CrewMember&gt;;
|
|
35
|
-
</code></pre>
|
|
36
|
-
<h2 id="basic-usage">Basic usage</h2>
|
|
37
|
-
<p>The property is <code>undefined</code> until a response arrives, then holds <code>request</code> · <code>response</code> · the typed <code>result</code>. Each body mutation sends a new request; mutations in the same frame are coalesced into one. The demo posts to the local mock <code>POST /docs-mock-api/api/register</code>.</p>
|
|
38
|
-
<pre><code><docs-demo-sources for="demo-api-post"></docs-demo-sources>
|
|
39
|
-
<demo-api-post></demo-api-post>
|
|
40
|
-
</code></pre>
|
|
41
|
-
<h2 id="method-form">Method form</h2>
|
|
42
|
-
<p>On a method, the decorator calls it with the full <code>ApiResult<T></code> after each request instead of assigning a property.</p>
|
|
43
|
-
<pre><code><docs-demo-sources for="demo-api-post-method"></docs-demo-sources>
|
|
44
|
-
<demo-api-post-method></demo-api-post-method>
|
|
45
|
-
</code></pre>
|
|
46
|
-
<h2 id="sending-again">Sending again</h2>
|
|
47
|
-
<p>Keep the decorator in a constant to call <code>send(component)</code>. It reads the current body and returns a <code>Promise<ApiResult<T> | undefined></code> resolved once the request completes. Use it for "Save" or "Retry" buttons.</p>
|
|
48
|
-
<pre><code class="language-typescript">const signUp = post(new Endpoint&lt;CrewMember&gt;("api/register"), signUpKey);
|
|
49
|
-
|
|
50
|
-
@signUp
|
|
51
|
-
@state()
|
|
52
|
-
payload?: ApiResult&lt;CrewMember&gt;;
|
|
53
|
-
|
|
54
|
-
async retry() {
|
|
55
|
-
const payload = await signUp.send(this);
|
|
56
|
-
console.log(payload?.result?.id);
|
|
57
|
-
}
|
|
58
|
-
</code></pre>
|
|
59
|
-
<p>The <code>send</code> method decorator does the same around a method. It runs after the method by default (waiting for a returned Promise); <code>{ when: "before" }</code> sends first.</p>
|
|
60
|
-
<pre><code class="language-typescript">import { send } from "@supersoniks/concorde/decorators";
|
|
61
|
-
|
|
62
|
-
@send(signUp)
|
|
63
|
-
async confirmCheckIn() {
|
|
64
|
-
// Validate the check-in form, then the POST is sent.
|
|
65
|
-
}
|
|
66
|
-
</code></pre>
|
|
67
|
-
<h2 id="manual-trigger">Manual trigger</h2>
|
|
68
|
-
<p>Set <code>autoPostOnBodyMutation: false</code> when the body is edited field by field (a check-in form) and the request must only go out on <code>send()</code> or <code>triggerKey</code>. A <code>triggerKey</code> publisher lets another component resend: calling <code>invalidate()</code> on it sends the current body.</p>
|
|
69
|
-
<pre><code class="language-typescript">const submitKey = new DataProviderKey&lt;number&gt;("checkInSubmit");
|
|
70
|
-
|
|
71
|
-
@post(checkInEndpoint, checkInKey, {
|
|
72
|
-
autoPostOnBodyMutation: false,
|
|
73
|
-
triggerKey: submitKey,
|
|
74
|
-
})
|
|
75
|
-
@state()
|
|
76
|
-
payload?: ApiResult&lt;CheckIn&gt;;
|
|
77
|
-
|
|
78
|
-
// Anywhere: dp(submitKey).invalidate();
|
|
79
|
-
</code></pre>
|
|
80
|
-
<p>By default (<code>skipIfBodyMissing: true</code>) nothing is sent while the body is <code>null</code> or <code>undefined</code>. <code>refetchEveryMs</code> repeats the request at a fixed interval after each response; use it only when repeating the operation is safe.</p>
|
|
81
|
-
<h2 id="api-configuration">API configuration</h2>
|
|
82
|
-
<p>Without a configuration key, <code>serviceURL</code> and credentials come from the HTML scope, as with <a href="/docs/decorators/get">@get</a>. Pass a <code>DataProviderKey<APIConfiguration></code> as third argument to read them from a publisher; options then move to the fourth argument. See <a href="/docs/misc/api-configuration">API configuration</a>.</p>
|
|
83
|
-
<pre><code class="language-typescript">@post(signUpEndpoint, signUpKey, apiConfigurationKey, { skipIfBodyMissing: false })
|
|
84
|
-
</code></pre>
|
|
85
|
-
<h2 id="dynamic-path">Dynamic path</h2>
|
|
86
|
-
<p>Placeholders in the endpoint (<code>${flight}</code>) are read from the host component; changing the property sends the same body to the new URL. See <a href="/docs/misc/dynamic-path">Dynamic paths</a>.</p>
|
|
87
|
-
<pre><code><docs-demo-sources for="demo-api-post-dynamic"></docs-demo-sources>
|
|
88
|
-
<demo-api-post-dynamic></demo-api-post-dynamic>
|
|
89
|
-
</code></pre>
|
|
90
|
-
<h2 id="api-reference">API reference</h2>
|
|
91
|
-
<p><code>post(endpoint, bodyKey, configurationKey?, options?)</code> returns a decorator for a property or a method, with a <code>send(component)</code> method.</p>
|
|
92
|
-
<table>
|
|
93
|
-
<thead>
|
|
94
|
-
<tr>
|
|
95
|
-
<th>Argument</th>
|
|
96
|
-
<th>Type</th>
|
|
97
|
-
<th>Description</th>
|
|
98
|
-
</tr>
|
|
99
|
-
</thead>
|
|
100
|
-
<tbody><tr>
|
|
101
|
-
<td><code>endpoint</code></td>
|
|
102
|
-
<td><code>Endpoint<T></code></td>
|
|
103
|
-
<td>Path and response type. Supports <code>${prop}</code> placeholders</td>
|
|
104
|
-
</tr>
|
|
105
|
-
<tr>
|
|
106
|
-
<td><code>bodyKey</code></td>
|
|
107
|
-
<td><code>DataProviderKey<B></code></td>
|
|
108
|
-
<td>Publisher read as request body</td>
|
|
109
|
-
</tr>
|
|
110
|
-
<tr>
|
|
111
|
-
<td><code>configurationKey</code></td>
|
|
112
|
-
<td><code>DataProviderKey<APIConfiguration></code> (optional)</td>
|
|
113
|
-
<td>API configuration publisher. Default: HTML scope</td>
|
|
114
|
-
</tr>
|
|
115
|
-
<tr>
|
|
116
|
-
<td><code>options.autoPostOnBodyMutation</code></td>
|
|
117
|
-
<td><code>boolean</code> (default <code>true</code>)</td>
|
|
118
|
-
<td>Send on connect and after each body mutation</td>
|
|
119
|
-
</tr>
|
|
120
|
-
<tr>
|
|
121
|
-
<td><code>options.skipIfBodyMissing</code></td>
|
|
122
|
-
<td><code>boolean</code> (default <code>true</code>)</td>
|
|
123
|
-
<td>Skip while the body is <code>null</code> or <code>undefined</code></td>
|
|
124
|
-
</tr>
|
|
125
|
-
<tr>
|
|
126
|
-
<td><code>options.triggerKey</code></td>
|
|
127
|
-
<td><code>DataProviderKey<unknown></code></td>
|
|
128
|
-
<td>Publisher whose <code>invalidate()</code> resends</td>
|
|
129
|
-
</tr>
|
|
130
|
-
<tr>
|
|
131
|
-
<td><code>options.refetchEveryMs</code></td>
|
|
132
|
-
<td><code>number</code> (default <code>0</code>, off)</td>
|
|
133
|
-
<td>Resend interval in ms after each response</td>
|
|
134
|
-
</tr>
|
|
135
|
-
<tr>
|
|
136
|
-
<td><code>options.skipEmptyPlaceholder</code></td>
|
|
137
|
-
<td><code>boolean</code> (default <code>false</code>)</td>
|
|
138
|
-
<td>Treat a placeholder resolved to <code>""</code> as not ready</td>
|
|
139
|
-
</tr>
|
|
140
|
-
<tr>
|
|
141
|
-
<td><code>send(handle, { when })</code></td>
|
|
142
|
-
<td><code>"after"</code> (default) or <code>"before"</code></td>
|
|
143
|
-
<td>Method decorator sending after or before the method</td>
|
|
144
|
-
</tr>
|
|
145
|
-
</tbody></table>
|
|
146
|
-
|
|
147
|
-
</article>
|
|
148
|
-
</main>
|
|
149
|
-
</body>
|
|
150
|
-
</html>
|
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
# @post
|
|
2
|
-
|
|
3
|
-
Sends the value of a publisher as the body of a `POST` request and stores the response in an `ApiResult<T>` property. Pass an [Endpoint](/docs/misc/endpoint) and a [DataProviderKey](/docs/misc/dataProviderKey) for the body; the request runs on connect and again whenever the body changes. [@put](/docs/decorators/put) and [@patch](/docs/decorators/patch) work the same way.
|
|
4
|
-
|
|
5
|
-
## Import
|
|
6
|
-
|
|
7
|
-
<sonic-code language="typescript">
|
|
8
|
-
<template>
|
|
9
|
-
import { post, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
10
|
-
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
11
|
-
import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
|
|
12
|
-
|
|
13
|
-
type SignUp = { email: string; password: string };
|
|
14
|
-
type CrewMember = { id: number; email: string };
|
|
15
|
-
|
|
16
|
-
const signUpKey = new DataProviderKey<SignUp>("crewSignUp");
|
|
17
|
-
|
|
18
|
-
@post(new Endpoint<CrewMember>("api/register"), signUpKey)
|
|
19
|
-
@state()
|
|
20
|
-
payload?: ApiResult<CrewMember>;
|
|
21
|
-
</template>
|
|
22
|
-
</sonic-code>
|
|
23
|
-
|
|
24
|
-
## Basic usage
|
|
25
|
-
|
|
26
|
-
The property is `undefined` until a response arrives, then holds `request` · `response` · the typed `result`. Each body mutation sends a new request; mutations in the same frame are coalesced into one. The demo posts to the local mock `POST /docs-mock-api/api/register`.
|
|
27
|
-
|
|
28
|
-
<sonic-code>
|
|
29
|
-
<template>
|
|
30
|
-
<docs-demo-sources for="demo-api-post"></docs-demo-sources>
|
|
31
|
-
<demo-api-post></demo-api-post>
|
|
32
|
-
</template>
|
|
33
|
-
</sonic-code>
|
|
34
|
-
|
|
35
|
-
## Method form
|
|
36
|
-
|
|
37
|
-
On a method, the decorator calls it with the full `ApiResult<T>` after each request instead of assigning a property.
|
|
38
|
-
|
|
39
|
-
<sonic-code>
|
|
40
|
-
<template>
|
|
41
|
-
<docs-demo-sources for="demo-api-post-method"></docs-demo-sources>
|
|
42
|
-
<demo-api-post-method></demo-api-post-method>
|
|
43
|
-
</template>
|
|
44
|
-
</sonic-code>
|
|
45
|
-
|
|
46
|
-
## Sending again
|
|
47
|
-
|
|
48
|
-
Keep the decorator in a constant to call `send(component)`. It reads the current body and returns a `Promise<ApiResult<T> | undefined>` resolved once the request completes. Use it for "Save" or "Retry" buttons.
|
|
49
|
-
|
|
50
|
-
<sonic-code language="typescript">
|
|
51
|
-
<template>
|
|
52
|
-
const signUp = post(new Endpoint<CrewMember>("api/register"), signUpKey);
|
|
53
|
-
|
|
54
|
-
@signUp
|
|
55
|
-
@state()
|
|
56
|
-
payload?: ApiResult<CrewMember>;
|
|
57
|
-
|
|
58
|
-
async retry() {
|
|
59
|
-
const payload = await signUp.send(this);
|
|
60
|
-
console.log(payload?.result?.id);
|
|
61
|
-
}
|
|
62
|
-
</template>
|
|
63
|
-
</sonic-code>
|
|
64
|
-
|
|
65
|
-
The `send` method decorator does the same around a method. It runs after the method by default (waiting for a returned Promise); `{ when: "before" }` sends first.
|
|
66
|
-
|
|
67
|
-
<sonic-code language="typescript">
|
|
68
|
-
<template>
|
|
69
|
-
import { send } from "@supersoniks/concorde/decorators";
|
|
70
|
-
|
|
71
|
-
@send(signUp)
|
|
72
|
-
async confirmCheckIn() {
|
|
73
|
-
// Validate the check-in form, then the POST is sent.
|
|
74
|
-
}
|
|
75
|
-
</template>
|
|
76
|
-
</sonic-code>
|
|
77
|
-
|
|
78
|
-
## Manual trigger
|
|
79
|
-
|
|
80
|
-
Set `autoPostOnBodyMutation: false` when the body is edited field by field (a check-in form) and the request must only go out on `send()` or `triggerKey`. A `triggerKey` publisher lets another component resend: calling `invalidate()` on it sends the current body.
|
|
81
|
-
|
|
82
|
-
<sonic-code language="typescript">
|
|
83
|
-
<template>
|
|
84
|
-
const submitKey = new DataProviderKey<number>("checkInSubmit");
|
|
85
|
-
|
|
86
|
-
@post(checkInEndpoint, checkInKey, {
|
|
87
|
-
autoPostOnBodyMutation: false,
|
|
88
|
-
triggerKey: submitKey,
|
|
89
|
-
})
|
|
90
|
-
@state()
|
|
91
|
-
payload?: ApiResult<CheckIn>;
|
|
92
|
-
|
|
93
|
-
// Anywhere: dp(submitKey).invalidate();
|
|
94
|
-
</template>
|
|
95
|
-
</sonic-code>
|
|
96
|
-
|
|
97
|
-
By default (`skipIfBodyMissing: true`) nothing is sent while the body is `null` or `undefined`. `refetchEveryMs` repeats the request at a fixed interval after each response; use it only when repeating the operation is safe.
|
|
98
|
-
|
|
99
|
-
## API configuration
|
|
100
|
-
|
|
101
|
-
Without a configuration key, `serviceURL` and credentials come from the HTML scope, as with [@get](/docs/decorators/get). Pass a `DataProviderKey<APIConfiguration>` as third argument to read them from a publisher; options then move to the fourth argument. See [API configuration](/docs/misc/api-configuration).
|
|
102
|
-
|
|
103
|
-
<sonic-code language="typescript">
|
|
104
|
-
<template>
|
|
105
|
-
@post(signUpEndpoint, signUpKey, apiConfigurationKey, { skipIfBodyMissing: false })
|
|
106
|
-
</template>
|
|
107
|
-
</sonic-code>
|
|
108
|
-
|
|
109
|
-
## Dynamic path
|
|
110
|
-
|
|
111
|
-
Placeholders in the endpoint (`${flight}`) are read from the host component; changing the property sends the same body to the new URL. See [Dynamic paths](/docs/misc/dynamic-path).
|
|
112
|
-
|
|
113
|
-
<sonic-code>
|
|
114
|
-
<template>
|
|
115
|
-
<docs-demo-sources for="demo-api-post-dynamic"></docs-demo-sources>
|
|
116
|
-
<demo-api-post-dynamic></demo-api-post-dynamic>
|
|
117
|
-
</template>
|
|
118
|
-
</sonic-code>
|
|
119
|
-
|
|
120
|
-
## API reference
|
|
121
|
-
|
|
122
|
-
`post(endpoint, bodyKey, configurationKey?, options?)` returns a decorator for a property or a method, with a `send(component)` method.
|
|
123
|
-
|
|
124
|
-
| Argument | Type | Description |
|
|
125
|
-
|----------|------|-------------|
|
|
126
|
-
| `endpoint` | `Endpoint<T>` | Path and response type. Supports `${prop}` placeholders |
|
|
127
|
-
| `bodyKey` | `DataProviderKey<B>` | Publisher read as request body |
|
|
128
|
-
| `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | API configuration publisher. Default: HTML scope |
|
|
129
|
-
| `options.autoPostOnBodyMutation` | `boolean` (default `true`) | Send on connect and after each body mutation |
|
|
130
|
-
| `options.skipIfBodyMissing` | `boolean` (default `true`) | Skip while the body is `null` or `undefined` |
|
|
131
|
-
| `options.triggerKey` | `DataProviderKey<unknown>` | Publisher whose `invalidate()` resends |
|
|
132
|
-
| `options.refetchEveryMs` | `number` (default `0`, off) | Resend interval in ms after each response |
|
|
133
|
-
| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
|
|
134
|
-
| `send(handle, { when })` | `"after"` (default) or `"before"` | Method decorator sending after or before the method |
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/publish" data-doc-id="docs/decorators/publish">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>@publish — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="@publish(key) writes a component property to one path of the store: every assignment to the property is published there. It never reads back from the store; it is the inverse of @subscribe. See Data f">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/publish, publish, @publish, decorator, @publish(key), set(), undefined, reflect: true, passenger, seat, ${prop}, null, skipEmptyPlaceholder">
|
|
9
|
-
<meta name="concorde-doc-id" content="docs/decorators/publish">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/publish">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/publish.md">
|
|
12
|
-
</head>
|
|
13
|
-
<body>
|
|
14
|
-
<header>
|
|
15
|
-
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/publish">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
-
</header>
|
|
17
|
-
<main>
|
|
18
|
-
<article>
|
|
19
|
-
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @publish</strong>. @publish(key) writes a component property to one path of the store: every assignment to the property is published there. It never reads back from the store; it is the inverse of @subscribe. See Data f <span>Doc ID: <code>docs/decorators/publish</code>. Keywords: Concorde, supersoniks, docs/decorators/publish, publish, @publish, decorator, @publish(key), set(), undefined, reflect: true, passenger, seat, ${prop}, null, skipEmptyPlaceholder. URL: <a href="https://concorde.supersoniks.org/docs/decorators/publish">https://concorde.supersoniks.org/docs/decorators/publish</a>.</span></p>
|
|
20
|
-
<h1 id="publish">@publish</h1>
|
|
21
|
-
<p><code>@publish(key)</code> writes a component property to one path of the store: every assignment to the property is published there. It never reads back from the store; it is the inverse of <a href="/docs/decorators/subscribe">@subscribe</a>. See <a href="/docs/getting-started/dataFlow">Data flow</a> for the overall model.</p>
|
|
22
|
-
<h2 id="import">Import</h2>
|
|
23
|
-
<pre><code class="language-typescript">import { publish } from "@supersoniks/concorde/decorators";
|
|
24
|
-
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
25
|
-
|
|
26
|
-
type CheckIn = { passenger: string; seat: string };
|
|
27
|
-
const checkInKey = new DataProviderKey&lt;CheckIn&gt;("checkIn");
|
|
28
|
-
|
|
29
|
-
@publish(checkInKey.passenger)
|
|
30
|
-
@state()
|
|
31
|
-
passenger = "Ada Lindqvist";
|
|
32
|
-
</code></pre>
|
|
33
|
-
<h2 id="basic-usage">Basic usage</h2>
|
|
34
|
-
<p>Each assignment calls <code>set()</code> on the publisher at the <a href="/docs/misc/dataProviderKey">DataProviderKey</a> path. <strong>On connect, a defined property value is published immediately</strong>, so the initializer overwrites what the store held. Leave the property <code>undefined</code> to keep the store value. To read and write the same path, use <a href="/docs/decorators/bind">@bind</a> with <code>reflect: true</code>.</p>
|
|
35
|
-
<p>The check-in form below publishes <code>passenger</code> and <code>seat</code>; the boarding pass reads them back with <a href="/docs/directives/sub">sub()</a>.</p>
|
|
36
|
-
<pre><code><docs-demo-sources for="demo-publish"></docs-demo-sources>
|
|
37
|
-
<demo-publish></demo-publish>
|
|
38
|
-
</code></pre>
|
|
39
|
-
<h2 id="dynamic-path">Dynamic path</h2>
|
|
40
|
-
<p><code>${prop}</code> placeholders resolve from properties of the same component. When a placeholder changes, the property is published to the new path. While it is <code>null</code> or <code>undefined</code>, nothing is published. Rules and <code>skipEmptyPlaceholder</code>: <a href="/docs/misc/dynamic-path">Dynamic paths</a>.</p>
|
|
41
|
-
<pre><code class="language-typescript">@property({ type: Number }) seatIndex = 0;
|
|
42
|
-
|
|
43
|
-
@publish(
|
|
44
|
-
new DataProviderKey&lt;string, { seatIndex: number }&gt;("onBoard.${seatIndex}.seat"),
|
|
45
|
-
{ skipEmptyPlaceholder: true },
|
|
46
|
-
)
|
|
47
|
-
@state()
|
|
48
|
-
seat = "1A";
|
|
49
|
-
</code></pre>
|
|
50
|
-
<h2 id="api-reference">API reference</h2>
|
|
51
|
-
<table>
|
|
52
|
-
<thead>
|
|
53
|
-
<tr>
|
|
54
|
-
<th>Argument</th>
|
|
55
|
-
<th>Type</th>
|
|
56
|
-
<th>Description</th>
|
|
57
|
-
</tr>
|
|
58
|
-
</thead>
|
|
59
|
-
<tbody><tr>
|
|
60
|
-
<td><code>key</code></td>
|
|
61
|
-
<td><code>DataProviderKey<T, U></code></td>
|
|
62
|
-
<td>Path to write. <code>U</code> lists the host properties used by <code>${…}</code> placeholders</td>
|
|
63
|
-
</tr>
|
|
64
|
-
<tr>
|
|
65
|
-
<td><code>options.skipEmptyPlaceholder</code></td>
|
|
66
|
-
<td><code>boolean</code> (default <code>false</code>)</td>
|
|
67
|
-
<td>Treat a placeholder resolved to <code>""</code> as not ready</td>
|
|
68
|
-
</tr>
|
|
69
|
-
</tbody></table>
|
|
70
|
-
|
|
71
|
-
</article>
|
|
72
|
-
</main>
|
|
73
|
-
</body>
|
|
74
|
-
</html>
|