@supersoniks/concorde 4.9.91 → 4.9.92

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

@@ -4700,7 +4700,7 @@
     }
   },
   {
-    "search": "Loads data through API.getDetailed. The decorated property is ApiResult<T> | null: request, response (or null for dataProvider(...) resolution without HTTP), and typed result.\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",
@@ -4715,14 +4715,14 @@
     }
   },
   {
-    "search": "Pass an Endpoint<T> as the first argument. Import get and ApiResult from @supersoniks/concorde/decorators, and Endpoint from @supersoniks/concorde/utils/endpoint.\n",
+    "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": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "get": {
+          "minimal-usage": {
             "count": 1,
-            "title": "",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -4730,14 +4730,14 @@
     }
   },
   {
-    "search": "${prop} on the endpoint or config key is resolved on the host. While a placeholder is null or undefined, no GET runs. Optional skipEmptyPlaceholder: true also blocks "" (empty string only). Details: Dynamic path placeholders.\n",
+    "search": "Keep the decorator in a constant to access refetch(component). Refetch only\ntargets the instance passed as the argument, even before it has received a\nresult.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "dynamic-path": {
+          "from-the-component": {
             "count": 1,
-            "title": "Dynamic path",
+            "title": "From the component",
             "type": "paragraph"
           }
         }
@@ -4745,14 +4745,14 @@
     }
   },
   {
-    "search": "The decorator returned by get(...) can be kept as a typed handle. Its refetch(component) action targets only the connected component instance and works even before the first ApiResult exists:\n",
+    "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",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "local-refetch-handle": {
+          "from-a-method-decorator": {
             "count": 1,
-            "title": "Local refetch handle",
+            "title": "From a method decorator",
             "type": "paragraph"
           }
         }
@@ -4760,14 +4760,14 @@
     }
   },
   {
-    "search": "The inline form remains unchanged:\n",
+    "search": "Use { when: "before" } when the GET must be scheduled before the method:\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "local-refetch-handle": {
+          "from-a-method-decorator": {
             "count": 1,
-            "title": "Local refetch handle",
+            "title": "From a method decorator",
             "type": "paragraph"
           }
         }
@@ -4775,14 +4775,14 @@
     }
   },
   {
-    "search": "For a refetch triggered from another component, keep using triggerKey and invalidate().\n",
+    "search": "The method decorator adds an explicit trigger; changes to dynamic endpoint\nproperties and configuration publishers keep their existing automatic behavior.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "local-refetch-handle": {
+          "from-a-method-decorator": {
             "count": 1,
-            "title": "Local refetch handle",
+            "title": "From a method decorator",
             "type": "paragraph"
           }
         }
