@supersoniks/concorde 5.1.1 → 5.1.3-immutable.1

package/src/docs/decorators/bind.md

@@ -0,0 +1,76 @@
+# @bind
+
+`@bind(key)` keeps a class property and one path of the DataProvider store in sync. With `{ reflect: true }` the sync goes both ways: the property follows the store, and each assignment is written back to it. For one direction only, use the complementary decorators: [@subscribe](/docs/decorators/subscribe) to read, [@publish](/docs/decorators/publish) to write. See [Data flow](/docs/getting-started/dataFlow) for the overall model.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { bind } from "@supersoniks/concorde/decorators";
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+
+type Flight = { flight: string; gate: string; boarded: number };
+const flightKey = new DataProviderKey&lt;Flight&gt;("flight");
+
+@bind(flightKey.boarded, { reflect: true })
+@state()
+boarded = 0;
+  </template>
+</sonic-code>
+
+## Basic usage
+
+The key is a [DataProviderKey](/docs/misc/dataProviderKey): TypeScript checks that the property type matches `T` at that path. The property updates each time the store value changes. Add `@state()` so Lit re-renders.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-bind"></docs-demo-sources>
+    <demo-bind></demo-bind>
+  </template>
+</sonic-code>
+
+## Reflect
+
+With `reflect: true`, each assignment to the property calls `set()` at the key path, so every other subscriber sees the new value. An internal guard prevents update loops. Without `reflect` (the default), assigning the property does not touch the store, and `@bind` behaves like `@subscribe`.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-bind-reflect"></docs-demo-sources>
+    <demo-bind-reflect></demo-bind-reflect>
+  </template>
+</sonic-code>
+
+## Dynamic path
+
+Placeholders such as `${index}` are resolved from properties of the same component, and `@bind` re-subscribes when they change. Declare them in the key's second generic and write them in a plain string, not a backtick template literal. While a placeholder is `null` or `undefined` the binding is inactive; `{ skipEmptyPlaceholder: true }` also waits on `""`. Full rules: [Dynamic paths](/docs/misc/dynamic-path).
+
+<sonic-code language="typescript">
+  <template>
+const personKey = new DataProviderKey&lt;Person, { dataProvider: string; index: number }&gt;(
+  "${dataProvider}.${index}",
+);
+
+@bind(personKey)
+@state()
+person: Person | null = null;
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-bind-dynamic"></docs-demo-sources>
+    <demo-bind-dynamic></demo-bind-dynamic>
+  </template>
+</sonic-code>
+
+## Lifecycle
+
+The decorator subscribes in `connectedCallback` and unsubscribes in `disconnectedCallback`. It works on any element with that lifecycle (`LitElement`, the `Subscriber` mixin).
+
+## API reference
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `key` | `DataProviderKey<T>` | Store path to bind. Supports `${prop}` placeholders |
+| `options.reflect` | `boolean` (default `false`) | Write local assignments back to the store |
+| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |

package/src/docs/decorators/get.md

