rasti 4.1.3 → 4.2.0

package/README.md

@@ -1,7 +1,7 @@
 <p align="center">
     <picture>
-        <source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/gh/8tentaculos/rasti@v4.1.3/docs/logo-dark.svg">
-        <img alt="Rasti.js" src="https://cdn.jsdelivr.net/gh/8tentaculos/rasti@v4.1.3/docs/logo.svg" height="120">
+        <source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/gh/8tentaculos/rasti@v4.2.0/docs/logo-dark.svg">
+        <img alt="Rasti.js" src="https://cdn.jsdelivr.net/gh/8tentaculos/rasti@v4.2.0/docs/logo.svg" height="120">
     </picture>
 </p>
 
@@ -115,10 +115,11 @@ const Link = Component.create`
 `;
 
 // Create a Navigation component that renders Link components for each route.
+// `html` builds a partial: a sub-template for lists and conditional blocks.
 const Navigation = Component.create`
     <nav>
-        ${({ props, partial }) => props.routes.map(
-            ({ label, href }) => partial`<${Link} href="${href}">${label}</${Link}>`
+        ${({ props, html }) => props.routes.map(
+            ({ label, href }) => html`<${Link} href="${href}">${label}</${Link}>`
         )}
     </nav>
 `;
@@ -253,13 +254,13 @@ type CardComponent = Component<CardProps>;
 
 const Card = Component.create<CardProps>`
     <div class="card">
-        <h2>${(({ props }) => props.title) satisfies RenderExpression<CardComponent>}</h2>
-        ${(({ props }) => props.renderChildren?.()) satisfies RenderExpression<CardComponent>}
+        <h2>${({ props }: CardComponent) => props.title}</h2>
+        ${({ props }: CardComponent) => props.renderChildren?.()}
     </div>
 `;
 ```
 
-The interpolations are typed with `satisfies` (see [Typing template interpolations](#typing-template-interpolations)).
+The interpolations are typed by annotating their parameter with the component type (see [Typing template interpolations](#typing-template-interpolations)).
 
 `Component.extend` adds the object members to the instance type. Inside its methods, `this` is the extended component, and lifecycle overrides get their parameters typed automatically:
 
@@ -347,15 +348,15 @@ type S = ComponentState<Counter>;
 
 ### Typing template interpolations
 
-Functions inside a template are `any` — rasti can't infer them from the surrounding string. Type each one inline with `satisfies` and the helper that matches how rasti treats it. `satisfies` types the function's parameters and `this` from the helper, and checks the function against it.
+Functions inside a template are `any` — rasti can't infer them from the surrounding string. How to type one depends on what rasti calls it with, and that depends on where it sits in the template.
 
 > Under `strict` / `noImplicitAny`, an untyped interpolation callback is an error (TS7031/TS7006), not a silent `any`. In non-strict mode typing is opt-in.
 
-| Interpolation | What it is | Type to use |
+| Interpolation | Called with | Type it with |
 |---|---|---|
-| Content `${fn}` or quoted attr `attr="${fn}"` | Run on render; `this` and the argument are the component | `RenderExpression<C>` |
-| Unquoted `onX=${fn}` | DOM handler, called `(event, component, matched)` | `EventHandler<C, E>` |
-| Function passed to a child (`handler=${fn}`) | Becomes the child's prop; typed by the child, not this component | the child's prop signature |
+| Content `${fn}` or quoted attr `attr="${fn}"` | The component, as its argument and as `this` | An arrow annotated with the component type: `({ props }: C) => …` |
+| Unquoted `onX=${fn}` | `(event, component, matched)`, with `this` the component | `satisfies EventHandler<C, E>` |
+| Function passed to a child (`handler=${fn}`) | Whatever the child calls it with | `satisfies ChildProps['handler']` |
 
 The component type `C` is `Component<P, S, M>` with the same generics passed to `create`, aliased next to the component. It is not a copy: it is the exact type of the component's instances.
 
@@ -367,7 +368,7 @@ type ToggleComponent = Component<ToggleProps, ToggleState>;
 
 const Toggle = Component.create<ToggleProps, ToggleState>`
     <button onClick=${(function() { this.state!.active = !this.state!.active; }) satisfies EventHandler<ToggleComponent, MouseEvent>}>