@@ -4790,7 +4790,7 @@
     }
   },
   {
-    "search": "Pass as the second argument (scoped config) or third (with a configuration key). Same shape as send decorators where applicable:\n",
+    "search": "Options are the second argument, or the third argument when an API\nconfiguration key is provided.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
@@ -4805,59 +4805,14 @@
     }
   },
   {
-    "search": "Same pattern as @post: a publisher acts as a signal, independent of the response payload.\n",
-    "files": {
-      "docs/_decorators/get.md": {
-        "title": "@get",
-        "hashes": {
-          "manual-refetch-triggerkey": {
-            "count": 1,
-            "title": "Manual refetch (`triggerKey`)",
-            "type": "paragraph"
-          }
-        }
-      }
-    }
-  },
-  {
-    "search": "Prefer triggerKey over mutating the API configuration publisher when you only want to reload the same URL — no need to touch serviceURL, tokens, etc.\n",
+    "search": "With a configuration key, use:\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "manual-refetch-triggerkey": {
-            "count": 1,
-            "title": "Manual refetch (`triggerKey`)",
-            "type": "paragraph"
-          }
-        }
-      }
-    }
-  },
-  {
-    "search": "The docs mock adds an X-Fetched-At response header on /docs-mock-api/geo/communes so live demos can show when the last fetch happened (response.headers.get("X-Fetched-At")).\n",
-    "files": {
-      "docs/_decorators/get.md": {
-        "title": "@get",
-        "hashes": {
-          "manual-refetch-triggerkey": {
-            "count": 1,
-            "title": "Manual refetch (`triggerKey`)",
-            "type": "paragraph"
-          }
-        }
-      }
-    }
-  },
-  {
-    "search": "Same demo service as sonic-queue (/docs-mock-api/geo/). Publisher setup lives in decorators-demo-geo.ts and decorators-demo-subscribe-publish-get-demos.ts.\n",
-    "files": {
-      "docs/_decorators/get.md": {
-        "title": "@get",
-        "hashes": {
-          "minimal-example": {
+          "options-getoptions": {
             "count": 1,
-            "title": "Minimal example",
+            "title": "Options (`GetOptions`)",
             "type": "paragraph"
           }
         }
@@ -4865,29 +4820,24 @@
     }
   },
   {
-    "search": "@get with triggerKey — refresh button + X-Fetched-At timestamp in the UI:\n",
+    "search": "See Dynamic path placeholders for\ndynamic path details.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "live-demos": {
+          "when-the-get-runs-again": {
             "count": 1,
-            "title": "Live demos",
+            "title": "When the GET runs again",
             "type": "paragraph"
           }
         }
-      }
-    }
-  },
-  {
-    "search": "Dynamic config and endpoint path. Manual refetch is triggered from a separate component (same triggerKey publisher):\n",
-    "files": {
-      "docs/_decorators/get.md": {
-        "title": "@get",
+      },
+      "docs/_decorators/post.md": {
+        "title": "@post",
         "hashes": {
-          "live-demos": {
+          "options-postoptions": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Options (`PostOptions`)",
             "type": "paragraph"
           }
         }
@@ -4895,14 +4845,14 @@
     }
   },
   {
-    "search": "Scoped @get with @publish / @subscribe on the payload (see @publish and @subscribe) — wrap under an ancestor with serviceURL="/docs-mock-api/geo/":\n",
+    "search": "See @post,\n@put, and\n@patch for write operations.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "live-demos": {
+          "demos": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Demos",
             "type": "paragraph"
           }
         }