@@ -0,0 +1,160 @@
+# @get
+
+`@get(endpoint)` runs an HTTP GET on an [Endpoint](/docs/misc/endpoint) and stores the full `ApiResult<T>` in a property, or passes it to a method. It runs again when the endpoint's placeholders or the API configuration change, and on demand through `refetch`. For writes, see [@post](/docs/decorators/post), [@put](/docs/decorators/put) and [@patch](/docs/decorators/patch).
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { get, Endpoint, type ApiResult } from "@supersoniks/concorde/decorators";
+
+type FlightBoard = { flights: Flight[] };
+const departuresEndpoint = new Endpoint&lt;FlightBoard&gt;("flights?direction=departures");
+
+@get(departuresEndpoint)
+@state()
+departures?: ApiResult&lt;FlightBoard&gt;;
+  </template>
+</sonic-code>
+
+## Property
+
+The property is `undefined` until the first response, then holds `result` (typed `T`), `response` (the HTTP response) and `request`. It is reset to `undefined` when the component disconnects.
+
+Without a configuration key, `serviceURL` and the token are read from the HTML scope: place the component under an element that sets them (see [API configuration](/docs/misc/api-configuration)). The GET waits until `serviceURL` is available.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-api-get"></docs-demo-sources>
+    <demo-api-get></demo-api-get>
+  </template>
+</sonic-code>
+
+## Method
+
+Decorate a method to receive the `ApiResult<T>` after each GET instead of storing it.
+
+<sonic-code language="typescript">
+  <template>
+@get(departuresEndpoint)
+onDepartures(payload?: ApiResult&lt;FlightBoard&gt;) {
+  this.boarding = payload?.result?.flights.filter((f) =&gt; f.status === "boarding") ?? [];
+}
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-api-get-method"></docs-demo-sources>
+    <demo-api-get-method></demo-api-get-method>
+  </template>
+</sonic-code>
+
+## Configuration key
+
+Pass a `DataProviderKey<APIConfiguration>` as the second argument to read the configuration from the store instead of the HTML scope. Any change to that publisher runs the GET again.
+
+<sonic-code language="typescript">
+  <template>
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+import type { APIConfiguration } from "@supersoniks/concorde/utils/api";
+
+const flightsApi = new DataProviderKey&lt;APIConfiguration&gt;("flightsApi");
+
+@get(departuresEndpoint, flightsApi)
+@state()
+departures?: ApiResult&lt;FlightBoard&gt;;
+  </template>
+</sonic-code>
+
+## Dynamic endpoint
+
+`${prop}` placeholders in the endpoint resolve from properties of the same component; each change runs a new GET. While a placeholder is `null` or `undefined`, no request is sent and the property is `undefined`. Rules: [Dynamic paths](/docs/misc/dynamic-path).
+
+<sonic-code language="typescript">
+  <template>
+const boardEndpoint = new Endpoint&lt;FlightBoard, { direction: string }&gt;(
+  "flights?direction=${direction}",
+);
+
+@property() direction = "departures";
+
+@get(boardEndpoint, flightsApi)
+@state()
+board?: ApiResult&lt;FlightBoard&gt;;
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-api-get-configuration-key"></docs-demo-sources>
+    <demo-api-get-configuration-key></demo-api-get-configuration-key>
+  </template>
+</sonic-code>
+
+## Refetch
+
+Keep the decorator in a constant to reuse it. `refetch(component)` runs the GET for that instance only and resolves with the new `ApiResult<T>` (or `undefined`).
+
+<sonic-code language="typescript">
+  <template>
+const departuresGet = get(departuresEndpoint);
+
+@departuresGet
+@state()
+departures?: ApiResult&lt;FlightBoard&gt;;
+
+async refresh() {
+  await departuresGet.refetch(this);
+}
+  </template>
+</sonic-code>
+
+`@refetch(handle)` does the same around a method. By default the GET runs **after** the method (and after its Promise, if it returns one); use `{ when: "before" }` to run it first. The method call resolves once the GET is done.
+
+<sonic-code language="typescript">
+  <template>
+import { refetch } from "@supersoniks/concorde/decorators";
+
+@refetch(departuresGet)
+async showArrivals() {
+  this.direction = "arrivals";
+}
+  </template>
+</sonic-code>
+
+## Polling and triggers
+
+`refetchEveryMs` runs the GET again that many milliseconds after each response (default `0`: off). `triggerKey` runs it whenever another component calls `invalidate()` on that publisher.
+
+<sonic-code language="typescript">
+  <template>
+import { dp } from "@supersoniks/concorde/utils";
+
+const boardRefresh = new DataProviderKey&lt;number&gt;("boardRefresh");
+
+@get(departuresEndpoint, { refetchEveryMs: 30000, triggerKey: boardRefresh })
+@state()
+departures?: ApiResult&lt;FlightBoard&gt;;
+
+// anywhere else
+dp(boardRefresh).invalidate();
+  </template>
+</sonic-code>
+
+## API reference
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `endpoint` | `Endpoint<T, U>` | Path relative to `serviceURL`. `U` lists the host properties used by `${…}` placeholders |
+| `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | Read the configuration from the store instead of the HTML scope |
+| `options.refetchEveryMs` | `number` (default `0`) | Polling interval after each response; `0` disables it |
+| `options.triggerKey` | `DataProviderKey<unknown>` | Publisher whose `invalidate()` runs the GET again |
+| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
+
+`options` is the second argument, or the third when a `configurationKey` is passed. The returned decorator exposes `refetch(component): Promise<ApiResult<T> | undefined>`.
+
+| `@refetch` argument | Type | Description |
+|---------------------|------|-------------|
+| `handle` | value returned by `get(…)` | GET to run |
+| `options.when` | `"before"` or `"after"` (default `"after"`) | Run the GET before or after the method |

package/src/docs/decorators/handle.md

@@ -0,0 +1,119 @@
+# @handle
+
+`@handle(...keys)` calls the decorated method each time a publisher assigns one of up to three store paths, with one typed argument per key. Nothing is stored on the component: use it for derived values and side effects, and [@subscribe](/docs/decorators/subscribe) when you only need the value. See [Data flow](/docs/getting-started/dataFlow) for the overall model.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { handle, Skip } from "@supersoniks/concorde/decorators";
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+
+const cockpitKey = new DataProviderKey&lt;{ altitude: number }&gt;("cockpit");
+
+@handle(cockpitKey.altitude)
+onAltitude(feet: number) {
+  this.meters = Math.round(feet * 0.3048);
+}
+  </template>
+</sonic-code>
+
+## Basic usage
+
+The method runs once with the current value when the component connects, then on **every** assignment, including `null` and `undefined`. Below, each climb assigns a new altitude and the method derives meters and flight level.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-handle"></docs-demo-sources>
+    <demo-handle></demo-handle>
+  </template>
+</sonic-code>
+
+## Dynamic path
+
+`${prop}` placeholders resolve from properties of the same component; when one changes, the method is called with the value at the new path. Rules: [Dynamic paths](/docs/misc/dynamic-path).
+
+<sonic-code language="typescript">
+  <template>
+const personKey = new DataProviderKey&lt;OnBoard, { seatIndex: number }&gt;(
+  "demoOnBoard.${seatIndex}",
+);
+
+@property({ type: Number }) seatIndex = 0;
+
+@handle(personKey)
+onPerson(person: OnBoard | null) {
+  this.announcement = person ? `${person.name}, please proceed to gate B12.` : "";
+}
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-handle-dynamic"></docs-demo-sources>
+    <demo-handle-dynamic></demo-handle-dynamic>
+  </template>
+</sonic-code>
+
+## Multiple keys
+
+Pass up to three [DataProviderKey](/docs/misc/dataProviderKey) values; the method receives one argument per key, in the same order. Any assignment to any key calls it, so other arguments may still be `null`.
+
+<sonic-code language="typescript">
+  <template>
+const flightKey = new DataProviderKey&lt;{ status: string; gate: string }&gt;("flight");
+const weatherKey = new DataProviderKey&lt;{ turbulence: boolean }&gt;("weather");
+
+@handle(flightKey.status, weatherKey.turbulence)
+onConditions(status: string, turbulence: boolean) {
+  this.seatbeltSign = status === "boarding" || turbulence === true;
+}
+  </template>
+</sonic-code>
+
+## Wait for all values
+
+With `waitForAllDefined: true`, the method runs only once every key holds a value other than `null` or `undefined`.
+
+<sonic-code language="typescript">
+  <template>
+@handle(flightKey.gate, passengerKey.name, { waitForAllDefined: true })
+announce(gate: string, name: string) {
+  this.message = `${name}, please proceed to gate ${gate}.`;
+}
+  </template>
+</sonic-code>
+
+## Skip values
+
+`skip` lists categories of values that must not call the method. A category is a named test, not a value to compare.
+
+| Category | Matches |
+|----------|---------|
+| `Skip.Nullish` | `null` or `undefined` |
+| `Skip.EmptyString` | `""` |
+| `Skip.EmptyObject` | `{}` (arrays excluded) |
+| `Skip.EmptyArray` | `[]` |
+
+<sonic-code language="typescript">
+  <template>
+@handle(passengerKey, { skip: [Skip.Nullish, Skip.EmptyObject] })
+onPassenger(passenger: Passenger) {
+  // not called while the publisher still holds {} (not loaded yet)
+  this.displayName = passenger.name;
+}
+  </template>
+</sonic-code>
+
+To reject a specific value, return early inside the method.
+
+## API reference
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `key` (1 to 3) | `DataProviderKey<T, U>` | Paths to watch; the method receives one value per key, in order |
+| `options.waitForAllDefined` | `boolean` (default `false`) | Call the method only when no value is `null` or `undefined` |
+| `options.skip` | `Skip[]` (default none) | Do not call the method when any value matches one of these categories |
+| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
+
+`options`, if present, is the last argument. `@handle` replaces the deprecated [@onAssign](/docs/decorators/on-assign): `@onAssign("a", "b")` is `@handle(keyA, keyB, { waitForAllDefined: true })`.

package/src/docs/decorators/on-assign.md

@@ -0,0 +1,63 @@
+# @onAssign
+
+Legacy decorator that calls a method with the values at one or more string paths of the store, once all of them are defined. For new code, use [@handle](/docs/decorators/handle) with `{ waitForAllDefined: true }`: same behaviour, with typed `DataProviderKey` paths.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { onAssign } from "@supersoniks/concorde/decorators";
+
+@onAssign("passenger", "passengerSettings")
+onReady(passenger: Passenger, settings: Settings) {}
+  </template>
+</sonic-code>
+
+## Wait for every path
+
+The method is called only when every path holds a value other than `null` or `undefined`, with the values in the order of the paths. After that, each assignment calls it again with the latest values. Subscriptions start after `connectedCallback` and stop in `disconnectedCallback`.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-on-assign"></docs-demo-sources>
+    <demo-on-assign></demo-on-assign>
+  </template>
+</sonic-code>
+
+## Dynamic path
+
+Paths accept `${prop}` placeholders resolved on the host. While a placeholder is `null` or `undefined`, that path is unsubscribed. Write the paths as plain strings, not template literals. Rules: [Dynamic path placeholders](/docs/misc/dynamic-path).
+
+<sonic-code language="typescript">
+  <template>
+@property({ type: Number }) seat = 0;
+
+@onAssign("passengers.${seat}", "passengerSettings.${seat}")
+onSeat(passenger: Passenger, settings: Settings) {}
+  </template>
+</sonic-code>
+
+## Migrate to @handle
+
+<sonic-code language="typescript">
+  <template>
+// Before
+@onAssign("passenger", "passengerSettings")
+onReady(passenger: any, settings: any) {}
+
+// After
+const passengerKey = new DataProviderKey&lt;Passenger&gt;("passenger");
+const settingsKey = new DataProviderKey&lt;Settings&gt;("passengerSettings");
+
+@handle(passengerKey, settingsKey, { waitForAllDefined: true })
+onReady(passenger: Passenger, settings: Settings) {}
+  </template>
+</sonic-code>
+
+`@handle` accepts up to three keys. For more paths, keep `@onAssign` or split the logic into several `@handle` methods.
+
+## API reference
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `...paths` | `string[]` | Dot paths in the store (`"flights.0.status"`), optionally with `${prop}` placeholders; the method receives one argument per path, in order |

package/src/docs/decorators/patch.md

@@ -0,0 +1,44 @@
+# @patch
+
+Sends the value of a publisher as the body of a `PATCH` request, to update part of a resource, and stores the response in an `ApiResult<T>` property. It takes the same arguments, options and `send(component)` handle as [@post](/docs/decorators/post); only the HTTP method differs.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { patch, type ApiResult } from "@supersoniks/concorde/decorators";
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
+  </template>
+</sonic-code>
+
+## Basic usage
+
+The body holds only the fields to change, here a gate change for flight CN 001.
+
+<sonic-code language="typescript">
+  <template>
+type Flight = { flight: string; route: string; gate: string };
+
+const gateChangeKey = new DataProviderKey&lt;Partial&lt;Flight&gt;&gt;("gateChange");
+
+@patch(new Endpoint&lt;Flight&gt;("flights/CN001"), gateChangeKey)
+@state()
+payload?: ApiResult&lt;Flight&gt;;
+
+moveToB12() {
+  set(gateChangeKey, { gate: "B12" }); // sends the PATCH
+}
+  </template>
+</sonic-code>
+
+Triggers, the `send` method decorator and every option are described on [@post](/docs/decorators/post).
+
+## API reference
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `endpoint` | `Endpoint<T>` | Resource path and response type |
+| `bodyKey` | `DataProviderKey<B>` | Publisher read as the partial body |
+| `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | API configuration publisher. Default: HTML scope |
+| `options` | `PatchOptions` | Same as [@post options](/docs/decorators/post) |

