@supersoniks/concorde 5.1.2 → 5.1.3-immutable.1

package/docs/src/docs/_decorators/handle.md

@@ -0,0 +1,175 @@
+# @handle
+
+Typed callback on one or more `DataProviderKey<T>` paths: invokes the decorated **method** when a publisher assigns a value (calculations, side effects, updating other `@state` properties, etc.).
+
+Unlike [@subscribe](#docs/_decorators/subscribe.md/subscribe), nothing is bound to the decorated member — only your method runs. `@handle` is typed and accepts up to **3 keys** plus an optional trailing `HandleOptions` object. It supersedes the string-based [@onAssign](#docs/_decorators/on-assign.md/on-assign).
+
+By default the method is called on **every** assignment, even when the value is `null` / `undefined`. Use the options below to restrict that.
+
+## Import
+
+<sonic-code language="typescript">
+  <template>
+import { handle, Skip } from "@supersoniks/concorde/decorators";
+import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+import { get, set } from "@supersoniks/concorde/utils";
+  </template>
+</sonic-code>
+
+## Basic example
+
+<sonic-code language="typescript">
+  <template>
+type DemoCounterData = { count: number };
+const demoDataKey = new DataProviderKey&lt;DemoCounterData&gt;("demoData");
+
+@customElement("demo-handle")
+export class DemoHandle extends LitElement {
+  @state() doubled = 0;
+  @state() lastUpdate = "";
+
+  @handle(demoDataKey.count)
+  onCountChange(count: number) {
+    this.doubled = count * 2;
+    this.lastUpdate = new Date().toLocaleTimeString();
+  }
+
+  incrementCount() {
+    const data = get(demoDataKey);
+    set(demoDataKey, { ...data, count: data.count + 1 });
+  }
+
+  render() {
+    return html`
+      &lt;p&gt;Doubled count: ${this.doubled}&lt;/p&gt;
+      &lt;p&gt;&lt;small&gt;Last update: ${this.lastUpdate}&lt;/small&gt;&lt;/p&gt;
+      &lt;sonic-button @click=${this.incrementCount}&gt;Increment&lt;/sonic-button&gt;
+    `;
+  }
+}
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-handle"></docs-demo-sources>
+    <demo-handle></demo-handle>
+  </template>
+</sonic-code>
+
+## Dynamic path
+
+Placeholders in `DataProviderKey` resolve from the host component’s properties (same rules as `@bind` / `@subscribe`).
+
+<sonic-code language="typescript">
+  <template>
+type User = { firstName: string; lastName: string; email: string };
+
+@customElement("demo-handle-dynamic")
+export class DemoHandleDynamic extends LitElement {
+  @property({ type: Number })
+  userIndex = 0;
+
+  @state() displayName = "";
+  @state() lastUpdate = "";
+
+  @handle(new DataProviderKey&lt;User, { userIndex: number }&gt;("demoUsers.${userIndex}"))
+  onUserAssigned(user: User) {
+    this.displayName = `${user.firstName} ${user.lastName}`;
+    this.lastUpdate = new Date().toLocaleTimeString();
+  }
+
+  render() {
+    return html`...`;
+  }
+}
+  </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 paths
+
+`@handle` accepts up to **3 keys**; the method receives one strongly-typed argument per key, in order. Each assignment triggers the method, so make your method safe against partial values (or use `waitForAllDefined`, see below).
+
+<sonic-code language="typescript">
+  <template>
+type QueueConfig = { onInactivity: { stillHere: { show: boolean } } };
+const config = new DataProviderKey&lt;QueueConfig&gt;("sessionQueueConfig");
+const idle = new DataProviderKey&lt;{ isIdle: boolean }&gt;("idleStatus");
+
+@customElement("demo-handle-multi")
+export class DemoHandleMulti extends LitElement {
+
+  // show: boolean, isIdle: boolean — fully typed from the keys
+  @handle(config.onInactivity.stillHere.show, idle.isIdle)
+  onInactivity(show: boolean, isIdle: boolean) {
+    if (show === true && isIdle === true) this.openModal();
+    else this.closeModal();
+  }
+}
+  </template>
+</sonic-code>
+
+## Options (`HandleOptions`)
+
+Pass an options object as the **last** argument. The names map to real situations seen in the apps.
+
+### `waitForAllDefined`
+
+Only call the method once **all** watched keys are defined (non `null` / `undefined`). This reproduces the historical `@onAssign` semantics — use it when the logic only makes sense with every source ready (e.g. building a date from `date` + `timeZone` + `direction`).
+
+<sonic-code language="typescript">
+  <template>
+@handle(trip.departureDate, trip.event.timeZone, form.direction, {
+  waitForAllDefined: true,
+})
+updateDepartureDate(date: number, timeZone: string, direction: string) {
+  // called only when the three values are all available
+  this.formDate = formatDate(date, timeZone, direction);
+}
+  </template>
+</sonic-code>
+
+### `skip`
+
+Do **not** call the method when a received value belongs to one of the listed **categories** (the `Skip` enum). Each entry is a named category — not a value — so there is no value/pattern ambiguity (e.g. `{}` is `Skip.EmptyObject`, an explicit "empty object" category, never a value comparison).
+
+| Category | Matches |
+| --- | --- |
+| `Skip.Nullish` | `null` or `undefined` (a publisher always emits `null`, never `undefined`) |
+| `Skip.EmptyString` | `""` |
+| `Skip.EmptyObject` | object with no keys (`{}`), arrays excluded |
+| `Skip.EmptyArray` | empty array (`[]`) |
+
+Useful when a not-yet-initialized publisher emits `{}` as a "loading" state. For a **specific value** (e.g. a particular string), guard inside the method instead.
+
+<sonic-code language="typescript">
+  <template>
+@handle(user.profile, { skip: [Skip.Nullish, Skip.EmptyObject] })
+onProfile(profile: Profile) {
+  // not called while the publisher still holds {} (not loaded yet)
+  this.displayName = profile.firstName;
+}
+  </template>
+</sonic-code>
+
+> Options can be combined, e.g. `@handle(a, b, { waitForAllDefined: true, skip: [Skip.Nullish] })`. For any **arbitrary** validation on a specific value, just guard inside the method (`if (!isValid(v)) return;`) — that is exactly what an `accept`-style predicate would do, since `@handle` only runs your method.
+
+### `skipEmptyPlaceholder`
+
+On a **dynamic key path** (`"items.${itemId}"`), if `true`, a placeholder resolved to `''` is treated as not ready (no subscription) — **empty string only**, not `0` or `false`. See [Dynamic path placeholders](#docs/_misc/dynamic-path.md/dynamic-path).
+
+## Highlights
+
+- Strict typing: the method receives one argument per key, in order.
+- Up to 3 keys; for 4+ keys (rare), keep [@onAssign](#docs/_decorators/on-assign.md/on-assign) for now.
+- By default the method runs on **every** assignment, even with `null` / `undefined` (unlike `@onAssign`, which waits for all values). Opt back into that behavior with `waitForAllDefined`.
+- `skip` filters out values by **named category** (e.g. `[Skip.Nullish, Skip.EmptyObject]`); for arbitrary checks on a specific value, guard inside the method.
+
+See also [DataProviderKey](#docs/_misc/dataProviderKey.md/dataProviderKey) and [Dynamic path placeholders](#docs/_misc/dynamic-path.md/dynamic-path).

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

@@ -0,0 +1,390 @@
+# @onAssign
+
+> **New apps:** use [@handle](#docs/_decorators/handle.md/handle) with `DataProviderKey` ([Data flow](#docs/_core-concept/dataFlow.md/dataFlow)). `@onAssign` uses untyped string paths; it remains documented for existing codebases — see **Migrating to @handle** below.
+
+The `@onAssign` decorator allows you to execute a method when one or more publishers are updated. The method is called only when all specified publishers have been assigned values.
+
+For a **typed** equivalent (recommended), use [@handle](#docs/_decorators/handle.md/handle).
+
+## Principle
+
+This decorator subscribes to one or more publishers by **string path** (legacy). When all specified publishers have been assigned values (via `set`), the decorated method is called with all the values as arguments. Prefer [@handle](#docs/_decorators/handle.md/handle) + `DataProviderKey` and `get` / `set` from [Data flow](#docs/_core-concept/dataFlow.md/dataFlow).
+
+This is particularly useful when you need to wait for multiple data sources to be ready before executing logic.
+
+## Usage
+
+### Import
+
+<sonic-code language="typescript">
+  <template>
+import { onAssign } from "@supersoniks/concorde/decorators";
+  </template>
+</sonic-code>
+
+### Basic example 
+
+
+<sonic-code language="typescript">
+  <template>
+//...
+@customElement("demo-on-assign")
+export class DemoOnAssign extends LitElement {
+  static styles = [tailwind];
+
+  @state() userWithSettings: any = null;
+  @state() isReady: boolean = false;
+  @state() lastUpdate: string = "";
+
+  @onAssign("demoUser", "demoUserSettings")
+  handleDataReady(user: any, settings: any) {
+    this.isReady = Object.keys(user).length > 0 && Object.keys(settings).length > 0;
+    this.userWithSettings = { ...user, ...settings };
+    this.lastUpdate = new Date().toLocaleTimeString();
+    this.requestUpdate();
+  }
+
+  render() {
+    const { name, email, theme, language } = this.userWithSettings;
+    return //...
+  }
+
+  updateData() {
+    const user = PublisherManager.get("demoUser");
+    const userSettings = PublisherManager.get("demoUserSettings");
+    const userNumber = Math.floor(Math.random() * 100);
+    user.set({
+      name: `User n°${userNumber}`,
+      email: `user-${userNumber}@example.com`,
+    });
+
+    userSettings.set({
+      theme: ["light", "dark", "auto"][Math.floor(Math.random() * 3)],
+      language: ["en", "fr", "es"][Math.floor(Math.random() * 3)],
+    });
+  }
+}
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-on-assign"></docs-demo-sources>
+    <demo-on-assign></demo-on-assign>
+  </template>
+</sonic-code>
+
+
+### Example with nested paths
+
+<sonic-code language="typescript">
+  <template>
+@customElement("product-view")
+export class ProductView extends LitElement {
+  product: any = null;
+  inventory: any = null;
+
+  @onAssign("store.product", "store.inventory")
+  handleProductData(product: any, inventory: any) {
+    this.product = product;
+    this.inventory = inventory;
+    this.requestUpdate();
+  }
+
+  render() {
+    if (!this.product) return html`<div>Loading...</div>`;
+
+    const stock = this.inventory[this.product.id] || 0;
+    return html`
+      <div>
+        <h2>${this.product.name}</h2>
+        <p>Price: ${this.product.price}€</p>
+        <p>Stock: ${stock}</p>
+      </div>
+    `;
+  }
+}
+  </template>
+</sonic-code>
+
+## Path syntax
+
+The path uses dot notation to navigate through the publisher structure:
+
+- **First segment**: dataProvider identifier (e.g., `"userData"`)
+- **Following segments**: nested properties (e.g., `"store.product"`)
+- **Array access**: use numeric index (e.g., `"data.items.0"`)
+
+### Dynamic path driven by class properties
+
+You can now build the paths dynamically by referencing the host class properties inside the strings passed to `@onAssign`. Two placeholder syntaxes are supported:
+
+- `` ${myProperty} `` or `` ${this.myProperty} ``
+- `` {$myProperty} ``
+
+Each placeholder is replaced at runtime with the current value of the corresponding property. `@onAssign` automatically watches those properties and:
+
+- re-evaluates the final paths when one of them changes,
+- removes the previous subscriptions before attaching the new ones,
+- observe the changes inside `willUpdate(changedProperties)` so nothing touches the getters/setters.
+
+While a placeholder is `null`/`undefined`, subscriptions are detached. Optional `skipEmptyPlaceholder` on [@handle](#docs/_decorators/handle.md/handle) (typed replacement). Details: [Dynamic path placeholders](#docs/_misc/dynamic-path.md/dynamic-path).
+
+
+<sonic-code language="typescript">
+  <template>
+@customElement("demo-on-assign-dynamic")
+export class DemoOnAssignDynamic extends LitElement {
+  static styles = [tailwind];
+
+  @property({ type: String })
+  dataProvider: "demoUsers" | "demoUsersAlt" = "demoUsers";
+
+  @property({ type: Number })
+  userIndex: number = 0;
+
+  @state() user: any = null;
+  @state() userSettings: any = null;
+
+  @onAssign("${dataProvider}.${userIndex}", "${dataProvider}Settings.${userIndex}")
+  handleUserDataReady(user: any, settings: any) {
+    this.user = user;
+    this.userSettings = settings;
+  }
+
+  updateUserIndex(e: Event) {
+    this.userIndex = parseInt((e.target as HTMLInputElement).value);
+  }
+
+  updateDataProvider(e: Event) {
+    this.dataProvider = (e.target as HTMLSelectElement).value as
+      | "demoUsers"
+      | "demoUsersAlt";
+  }
+
+  updateCurrentUserData() {
+    const usersPublisher = PublisherManager.get(this.dataProvider);
+    const settingsPublisher = PublisherManager.get(
+      `${this.dataProvider}Settings`
+    );
+    const userPublisher = Objects.traverse(
+      usersPublisher,
+      [String(this.userIndex)]
+    ) as PublisherProxy;
+    const settingPublisher = Objects.traverse(
+      settingsPublisher,
+      [String(this.userIndex)]
+    ) as PublisherProxy;
+
+    if (userPublisher && settingPublisher) {
+      // Générer de nouvelles données aléatoires
+      const randomNames = [
+        { firstName: "Alice", lastName: "Wonder" },
+        { firstName: "Bob", lastName: "Builder" },
+        { firstName: "Charlie", lastName: "Chaplin" },
+      ];
+      const randomThemes = ["light", "dark", "auto"];
+      const randomLanguages = ["en", "fr", "es"];
+
+      const randomName =
+        randomNames[Math.floor(Math.random() * randomNames.length)];
+      const randomEmail = `${randomName.firstName.toLowerCase()}.${randomName.lastName.toLowerCase()}@example.com`;
+      const randomTheme =
+        randomThemes[Math.floor(Math.random() * randomThemes.length)];
+      const randomLanguage =
+        randomLanguages[Math.floor(Math.random() * randomLanguages.length)];
+
+      // Mettre à jour l'utilisateur directement
+      const currentUser = userPublisher.get() || {};
+      userPublisher.set({
+        ...currentUser,
+        firstName: randomName.firstName,
+        lastName: randomName.lastName,
+        email: randomEmail,
+      });
+
+      // Mettre à jour les settings directement
+      settingPublisher.set({
+        theme: randomTheme,
+        language: randomLanguage,
+      });
+    }
+  }
+
+  render() {
+    return html`
+      &lt;div class="flex flex-col gap-2"&gt;
+        &lt;sonic-select label="Users set" @change=${this.updateDataProvider}&gt;
+          &lt;option value="demoUsers"&gt;First set of users&lt;/option&gt;
+          &lt;option value="demoUsersAlt"&gt;Second set of users&lt;/option&gt;
+        &lt;/sonic-select&gt;
+        &lt;sonic-input
+          type="number"
+          .value=${this.userIndex}
+          @input=${this.updateUserIndex}
+          min="0"
+          max="9"
+          label="Index"
+          class="block"
+        &gt;&lt;/sonic-input&gt;
+        &lt;sonic-button @click=${this.updateCurrentUserData}&gt;
+          Update current user data
+        &lt;/sonic-button&gt;
+        &lt;div class="flex flex-col gap-2 border p-2"&gt;
+          &lt;div&gt;
+            &lt;sonic-icon name="user" library="heroicons"&gt;&lt;/sonic-icon&gt;
+            ${this.user?.firstName} ${this.user?.lastName}
+          &lt;/div&gt;
+          &lt;div&gt;
+            &lt;sonic-icon name="envelope" library="heroicons"&gt;&lt;/sonic-icon&gt;
+            ${this.user?.email}
+          &lt;/div&gt;
+          &lt;div&gt;
+            Theme: ${this.userSettings?.theme} | Language:
+            ${this.userSettings?.language}
+          &lt;/div&gt;
+        &lt;/div&gt;
+      &lt;/div&gt;
+    `;
+  }
+}
+  </template>
+</sonic-code>
+
+<sonic-code>
+  <template>
+    <docs-demo-sources for="demo-on-assign-dynamic"></docs-demo-sources>
+    <demo-on-assign-dynamic></demo-on-assign-dynamic>
+  </template>
+</sonic-code>
+
+> ⚠️ Use classic string literals: `@onAssign("${dataProvider}.${profileId}", "settings.${profileId}")`. Do **not** use template literals (backticks), otherwise JavaScript would try to interpolate the value immediately.
+
+Additional constraints:
+
+- The hosting class must expose a `willUpdate(changedProperties?: Map<PropertyKey, unknown>)` method (LitElement already provides it) so that `@onAssign` can listen to dependency changes.
+- Dependencies need to be reactive (e.g. `@property()` on LitElement) or you must call `this.requestUpdate("myProp")` manually after changing them, otherwise `willUpdate` will never be notified.
+- If you use nested expressions like `${user.id}`, the first segment (`user`) is the one being observed: you need to reassign `this.user` (e.g. with a new object) so that the binding can detect the change.
+
+## Behavior
+
+- The method is called only when **all** specified publishers have been assigned values
+- The method receives the values of all publishers as arguments, in the same order as specified
+- Subscription happens at the time of `connectedCallback`
+- Unsubscription happens automatically at the time of `disconnectedCallback`
+- If a publisher doesn't exist yet, it will be created with the value `null`
+- The method is called with `this` bound to the component instance
+
+## Use cases
+
+This decorator is particularly useful for:
+
+- **Waiting for multiple data sources** before rendering or executing logic
+- **Synchronizing data** from different publishers
+- **Initializing components** that depend on multiple data providers
+- **Handling complex data dependencies** where you need all data to be ready
+
+## Complete example
+
+<sonic-code language="typescript">
+  <template>
+import { html, LitElement } from "lit";
+import { customElement } from "lit/decorators.js";
+import { onAssign } from "@supersoniks/concorde/decorators";
+import { PublisherManager } from "@supersoniks/concorde/core/utils/PublisherProxy";
+
+@customElement("order-summary")
+export class OrderSummary extends LitElement {
+  order: any = null;
+  customer: any = null;
+  shipping: any = null;
+
+  @onAssign("orderData", "customerData", "shippingData")
+  handleOrderReady(order: any, customer: any, shipping: any) {
+    this.order = order;
+    this.customer = customer;
+    this.shipping = shipping;
+    this.requestUpdate();
+  }
+
+  render() {
+    if (!this.order || !this.customer || !this.shipping) {
+      return html`<div>Loading order details...</div>`;
+    }
+
+    return html`
+      <div class="order-summary">
+        <h2>Order #${this.order.id}</h2>
+        <p>Customer: ${this.customer.name}</p>
+        <p>Shipping to: ${this.shipping.address}</p>
+        <p>Total: ${this.order.total}€</p>
+      </div>
+    `;
+  }
+}
+// Somewhere in your code, update the publishers:
+const orderPub = PublisherManager.get("orderData");
+const customerPub = PublisherManager.get("customerData");
+const shippingPub = PublisherManager.get("shippingData");
+// The method will be called only when all three are set:
+orderPub.set({ id: "123", total: 99.99 });
+customerPub.set({ name: "John Doe", email: "john@example.com" });
+shippingPub.set({ address: "123 Main St" });
+// handleOrderReady will be called with all three values
+  </template>
+</sonic-code>
+
+## Migrating to @handle
+
+`@handle` is the typed successor of `@onAssign`. The key behavioral difference: `@onAssign` waits for **all** values to be defined before calling the method, whereas `@handle` calls it on **every** assignment by default. Use the `waitForAllDefined` option to keep the old semantics.
+
+### Why migrate
+
+- **Typed paths**: keys are `DataProviderKey<T>`, so the method arguments are strongly typed (no more `any`).
+- **Explicit intent**: `waitForAllDefined` and `skip` replace implicit behavior.
+- **Single API**: `@handle` covers the mono- and multi-path cases (up to 3 keys).
+
+### Equivalent semantics (`waitForAllDefined`)
+
+<sonic-code language="typescript">
+  <template>
+// Before
+@onAssign("demoUser", "demoUserSettings")
+handleDataReady(user: any, settings: any) { /* ... */ }
+
+// After — same "wait for everything" behavior, but typed
+const user = new DataProviderKey&lt;User&gt;("demoUser");
+const settings = new DataProviderKey&lt;Settings&gt;("demoUserSettings");
+
+@handle(user, settings, { waitForAllDefined: true })
+handleDataReady(user: User, settings: Settings) { /* ... */ }
+  </template>
+</sonic-code>
+
+### Single path
+
+<sonic-code language="typescript">
+  <template>
+// Before
+@onAssign("settings.modules.logs_route.enabled")
+onLogRoute(value: boolean) { /* ... */ }
+
+// After
+const settings = new DataProviderKey&lt;AppSettings&gt;("settings");
+
+@handle(settings.modules.logs_route.enabled)
+onLogRoute(value: boolean) { /* ... */ }
+  </template>
+</sonic-code>
+
+### 4+ paths
+
+`@handle` is capped at 3 keys. For the rare case of 4 or more publishers, keep `@onAssign` for now, or split the logic into several `@handle` methods that each store their value and call a shared method (guarding against partial values).
+
+## Notes
+
+- This decorator works with any component that has `connectedCallback` and `disconnectedCallback` methods (such as `LitElement` or components extending `Subscriber`)
+- The method is called synchronously when all publishers are ready
+- If you need to update the UI, remember to call `this.requestUpdate()` inside the method
+- For more information about publishers, see the documentation on [Sharing data](#docs/_getting-started/pubsub.md/pubsub)
+

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

@@ -0,0 +1,70 @@
+# @patch
+
+`@patch` applies a partial update with the body from a publisher. It uses the
+same model as [@post](#docs/_decorators/post.md/post):
+`Endpoint<T>`, `DataProviderKey<B>`, `ApiResult<T>`, options, and the
+`send(component)` handle.
+
+## Minimal usage
+
+```typescript
+const bodyKey = new DataProviderKey<Partial<User>>("users.patch");
+const patchUser = patch(new Endpoint<User>("users/42"), bodyKey);
+
+@patchUser
+@state()
+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
+async savePatch() {
+  await patchUser.send(this);
+}
+```
+
+`send(component)` returns a Promise resolved after the PATCH completes. See
+[@post](#docs/_decorators/post.md/post) for the method-decorator form and the
+`when: "before"` option.
+
+The PATCH is also sent automatically when the body mutates, unless
+`autoPostOnBodyMutation: false` is set. The available options are described in
+[@post](#docs/_decorators/post.md/post):
+
+- `autoPostOnBodyMutation`
+- `skipIfBodyMissing`
+- `refetchEveryMs`
+- `skipEmptyPlaceholder`
+- `triggerKey`
+
+Pass explicit API configuration as the third argument:
+
+```typescript
+@patch(endpoint, bodyKey, apiConfigurationKey)
+```
+
+## 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>
+
+## See also
+
+- [@post](#docs/_decorators/post.md/post) — options and triggers
+- [@put](#docs/_decorators/put.md/put) — full replacement
+- [Dynamic path placeholders](#docs/_misc/dynamic-path.md/dynamic-path)