@@ -4910,14 +4860,14 @@
     }
   },
   {
-    "search": "Stale responses are ignored if the path or generation changed before the request finished.\n",
+    "search": "External invalidation is currently available through triggerKey; it is kept\nout of the main usage examples.\n",
     "files": {
       "docs/_decorators/get.md": {
         "title": "@get",
         "hashes": {
-          "live-demos": {
+          "advanced": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Advanced",
             "type": "paragraph"
           }
         }
@@ -4925,9 +4875,9 @@
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "live-demos": {
+          "advanced": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Advanced",
             "type": "paragraph"
           }
         }
@@ -5835,7 +5785,7 @@
     }
   },
   {
-    "search": "Sends data through API.patchDetailed. Same model as @post: decorated property is ApiResult<T> | null (request, response, result).\n",
+    "search": "@patch applies a partial update with the body from a publisher. It uses the\nsame model as @post:\nEndpoint<T>, DataProviderKey<B>, ApiResult<T>, options, and the\nsend(component) handle.\n",
     "files": {
       "docs/_decorators/patch.md": {
         "title": "@patch",
@@ -5850,14 +5800,24 @@
     }
   },
   {
-    "search": "Pass an Endpoint<T> and a DataProviderKey for the request body. Import patch and ApiResult from @supersoniks/concorde/decorators.\n",
+    "search": "To run the operation again from the component:\n",
     "files": {
       "docs/_decorators/patch.md": {
         "title": "@patch",
         "hashes": {
-          "patch": {
+          "minimal-usage": {
             "count": 1,
-            "title": "",
+            "title": "Minimal usage",
+            "type": "paragraph"
+          }
+        }
+      },
+      "docs/_decorators/put.md": {
+        "title": "@put",
+        "hashes": {
+          "minimal-usage": {
+            "count": 1,
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5865,24 +5825,14 @@
     }
   },
   {
-    "search": "Same as @post / @get: scoped HTML.getApiConfiguration(host) or DataProviderKey<APIConfiguration> as third argument.\n",
+    "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": {
       "docs/_decorators/patch.md": {
         "title": "@patch",
         "hashes": {
-          "configuration": {
+          "minimal-usage": {
             "count": 1,
-            "title": "Configuration",
-            "type": "paragraph"
-          }
-        }
-      },
-      "docs/_decorators/put.md": {
-        "title": "@put",
-        "hashes": {
-          "configuration": {
-            "count": 1,
-            "title": "Configuration",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5890,14 +5840,14 @@
     }
   },
   {
-    "search": "Same shape as PostOptions on @post (ApiSendOptions): refetchEveryMs, skipIfBodyMissing, autoPostOnBodyMutation, triggerKey, skipEmptyPlaceholder. See Dynamic path placeholders for ${sessionId} and empty-string behaviour.\n",
+    "search": "Pass explicit API configuration as the third argument:\n",
     "files": {
       "docs/_decorators/patch.md": {
         "title": "@patch",
         "hashes": {
-          "options-patchoptions": {
+          "minimal-usage": {
             "count": 1,
-            "title": "Options (`PatchOptions`)",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5905,9 +5855,9 @@
       "docs/_decorators/put.md": {
         "title": "@put",
         "hashes": {
-          "options-putoptions": {
+          "minimal-usage": {
             "count": 1,
-            "title": "Options (`PutOptions`)",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5915,22 +5865,22 @@
     }
   },
   {
-    "search": "@patch(\n  new Endpoint<Resource, { resourceId: string }>("resources/${resourceId}"),\n  patchBodyKey,\n  { skipEmptyPlaceholder: true },\n)\n@state()\npayload?: ApiResult<Resource> | null;\n  \n\n",
+    "search": "@post",
     "files": {
-      "docs/_decorators/patch.md": {
-        "title": "@patch",
+      "docs/_decorators/post.md": {
+        "title": "@post",
         "hashes": {
-          "example": {
+          "post": {
             "count": 1,
-            "title": "Example",
-            "type": "paragraph"
+            "title": "",
+            "type": "page"
           }
         }
       }
     }
   },
   {
-    "search": "@post",
+    "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",
@@ -5938,21 +5888,21 @@
           "post": {
             "count": 1,
             "title": "",
-            "type": "page"
+            "type": "paragraph"
           }
         }
       }
     }
   },
   {
-    "search": "Sends data through API.postDetailed. The decorated property is ApiResult<T> | null: request, response, and typed result.\n",
+    "search": "Pass an Endpoint<T> and a DataProviderKey<B> for the request body.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "post": {
+          "minimal-usage": {
             "count": 1,
-            "title": "",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5960,14 +5910,14 @@
     }
   },
   {
-    "search": "Pass an Endpoint<T> as the first argument and a DataProviderKey for the request body as the second. Import post and ApiResult from @supersoniks/concorde/decorators, and Endpoint from @supersoniks/concorde/utils/endpoint.\n",
+    "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": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "post": {
+          "minimal-usage": {
             "count": 1,
-            "title": "",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5975,14 +5925,14 @@
     }
   },
   {
-    "search": "Same as @get: scoped HTML.getApiConfiguration(host) by default, or DataProviderKey<APIConfiguration> as third argument. See API configuration for mock demos.\n",
+    "search": "API configuration is read from the HTML scope, as with\n@get.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "configuration": {
+          "minimal-usage": {
             "count": 1,
-            "title": "Configuration",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }
@@ -5990,14 +5940,14 @@
     }
   },
   {
-    "search": "The decorator returned by post(...) can be kept as a typed handle. Its send(component) action re-runs the POST with the current body publisher:\n",
+    "search": "Keep the decorator to access send(component). The body is read again when the\noperation runs.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "local-send-handle": {
+          "from-the-component": {
             "count": 1,
-            "title": "Local send handle",
+            "title": "From the component",
             "type": "paragraph"
           }
         }
@@ -6005,14 +5955,14 @@
     }
   },
   {
-    "search": "send() is an explicit write operation. It is intentionally distinct from GET invalidation because replaying a POST, PUT, or PATCH can have side effects.\n",
+    "search": "send() is useful for “Save” or “Retry” buttons. It can repeat an operation\nwith side effects.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "local-send-handle": {
+          "from-the-component": {
             "count": 1,
-            "title": "Local send handle",
+            "title": "From the component",
             "type": "paragraph"
           }
         }
@@ -6020,14 +5970,14 @@
     }
   },
   {
-    "search": "Mock service: POST /docs-mock-api/api/register (same route as sonic-submit demos). Publisher setup lives in decorators-demo-post.ts.\n",
+    "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",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "minimal-example": {
+          "from-a-method-decorator": {
             "count": 1,
-            "title": "Minimal example",
+            "title": "From a method decorator",
             "type": "paragraph"
           }
         }
@@ -6035,14 +5985,14 @@
     }
   },
   {
-    "search": "@post(\n  new Endpoint<SyncResponse, { sessionId: string }>("sessions/${sessionId}/sync"),\n  syncRequest,\n  { triggerKey: syncTrigger },\n)\n@state()\npayload?: ApiResult<SyncResponse> | null;\n  \n\n",
+    "search": "Use { when: "before" } when the body must be sent before the method runs:\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "minimal-example": {
+          "from-a-method-decorator": {
             "count": 1,
-            "title": "Minimal example",
+            "title": "From a method decorator",
             "type": "paragraph"
           }
         }
@@ -6050,14 +6000,14 @@
     }
   },
   {
-    "search": "Dynamic endpoint path — changing sessionId on the host re-runs the POST (POST /docs-mock-api/api/sessions/{id}/sync):\n",
+    "search": "The method decorator adds an explicit send. If the method also mutates the body\npublisher, set autoPostOnBodyMutation: false when the decorated method must\nbe the only trigger.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "live-demos": {
+          "from-a-method-decorator": {
             "count": 1,
-            "title": "Live demos",
+            "title": "From a method decorator",
             "type": "paragraph"
           }
         }
@@ -6065,14 +6015,14 @@
     }
   },
   {
-    "search": "@post + @publish on the same property (see @publish):\n",
+    "search": "Options are the third argument, or the fourth argument when a configuration key\nis provided.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "live-demos": {
+          "options-postoptions": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Options (`PostOptions`)",
             "type": "paragraph"
           }
         }
@@ -6080,14 +6030,14 @@
     }
   },
   {
-    "search": "Note: plusieurs composants @post sur la même page qui partagent le même bodyKey enverront chacun une requête à chaque mutation du body — utiliser une clé par composant (voir les deux démos live ci-dessus).\n",
+    "search": "With a configuration key:\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "live-demos": {
+          "options-postoptions": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Options (`PostOptions`)",
             "type": "paragraph"
           }
         }
@@ -6095,14 +6045,14 @@
     }
   },
   {
-    "search": "Path placeholders (${sessionId}, …): Dynamic path placeholders.\n",
+    "search": "See @put and\n@patch: they use the same model with a\ndifferent HTTP method.\n",
     "files": {
       "docs/_decorators/post.md": {
         "title": "@post",
         "hashes": {
-          "live-demos": {
+          "demos": {
             "count": 1,
-            "title": "Live demos",
+            "title": "Demos",
             "type": "paragraph"
           }
         }
@@ -6185,7 +6135,7 @@
     }
   },
   {
-    "search": "Sends data through API.putDetailed. Same model as @post: decorated property is ApiResult<T> | null (request, response, result).\n",
+    "search": "@put replaces a resource with the body from a publisher. It uses exactly the\nsame model as @post:\nEndpoint<T>, DataProviderKey<B>, ApiResult<T>, options, and the\nsend(component) handle.\n",
     "files": {
       "docs/_decorators/put.md": {
         "title": "@put",
@@ -6200,44 +6150,14 @@
     }
   },
   {
-    "search": "Pass an Endpoint<T> and a DataProviderKey for the request body. Import put and ApiResult from @supersoniks/concorde/decorators.\n",
+    "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": {
       "docs/_decorators/put.md": {
         "title": "@put",
         "hashes": {
-          "put": {
+          "minimal-usage": {
             "count": 1,
-            "title": "",
-            "type": "paragraph"
-          }
-        }
-      }
-    }
-  },
-  {
-    "search": "@put(new Endpoint<Resource, { resourceId: string }>("resources/${resourceId}"), bodyKey)\n@state()\npayload?: ApiResult<Resource> | null;\n  \n\n",
-    "files": {
-      "docs/_decorators/put.md": {
-        "title": "@put",
-        "hashes": {
-          "example": {
-            "count": 1,
-            "title": "Example",
-            "type": "paragraph"
-          }
-        }
-      }
-    }
-  },
-  {
-    "search": "Changing resourceId on the host re-runs the PUT when the path becomes ready — see Dynamic path placeholders.\n",
-    "files": {
-      "docs/_decorators/put.md": {
-        "title": "@put",
-        "hashes": {
-          "example": {
-            "count": 1,
-            "title": "Example",
+            "title": "Minimal usage",
             "type": "paragraph"
           }
         }