@supersoniks/concorde 4.9.91 → 4.9.93

package/src/docs/example/decorators-demo-subscribe-publish-get-demos.ts

@@ -5,6 +5,7 @@ import type { ApiResult } from "@supersoniks/concorde/core/utils/api";
 import { DataProviderKey } from "@supersoniks/concorde/core/utils/dataProviderKey";
 import { sub } from "@supersoniks/concorde/directives";
 import {
+  dp,
   get as storeGet,
   set,
 } from "@supersoniks/concorde/core/utils/PublisherProxy";
@@ -28,6 +29,9 @@ const geoCommunesGet = get(
   geoCommunesApiGetEndpoint,
   docsDemoGeoApiConfigurationKey,
 );
+const geoCommunesMethodTriggerKey = new DataProviderKey<number>(
+  "docsDemoGeoCommunesMethodTrigger",
+);
 
 @customElement("demo-publish")
 export class DemoPublish extends LitElement {
@@ -91,8 +95,8 @@ export class DemoApiGet extends LitElement {
   @state()
   geoApiPayload?: ApiResult<GeoCommuneRow[]>;
 
-  private refresh() {
-    geoCommunesGet.refetch(this);
+  private async refresh() {
+    await geoCommunesGet.refetch(this);
   }
 
   render() {
@@ -124,6 +128,61 @@ export class DemoApiGet extends LitElement {
   }
 }
 
+@customElement("demo-api-get-method")
+export class DemoApiGetMethod extends LitElement {
+  static styles = [tailwind];
+
+  @state()
+  private payload?: ApiResult<GeoCommuneRow[]>;
+
+  connectedCallback() {
+    super.connectedCallback();
+    set(geoCommunesMethodTriggerKey, 0);
+  }
+
+  @get(geoCommunesApiGetEndpoint, docsDemoGeoApiConfigurationKey, {
+    triggerKey: geoCommunesMethodTriggerKey,
+  })
+  handlePayload(payload?: ApiResult<GeoCommuneRow[]>) {
+    this.payload = payload;
+  }
+
+  private refresh() {
+    dp(geoCommunesMethodTriggerKey).invalidate();
+  }
+
+  render() {
+    const rows = this.payload?.result ?? [];
+    return html`
+      <div class="space-y-3">
+        <div class="flex flex-wrap items-center gap-3">
+          <span class="text-sm font-medium">🗺️ GET function mode</span>
+          <sonic-button size="sm" @click=${this.refresh}>
+            Invalidate trigger
+          </sonic-button>
+        </div>
+        <p class="text-sm text-neutral-600 dark:text-neutral-400">
+          The <code>@get</code> decorator calls <code>handlePayload</code> with
+          the complete API payload.
+        </p>
+        <p class="text-xs text-neutral-500">
+          HTTP status:
+          <strong>${this.payload?.response?.status ?? "loading…"}</strong>
+        </p>
+        <ul class="grid gap-1 sm:grid-cols-2">
+          ${rows.slice(0, 6).map(
+            (commune) =>
+              html`<li class="text-sm">
+                ${commune.nom}
+                <span class="text-neutral-500">(${commune.code})</span>
+              </li>`,
+          )}
+        </ul>
+      </div>
+    `;
+  }
+}
+
 @customElement("demo-api-get-configuration-key")
 export class DemoApiGetConfigurationKey extends LitElement {
   static styles = [tailwind];

package/src/docs/search/docs-search.json

@@ -4700,7 +4700,7 @@
     }
   },
   {
-    "search": "@get loads data and stores the result in an ApiResult<T> | null property.\n",
+    "search": "@get loads data and stores the result in an optional ApiResult<T> property.\nThe property is undefined until a result is available.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
@@ -4714,6 +4714,21 @@
       }
     }
   },