package/src/docs/decorators/post.md

@@ -0,0 +1,134 @@
+# @post
+
+Sends the value of a publisher as the body of a `POST` request and stores the response in an `ApiResult<T>` property. Pass an [Endpoint](/docs/misc/endpoint) and a [DataProviderKey](/docs/misc/dataProviderKey) for the body; the request runs on connect and again whenever the body changes. [@put](/docs/decorators/put) and [@patch](/docs/decorators/patch) work the same way.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { post, type ApiResult } from "@supersoniks/concorde/decorators";
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+import { Endpoint } from "@supersoniks/concorde/utils/endpoint";
+
+type SignUp = { email: string; password: string };
+type CrewMember = { id: number; email: string };
+
+const signUpKey = new DataProviderKey&lt;SignUp&gt;("crewSignUp");
+
+@post(new Endpoint&lt;CrewMember&gt;("api/register"), signUpKey)
+@state()
+payload?: ApiResult&lt;CrewMember&gt;;
+  </template>
+</sonic-code>
+
+## Basic usage
+
+The property is `undefined` until a response arrives, then holds `request` · `response` · the typed `result`. Each body mutation sends a new request; mutations in the same frame are coalesced into one. The demo posts to the local mock `POST /docs-mock-api/api/register`.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-api-post"></docs-demo-sources>
+    <demo-api-post></demo-api-post>
+  </template>
+</sonic-code>
+
+## Method form
+
+On a method, the decorator calls it with the full `ApiResult<T>` after each request instead of assigning a property.
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-api-post-method"></docs-demo-sources>
+    <demo-api-post-method></demo-api-post-method>
+  </template>
+</sonic-code>
+
+## Sending again
+
+Keep the decorator in a constant to call `send(component)`. It reads the current body and returns a `Promise<ApiResult<T> | undefined>` resolved once the request completes. Use it for "Save" or "Retry" buttons.
+
+<sonic-code language="typescript">
+  <template>
+const signUp = post(new Endpoint&lt;CrewMember&gt;("api/register"), signUpKey);
+
+@signUp
+@state()
+payload?: ApiResult&lt;CrewMember&gt;;
+
+async retry() {
+  const payload = await signUp.send(this);
+  console.log(payload?.result?.id);
+}
+  </template>
+</sonic-code>
+
+The `send` method decorator does the same around a method. It runs after the method by default (waiting for a returned Promise); `{ when: "before" }` sends first.
+
+<sonic-code language="typescript">
+  <template>
+import { send } from "@supersoniks/concorde/decorators";
+
+@send(signUp)
+async confirmCheckIn() {
+  // Validate the check-in form, then the POST is sent.
+}
+  </template>
+</sonic-code>
+
+## Manual trigger
+
+Set `autoPostOnBodyMutation: false` when the body is edited field by field (a check-in form) and the request must only go out on `send()` or `triggerKey`. A `triggerKey` publisher lets another component resend: calling `invalidate()` on it sends the current body.
+
+<sonic-code language="typescript">
+  <template>
+const submitKey = new DataProviderKey&lt;number&gt;("checkInSubmit");
+
+@post(checkInEndpoint, checkInKey, {
+  autoPostOnBodyMutation: false,
+  triggerKey: submitKey,
+})
+@state()
+payload?: ApiResult&lt;CheckIn&gt;;
+
+// Anywhere: dp(submitKey).invalidate();
+  </template>
+</sonic-code>
+
+By default (`skipIfBodyMissing: true`) nothing is sent while the body is `null` or `undefined`. `refetchEveryMs` repeats the request at a fixed interval after each response; use it only when repeating the operation is safe.
+
+## API configuration
+
+Without a configuration key, `serviceURL` and credentials come from the HTML scope, as with [@get](/docs/decorators/get). Pass a `DataProviderKey<APIConfiguration>` as third argument to read them from a publisher; options then move to the fourth argument. See [API configuration](/docs/misc/api-configuration).
+
+<sonic-code language="typescript">
+  <template>
+@post(signUpEndpoint, signUpKey, apiConfigurationKey, { skipIfBodyMissing: false })
+  </template>
+</sonic-code>
+
+## Dynamic path
+
+Placeholders in the endpoint (`${flight}`) are read from the host component; changing the property sends the same body to the new URL. See [Dynamic paths](/docs/misc/dynamic-path).
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-api-post-dynamic"></docs-demo-sources>
+    <demo-api-post-dynamic></demo-api-post-dynamic>
+  </template>
+</sonic-code>
+
+## API reference
+
+`post(endpoint, bodyKey, configurationKey?, options?)` returns a decorator for a property or a method, with a `send(component)` method.
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `endpoint` | `Endpoint<T>` | Path and response type. Supports `${prop}` placeholders |
+| `bodyKey` | `DataProviderKey<B>` | Publisher read as request body |
+| `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | API configuration publisher. Default: HTML scope |
+| `options.autoPostOnBodyMutation` | `boolean` (default `true`) | Send on connect and after each body mutation |
+| `options.skipIfBodyMissing` | `boolean` (default `true`) | Skip while the body is `null` or `undefined` |
+| `options.triggerKey` | `DataProviderKey<unknown>` | Publisher whose `invalidate()` resends |
+| `options.refetchEveryMs` | `number` (default `0`, off) | Resend interval in ms after each response |
+| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
+| `send(handle, { when })` | `"after"` (default) or `"before"` | Method decorator sending after or before the method |

package/src/docs/decorators/publish.md

@@ -0,0 +1,56 @@
+# @publish
+
+`@publish(key)` writes a component property to one path of the store: every assignment to the property is published there. It never reads back from the store; it is the inverse of [@subscribe](/docs/decorators/subscribe). See [Data flow](/docs/getting-started/dataFlow) for the overall model.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { publish } from "@supersoniks/concorde/decorators";
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+
+type CheckIn = { passenger: string; seat: string };
+const checkInKey = new DataProviderKey&lt;CheckIn&gt;("checkIn");
+
+@publish(checkInKey.passenger)
+@state()
+passenger = "Ada Lindqvist";
+  </template>
+</sonic-code>
+
+## Basic usage
+
+Each assignment calls `set()` on the publisher at the [DataProviderKey](/docs/misc/dataProviderKey) path. **On connect, a defined property value is published immediately**, so the initializer overwrites what the store held. Leave the property `undefined` to keep the store value. To read and write the same path, use [@bind](/docs/decorators/bind) with `reflect: true`.
+
+The check-in form below publishes `passenger` and `seat`; the boarding pass reads them back with [sub()](/docs/directives/sub).
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-publish"></docs-demo-sources>
+    <demo-publish></demo-publish>
+  </template>
+</sonic-code>
+
+## Dynamic path
+
+`${prop}` placeholders resolve from properties of the same component. When a placeholder changes, the property is published to the new path. While it is `null` or `undefined`, nothing is published. Rules and `skipEmptyPlaceholder`: [Dynamic paths](/docs/misc/dynamic-path).
+
+<sonic-code language="typescript">
+  <template>
+@property({ type: Number }) seatIndex = 0;
+
+@publish(
+  new DataProviderKey&lt;string, { seatIndex: number }&gt;("onBoard.${seatIndex}.seat"),
+  { skipEmptyPlaceholder: true },
+)
+@state()
+seat = "1A";
+  </template>
+</sonic-code>
+
+## API reference
+
+| Argument | Type | Description |
+|----------|------|-------------|
+| `key` | `DataProviderKey<T, U>` | Path to write. `U` lists the host properties used by `${…}` placeholders |
+| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |