@supersoniks/concorde 4.6.0 → 4.7.0

package/src/docs/_core-concept/subscriber.md

@@ -1,12 +1,14 @@
-# The subscriber mixin
+# Legacy: Subscriber mixin
 
-This is a mixin that is commonly extended by Concorde core components and destination components. Pure UI components usually don't extend it, especially those outside of form components.
+> **New app components:** [My first component](#docs/_getting-started/my-first-component.md/my-first-component) and [Data flow](#docs/_core-concept/dataFlow.md/dataFlow) — extend `LitElement` with decorators (`@subscribe`, `@ancestorAttribute`, …). This mixin remains in **core** components (`sonic-list`, `sonic-fetch`, …) and [legacy tutorials](#docs/_getting-started/my-first-subscriber.md/my-first-subscriber).
+
+The Subscriber mixin was commonly extended by Concorde core components and older destination components. Pure UI components usually don't extend it, especially those outside of form components.
 
 ## DataProvider Attribute: Automatic Filling of Subscriber Properties
 
 Upon being added to the DOM (connectedCallback), subscribers search for the first occurrence of the `dataProvider` attribute in their parent's HTML structure.
 
-The value of this attribute is used to obtain a publisher via the PublisherManager (see [🥨 Sharing Data](#docs/_getting-started/pubsub.md/pubsub)).
+The value of this attribute is the DataProvider path (see [Data flow](#docs/_core-concept/dataFlow.md/dataFlow) and [DataProviderKey](#docs/_misc/dataProviderKey.md/dataProviderKey); legacy API: [Sharing Data](#docs/_getting-started/pubsub.md/pubsub)).
 
 The subscriber then subscribes to the publisher as a data template to be filled.
 
@@ -51,14 +53,11 @@ Suppose that:
 </sonic-code>
 - We want to keep the display of an image and its `title` attribute up to date, as well as a "contact" button to email the person in the photo. The content of the subscriber could be as follows:
 
-<sonic-code language="html">
-  <template>
-<img data-bind ::src="$img.avatar" ::title="ucFirst|$img.caption" />
-<a data-bind ::href="mailto:$email" ::inner-html="$email"></a>
-  </template>
-</sonic-code>
+In a **Lit** app, use the same data with [data configuration](#docs/_getting-started/my-first-component.md/my-first-component) (`@subscribe` + `DataProviderKey`) on a small row component — see `docs-user` in `src/docs/example/users.ts`.
+
+For **HTML-only** embedding (no Lit), attribute binding is described in [HTML integration](#docs/_misc/html-integration.md/html-integration) and in the Legacy [Subscriber mixin](#docs/_core-concept/subscriber.md/subscriber) pages.
 
-This example also illustrates:
+This pattern also illustrates:
 
 - Binding to subproperties using dot syntax, as done for the `src` attribute of the `img` tag.
 - Using a simple expression to include the property within a string, as in creating a `mailto` link.

package/src/docs/_decorators/ancestor-attribute.md

@@ -25,15 +25,15 @@ The component reads `dataProvider` and `testAttribute` from its ancestor wrapper
 import { html, LitElement } from "lit";
 import { customElement } from "lit/decorators.js";
 import { ancestorAttribute } from "@supersoniks/concorde/decorators";
-//
+
 @customElement("demo-ancestor-attribute")
 export class DemoAncestorAttribute extends LitElement {
   @ancestorAttribute("dataProvider")
   dataProvider: string | null = null;
-//
+
   @ancestorAttribute("testAttribute")
   testAttribute: string | null = null;
-//
+
   render() {
     return html`
       <section>
@@ -49,6 +49,7 @@ export class DemoAncestorAttribute extends LitElement {
 <sonic-code>
   <template>
 <div dataProvider="demoDataProvider" testAttribute="test-value-123">
+  <docs-demo-sources for="demo-ancestor-attribute"></docs-demo-sources>
   <demo-ancestor-attribute></demo-ancestor-attribute>
 </div>
   </template>

package/src/docs/_decorators/auto-subscribe.md

@@ -1,5 +1,7 @@
 # @autoSubscribe
 
+> **Legacy:** prefer [@subscribe](#docs/_decorators/subscribe.md/subscribe) + `DataProviderKey`. Examples below may still show `PublisherManager` for existing codebases.
+
 The `@autoSubscribe` decorator automatically detects which publishers are accessed within a method and subscribes to them. When any of these publishers change, the method is automatically re-executed.
 
 ## Principle
@@ -24,10 +26,10 @@ import { autoSubscribe } from "@supersoniks/concorde/decorators";
 @customElement("demo-auto-subscribe")
 export class DemoAutoSubscribe extends LitElement {
   static styles = [tailwind];
-  //
+
   @state() displayText: string = "";
   @state() computedValue: number = 0;
-  //
+
   @autoSubscribe()
   updateDisplay() {
     const value1 = PublisherManager.get("autoValue1").get() || 0;
@@ -35,7 +37,7 @@ export class DemoAutoSubscribe extends LitElement {
     this.computedValue = value1 + value2;
     this.displayText = `${value1} + ${value2} = ${this.computedValue}`;
   }
-  //
+
   render() {
     return html`
       <p><strong>${this.displayText}</strong></p>
@@ -49,7 +51,7 @@ export class DemoAutoSubscribe extends LitElement {
       </div>
     `;
   }
-  //
+
   randomizeValue(publisherId: string) {
     const value = PublisherManager.get(publisherId);
     value.set(Math.floor(Math.random() * 100));
@@ -61,6 +63,7 @@ export class DemoAutoSubscribe extends LitElement {
 
 <sonic-code >
   <template>
+    <docs-demo-sources for="demo-auto-subscribe"></docs-demo-sources>
     <demo-auto-subscribe></demo-auto-subscribe>
   </template>
 </sonic-code>
@@ -75,12 +78,12 @@ export class ReactiveView extends LitElement {
   render() {
     const data = PublisherManager.get("myData");
     const config = PublisherManager.get("config");
-    //
+
     // This render method will be automatically re-executed
     // when myData or config change
     const value = data.get()?.value || 0;
     const multiplier = config.get()?.multiplier || 1;
-    //
+
     return html`
       <div>
         <h1>Result: ${value * multiplier}</h1>
@@ -125,40 +128,40 @@ import { html, LitElement } from "lit";
 import { customElement } from "lit/decorators.js";
 import { autoSubscribe } from "@supersoniks/concorde/decorators";
 import { PublisherManager } from "@supersoniks/concorde/core/utils/PublisherProxy";
-//
+
 @customElement("shopping-cart")
 export class ShoppingCart extends LitElement {
   items: any[] = [];
   total: number = 0;
   discount: number = 0;
-  //
+
   @autoSubscribe()
   calculateTotal() {
     const cart = PublisherManager.get("cart");
     const promo = PublisherManager.get("promo");
-    //
+
     // Access cart items
     this.items = cart.items.get() || [];
-    //
+
     // Access promo code
     const promoCode = promo.code.get() || "";
     const discountPercent = promoCode === "SAVE10" ? 0.1 : 0;
-    //
+
     // Calculate totals
     const subtotal = this.items.reduce((sum, item) => 
       sum + (item.price * item.quantity), 0
     );
     this.discount = subtotal * discountPercent;
     this.total = subtotal - this.discount;
-    //
+
     this.requestUpdate();
   }
-  //
+
   connectedCallback() {
     super.connectedCallback();
     this.calculateTotal();
   }
-  //
+
   render() {
     return html`
       <div class="cart">
@@ -175,14 +178,14 @@ export class ShoppingCart extends LitElement {
     `;
   }
 }
-//
+
 // When you update the publishers, calculateTotal is automatically called:
 const cart = PublisherManager.get("cart");
 cart.items.set([
   { name: "Product 1", price: 10, quantity: 2 },
   { name: "Product 2", price: 15, quantity: 1 }
 ]);
-//
+
 const promo = PublisherManager.get("promo");
 promo.code.set("SAVE10");
 // calculateTotal will be automatically called and the UI will update

package/src/docs/_decorators/bind.md

@@ -8,7 +8,7 @@ For Lit re-renders, also add `@state()` on the same property.
 
 ## Principle
 
-The decorator subscribes via `PublisherManager` using dot notation. Publisher updates flow into the decorated property.
+The decorator subscribes to the DataProvider store using dot notation or a `DataProviderKey`. Updates flow into the decorated property ([Data flow](#docs/_core-concept/dataFlow.md/dataFlow)).
 
 ## Import
 
@@ -25,26 +25,26 @@ import { bind } from "@supersoniks/concorde/decorators";
 @customElement("demo-bind")
 export class DemoBind extends LitElement {
   static styles = [tailwind];
-  //
+
   @bind("demoData.firstName")
   @state()
   firstName = "";
-  //
+
   @bind("demoData.lastName")
   @state()
   lastName: string = "";
-  //
+
   @bind("demoData.count")
   @state()
   count: number = 0;
-  //
+
   render() {
     return //......
   }
-  //
+
   updateData() {
-    const demoData = PublisherManager.get("demoData");
-    const demoUsers = PublisherManager.get("demoUsers");
+    set(demoDataKey, { ...get(demoDataKey), count: get(demoDataKey).count + 1 });
+    // see demo-bind in src/docs/example/decorators-demo-bind-demos.ts
     const randomIndex = Math.floor(Math.random() * demoUsers.get().length);
     const randomUser = demoUsers.get()[randomIndex];
     demoData.set({
@@ -54,12 +54,13 @@ export class DemoBind extends LitElement {
     });
   }
 }
-//
+
 </template>
 </sonic-code>
 
 <sonic-code>
   <template>
+    <docs-demo-sources for="demo-bind"></docs-demo-sources>
     <demo-bind></demo-bind>
   </template>
 </sonic-code>
@@ -72,10 +73,10 @@ export class DemoBind extends LitElement {
   <template>
 import { bind } from "@supersoniks/concorde/decorators";
 import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
-//
+
 type Data = { count: number };
 const dataKey = new DataProviderKey<Data>("data");
-//
+
 @bind(dataKey.count, { reflect: true })
 @state()
 count: number = 0;
@@ -99,15 +100,15 @@ avatar: string;
 @customElement("demo-bind-reflect")
 export class DemoBindReflect extends LitElement {
   static styles = [tailwind];
-//
+
   @bind("bindReflectDemo.count", { reflect: true })
   @state()
   withReflect: number = 0;
-//
+
   @bind("bindReflectDemo.count")
   @state()
   withoutReflect: number = 0;
-//
+
   render() {
     return html`
       <div class="mb-3">
@@ -124,13 +125,14 @@ export class DemoBindReflect extends LitElement {
     `;
   }
 }
-//
+
 </template>
 </sonic-code>
 
 <sonic-code toggleCode>
   <template>
-<demo-bind-reflect></demo-bind-reflect>
+    <docs-demo-sources for="demo-bind-reflect"></docs-demo-sources>
+    <demo-bind-reflect></demo-bind-reflect>
   </template>
 </sonic-code>
 
@@ -148,6 +150,7 @@ Use `${prop}` or `${this.prop}` inside a **normal string literal** (not a JS tem
 
 <sonic-code>
   <template>
+    <docs-demo-sources for="demo-bind-dynamic"></docs-demo-sources>
     <demo-bind-dynamic></demo-bind-dynamic>
   </template>
 </sonic-code>

package/src/docs/_decorators/get.md

@@ -7,7 +7,7 @@ Pass an [`Endpoint<T>`](#docs/_misc/endpoint.md/endpoint) as the first argument.
 ## Configuration
 
 - **Default:** `HTML.getApiConfiguration(host)` (ancestor `serviceURL`, etc.).
-- **Second argument:** `DataProviderKey<APIConfiguration>` — config is read from the publisher at the resolved path; internal mutations trigger another GET.
+- **Second argument:** `DataProviderKey<APIConfiguration>` — config is read from the publisher at the resolved path; internal mutations trigger another GET. See [API configuration](#docs/_misc/api-configuration.md/api-configuration) for mock demos.
 
 ## When the GET runs again
 
@@ -26,7 +26,7 @@ import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
 
 ## Minimal example
 
-Same demo service as [`sonic-queue`](../../core/components/functional/queue/queue.demo.ts) (`geo.api.gouv.fr`). Publisher setup lives in `decorators-demo-geo.ts` and `decorators-demo-subscribe-publish-get-demos.ts`.
+Same demo service as [`sonic-queue`](../../core/components/functional/queue/queue.demo.ts) (`/docs-mock-api/geo/`). Publisher setup lives in `decorators-demo-geo.ts` and `decorators-demo-subscribe-publish-get-demos.ts`.
 
 <sonic-code language="typescript">
   <template>
@@ -40,6 +40,7 @@ payload: ApiGetResult<User> | null = null;
 
 <sonic-code>
   <template>
+    <docs-demo-sources for="demo-api-get"></docs-demo-sources>
     <demo-api-get></demo-api-get>
   </template>
 </sonic-code>
@@ -48,15 +49,17 @@ Dynamic config and endpoint path (`demo-api-get-configuration-key` in doc source
 
 <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>
 
-Scoped `@get` with `@publish` / `@subscribe` on the payload (see [@publish](#docs/_decorators/publish.md/publish) and [@subscribe](#docs/_decorators/subscribe.md/subscribe)) — wrap under an ancestor with `serviceURL="https://geo.api.gouv.fr/"`:
+Scoped `@get` with `@publish` / `@subscribe` on the payload (see [@publish](#docs/_decorators/publish.md/publish) and [@subscribe](#docs/_decorators/subscribe.md/subscribe)) — wrap under an ancestor with `serviceURL="/docs-mock-api/geo/"`:
 
 <sonic-code>
   <template>
-<div serviceURL="https://geo.api.gouv.fr/">
+<div serviceURL="/docs-mock-api/geo/">
+  <docs-demo-sources for="demo-api-get-publish-subscribe"></docs-demo-sources>
   <demo-api-get-publish-subscribe></demo-api-get-publish-subscribe>
 </div>
   </template>

package/src/docs/_decorators/handle.md

@@ -12,6 +12,7 @@ By default the method is called on **every** assignment, even when the value is
   <template>
 import { handle, Skip } from "@supersoniks/concorde/decorators";
 import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
+import { get, set } from "@supersoniks/concorde/utils";
   </template>
 </sonic-code>
 
@@ -21,24 +22,23 @@ import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
   <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 publisher = PublisherManager.get("demoData");
-    const data = publisher.get() as DemoCounterData;
-    publisher.set({ ...data, count: data.count + 1 });
+    const data = get(demoDataKey);
+    set(demoDataKey, { ...data, count: data.count + 1 });
   }
-  //
+
   render() {
     return html`
       &lt;p&gt;Doubled count: ${this.doubled}&lt;/p&gt;
@@ -52,6 +52,7 @@ export class DemoHandle extends LitElement {
 
 <sonic-code>
   <template>
+    <docs-demo-sources for="demo-handle"></docs-demo-sources>
     <demo-handle></demo-handle>
   </template>
 </sonic-code>
@@ -63,21 +64,21 @@ Placeholders in `DataProviderKey` resolve from the host component’s properties
 <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`...`;
   }
@@ -87,6 +88,7 @@ export class DemoHandleDynamic extends LitElement {
 
 <sonic-code>
   <template>
+    <docs-demo-sources for="demo-handle-dynamic"></docs-demo-sources>
     <demo-handle-dynamic></demo-handle-dynamic>
   </template>
 </sonic-code>
@@ -100,10 +102,10 @@ export class DemoHandleDynamic extends LitElement {
 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) {