+  {
+    "search": "The same decorator adapts to a method. The method receives the complete\nApiResult<T> payload after each GET:\n",
+    "files": {
+      "docs/_decorators/get.md": {
+        "title": "@get",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
   {
     "search": "The first argument is always an\nEndpoint<T>. API configuration is read\nfrom the HTML scope (serviceURL, token, etc.), so the component is usually\nplaced below an element that provides this configuration.\n",
     "files": {
@@ -4745,7 +4760,37 @@
     }
   },
   {
-    "search": "The refetch can decorate a local method. The default is after; if the\nmethod returns a Promise, the GET waits for its resolution.\n",
+    "search": "refetch(component) returns a Promise<ApiResult<T> | undefined> that resolves\nafter the GET has completed.\n",
+    "files": {
+      "docs/_decorators/get.md": {
+        "title": "@get",
+        "hashes": {
+          "from-the-component": {
+            "count": 1,
+            "title": "From the component",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
+  {
+    "search": "The named handle can also decorate a method and be reused for refetching:\n",
+    "files": {
+      "docs/_decorators/get.md": {
+        "title": "@get",
+        "hashes": {
+          "from-the-component": {
+            "count": 1,
+            "title": "From the component",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
+  {
+    "search": "The refetch can decorate a local method. The default is after; if the\nmethod returns a Promise, the GET waits for its resolution. The decorated method\ncall also waits for the refetch to complete.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
@@ -4760,7 +4805,7 @@
     }
   },
   {
-    "search": "Use { when: "before" } when the GET must be scheduled before the method:\n",
+    "search": "Use { when: "before" } when the GET must complete before the method runs:\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
@@ -5799,6 +5844,31 @@
       }
     }
   },
+  {
+    "search": "The same decorator adapts to a method:\n",
+    "files": {
+      "docs/_decorators/patch.md": {
+        "title": "@patch",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      },
+      "docs/_decorators/put.md": {
+        "title": "@put",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
   {
     "search": "To run the operation again from the component:\n",
     "files": {
@@ -5824,6 +5894,21 @@
       }
     }
   },
+  {
+    "search": "send(component) returns a Promise resolved after the PATCH completes. See\n@post for the method-decorator form and the\nwhen: "before" option.\n",
+    "files": {
+      "docs/_decorators/patch.md": {
+        "title": "@patch",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
   {
     "search": "The PATCH is also sent automatically when the body mutates, unless\nautoPostOnBodyMutation: false is set. The available options are described in\n@post:\n",
     "files": {
@@ -5880,7 +5965,7 @@
     }
   },
   {
-    "search": "@post sends the contents of a publisher and stores the response in an\nApiResult<T> | null property.\n",
+    "search": "@post sends the contents of a publisher and stores the response in an\noptional ApiResult<T> property. The property is undefined until a result\nis available.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
@@ -5909,6 +5994,21 @@
       }
     }
   },
+  {
+    "search": "The same decorator adapts to a method and receives the complete payload:\n",
+    "files": {
+      "docs/_decorators/post.md": {
+        "title": "@post",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
   {
     "search": "The current body is read from userBodyKey. By default, the POST is sent when\nthe component connects and after each body mutation. Mutations in the same\nframe are coalesced into one request.\n",
     "files": {
@@ -5955,7 +6055,7 @@
     }
   },
   {
-    "search": "send() is useful for “Save” or “Retry” buttons. It can repeat an operation\nwith side effects.\n",
+    "search": "send() returns a Promise<ApiResult<T> | undefined> that resolves after the\noperation completes. It is useful for “Save” or “Retry” buttons and can repeat\nan operation with side effects.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
@@ -5970,7 +6070,7 @@
     }
   },
   {
-    "search": "The send action can decorate a local method. It runs after the method by\ndefault and waits for an eventual Promise to resolve:\n",
+    "search": "The send action can decorate a local method. It runs after the method by\ndefault, waits for an eventual Promise to resolve, and the decorated method\ncall waits for the send to complete:\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
@@ -5985,7 +6085,7 @@
     }
   },
   {
-    "search": "Use { when: "before" } when the body must be sent before the method runs:\n",
+    "search": "Use { when: "before" } when the send must complete before the method runs:\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
@@ -6149,6 +6249,21 @@
       }
     }
   },
+  {
+    "search": "send(component) returns a Promise resolved after the PUT completes. See\n@post for the method-decorator form and the\nwhen: "before" option.\n",
+    "files": {
+      "docs/_decorators/put.md": {
+        "title": "@put",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      }
+    }
+  },
   {
     "search": "The PUT is also sent automatically when the body mutates, unless\nautoPostOnBodyMutation: false is set. See\n@post for the option details:\n",
     "files": {

package/src/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./components.ts","./concorde-loaded.ts","./css.d.ts","./dataprovider.ts","./decorators.ts","./directives.ts","./index.ts","./mixins.ts","./utils.ts","./core/core.ts","./core/_types/endpoint.ts","./core/_types/key.ts","./core/_types/types.ts","./core/components/functional/functional.ts","./core/components/functional/date/date.ts","./core/components/functional/example/example.ts","./core/components/functional/fetch/fetch.ts","./core/components/functional/if/if.test.ts","./core/components/functional/if/if.ts","./core/components/functional/list/list.demo.ts","./core/components/functional/list/list.spec.ts","./core/components/functional/list/list.ts","./core/components/functional/mix/mix.ts","./core/components/functional/queue/queue.demo.ts","./core/components/functional/queue/queue.ts","./core/components/functional/router/redirect.ts","./core/components/functional/router/router.demo.ts","./core/components/functional/router/router.spec.ts","./core/components/functional/router/router.ts","./core/components/functional/sdui/SDUIDescriptorTransformer.ts","./core/components/functional/sdui/sdui-utils.ts","./core/components/functional/sdui/sdui.ts","./core/components/functional/sdui/types.ts","./core/components/functional/sonic-scope/sonic-scope.ts","./core/components/functional/states/states.demo.ts","./core/components/functional/states/states.spec.ts","./core/components/functional/states/states.ts","./core/components/functional/submit/submit.ts","./core/components/functional/subscriber/subscriber.ts","./core/components/functional/translation/translation.ts","./core/components/functional/value/value.ts","./core/components/ui/ui.ts","./core/components/ui/_css/scroll.ts","./core/components/ui/_css/shadow.ts","./core/components/ui/_css/size.ts","./core/components/ui/_css/type.ts","./core/components/ui/alert/alert.ts","./core/components/ui/alert-messages/alert-messages.ts","./core/components/ui/badge/badge.ts","./core/components/ui/button/button.ts","./core/components/ui/captcha/altchaStyles.ts","./core/components/ui/captcha/captcha.ts","./core/components/ui/card/card-footer.ts","./core/components/ui/card/card-header-descripton.ts","./core/components/ui/card/card-header.ts","./core/components/ui/card/card-main.ts","./core/components/ui/card/card.ts","./core/components/ui/divider/divider.ts","./core/components/ui/form/checkbox/checkbox.ts","./core/components/ui/form/css/form-control.ts","./core/components/ui/form/fieldset/fieldset.ts","./core/components/ui/form/fieldset/legend-description.ts","./core/components/ui/form/fieldset/legend.ts","./core/components/ui/form/form-actions/form-actions.ts","./core/components/ui/form/form-layout/form-layout.ts","./core/components/ui/form/input/input.ts","./core/components/ui/form/input/password-helper.ts","./core/components/ui/form/input/same-value-helper.ts","./core/components/ui/form/input-autocomplete/input-autocomplete.ts","./core/components/ui/form/radio/radio.ts","./core/components/ui/form/select/select.ts","./core/components/ui/form/switch/switch.ts","./core/components/ui/form/textarea/textarea.ts","./core/components/ui/group/group.ts","./core/components/ui/icon/icon.stories.ts","./core/components/ui/icon/icon.ts","./core/components/ui/icon/icons.ts","./core/components/ui/image/image.ts","./core/components/ui/link/link.ts","./core/components/ui/loader/loader.stories.ts","./core/components/ui/loader/loader.ts","./core/components/ui/loader/styles/fixed.ts","./core/components/ui/loader/styles/inline.ts","./core/components/ui/menu/menu-item.ts","./core/components/ui/menu/menu.ts","./core/components/ui/modal/modal-actions.ts","./core/components/ui/modal/modal-close.ts","./core/components/ui/modal/modal-content.ts","./core/components/ui/modal/modal-subtitle.ts","./core/components/ui/modal/modal-title.ts","./core/components/ui/modal/modal-utils.ts","./core/components/ui/modal/modal.ts","./core/components/ui/pop/pop.ts","./core/components/ui/progress/progress.ts","./core/components/ui/table/table-caption.ts","./core/components/ui/table/table-tbody.ts","./core/components/ui/table/table-td.ts","./core/components/ui/table/table-tfoot.ts","./core/components/ui/table/table-th.ts","./core/components/ui/table/table-thead.ts","./core/components/ui/table/table-tr.ts","./core/components/ui/table/table.ts","./core/components/ui/theme/theme.ts","./core/components/ui/theme/theme-collection/core-variables.ts","./core/components/ui/theme/theme-collection/dark.ts","./core/components/ui/theme/theme-collection/light.ts","./core/components/ui/toast/message-subscriber.ts","./core/components/ui/toast/toast-item.ts","./core/components/ui/toast/toast.ts","./core/components/ui/toast/types.ts","./core/components/ui/tooltip/tooltip.ts","./core/decorators/Subscriber.ts","./core/decorators/api.post.spec.ts","./core/decorators/api.spec.ts","./core/decorators/api.ts","./core/decorators/lifecycle.ts","./core/decorators/subscriber/ancestorAttribute.spec.ts","./core/decorators/subscriber/ancestorAttribute.ts","./core/decorators/subscriber/autoFill.ts","./core/decorators/subscriber/autoSubscribe.ts","./core/decorators/subscriber/bind.ts","./core/decorators/subscriber/common.ts","./core/decorators/subscriber/dynamicPath.spec.ts","./core/decorators/subscriber/dynamicPath.ts","./core/decorators/subscriber/dynamicPropertyWatch.spec.ts","./core/decorators/subscriber/dynamicPropertyWatch.ts","./core/decorators/subscriber/handle.disambig.spec.ts","./core/decorators/subscriber/handle.skip.spec.ts","./core/decorators/subscriber/handle.ts","./core/decorators/subscriber/onAssign.ts","./core/decorators/subscriber/publish.spec.ts","./core/decorators/subscriber/publish.ts","./core/decorators/subscriber/publisherPath.ts","./core/decorators/subscriber/subscribe.spec.ts","./core/decorators/subscriber/subscribe.ts","./core/directives/DataProvider.sub.spec.ts","./core/directives/DataProvider.ts","./core/directives/Wording.ts","./core/mixins/Fetcher.ts","./core/mixins/FormCheckable.ts","./core/mixins/FormElement.ts","./core/mixins/FormInput.ts","./core/mixins/Subscriber.ts","./core/mixins/TemplatesContainer.ts","./core/mixins/mixins.ts","./core/utils/AncestorAttributeObserver.ts","./core/utils/Arrays.ts","./core/utils/DataBindObserver.ts","./core/utils/Electron.ts","./core/utils/Format.ts","./core/utils/HTML.ts","./core/utils/LocationHandler.ts","./core/utils/Objects.ts","./core/utils/PublisherProxy.ts","./core/utils/SafariScrollGuard.ts","./core/utils/Utils.ts","./core/utils/aesCrypto.ts","./core/utils/api.ts","./core/utils/dataProviderKey.spec.ts","./core/utils/dataProviderKey.ts","./core/utils/dpOptions.spec.ts","./core/utils/endpoint.spec.ts","./core/utils/endpoint.ts","./core/utils/publisherPathKey.spec.ts","./core/utils/route.spec.ts","./core/utils/route.ts","./core/utils/url-pattern.ts","./test-utils/TestUtils.ts"],"version":"5.9.2"}
+{"root":["./components.ts","./concorde-loaded.ts","./css.d.ts","./dataprovider.ts","./decorators.ts","./directives.ts","./index.ts","./mixins.ts","./utils.ts","./core/core.ts","./core/_types/endpoint.ts","./core/_types/key.ts","./core/_types/types.ts","./core/components/functional/functional.ts","./core/components/functional/date/date.ts","./core/components/functional/example/example.ts","./core/components/functional/fetch/fetch.ts","./core/components/functional/if/if.test.ts","./core/components/functional/if/if.ts","./core/components/functional/list/list.demo.ts","./core/components/functional/list/list.spec.ts","./core/components/functional/list/list.ts","./core/components/functional/mix/mix.ts","./core/components/functional/queue/queue.demo.ts","./core/components/functional/queue/queue.ts","./core/components/functional/router/redirect.ts","./core/components/functional/router/router.demo.ts","./core/components/functional/router/router.spec.ts","./core/components/functional/router/router.ts","./core/components/functional/sdui/SDUIDescriptorTransformer.ts","./core/components/functional/sdui/sdui-utils.ts","./core/components/functional/sdui/sdui.ts","./core/components/functional/sdui/types.ts","./core/components/functional/sonic-scope/sonic-scope.ts","./core/components/functional/states/states.demo.ts","./core/components/functional/states/states.spec.ts","./core/components/functional/states/states.ts","./core/components/functional/submit/submit.ts","./core/components/functional/subscriber/subscriber.ts","./core/components/functional/translation/translation.ts","./core/components/functional/value/value.ts","./core/components/ui/ui.ts","./core/components/ui/_css/scroll.ts","./core/components/ui/_css/shadow.ts","./core/components/ui/_css/size.ts","./core/components/ui/_css/type.ts","./core/components/ui/alert/alert.ts","./core/components/ui/alert-messages/alert-messages.ts","./core/components/ui/badge/badge.ts","./core/components/ui/button/button.ts","./core/components/ui/captcha/altchaStyles.ts","./core/components/ui/captcha/captcha.ts","./core/components/ui/card/card-footer.ts","./core/components/ui/card/card-header-descripton.ts","./core/components/ui/card/card-header.ts","./core/components/ui/card/card-main.ts","./core/components/ui/card/card.ts","./core/components/ui/divider/divider.ts","./core/components/ui/form/checkbox/checkbox.ts","./core/components/ui/form/css/form-control.ts","./core/components/ui/form/fieldset/fieldset.ts","./core/components/ui/form/fieldset/legend-description.ts","./core/components/ui/form/fieldset/legend.ts","./core/components/ui/form/form-actions/form-actions.ts","./core/components/ui/form/form-layout/form-layout.ts","./core/components/ui/form/input/input.ts","./core/components/ui/form/input/password-helper.ts","./core/components/ui/form/input/same-value-helper.ts","./core/components/ui/form/input-autocomplete/input-autocomplete.ts","./core/components/ui/form/radio/radio.ts","./core/components/ui/form/select/select.ts","./core/components/ui/form/switch/switch.ts","./core/components/ui/form/textarea/textarea.ts","./core/components/ui/group/group.ts","./core/components/ui/icon/icon.stories.ts","./core/components/ui/icon/icon.ts","./core/components/ui/icon/icons.ts","./core/components/ui/image/image.ts","./core/components/ui/link/link.ts","./core/components/ui/loader/loader.stories.ts","./core/components/ui/loader/loader.ts","./core/components/ui/loader/styles/fixed.ts","./core/components/ui/loader/styles/inline.ts","./core/components/ui/menu/menu-item.ts","./core/components/ui/menu/menu.ts","./core/components/ui/modal/modal-actions.ts","./core/components/ui/modal/modal-close.ts","./core/components/ui/modal/modal-content.ts","./core/components/ui/modal/modal-subtitle.ts","./core/components/ui/modal/modal-title.ts","./core/components/ui/modal/modal-utils.ts","./core/components/ui/modal/modal.ts","./core/components/ui/pop/pop.ts","./core/components/ui/progress/progress.ts","./core/components/ui/table/table-caption.ts","./core/components/ui/table/table-tbody.ts","./core/components/ui/table/table-td.ts","./core/components/ui/table/table-tfoot.ts","./core/components/ui/table/table-th.ts","./core/components/ui/table/table-thead.ts","./core/components/ui/table/table-tr.ts","./core/components/ui/table/table.ts","./core/components/ui/theme/theme.ts","./core/components/ui/theme/theme-collection/core-variables.ts","./core/components/ui/theme/theme-collection/dark.ts","./core/components/ui/theme/theme-collection/light.ts","./core/components/ui/toast/message-subscriber.ts","./core/components/ui/toast/toast-item.ts","./core/components/ui/toast/toast.ts","./core/components/ui/toast/types.ts","./core/components/ui/tooltip/tooltip.ts","./core/decorators/Subscriber.ts","./core/decorators/api.post.spec.ts","./core/decorators/api.spec.ts","./core/decorators/api.ts","./core/decorators/lifecycle.ts","./core/decorators/subscriber/ancestorAttribute.spec.ts","./core/decorators/subscriber/ancestorAttribute.ts","./core/decorators/subscriber/autoFill.ts","./core/decorators/subscriber/autoSubscribe.ts","./core/decorators/subscriber/bind.ts","./core/decorators/subscriber/common.ts","./core/decorators/subscriber/dynamicPath.spec.ts","./core/decorators/subscriber/dynamicPath.ts","./core/decorators/subscriber/dynamicPropertyWatch.spec.ts","./core/decorators/subscriber/dynamicPropertyWatch.ts","./core/decorators/subscriber/handle.disambig.spec.ts","./core/decorators/subscriber/handle.skip.spec.ts","./core/decorators/subscriber/handle.ts","./core/decorators/subscriber/onAssign.ts","./core/decorators/subscriber/publish.spec.ts","./core/decorators/subscriber/publish.ts","./core/decorators/subscriber/publisherPath.ts","./core/decorators/subscriber/subscribe.spec.ts","./core/decorators/subscriber/subscribe.ts","./core/directives/DataProvider.sub.spec.ts","./core/directives/DataProvider.ts","./core/directives/Wording.ts","./core/mixins/Fetcher.ts","./core/mixins/FormCheckable.ts","./core/mixins/FormElement.ts","./core/mixins/FormInput.ts","./core/mixins/Subscriber.ts","./core/mixins/TemplatesContainer.ts","./core/mixins/mixins.ts","./core/utils/AncestorAttributeObserver.ts","./core/utils/Arrays.ts","./core/utils/DataBindObserver.ts","./core/utils/Electron.ts","./core/utils/Format.ts","./core/utils/HTML.ts","./core/utils/LocationHandler.ts","./core/utils/Objects.ts","./core/utils/PublisherProxy.ts","./core/utils/SafariScrollGuard.ts","./core/utils/Utils.ts","./core/utils/aesCrypto.ts","./core/utils/api.spec.ts","./core/utils/api.ts","./core/utils/dataProviderKey.spec.ts","./core/utils/dataProviderKey.ts","./core/utils/dpOptions.spec.ts","./core/utils/endpoint.spec.ts","./core/utils/endpoint.ts","./core/utils/publisherPathKey.spec.ts","./core/utils/route.spec.ts","./core/utils/route.ts","./core/utils/url-pattern.ts","./test-utils/TestUtils.ts"],"version":"5.9.2"}