@supersoniks/concorde 5.1.2 → 5.1.3-immutable.1
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 +4993 -4833
- 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 +4993 -4833
- 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 +54 -0
- package/src/core/utils/immutableValue.ts +102 -0
- package/src/core/utils/nestedDotForm.spec.ts +88 -0
- package/src/core/utils/publisherImmutable.spec.ts +76 -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 +29 -55
- 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
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="fr" data-crawl-url="https://concorde.supersoniks.org/crawl/docs/_decorators/bind.html" data-doc-id="docs/_decorators/bind">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>@bind — Concorde</title>
|
|
7
|
+
<meta name="description" content="Binds a class property to a path in a publisher. The property updates when publisher data changes.">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/_decorators/bind, bind, @bind, decorator, @state(), DataProviderKey, . Use , reflect: true, publisher.set(...)">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/_decorators/bind">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/crawl/docs/_decorators/bind.html">
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<p><a href="../../index.html">Concorde documentation (crawl)</a> · <a href="https://concorde.supersoniks.org/#docs/_decorators/bind.md/bind" rel="nofollow">interactive version</a></p>
|
|
15
|
+
</header>
|
|
16
|
+
<main>
|
|
17
|
+
<article>
|
|
18
|
+
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @bind</strong>. Binds a class property to a path in a publisher. The property updates when publisher data changes. <span>Doc ID: <code>docs/_decorators/bind</code>. Keywords: Concorde, supersoniks, docs/_decorators/bind, bind, @bind, decorator, @state(), DataProviderKey, . Use , reflect: true, publisher.set(...). URL: <a href="https://concorde.supersoniks.org/crawl/docs/_decorators/bind.html">https://concorde.supersoniks.org/crawl/docs/_decorators/bind.html</a>.</span></p>
|
|
19
|
+
<h1 id="bind">@bind</h1>
|
|
20
|
+
<p>Binds a class property to a path in a publisher. The property updates when publisher data changes.</p>
|
|
21
|
+
<p>For Lit re-renders, also add <code>@state()</code> on the same property.</p>
|
|
22
|
+
<p><strong>See also:</strong> <a href="./subscribe.html#subscribe">@subscribe</a>, <a href="./handle.html#handle">@handle</a>, <a href="./publish.html#publish">@publish</a>, <a href="./get.html#get">@get</a>, <a href="./post.html#post">@post</a>, <a href="./put.html#put">@put</a>, <a href="./patch.html#patch">@patch</a>.</p>
|
|
23
|
+
<h2 id="principle">Principle</h2>
|
|
24
|
+
<p>The decorator subscribes to the DataProvider store using dot notation or a <code>DataProviderKey</code>. Updates flow into the decorated property (<a href="../_core-concept/dataFlow.html#dataFlow">Data flow</a>).</p>
|
|
25
|
+
<h2 id="import">Import</h2>
|
|
26
|
+
<pre><code class="language-typescript">import { bind } from "@supersoniks/concorde/decorators";
|
|
27
|
+
</code></pre>
|
|
28
|
+
<h2 id="example">Example</h2>
|
|
29
|
+
<pre><code class="language-typescript">@customElement("demo-bind")
|
|
30
|
+
export class DemoBind extends LitElement {
|
|
31
|
+
static styles = [tailwind];
|
|
32
|
+
|
|
33
|
+
@bind("demoData.firstName")
|
|
34
|
+
@state()
|
|
35
|
+
firstName = "";
|
|
36
|
+
|
|
37
|
+
@bind("demoData.lastName")
|
|
38
|
+
@state()
|
|
39
|
+
lastName: string = "";
|
|
40
|
+
|
|
41
|
+
@bind("demoData.count")
|
|
42
|
+
@state()
|
|
43
|
+
count: number = 0;
|
|
44
|
+
|
|
45
|
+
render() {
|
|
46
|
+
return //......
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
updateData() {
|
|
50
|
+
set(demoDataKey, { ...get(demoDataKey), count: get(demoDataKey).count + 1 });
|
|
51
|
+
// see demo-bind in src/docs/example/decorators-demo-bind-demos.ts
|
|
52
|
+
const randomIndex = Math.floor(Math.random() * demoUsers.get().length);
|
|
53
|
+
const randomUser = demoUsers.get()[randomIndex];
|
|
54
|
+
demoData.set({
|
|
55
|
+
firstName: randomUser.firstName,
|
|
56
|
+
lastName: randomUser.lastName,
|
|
57
|
+
count: (demoData.count.get() || 0) + 1,
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
</code></pre>
|
|
62
|
+
<pre><code><docs-demo-sources for="demo-bind"></docs-demo-sources>
|
|
63
|
+
<demo-bind></demo-bind>
|
|
64
|
+
</code></pre>
|
|
65
|
+
<h2 id="dataproviderkey-strict-typing"><code>DataProviderKey</code> (strict typing)</h2>
|
|
66
|
+
<p><code>@bind</code> accepts either a string path (legacy) or a <code>DataProviderKey<T></code>. The property type must match <code>T</code>. Use <code>reflect: true</code> to push local writes back to the publisher (see below). See <a href="../_misc/dataProviderKey.html#dataProviderKey">DataProviderKey</a>.</p>
|
|
67
|
+
<pre><code class="language-typescript">import { bind } from "@supersoniks/concorde/decorators";
|
|
68
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
69
|
+
|
|
70
|
+
type Data = { count: number };
|
|
71
|
+
const dataKey = new DataProviderKey<Data>("data");
|
|
72
|
+
|
|
73
|
+
@bind(dataKey.count, { reflect: true })
|
|
74
|
+
@state()
|
|
75
|
+
count: number = 0;
|
|
76
|
+
</code></pre>
|
|
77
|
+
<h2 id="reflect-reflect-true">Reflect (<code>reflect: true</code>)</h2>
|
|
78
|
+
<p>Two-way sync: reads from the publisher and local assignments call <code>publisher.set(...)</code>. An internal guard avoids infinite loops.</p>
|
|
79
|
+
<pre><code class="language-typescript">@bind("userData.profile.avatarUrl", { reflect: true })
|
|
80
|
+
@state()
|
|
81
|
+
avatar: string;
|
|
82
|
+
</code></pre>
|
|
83
|
+
<pre><code class="language-typescript">@customElement("demo-bind-reflect")
|
|
84
|
+
export class DemoBindReflect extends LitElement {
|
|
85
|
+
static styles = [tailwind];
|
|
86
|
+
|
|
87
|
+
@bind("bindReflectDemo.count", { reflect: true })
|
|
88
|
+
@state()
|
|
89
|
+
withReflect: number = 0;
|
|
90
|
+
|
|
91
|
+
@bind("bindReflectDemo.count")
|
|
92
|
+
@state()
|
|
93
|
+
withoutReflect: number = 0;
|
|
94
|
+
|
|
95
|
+
render() {
|
|
96
|
+
return html`
|
|
97
|
+
<div class="mb-3">
|
|
98
|
+
from publisher : ${sub("bindReflectDemo.count") || 0} <br />
|
|
99
|
+
from component with reflect : ${this.withReflect || 0} <br />
|
|
100
|
+
from component without reflect : ${this.withoutReflect || 0}
|
|
101
|
+
</div>
|
|
102
|
+
<sonic-button @click=${() => this.withReflect++}
|
|
103
|
+
>Increment with reflect</sonic-button
|
|
104
|
+
>
|
|
105
|
+
<sonic-button @click=${() => this.withoutReflect++}
|
|
106
|
+
>Increment without reflect</sonic-button
|
|
107
|
+
>
|
|
108
|
+
`;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
</code></pre>
|
|
112
|
+
<pre><code><docs-demo-sources for="demo-bind-reflect"></docs-demo-sources>
|
|
113
|
+
<demo-bind-reflect></demo-bind-reflect>
|
|
114
|
+
</code></pre>
|
|
115
|
+
<h2 id="path-syntax">Path syntax</h2>
|
|
116
|
+
<ul>
|
|
117
|
+
<li>First segment: data provider id.</li>
|
|
118
|
+
<li>Nested properties: dot notation.</li>
|
|
119
|
+
<li>Arrays: numeric index (<code>items.0</code>).</li>
|
|
120
|
+
</ul>
|
|
121
|
+
<h3 id="dynamic-paths">Dynamic paths</h3>
|
|
122
|
+
<p>Use <code>${prop}</code> or <code>${this.prop}</code> inside a <strong>normal string literal</strong> (not a JS template literal with backticks). <code>@bind</code> re-subscribes when a reactive dependency changes. While a placeholder is <code>null</code>/<code>undefined</code>, the bind is inactive; optional <code>{ skipEmptyPlaceholder: true }</code> also waits on <code>""</code>. See <a href="../_misc/dynamic-path.html#dynamic-path">Dynamic path placeholders</a>.</p>
|
|
123
|
+
<blockquote>
|
|
124
|
+
<p>Properties referenced in the pattern must be reactive (<code>@property</code>, etc.) or you must call <code>requestUpdate</code> manually.</p>
|
|
125
|
+
</blockquote>
|
|
126
|
+
<pre><code><docs-demo-sources for="demo-bind-dynamic"></docs-demo-sources>
|
|
127
|
+
<demo-bind-dynamic></demo-bind-dynamic>
|
|
128
|
+
</code></pre>
|
|
129
|
+
<h2 id="behavior">Behavior</h2>
|
|
130
|
+
<ul>
|
|
131
|
+
<li>Subscribes at <code>connectedCallback</code>, unsubscribes at <code>disconnectedCallback</code>.</li>
|
|
132
|
+
<li>If the path does not exist yet, a publisher may be created with <code>null</code>.</li>
|
|
133
|
+
</ul>
|
|
134
|
+
<h2 id="notes">Notes</h2>
|
|
135
|
+
<p>Works with any component that has the usual DOM lifecycle (<code>LitElement</code>, <code>Subscriber</code> mixin, etc.).</p>
|
|
136
|
+
<p>Shared data: <a href="../_getting-started/pubsub.html#pubsub">Sharing data</a>.</p>
|
|
137
|
+
|
|
138
|
+
</article>
|
|
139
|
+
</main>
|
|
140
|
+
</body>
|
|
141
|
+
</html>
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="fr" data-crawl-url="https://concorde.supersoniks.org/crawl/docs/_decorators/get.html" data-doc-id="docs/_decorators/get">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>@get — Concorde</title>
|
|
7
|
+
<meta name="description" content="@get loads data and stores the result in an optional ApiResult<T> property.">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/_decorators/get, get, @get, decorator, ApiResult, undefined, payload.result, payload.response, payload.request,
|
|
9
|
+
|
|
10
|
+
The first argument is always an
|
|
11
|
+
[, serviceURL, refetch(component)">
|
|
12
|
+
<meta name="concorde-doc-id" content="docs/_decorators/get">
|
|
13
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/crawl/docs/_decorators/get.html">
|
|
14
|
+
</head>
|
|
15
|
+
<body>
|
|
16
|
+
<header>
|
|
17
|
+
<p><a href="../../index.html">Concorde documentation (crawl)</a> · <a href="https://concorde.supersoniks.org/#docs/_decorators/get.md/get" rel="nofollow">interactive version</a></p>
|
|
18
|
+
</header>
|
|
19
|
+
<main>
|
|
20
|
+
<article>
|
|
21
|
+
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @get</strong>. @get loads data and stores the result in an optional ApiResult<T> property. <span>Doc ID: <code>docs/_decorators/get</code>. Keywords: Concorde, supersoniks, docs/_decorators/get, get, @get, decorator, ApiResult, undefined, payload.result, payload.response, payload.request,
|
|
22
|
+
|
|
23
|
+
The first argument is always an
|
|
24
|
+
[, serviceURL, refetch(component). URL: <a href="https://concorde.supersoniks.org/crawl/docs/_decorators/get.html">https://concorde.supersoniks.org/crawl/docs/_decorators/get.html</a>.</span></p>
|
|
25
|
+
<h1 id="get">@get</h1>
|
|
26
|
+
<p><code>@get</code> loads data and stores the result in an optional <code>ApiResult<T></code> property.
|
|
27
|
+
The property is <code>undefined</code> until a result is available.</p>
|
|
28
|
+
<ul>
|
|
29
|
+
<li><code>payload.result</code>: typed data;</li>
|
|
30
|
+
<li><code>payload.response</code>: the HTTP response;</li>
|
|
31
|
+
<li><code>payload.request</code>: the request that was sent.</li>
|
|
32
|
+
</ul>
|
|
33
|
+
<h2 id="minimal-usage">Minimal usage</h2>
|
|
34
|
+
<pre><code class="language-typescript">const usersEndpoint = new Endpoint<User[]>("users");
|
|
35
|
+
|
|
36
|
+
@get(usersEndpoint)
|
|
37
|
+
@state()
|
|
38
|
+
payload?: ApiResult<User[]>;
|
|
39
|
+
</code></pre>
|
|
40
|
+
<p>The same decorator adapts to a method. The method receives the complete
|
|
41
|
+
<code>ApiResult<T></code> payload after each GET:</p>
|
|
42
|
+
<pre><code class="language-typescript">@get(usersEndpoint)
|
|
43
|
+
handleUsers(payload?: ApiResult<User[]>) {
|
|
44
|
+
if (!payload) return;
|
|
45
|
+
|
|
46
|
+
console.log(payload.response?.status);
|
|
47
|
+
console.log(payload.result);
|
|
48
|
+
}
|
|
49
|
+
</code></pre>
|
|
50
|
+
<p>The first argument is always an
|
|
51
|
+
<a href="../_misc/endpoint.html#endpoint"><code>Endpoint<T></code></a>. API configuration is read
|
|
52
|
+
from the HTML scope (<code>serviceURL</code>, token, etc.), so the component is usually
|
|
53
|
+
placed below an element that provides this configuration.</p>
|
|
54
|
+
<h2 id="refetching-a-get">Refetching a GET</h2>
|
|
55
|
+
<h3 id="from-the-component">From the component</h3>
|
|
56
|
+
<p>Keep the decorator in a constant to access <code>refetch(component)</code>. Refetch only
|
|
57
|
+
targets the instance passed as the argument, even before it has received a
|
|
58
|
+
result.</p>
|
|
59
|
+
<pre><code class="language-typescript">const usersGet = get(new Endpoint<User[]>("users"));
|
|
60
|
+
|
|
61
|
+
@usersGet
|
|
62
|
+
@state()
|
|
63
|
+
payload?: ApiResult<User[]>;
|
|
64
|
+
|
|
65
|
+
async refresh() {
|
|
66
|
+
const payload = await usersGet.refetch(this);
|
|
67
|
+
console.log(payload?.result);
|
|
68
|
+
}
|
|
69
|
+
</code></pre>
|
|
70
|
+
<p><code>refetch(component)</code> returns a <code>Promise<ApiResult<T> | undefined></code> that resolves
|
|
71
|
+
after the GET has completed.</p>
|
|
72
|
+
<p>The named handle can also decorate a method and be reused for refetching:</p>
|
|
73
|
+
<pre><code class="language-typescript">const usersGet = get(new Endpoint<User[]>("users"));
|
|
74
|
+
|
|
75
|
+
@usersGet
|
|
76
|
+
handleUsers(payload?: ApiResult<User[]>) {
|
|
77
|
+
// ...
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
@refetch(usersGet)
|
|
81
|
+
reloadUsers() {
|
|
82
|
+
// The GET runs and handleUsers receives its payload.
|
|
83
|
+
}
|
|
84
|
+
</code></pre>
|
|
85
|
+
<h3 id="from-a-method-decorator">From a method decorator</h3>
|
|
86
|
+
<p>The refetch can decorate a local method. The default is <code>after</code>; if the
|
|
87
|
+
method returns a Promise, the GET waits for its resolution. The decorated method
|
|
88
|
+
call also waits for the refetch to complete.</p>
|
|
89
|
+
<pre><code class="language-typescript">import { refetch } from "@supersoniks/concorde/decorators";
|
|
90
|
+
|
|
91
|
+
@refetch(usersGet)
|
|
92
|
+
async reload() {
|
|
93
|
+
this.userId = "42";
|
|
94
|
+
}
|
|
95
|
+
</code></pre>
|
|
96
|
+
<p>Use <code>{ when: "before" }</code> when the GET must complete before the method runs:</p>
|
|
97
|
+
<pre><code class="language-typescript">@refetch(usersGet, { when: "before" })
|
|
98
|
+
reloadBefore() {
|
|
99
|
+
// The refetch has completed before this method runs.
|
|
100
|
+
}
|
|
101
|
+
</code></pre>
|
|
102
|
+
<p>The method decorator adds an explicit trigger; changes to dynamic endpoint
|
|
103
|
+
properties and configuration publishers keep their existing automatic behavior.</p>
|
|
104
|
+
<h2 id="options-getoptions">Options (<code>GetOptions</code>)</h2>
|
|
105
|
+
<p>Options are the second argument, or the third argument when an API
|
|
106
|
+
configuration key is provided.</p>
|
|
107
|
+
<ul>
|
|
108
|
+
<li><code>skipEmptyPlaceholder</code>: blocks the GET when <code>${prop}</code> is <code>""</code>.</li>
|
|
109
|
+
<li><code>refetchEveryMs</code>: automatically runs the GET again after this interval
|
|
110
|
+
(milliseconds). Omit the option, or use <code>0</code>, to disable polling.</li>
|
|
111
|
+
<li><code>triggerKey</code>: a publisher whose <code>invalidate()</code> runs the GET again.</li>
|
|
112
|
+
</ul>
|
|
113
|
+
<p>With a configuration key, use:</p>
|
|
114
|
+
<pre><code class="language-typescript">@get(usersEndpoint, apiConfigurationKey)
|
|
115
|
+
</code></pre>
|
|
116
|
+
<h2 id="when-the-get-runs-again">When the GET runs again</h2>
|
|
117
|
+
<ul>
|
|
118
|
+
<li>when the component connects and configuration is available;</li>
|
|
119
|
+
<li>when a property used in <code>${...}</code> changes;</li>
|
|
120
|
+
<li>when a configuration publisher changes;</li>
|
|
121
|
+
<li>when the <code>triggerKey</code> publisher is invalidated;</li>
|
|
122
|
+
<li>after each response when <code>refetchEveryMs</code> is set.</li>
|
|
123
|
+
</ul>
|
|
124
|
+
<p>See <a href="../_misc/dynamic-path.html#dynamic-path">Dynamic path placeholders</a> for
|
|
125
|
+
dynamic path details.</p>
|
|
126
|
+
<h2 id="import">Import</h2>
|
|
127
|
+
<pre><code class="language-typescript">import { get, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
128
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
129
|
+
import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
|
|
130
|
+
</code></pre>
|
|
131
|
+
<h2 id="demos">Demos</h2>
|
|
132
|
+
<pre><code><docs-demo-sources for="demo-api-get"></docs-demo-sources>
|
|
133
|
+
<demo-api-get></demo-api-get>
|
|
134
|
+
<docs-demo-sources for="demo-api-get-method"></docs-demo-sources>
|
|
135
|
+
<demo-api-get-method></demo-api-get-method>
|
|
136
|
+
<docs-demo-sources for="demo-api-get-configuration-key"></docs-demo-sources>
|
|
137
|
+
<demo-api-get-configuration-key></demo-api-get-configuration-key>
|
|
138
|
+
</code></pre>
|
|
139
|
+
<p>See <a href="./post.html#post">@post</a>,
|
|
140
|
+
<a href="./put.html#put">@put</a>, and
|
|
141
|
+
<a href="./patch.html#patch">@patch</a> for write operations.</p>
|
|
142
|
+
<h2 id="advanced">Advanced</h2>
|
|
143
|
+
<p>External invalidation is currently available through <code>triggerKey</code>; it is kept
|
|
144
|
+
out of the main usage examples.</p>
|
|
145
|
+
|
|
146
|
+
</article>
|
|
147
|
+
</main>
|
|
148
|
+
</body>
|
|
149
|
+
</html>
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="fr" data-crawl-url="https://concorde.supersoniks.org/crawl/docs/_decorators/handle.html" data-doc-id="docs/_decorators/handle">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>@handle — Concorde</title>
|
|
7
|
+
<meta name="description" content="Typed callback on one or more DataProviderKey<T> paths: invokes the decorated method when a publisher assigns a value (calculations, side effects, updating other @state properties, etc.).">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/_decorators/handle, handle, @handle, decorator, DataProviderKey, @state, HandleOptions, null, undefined, @bind, @subscribe, ${user.firstName} ${user.lastName}">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/_decorators/handle">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/crawl/docs/_decorators/handle.html">
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<p><a href="../../index.html">Concorde documentation (crawl)</a> · <a href="https://concorde.supersoniks.org/#docs/_decorators/handle.md/handle" rel="nofollow">interactive version</a></p>
|
|
15
|
+
</header>
|
|
16
|
+
<main>
|
|
17
|
+
<article>
|
|
18
|
+
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @handle</strong>. Typed callback on one or more DataProviderKey<T> paths: invokes the decorated method when a publisher assigns a value (calculations, side effects, updating other @state properties, etc.). <span>Doc ID: <code>docs/_decorators/handle</code>. Keywords: Concorde, supersoniks, docs/_decorators/handle, handle, @handle, decorator, DataProviderKey, @state, HandleOptions, null, undefined, @bind, @subscribe, ${user.firstName} ${user.lastName}. URL: <a href="https://concorde.supersoniks.org/crawl/docs/_decorators/handle.html">https://concorde.supersoniks.org/crawl/docs/_decorators/handle.html</a>.</span></p>
|
|
19
|
+
<h1 id="handle">@handle</h1>
|
|
20
|
+
<p>Typed callback on one or more <code>DataProviderKey<T></code> paths: invokes the decorated <strong>method</strong> when a publisher assigns a value (calculations, side effects, updating other <code>@state</code> properties, etc.).</p>
|
|
21
|
+
<p>Unlike <a href="./subscribe.html#subscribe">@subscribe</a>, nothing is bound to the decorated member — only your method runs. <code>@handle</code> is typed and accepts up to <strong>3 keys</strong> plus an optional trailing <code>HandleOptions</code> object. It supersedes the string-based <a href="./on-assign.html#on-assign">@onAssign</a>.</p>
|
|
22
|
+
<p>By default the method is called on <strong>every</strong> assignment, even when the value is <code>null</code> / <code>undefined</code>. Use the options below to restrict that.</p>
|
|
23
|
+
<h2 id="import">Import</h2>
|
|
24
|
+
<pre><code class="language-typescript">import { handle, Skip } from "@supersoniks/concorde/decorators";
|
|
25
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
26
|
+
import { get, set } from "@supersoniks/concorde/utils";
|
|
27
|
+
</code></pre>
|
|
28
|
+
<h2 id="basic-example">Basic example</h2>
|
|
29
|
+
<pre><code class="language-typescript">type DemoCounterData = { count: number };
|
|
30
|
+
const demoDataKey = new DataProviderKey&lt;DemoCounterData&gt;("demoData");
|
|
31
|
+
|
|
32
|
+
@customElement("demo-handle")
|
|
33
|
+
export class DemoHandle extends LitElement {
|
|
34
|
+
@state() doubled = 0;
|
|
35
|
+
@state() lastUpdate = "";
|
|
36
|
+
|
|
37
|
+
@handle(demoDataKey.count)
|
|
38
|
+
onCountChange(count: number) {
|
|
39
|
+
this.doubled = count * 2;
|
|
40
|
+
this.lastUpdate = new Date().toLocaleTimeString();
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
incrementCount() {
|
|
44
|
+
const data = get(demoDataKey);
|
|
45
|
+
set(demoDataKey, { ...data, count: data.count + 1 });
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
render() {
|
|
49
|
+
return html`
|
|
50
|
+
&lt;p&gt;Doubled count: ${this.doubled}&lt;/p&gt;
|
|
51
|
+
&lt;p&gt;&lt;small&gt;Last update: ${this.lastUpdate}&lt;/small&gt;&lt;/p&gt;
|
|
52
|
+
&lt;sonic-button @click=${this.incrementCount}&gt;Increment&lt;/sonic-button&gt;
|
|
53
|
+
`;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
</code></pre>
|
|
57
|
+
<pre><code><docs-demo-sources for="demo-handle"></docs-demo-sources>
|
|
58
|
+
<demo-handle></demo-handle>
|
|
59
|
+
</code></pre>
|
|
60
|
+
<h2 id="dynamic-path">Dynamic path</h2>
|
|
61
|
+
<p>Placeholders in <code>DataProviderKey</code> resolve from the host component’s properties (same rules as <code>@bind</code> / <code>@subscribe</code>).</p>
|
|
62
|
+
<pre><code class="language-typescript">type User = { firstName: string; lastName: string; email: string };
|
|
63
|
+
|
|
64
|
+
@customElement("demo-handle-dynamic")
|
|
65
|
+
export class DemoHandleDynamic extends LitElement {
|
|
66
|
+
@property({ type: Number })
|
|
67
|
+
userIndex = 0;
|
|
68
|
+
|
|
69
|
+
@state() displayName = "";
|
|
70
|
+
@state() lastUpdate = "";
|
|
71
|
+
|
|
72
|
+
@handle(new DataProviderKey&lt;User, { userIndex: number }&gt;("demoUsers.${userIndex}"))
|
|
73
|
+
onUserAssigned(user: User) {
|
|
74
|
+
this.displayName = `${user.firstName} ${user.lastName}`;
|
|
75
|
+
this.lastUpdate = new Date().toLocaleTimeString();
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
render() {
|
|
79
|
+
return html`...`;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
</code></pre>
|
|
83
|
+
<pre><code><docs-demo-sources for="demo-handle-dynamic"></docs-demo-sources>
|
|
84
|
+
<demo-handle-dynamic></demo-handle-dynamic>
|
|
85
|
+
</code></pre>
|
|
86
|
+
<h2 id="multiple-paths">Multiple paths</h2>
|
|
87
|
+
<p><code>@handle</code> accepts up to <strong>3 keys</strong>; the method receives one strongly-typed argument per key, in order. Each assignment triggers the method, so make your method safe against partial values (or use <code>waitForAllDefined</code>, see below).</p>
|
|
88
|
+
<pre><code class="language-typescript">type QueueConfig = { onInactivity: { stillHere: { show: boolean } } };
|
|
89
|
+
const config = new DataProviderKey&lt;QueueConfig&gt;("sessionQueueConfig");
|
|
90
|
+
const idle = new DataProviderKey&lt;{ isIdle: boolean }&gt;("idleStatus");
|
|
91
|
+
|
|
92
|
+
@customElement("demo-handle-multi")
|
|
93
|
+
export class DemoHandleMulti extends LitElement {
|
|
94
|
+
|
|
95
|
+
// show: boolean, isIdle: boolean — fully typed from the keys
|
|
96
|
+
@handle(config.onInactivity.stillHere.show, idle.isIdle)
|
|
97
|
+
onInactivity(show: boolean, isIdle: boolean) {
|
|
98
|
+
if (show === true && isIdle === true) this.openModal();
|
|
99
|
+
else this.closeModal();
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
</code></pre>
|
|
103
|
+
<h2 id="options-handleoptions">Options (<code>HandleOptions</code>)</h2>
|
|
104
|
+
<p>Pass an options object as the <strong>last</strong> argument. The names map to real situations seen in the apps.</p>
|
|
105
|
+
<h3 id="waitforalldefined"><code>waitForAllDefined</code></h3>
|
|
106
|
+
<p>Only call the method once <strong>all</strong> watched keys are defined (non <code>null</code> / <code>undefined</code>). This reproduces the historical <code>@onAssign</code> semantics — use it when the logic only makes sense with every source ready (e.g. building a date from <code>date</code> + <code>timeZone</code> + <code>direction</code>).</p>
|
|
107
|
+
<pre><code class="language-typescript">@handle(trip.departureDate, trip.event.timeZone, form.direction, {
|
|
108
|
+
waitForAllDefined: true,
|
|
109
|
+
})
|
|
110
|
+
updateDepartureDate(date: number, timeZone: string, direction: string) {
|
|
111
|
+
// called only when the three values are all available
|
|
112
|
+
this.formDate = formatDate(date, timeZone, direction);
|
|
113
|
+
}
|
|
114
|
+
</code></pre>
|
|
115
|
+
<h3 id="skip"><code>skip</code></h3>
|
|
116
|
+
<p>Do <strong>not</strong> call the method when a received value belongs to one of the listed <strong>categories</strong> (the <code>Skip</code> enum). Each entry is a named category — not a value — so there is no value/pattern ambiguity (e.g. <code>{}</code> is <code>Skip.EmptyObject</code>, an explicit "empty object" category, never a value comparison).</p>
|
|
117
|
+
<table>
|
|
118
|
+
<thead>
|
|
119
|
+
<tr>
|
|
120
|
+
<th>Category</th>
|
|
121
|
+
<th>Matches</th>
|
|
122
|
+
</tr>
|
|
123
|
+
</thead>
|
|
124
|
+
<tbody><tr>
|
|
125
|
+
<td><code>Skip.Nullish</code></td>
|
|
126
|
+
<td><code>null</code> or <code>undefined</code> (a publisher always emits <code>null</code>, never <code>undefined</code>)</td>
|
|
127
|
+
</tr>
|
|
128
|
+
<tr>
|
|
129
|
+
<td><code>Skip.EmptyString</code></td>
|
|
130
|
+
<td><code>""</code></td>
|
|
131
|
+
</tr>
|
|
132
|
+
<tr>
|
|
133
|
+
<td><code>Skip.EmptyObject</code></td>
|
|
134
|
+
<td>object with no keys (<code>{}</code>), arrays excluded</td>
|
|
135
|
+
</tr>
|
|
136
|
+
<tr>
|
|
137
|
+
<td><code>Skip.EmptyArray</code></td>
|
|
138
|
+
<td>empty array (<code>[]</code>)</td>
|
|
139
|
+
</tr>
|
|
140
|
+
</tbody></table>
|
|
141
|
+
<p>Useful when a not-yet-initialized publisher emits <code>{}</code> as a "loading" state. For a <strong>specific value</strong> (e.g. a particular string), guard inside the method instead.</p>
|
|
142
|
+
<pre><code class="language-typescript">@handle(user.profile, { skip: [Skip.Nullish, Skip.EmptyObject] })
|
|
143
|
+
onProfile(profile: Profile) {
|
|
144
|
+
// not called while the publisher still holds {} (not loaded yet)
|
|
145
|
+
this.displayName = profile.firstName;
|
|
146
|
+
}
|
|
147
|
+
</code></pre>
|
|
148
|
+
<blockquote>
|
|
149
|
+
<p>Options can be combined, e.g. <code>@handle(a, b, { waitForAllDefined: true, skip: [Skip.Nullish] })</code>. For any <strong>arbitrary</strong> validation on a specific value, just guard inside the method (<code>if (!isValid(v)) return;</code>) — that is exactly what an <code>accept</code>-style predicate would do, since <code>@handle</code> only runs your method.</p>
|
|
150
|
+
</blockquote>
|
|
151
|
+
<h3 id="skipemptyplaceholder"><code>skipEmptyPlaceholder</code></h3>
|
|
152
|
+
<p>On a <strong>dynamic key path</strong> (<code>"items.${itemId}"</code>), if <code>true</code>, a placeholder resolved to <code>''</code> is treated as not ready (no subscription) — <strong>empty string only</strong>, not <code>0</code> or <code>false</code>. See <a href="../_misc/dynamic-path.html#dynamic-path">Dynamic path placeholders</a>.</p>
|
|
153
|
+
<h2 id="highlights">Highlights</h2>
|
|
154
|
+
<ul>
|
|
155
|
+
<li>Strict typing: the method receives one argument per key, in order.</li>
|
|
156
|
+
<li>Up to 3 keys; for 4+ keys (rare), keep <a href="./on-assign.html#on-assign">@onAssign</a> for now.</li>
|
|
157
|
+
<li>By default the method runs on <strong>every</strong> assignment, even with <code>null</code> / <code>undefined</code> (unlike <code>@onAssign</code>, which waits for all values). Opt back into that behavior with <code>waitForAllDefined</code>.</li>
|
|
158
|
+
<li><code>skip</code> filters out values by <strong>named category</strong> (e.g. <code>[Skip.Nullish, Skip.EmptyObject]</code>); for arbitrary checks on a specific value, guard inside the method.</li>
|
|
159
|
+
</ul>
|
|
160
|
+
<p>See also <a href="../_misc/dataProviderKey.html#dataProviderKey">DataProviderKey</a> and <a href="../_misc/dynamic-path.html#dynamic-path">Dynamic path placeholders</a>.</p>
|
|
161
|
+
|
|
162
|
+
</article>
|
|
163
|
+
</main>
|
|
164
|
+
</body>
|
|
165
|
+
</html>
|