@supersoniks/concorde 5.1.0 → 5.1.2

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

@@ -1,75 +0,0 @@
-# Legacy: Subscriber mixin
-
-> **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 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.
-
-The reactive properties of the component reflect in real-time the properties with the same name in the publisher.
-
-This functionality is commonly used in the generic components [fetch](#core/components/functional/fetch/fetch.md/fetch), [queue](#core/components/functional/queue/queue.md/queue), and [list](#core/components/functional/list/list.md/list).
-
-If the subscriber is inside another subscriber, it can subscribe to a data of its parent using the attribute `subDataProvider = 'address.of.my.data'` instead of the parent's data. This allows for dynamic behavior.
-
-## Automated Translation
-
-In a similar manner, searching for ancestor attributes can be used to configure automatic translation for any property starting with "wording" and ending with a label identifier recognized by the wordingProvider API.
-
-Normally, this API is globally configured and not within the component. Therefore, remember to prefix translatable label identifiers present in the ticketing system, for example, with "wording".
-
-## Reactive Property `props`
-
-The value of this property can be provided as a JSON object or any other value. This value is then assigned to the associated publisher via the `dataProvider` attribute. As a result, the reactive properties of all subscribers associated with the same `dataProvider` are filled as mentioned above.
-
-## Disabling Automatic Filling of Reactive Properties
-
-It is possible to disable the automatic filling of reactive properties in a particular component. To do so, set the variable `noAutoFill = true` in the component's class. However, the reactive property `props` will still be updated.
-
-For example, `sonic-subscriber` and `sonic-fetch` have this attribute because they do not have reactive properties.
-
-**☢ CAUTION:** When creating an object of type Subscriber or Fetcher, make sure to use the mixins and not directly extend the concrete fetch component (`sonic-fetch`) and subscriber component (`sonic-subscriber`). This is because the `noAutofill = true` attribute is set in those components.
-
-**TIPS:** 
-If you disable automatic filling, you will likely make the rendering dynamic by writing expressions like `this.props.my.subproperty`. If `props` is updated, the rendering will be triggered. However, if `this.props.my.subproperty` is directly modified, the rendering will not be triggered. To achieve more reactivity, you can enable rendering when any subproperty is modified. Simply set the variable `renderOnPropsInternalChange = true` in the class that implements the corresponding mixin.
-
-## Data Binding
-
-Suppose that:
-
-- You have a subscriber subscribed to a publisher via its `dataProvider` attribute.
-- The published data has the following structure:
-
-<sonic-code language="javascript">
-  <template>
-    {"img": { "avatar": "my-avatar.jpg", "caption": "look at my smile" }, "email": "an.email@example.com" }
-  </template>
-</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:
-
-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 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.
-- Using formatting functions, as in the `title` attribute of the `img` tag. You can find (and add) formatting functions in the `core/utils/Format.ts` file.
-- Writing for properties that are in camel case. Convert everything to lowercase and add hyphens. Note that `innerHTML` (or `outerHTML`) is a special case where no hyphens are added between each letter.
-
-**Note:** Data binding implies that updating the `img.src` data via the publisher will change the photo without any additional calls.
-
-**Special Variables:**
-- `_self_` targets the root of the data. This is useful, for example, when the data is a pure string.
-- `_parent_` targets the parent publisher of the current publisher, if any. For example, the subscribers of lists have the complete data of the list as their parent.
-- `_metadata_` is only used in the case of *sonic-list* at the moment. In a simple list, `_metadata_` see the (list)[] component for further details
-
-**Disabling this functionality:**
-You can disable data binding if it is not needed by calling `DataBinding.disable()`.

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

@@ -1,127 +0,0 @@
-# @ancestorAttribute
-
-The `@ancestorAttribute` decorator automatically injects the value of an ancestor's attribute into a class property at the time of `connectedCallback`.
-
-## Principle
-
-This decorator uses `HTML.getAncestorAttributeValue` to traverse up the DOM tree from the current element and find the first ancestor that has the specified attribute. The value of this attribute is then assigned to the decorated property.
-
-## Usage
-
-### Import
-
-<sonic-code language="typescript">
-  <template>
-import { ancestorAttribute } from "@supersoniks/concorde/decorators";
-  </template>
-</sonic-code>
-
-### Basic example
-
-The component reads `dataProvider` and `testAttribute` from its ancestor wrapper. By default (`dynamic: false`), values are read once at connect.
-
-<sonic-code language="typescript">
-  <template>
-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`
-      <p>dataProvider: <strong>${this.dataProvider ?? "null"}</strong></p>
-      <p>testAttribute: <strong>${this.testAttribute ?? "null"}</strong></p>
-    `;
-  }
-}
-  </template>
-</sonic-code>
-
-<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>
-</sonic-code>
-
-## Use cases
-
-This decorator is particularly useful for:
-
-- **Retrieving the `dataProvider`** from an ancestor without having to pass it explicitly
-- **Retrieving the `formDataProvider`** in form components
-- **Retrieving the `wordingProvider`** for translation
-- **Retrieving any other attribute** defined on an ancestor
-
-## Behavior
-
-- The search starts from the current element and traverses up the DOM tree
-- The injection happens automatically at the time of `connectedCallback`
-- By default (`dynamic: false`), the value is read once at connect time and is not updated afterward
-- With `{ dynamic: true }`, the property stays in sync when:
-  - an ancestor **changes** the attribute value
-  - a **closer** ancestor **gains** the attribute (that value wins)
-  - the **nearest** ancestor **loses** the attribute (falls back to the next one up, or `null`)
-- When `dynamic` is enabled, updates also propagate to `@subscribe` / `@bind` paths that depend on the decorated property (e.g. `${dataProvider}`)
-
-### Dynamic mode
-
-Use `{ dynamic: true }` when the decorated property must follow the DOM. With Lit, add **`@state()`** on the same property so template updates are visible when the observer assigns a new value.
-
-The live demo below shows only the resolved attribute value — no store, no reparenting.
-
-<sonic-code language="typescript">
-  <template>
-@customElement("demo-ancestor-attribute-dynamic")
-export class DemoAncestorAttributeDynamic extends LitElement {
-  @ancestorAttribute("dataProvider", { dynamic: true })
-  @state()
-  dataProvider: string | null = null;
-
-  render() {
-    return html`
-      &lt;p&gt;Nearest ancestor: &lt;strong&gt;${this.dataProvider ?? "null"}&lt;/strong&gt;&lt;/p&gt;
-    `;
-  }
-}
-  </template>
-</sonic-code>
-
-Try in the demo:
-
-- **parent-a** / **parent-b** — change the value on the direct parent
-- **Remove parent attr** — falls back to **outer**
-- **Add closer** — a wrapper with `from-closer` becomes the nearest ancestor
-- **Remove closer** — back to parent or outer
-- **Remove outer attr** — if parent has no attribute either, the child shows `null`
-
-<sonic-code>
-  <template>
-    <docs-demo-sources for="demo-ancestor-attribute-dynamic-section"></docs-demo-sources>
-    <demo-ancestor-attribute-dynamic-section></demo-ancestor-attribute-dynamic-section>
-  </template>
-</sonic-code>
-
-Static mode (default) — read once at connect, no observer:
-
-<sonic-code language="typescript">
-  <template>
-@ancestorAttribute("dataProvider")
-dataProvider: string | null = null;
-  </template>
-</sonic-code>
-
-## Notes
-
-- This decorator works with any component that has a `connectedCallback` method (such as `LitElement` or components extending `Subscriber`)
-- The search also traverses Shadow DOM if necessary
-- If multiple ancestors have the attribute, the closest one will be used

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

