@supersoniks/concorde 4.9.93 → 4.9.94

package/docs/crawl/docs/_decorators/get.html

@@ -8,9 +8,7 @@
   <meta name="keywords" content="Concorde, supersoniks, docs/_decorators/get, get, @get, decorator, ApiResult, undefined, payload.result, payload.response, payload.request, 
 
 The first argument is always an
-[, serviceURL, refetch(component), 
-
-">
+[, serviceURL, refetch(component)">
   <meta name="concorde-doc-id" content="docs/_decorators/get">
   <link rel="canonical" href="https://concorde.supersoniks.org/crawl/docs/_decorators/get.html">
 </head>
@@ -23,9 +21,7 @@ The first argument is always an
       <p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @get</strong>. @get loads data and stores the result in an optional ApiResult&lt;T&gt; 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, 
 
 The first argument is always an
-[, 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>
+[, 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>
       <h1 id="get">@get</h1>
 <p><code>@get</code> loads data and stores the result in an optional <code>ApiResult&lt;T&gt;</code> property.
 The property is <code>undefined</code> until a result is available.</p>
@@ -41,6 +37,16 @@ The property is <code>undefined</code> until a result is available.</p>
 @state()
 payload?: ApiResult&lt;User[]&gt;;
 </code></pre>
+<p>The same decorator adapts to a method. The method receives the complete
+<code>ApiResult&lt;T&gt;</code> payload after each GET:</p>
+<pre><code class="language-typescript">@get(usersEndpoint)
+handleUsers(payload?: ApiResult&lt;User[]&gt;) {
+  if (!payload) return;
+
+  console.log(payload.response?.status);
+  console.log(payload.result);
+}
+</code></pre>
 <p>The first argument is always an
 <a href="../_misc/endpoint.html#endpoint"><code>Endpoint&lt;T&gt;</code></a>. API configuration is read
 from the HTML scope (<code>serviceURL</code>, token, etc.), so the component is usually
@@ -63,6 +69,19 @@ async refresh() {
 </code></pre>
 <p><code>refetch(component)</code> returns a <code>Promise&lt;ApiResult&lt;T&gt; | undefined&gt;</code> that resolves
 after the GET has completed.</p>
+<p>The named handle can also decorate a method and be reused for refetching:</p>
+<pre><code class="language-typescript">const usersGet = get(new Endpoint&lt;User[]&gt;(&quot;users&quot;));
+
+@usersGet
+handleUsers(payload?: ApiResult&lt;User[]&gt;) {
+  // ...
+}
+
+@refetch(usersGet)
+reloadUsers() {
+  // The GET runs and handleUsers receives its payload.
+}
+</code></pre>
 <h3 id="from-a-method-decorator">From a method decorator</h3>
 <p>The refetch can decorate a local method. The default is <code>after</code>; if the
 method returns a Promise, the GET waits for its resolution. The decorated method
@@ -112,6 +131,8 @@ import { Endpoint } from &quot;@supersoniks/concorde/utils/endpoint&quot;;
 <h2 id="demos">Demos</h2>
 <pre><code>&lt;docs-demo-sources for=&quot;demo-api-get&quot;&gt;&lt;/docs-demo-sources&gt;
     &lt;demo-api-get&gt;&lt;/demo-api-get&gt;
+    &lt;docs-demo-sources for=&quot;demo-api-get-method&quot;&gt;&lt;/docs-demo-sources&gt;
+    &lt;demo-api-get-method&gt;&lt;/demo-api-get-method&gt;
     &lt;docs-demo-sources for=&quot;demo-api-get-configuration-key&quot;&gt;&lt;/docs-demo-sources&gt;
     &lt;demo-api-get-configuration-key&gt;&lt;/demo-api-get-configuration-key&gt;
 </code></pre>

package/docs/crawl/docs/_decorators/patch.html

@@ -33,6 +33,12 @@ const patchUser = patch(new Endpoint<User>("users/42"), bodyKey)
 @state()
 payload?: ApiResult<User>;
 </code></pre>
+<p>The same decorator adapts to a method:</p>
+<pre><code class="language-typescript">@patch(new Endpoint&lt;User&gt;(&quot;users/42&quot;), bodyKey)
+handlePatch(payload?: ApiResult&lt;User&gt;) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+</code></pre>
 <p>To run the operation again from the component:</p>
 <pre><code class="language-typescript">async savePatch() {
   await patchUser.send(this);

package/docs/crawl/docs/_decorators/post.html

@@ -41,6 +41,12 @@ const createUser = post(new Endpoint<User>("users"), userBodyKey
 @state()
 payload?: ApiResult<User>;
 </code></pre>
+<p>The same decorator adapts to a method and receives the complete payload:</p>
+<pre><code class="language-typescript">@post(new Endpoint&lt;User&gt;(&quot;users&quot;), userBodyKey)
+handleCreate(payload?: ApiResult&lt;User&gt;) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+</code></pre>
 <p>The current body is read from <code>userBodyKey</code>. By default, the POST is sent when
 the component connects and after each body mutation. Mutations in the same
 frame are coalesced into one request.</p>
@@ -115,6 +121,8 @@ import { Endpoint } from &quot;@supersoniks/concorde/utils/endpoint&quot;;
 <h2 id="demos">Demos</h2>
 <pre><code>&lt;docs-demo-sources for=&quot;demo-api-post&quot;&gt;&lt;/docs-demo-sources&gt;
     &lt;demo-api-post&gt;&lt;/demo-api-post&gt;
+    &lt;docs-demo-sources for=&quot;demo-api-post-method&quot;&gt;&lt;/docs-demo-sources&gt;
+    &lt;demo-api-post-method&gt;&lt;/demo-api-post-method&gt;
     &lt;docs-demo-sources for=&quot;demo-api-post-dynamic&quot;&gt;&lt;/docs-demo-sources&gt;
     &lt;demo-api-post-dynamic&gt;&lt;/demo-api-post-dynamic&gt;
 </code></pre>

package/docs/crawl/docs/_decorators/put.html

@@ -33,6 +33,12 @@ const updateUser = put(new Endpoint<User>("users/42"), bodyKey);
 @state()
 payload?: ApiResult<User>;
 </code></pre>
+<p>The same decorator adapts to a method:</p>
+<pre><code class="language-typescript">@put(new Endpoint&lt;User&gt;(&quot;users/42&quot;), bodyKey)
+handleUpdate(payload?: ApiResult&lt;User&gt;) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+</code></pre>
 <p>To run the operation again from the component:</p>
 <pre><code class="language-typescript">async update() {
   await updateUser.send(this);

package/docs/crawl/hubs/decorators.html

@@ -167,6 +167,17 @@ const usersEndpoint = new Endpoint ("users");
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method. The method receives the complete
+ApiResult  payload after each GET:
+
+@get(usersEndpoint)
+handleUsers(payload?: ApiResult ) {
+  if (!payload) return;
+
+  console.log(payload.response?.status);
+  console.log(payload.result);
+}
+
 The first argument is always an
 Endpoint . API configuration is read
 from the HTML scope (serviceURL, token, etc.), so the component is usually
@@ -188,16 +199,7 @@ payload?: ApiResult ;
 
 async refresh() {
   const payload = await usersGet.refetch(this);
-  console.log(payload?.result);
-}
-
-refetch(component) returns a Promise  | undefined> that resolves
-after the GET has completed.
-
-From a method decorator
-
-The refetch can decorate a local method. The default is after; if the
-method returns a Promise, the GET waits for its resol</pre>
+  console.log(</pre>
 </section>
 <section id="docs-_decorators-handle" data-doc-id="docs/_decorators/handle">
   <h2><a href="../docs/_decorators/handle.html">@handle</a></h2>
@@ -294,6 +296,13 @@ const patchUser = patch(new Endpoint (&quot;users/42&quot;), bodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method:
+
+@patch(new Endpoint (&quot;users/42&quot;), bodyKey)
+handlePatch(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 To run the operation again from the component:
 
 async savePatch() {
@@ -320,13 +329,7 @@ Pass explicit API configuration as the third argument:
 
 Import
 
-import { patch, type ApiResult } from &quot;@supersoniks/concorde/decorators&quot;;
-import { DataProviderKey } from &quot;@supersoniks/concorde/dataProviderKey&quot;;
-import { Endpoint } from &quot;@supersoniks/concorde/utils/endpoint&quot;;
-
-See also
-
-- @post —</pre>
+import { patch, type ApiResult } from &quot;@supersoniks/</pre>
 </section>
 <section id="docs-_decorators-post" data-doc-id="docs/_decorators/post">
   <h2><a href="../docs/_decorators/post.html">@post</a></h2>
@@ -349,6 +352,13 @@ const createUser = post(new Endpoint (&quot;users&quot;), userBodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method and receives the complete payload:
+
+@post(new Endpoint (&quot;users&quot;), userBodyKey)
+handleCreate(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 The current body is read from userBodyKey. By default, the POST is sent when
 the component connects and after each body mutation. Mutations in the same
 frame are coalesced into one request.
@@ -369,13 +379,7 @@ async saveAgain() {
 }
 
 send() returns a Promise  | undefined&gt; that resolves after the
-operation completes. It is useful for “Save” or “Retry” buttons and can repeat
-an operation with side effects.
-
-From a method decorator
-
-The send action can decorate a local method. It runs after the method by
-default, waits for an eventu</pre>
+operation completes. It</pre>
 </section>
 <section id="docs-_decorators-publish" data-doc-id="docs/_decorators/publish">
   <h2><a href="../docs/_decorators/publish.html">@publish</a></h2>
@@ -440,6 +444,13 @@ const updateUser = put(new Endpoint (&quot;users/42&quot;), bodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method:
+
+@put(new Endpoint (&quot;users/42&quot;), bodyKey)
+handleUpdate(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 To run the operation again from the component:
 
 async update() {
@@ -467,13 +478,7 @@ Pass explicit API configuration as the third argument:
 Import
 
 import { put, type ApiResult } from &quot;@supersoniks/concorde/decorators&quot;;
-import { DataProviderKey } from &quot;@supersoniks/concorde/dataProviderKey&quot;;
-import { Endpoint } from &quot;@supersoniks/concorde/utils/endpoint&quot;;
-
-See also
-
-- @post — options and triggers
-- @</pre>
+impo</pre>
 </section>
 <section id="docs-_decorators-subscribe" data-doc-id="docs/_decorators/subscribe">
   <h2><a href="../docs/_decorators/subscribe.html">@subscribe</a></h2>

package/docs/crawl/hubs/remote-data.html

@@ -171,6 +171,17 @@ const usersEndpoint = new Endpoint ("users");
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method. The method receives the complete
+ApiResult  payload after each GET:
+
+@get(usersEndpoint)
+handleUsers(payload?: ApiResult ) {
+  if (!payload) return;
+
+  console.log(payload.response?.status);
+  console.log(payload.result);
+}
+
 The first argument is always an
 Endpoint . API configuration is read
 from the HTML scope (serviceURL, token, etc.), so the component is usually
@@ -192,16 +203,7 @@ payload?: ApiResult ;
 
 async refresh() {
   const payload = await usersGet.refetch(this);
-  console.log(payload?.result);
-}
-
-refetch(component) returns a Promise  | undefined> that resolves
-after the GET has completed.
-
-From a method decorator
-
-The refetch can decorate a local method. The default is after; if the
-method returns a Promise, the GET waits for its resol</pre>
+  console.log(</pre>
 </section>
 <section id="docs-_decorators-patch" data-doc-id="docs/_decorators/patch">
   <h2><a href="../docs/_decorators/patch.html">@patch</a></h2>
@@ -223,6 +225,13 @@ const patchUser = patch(new Endpoint (&quot;users/42&quot;), bodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method:
+
+@patch(new Endpoint (&quot;users/42&quot;), bodyKey)
+handlePatch(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 To run the operation again from the component:
 
 async savePatch() {
@@ -249,13 +258,7 @@ Pass explicit API configuration as the third argument:
 
 Import
 
-import { patch, type ApiResult } from &quot;@supersoniks/concorde/decorators&quot;;
-import { DataProviderKey } from &quot;@supersoniks/concorde/dataProviderKey&quot;;
-import { Endpoint } from &quot;@supersoniks/concorde/utils/endpoint&quot;;
-
-See also
-
-- @post —</pre>
+import { patch, type ApiResult } from &quot;@supersoniks/</pre>
 </section>
 <section id="docs-_decorators-post" data-doc-id="docs/_decorators/post">
   <h2><a href="../docs/_decorators/post.html">@post</a></h2>
@@ -278,6 +281,13 @@ const createUser = post(new Endpoint (&quot;users&quot;), userBodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method and receives the complete payload:
+
+@post(new Endpoint (&quot;users&quot;), userBodyKey)
+handleCreate(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 The current body is read from userBodyKey. By default, the POST is sent when
 the component connects and after each body mutation. Mutations in the same
 frame are coalesced into one request.
@@ -298,13 +308,7 @@ async saveAgain() {
 }
 
 send() returns a Promise  | undefined&gt; that resolves after the
-operation completes. It is useful for “Save” or “Retry” buttons and can repeat
-an operation with side effects.
-
-From a method decorator
-
-The send action can decorate a local method. It runs after the method by
-default, waits for an eventu</pre>
+operation completes. It</pre>
 </section>
 <section id="docs-_decorators-put" data-doc-id="docs/_decorators/put">
   <h2><a href="../docs/_decorators/put.html">@put</a></h2>
@@ -326,6 +330,13 @@ const updateUser = put(new Endpoint (&quot;users/42&quot;), bodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method:
+
+@put(new Endpoint (&quot;users/42&quot;), bodyKey)
+handleUpdate(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 To run the operation again from the component:
 
 async update() {
@@ -353,13 +364,7 @@ Pass explicit API configuration as the third argument:
 Import
 
 import { put, type ApiResult } from &quot;@supersoniks/concorde/decorators&quot;;
-import { DataProviderKey } from &quot;@supersoniks/concorde/dataProviderKey&quot;;
-import { Endpoint } from &quot;@supersoniks/concorde/utils/endpoint&quot;;
-
-See also
-
-- @post — options and triggers
-- @</pre>
+impo</pre>
 </section>
 <section id="docs-_misc-api-configuration" data-doc-id="docs/_misc/api-configuration">
   <h2><a href="../docs/_misc/api-configuration.html">API configuration</a></h2>

package/docs/index.html

@@ -10,7 +10,7 @@
     <!-- <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
      -->
     <script src="https://cdn.jsdelivr.net/npm/marked@13.0.3"></script>
-    <script type="module" crossorigin src="./assets/index-DURr6O71.js"></script>
+    <script type="module" crossorigin src="./assets/index-DpIkksht.js"></script>
     <link rel="stylesheet" crossorigin href="./assets/index-D2Q3JyQ6.css">
   </head>
   <body class="px-6 lg:px-20">

package/docs/llms-full.txt

@@ -3137,9 +3137,7 @@ Shared data: Sharing data.
 - Keywords: Concorde, supersoniks, docs/_decorators/get, get, @get, decorator, ApiResult, undefined, payload.result, payload.response, payload.request, 
 
 The first argument is always an
-[, serviceURL, refetch(component), 
-
-
+[, serviceURL, refetch(component)
 
 @get
 
@@ -3158,6 +3156,17 @@ const usersEndpoint = new Endpoint ("users");
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method. The method receives the complete
+ApiResult  payload after each GET:
+
+@get(usersEndpoint)
+handleUsers(payload?: ApiResult ) {
+  if (!payload) return;
+
+  console.log(payload.response?.status);
+  console.log(payload.result);
+}
+
 The first argument is always an
 Endpoint . API configuration is read
 from the HTML scope (serviceURL, token, etc.), so the component is usually
@@ -3185,6 +3194,20 @@ async refresh() {
 refetch(component) returns a Promise  | undefined> that resolves
 after the GET has completed.
 
+The named handle can also decorate a method and be reused for refetching:
+
+const usersGet = get(new Endpoint ("users"));
+
+@usersGet
+handleUsers(payload?: ApiResult ) {
+  // ...
+}
+
+@refetch(usersGet)
+reloadUsers() {
+  // The GET runs and handleUsers receives its payload.
+}
+
 From a method decorator
 
 The refetch can decorate a local method. The default is after; if the
@@ -3775,6 +3798,13 @@ const patchUser = patch(new Endpoint ("users/42"), bodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method:
+
+@patch(new Endpoint ("users/42"), bodyKey)
+handlePatch(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 To run the operation again from the component:
 
 async savePatch() {
@@ -3842,6 +3872,13 @@ const createUser = post(new Endpoint ("users"), userBodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method and receives the complete payload:
+
+@post(new Endpoint ("users"), userBodyKey)
+handleCreate(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 The current body is read from userBodyKey. By default, the POST is sent when
 the component connects and after each body mutation. Mutations in the same
 frame are coalesced into one request.
@@ -4011,6 +4048,13 @@ const updateUser = put(new Endpoint ("users/42"), bodyKey);
 @state()
 payload?: ApiResult ;
 
+The same decorator adapts to a method:
+
+@put(new Endpoint ("users/42"), bodyKey)
+handleUpdate(payload?: ApiResult ) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+
 To run the operation again from the component:
 
 async update() {

package/docs/src/docs/_decorators/get.md

@@ -17,6 +17,19 @@ const usersEndpoint = new Endpoint<User[]>("users");
 payload?: ApiResult<User[]>;
 ```
 
+The same decorator adapts to a method. The method receives the complete
+`ApiResult<T>` payload after each GET:
+
+```typescript
+@get(usersEndpoint)
+handleUsers(payload?: ApiResult<User[]>) {
+  if (!payload) return;
+
+  console.log(payload.response?.status);
+  console.log(payload.result);
+}
+```
+
 The first argument is always an
 [`Endpoint<T>`](#docs/_misc/endpoint.md/endpoint). API configuration is read
 from the HTML scope (`serviceURL`, token, etc.), so the component is usually
@@ -46,6 +59,22 @@ async refresh() {
 `refetch(component)` returns a `Promise<ApiResult<T> | undefined>` that resolves
 after the GET has completed.
 
+The named handle can also decorate a method and be reused for refetching:
+
+```typescript
+const usersGet = get(new Endpoint<User[]>("users"));
+
+@usersGet
+handleUsers(payload?: ApiResult<User[]>) {
+  // ...
+}
+
+@refetch(usersGet)
+reloadUsers() {
+  // The GET runs and handleUsers receives its payload.
+}
+```
+
 ### From a method decorator
 
 The refetch can decorate a local method. The default is `after`; if the
@@ -116,6 +145,8 @@ import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
   <template>
     <docs-demo-sources for="demo-api-get"></docs-demo-sources>
     <demo-api-get></demo-api-get>
+    <docs-demo-sources for="demo-api-get-method"></docs-demo-sources>
+    <demo-api-get-method></demo-api-get-method>
     <docs-demo-sources for="demo-api-get-configuration-key"></docs-demo-sources>
     <demo-api-get-configuration-key></demo-api-get-configuration-key>
   </template>

package/docs/src/docs/_decorators/patch.md

@@ -16,6 +16,15 @@ const patchUser = patch(new Endpoint<User>("users/42"), bodyKey);
 payload?: ApiResult<User>;
 ```
 
+The same decorator adapts to a method:
+
+```typescript
+@patch(new Endpoint<User>("users/42"), bodyKey)
+handlePatch(payload?: ApiResult<User>) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+```
+
 To run the operation again from the component:
 
 ```typescript

package/docs/src/docs/_decorators/post.md

@@ -17,6 +17,15 @@ const createUser = post(new Endpoint<User>("users"), userBodyKey);
 payload?: ApiResult<User>;
 ```
 
+The same decorator adapts to a method and receives the complete payload:
+
+```typescript
+@post(new Endpoint<User>("users"), userBodyKey)
+handleCreate(payload?: ApiResult<User>) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+```
+
 The current body is read from `userBodyKey`. By default, the POST is sent when
 the component connects and after each body mutation. Mutations in the same
 frame are coalesced into one request.
@@ -120,6 +129,8 @@ import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
   <template>
     <docs-demo-sources for="demo-api-post"></docs-demo-sources>
     <demo-api-post></demo-api-post>
+    <docs-demo-sources for="demo-api-post-method"></docs-demo-sources>
+    <demo-api-post-method></demo-api-post-method>
     <docs-demo-sources for="demo-api-post-dynamic"></docs-demo-sources>
     <demo-api-post-dynamic></demo-api-post-dynamic>
   </template>

package/docs/src/docs/_decorators/put.md

@@ -16,6 +16,15 @@ const updateUser = put(new Endpoint<User>("users/42"), bodyKey);
 payload?: ApiResult<User>;
 ```
 
+The same decorator adapts to a method:
+
+```typescript
+@put(new Endpoint<User>("users/42"), bodyKey)
+handleUpdate(payload?: ApiResult<User>) {
+  if (payload?.response?.ok) console.log(payload.result);
+}
+```
+
 To run the operation again from the component:
 
 ```typescript