-        ${(({ props, state }) => `${props.label}: ${state!.active ? 'on' : 'off'}`) satisfies RenderExpression<ToggleComponent>}
+        ${({ props, state }: ToggleComponent) => `${props.label}: ${state!.active ? 'on' : 'off'}`}
     </button>
 `.extend({
     onCreate() { this.state = new ToggleState({ active: false }); }
@@ -376,10 +377,20 @@ const Toggle = Component.create<ToggleProps, ToggleState>`
 
 Inside its own template, a component can't use `InstanceType<typeof Toggle>`: the type of `Toggle` depends on the template itself, so TypeScript reports a circular reference (TS7022).
 
-In an arrow function, annotating the parameter is a lighter alternative. It types the argument but not `this`, so a `function` still needs `satisfies`:
+**Content and quoted attributes** receive the component as their argument, so annotating the parameter types everything they read. A `function` that reads `this` instead needs `satisfies RenderExpression<C>`, which types `this` as well:
 
 ```ts
-${({ props, state }: ToggleComponent) => `${props.label}: ${state!.active ? 'on' : 'off'}`}
+${(function() { return this.props.label; }) satisfies RenderExpression<ToggleComponent>}
+```
+
+**Unquoted handlers** receive the event first, not the component. An annotated parameter still compiles there, since the template's expressions are `any`, and fails at runtime. `satisfies` checks the function against what rasti passes it:
+
+```ts
+// Compiles, but the argument is the MouseEvent: `props` is undefined at runtime.
+onClick=${({ props }: ToggleComponent) => console.log(props.label)}
+
+// Rejected (TS2339): `props` does not exist on `MouseEvent`.
+onClick=${(({ props }) => console.log(props.label)) satisfies EventHandler<ToggleComponent, MouseEvent>}
 ```
 
 #### Templates that call the component's own methods