@@ -1,202 +0,0 @@
-# @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
-
-This decorator wraps a method to track which publishers are accessed during its execution. It then subscribes to all accessed publishers, and when any of them change, the method is re-executed. This provides automatic reactivity without manually managing subscriptions.
-
-## Usage
-
-### Import
-
-<sonic-code language="typescript">
-  <template>
-import { autoSubscribe } from "@supersoniks/concorde/decorators";
-  </template>
-</sonic-code>
-
-### Basic example
-
-
-<sonic-code language="typescript">
-<template>
-@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;
-    const value2 = PublisherManager.get("autoValue2").get() || 0;
-    this.computedValue = value1 + value2;
-    this.displayText = `${value1} + ${value2} = ${this.computedValue}`;
-  }
-
-  render() {
-    return html`
-      <p><strong>${this.displayText}</strong></p>
-      <div>
-        <sonic-button @click=${() => this.randomizeValue("autoValue1")}>
-          Randomize Value 1
-        </sonic-button>
-        <sonic-button @click=${() => this.randomizeValue("autoValue2")}>
-          Randomize Value 2
-        </sonic-button>
-      </div>
-    `;
-  }
-
-  randomizeValue(publisherId: string) {
-    const value = PublisherManager.get(publisherId);
-    value.set(Math.floor(Math.random() * 100));
-  }
-}
-</template>
-</sonic-code>
-
-
-<sonic-code >
-  <template>
-    <docs-demo-sources for="demo-auto-subscribe"></docs-demo-sources>
-    <demo-auto-subscribe></demo-auto-subscribe>
-  </template>
-</sonic-code>
-
-### Example with render method
-
-<sonic-code language="typescript">
-  <template>
-@customElement("reactive-view")
-export class ReactiveView extends LitElement {
-  @autoSubscribe()
-  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>
-        <p>Value: ${value}</p>
-        <p>Multiplier: ${multiplier}</p>
-      </div>
-    `;
-  }
-}
-  </template>
-</sonic-code>
-
-## How it works
-
-1. **First execution**: When the method is called, `PublisherManager.collectModifiedPublisher()` is used to track which publishers are accessed
-2. **Subscription**: After execution, the decorator subscribes to all detected publishers
-3. **Re-execution**: When any subscribed publisher changes, the method is automatically called again
-4. **Cleanup**: On `disconnectedCallback`, all subscriptions are automatically removed
-
-## Behavior
-
-- The method is automatically called on `connectedCallback`
-- The method is re-executed whenever any accessed publisher changes
-- Subscriptions are managed automatically (no manual cleanup needed)
-- Only publishers accessed during method execution are subscribed to
-- The decorator uses `queueMicrotask` to batch multiple updates and avoid unnecessary re-renders
-
-## Use cases
-
-This decorator is particularly useful for:
-
-- **Reactive rendering** where the render method depends on multiple publishers
-- **Data transformation** that needs to update when source data changes
-- **Computed properties** that depend on multiple data sources
-- **Automatic synchronization** between publishers and component state
-
-## Complete example
-
-<sonic-code language="typescript">
-  <template>
-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">
-        <h2>Shopping Cart</h2>
-        ${this.items.map(item => html`
-          <div>${item.name} x${item.quantity} - ${item.price}€</div>
-        `)}
-        <div class="total">
-          <p>Subtotal: ${this.total + this.discount}€</p>
-          <p>Discount: -${this.discount}€</p>
-          <p><strong>Total: ${this.total}€</strong></p>
-        </div>
-      </div>
-    `;
-  }
-}
-
-// 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
-  </template>
-</sonic-code>
-
-## Notes
-
-- This decorator works with any component that has `connectedCallback` and `disconnectedCallback` methods (such as `LitElement` or components extending `Subscriber`)
-- The method is called automatically on `connectedCallback`
-- Remember to call `this.requestUpdate()` if you're updating component properties
-- The decorator uses debouncing via `queueMicrotask` to prevent excessive re-executions
-- For more information about publishers, see the documentation on [Sharing data](#docs/_getting-started/pubsub.md/pubsub)
-

package/docs/src/docs/_decorators/bind.md

@@ -1,167 +0,0 @@
-# @bind
-
-Binds a class property to a path in a publisher. The property updates when publisher data changes.
-
-For Lit re-renders, also add `@state()` on the same property.
-
-**See also:** [@subscribe](#docs/_decorators/subscribe.md/subscribe), [@handle](#docs/_decorators/handle.md/handle), [@publish](#docs/_decorators/publish.md/publish), [@get](#docs/_decorators/get.md/get), [@post](#docs/_decorators/post.md/post), [@put](#docs/_decorators/put.md/put), [@patch](#docs/_decorators/patch.md/patch).
-
-## Principle
-
-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
-
-<sonic-code language="typescript">
-  <template>
-import { bind } from "@supersoniks/concorde/decorators";
-  </template>
-</sonic-code>
-
-## Example
-
-<sonic-code language="typescript">
-<template>
-@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() {
-    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({
-      firstName: randomUser.firstName,
-      lastName: randomUser.lastName,
-      count: (demoData.count.get() || 0) + 1,
-    });
-  }
-}
-
-</template>
-</sonic-code>
-
-<sonic-code>
-  <template>
-    <docs-demo-sources for="demo-bind"></docs-demo-sources>
-    <demo-bind></demo-bind>
-  </template>
-</sonic-code>
-
-## `DataProviderKey` (strict typing)
-
-`@bind` accepts either a string path (legacy) or a `DataProviderKey<T>`. The property type must match `T`. Use `reflect: true` to push local writes back to the publisher (see below). See [DataProviderKey](#docs/_misc/dataProviderKey.md/dataProviderKey).
-
-<sonic-code language="typescript">
-  <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;
-  </template>
-</sonic-code>
-
-## Reflect (`reflect: true`)
-
-Two-way sync: reads from the publisher and local assignments call `publisher.set(...)`. An internal guard avoids infinite loops.
-
-<sonic-code language="typescript">
-  <template>
-@bind("userData.profile.avatarUrl", { reflect: true })
-@state()
-avatar: string;
-  </template>
-</sonic-code>
-
-<sonic-code language="typescript">
-  <template>
-@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">
-        from publisher : ${sub("bindReflectDemo.count") || 0} <br />
-        from component with reflect : ${this.withReflect || 0} <br />
-        from component without reflect : ${this.withoutReflect || 0}
-      </div>
-      <sonic-button @click=${() => this.withReflect++}
-        >Increment with reflect</sonic-button
-      >
-      <sonic-button @click=${() => this.withoutReflect++}
-        >Increment without reflect</sonic-button
-      >
-    `;
-  }
-}
-
-</template>
-</sonic-code>
-
-<sonic-code toggleCode>
-  <template>
-    <docs-demo-sources for="demo-bind-reflect"></docs-demo-sources>
-    <demo-bind-reflect></demo-bind-reflect>
-  </template>
-</sonic-code>
-
-## Path syntax
-
-- First segment: data provider id.
-- Nested properties: dot notation.
-- Arrays: numeric index (`items.0`).
-
-### Dynamic paths
-
-Use `${prop}` or `${this.prop}` inside a **normal string literal** (not a JS template literal with backticks). `@bind` re-subscribes when a reactive dependency changes. While a placeholder is `null`/`undefined`, the bind is inactive; optional `{ skipEmptyPlaceholder: true }` also waits on `""`. See [Dynamic path placeholders](#docs/_misc/dynamic-path.md/dynamic-path).
-
-> Properties referenced in the pattern must be reactive (`@property`, etc.) or you must call `requestUpdate` manually.
-
-<sonic-code>
-  <template>
-    <docs-demo-sources for="demo-bind-dynamic"></docs-demo-sources>
-    <demo-bind-dynamic></demo-bind-dynamic>
-  </template>
-</sonic-code>
-
-## Behavior
-
-- Subscribes at `connectedCallback`, unsubscribes at `disconnectedCallback`.
-- If the path does not exist yet, a publisher may be created with `null`.
-
-## Notes
-
-Works with any component that has the usual DOM lifecycle (`LitElement`, `Subscriber` mixin, etc.).
-
-Shared data: [Sharing data](#docs/_getting-started/pubsub.md/pubsub).