@@ -391,7 +402,7 @@ interface ListProps { items: string[]; handleSelect: (item: string) => void; }
 
 class ListBase extends Component<ListProps> {
     renderItems() {
-        return this.props.items.map((item) => this.partial`<li>${item}</li>`);
+        return this.props.items.map((item) => this.html`<li>${item}</li>`);
     }
     select(ev: MouseEvent) {
         const li = (ev.target as HTMLElement).closest('li');
@@ -401,7 +412,7 @@ class ListBase extends Component<ListProps> {
 
 const List = ListBase.create`
     <ul onClick=${(function(ev) { this.select(ev); }) satisfies EventHandler<ListBase, MouseEvent>}>
-        ${((self) => self.renderItems()) satisfies RenderExpression<ListBase>}
+        ${(self: ListBase) => self.renderItems()}
     </ul>
 `;
 
@@ -417,9 +428,18 @@ For a function passed to a child, neither helper fits — its type comes from th
 handleChange=${((checked) => model.toggleAll(checked)) satisfies ToggleAllProps['handleChange']}
 ```
 
+A quoted value is the result of a function the parent runs, so what reaches the child is what that function returns. Annotate its return type with the child's prop: that checks the value, and it types the parameters of a callback returned by a thunk, which would otherwise be an implicit `any` (TS7006):
+
+```ts
+// where the child was created with Component.create<HeaderProps>`...`
+handleAddTodo="${({ model }: AppComponent): HeaderProps['handleAddTodo'] => (title) => model!.addTodo(title)}"
+```
+
+`satisfies` on the returned callback does the same, `({ model }: AppComponent) => ((title) => model!.addTodo(title)) satisfies HeaderProps['handleAddTodo']`; the return type keeps the whole contract in the signature.
+
 ### Known limitations
 
-- **Template interpolation callbacks are `any`**. Functions in ``Component.create`...` `` templates can't be inferred from the surrounding string — type them with `satisfies` (see [Typing template interpolations](#typing-template-interpolations)).
+- **Template interpolation callbacks are `any`**. Functions in ``Component.create`...` `` templates can't be inferred from the surrounding string — type them by where they sit in the template (see [Typing template interpolations](#typing-template-interpolations)).
 - **A component can't name its own type in its template**. `InstanceType<typeof X>` is circular there (TS7022). Use `Component<P, S, M>` (see [Typing template interpolations](#typing-template-interpolations)), or the class `create` is called on when the template calls its methods (see [Templates that call the component's own methods](#templates-that-call-the-components-own-methods)).
 - **`Model<A>` instance keys require declaration merging**. TypeScript can't add `A`'s keys to a `class extends Model<A>` automatically — see the `interface Todo extends TodoAttrs {}` pattern above.
 - **`this.$()` can return `null`**. It mirrors `querySelector`, so handle the empty case (`?.`) and pass a type argument to narrow the element: `this.$<HTMLInputElement>('input.edit')?.focus()`. `this.$$()` returns a `NodeListOf<HTMLElement>` (also narrowable).

package/dist/rasti.js

@@ -2445,6 +2445,8 @@
             this.options = options;
             // Bind `partial` method to `this`.
             this.partial = this.partial.bind(this);
+            // Expose `partial` as `html`, unless a subclass defines its own `html`.
+            if (!('html' in this)) this.html = this.partial;
             // Bind `onChange` method to `this`.
             this.onChange = this.onChange.bind(this);
             // Call lifecycle method.
@@ -2637,7 +2639,7 @@
          * It will return a Partial object that preserves structure for position-based recycling.
          * Components will be added as children by the parent component. Template strings literals 
          * will be marked as safe HTML to be rendered.
-         * This method is bound to the component instance by default.
+         * This method is bound to the component instance by default, and is also available as `this.html`.
          * @param {TemplateStringsArray} strings - Template strings.
          * @param  {...any} expressions - Template expressions.
          * @return {Partial} Partial object containing strings and expressions.
@@ -3192,8 +3194,8 @@
          *   // Create a navigation component. Add buttons as children. Iterate over items.
          *   const Navigation = Component.create`
          *       <nav>
-         *           ${({ props, partial }) => props.items.map(
-         *               item => partial`<${Button}>${item.label}</${Button}>`
+         *           ${({ props, html }) => props.items.map(
+         *               item => html`<${Button}>${item.label}</${Button}>`
          *           )}
          *       </nav>
          *   `;
@@ -3226,7 +3228,7 @@
          *   ```javascript
          *   class ListBase extends Component {
          *       renderItems() {
-         *           return this.props.items.map(item => this.partial`<li>${item}</li>`);
+         *           return this.props.items.map(item => this.html`<li>${item}</li>`);
          *       }
          *   }
          *   const List = ListBase.create`
@@ -3325,6 +3327,7 @@
      * @property {Model} [model] A `Model` or any emitter object containing data and business logic. The component will listen to `change` events and call `onChange` lifecycle method.
      * @property {Model} [state] A `Model` or any emitter object containing data and business logic, to be used as internal state. The component will listen to `change` events and call `onChange` lifecycle method.
      * @property {Model} [props] Automatically created from any options not merged to the component instance. Contains props passed from parent component as a `Model`. The component will listen to `change` events on props and call `onChange` lifecycle method. When a component with a `key` is recycled during parent re-render, new props are automatically updated and any changes trigger a re-render.
+     * @property {Function} html Alias of {@link #module_component__partial partial}, bound to the component instance. Not set when a subclass defines its own `html`.
      * @see {@link #module_component_create Component.create}
      * @example
      * import { Component, Model } from 'rasti';