@ethlete/core 5.0.0-next.6 → 5.0.0-next.61

package/migrations/seo-directive-removed.md

@@ -0,0 +1,80 @@
+# Replace `SeoDirective` with the `apply*Binding` functions
+
+`SeoDirective` and its `SeoConfig` types were removed in `@ethlete/core` v5. The directive wrote to
+`document` directly, so it never worked under server rendering, and it held one config object per
+component, so a child route could only override a parent by re-declaring the whole config.
+
+No codemod can do this rewrite: an Observable value becomes a signal, and one config key becomes one
+function call. Both are decisions about the call site.
+
+## What to change
+
+1. Find every component that injects `SeoDirective` or lists it in `hostDirectives` or `imports`.
+2. Remove the directive from the component.
+3. Replace the `updateConfig({ … })` call with one `apply*Binding` call per key it set.
+4. Turn an Observable value into a signal: `toSignal()` at the edge of the component, or a
+   `computed()` over a signal that is already there.
+5. Import each `apply*Binding` function from `@ethlete/core`.
+
+## The replacement for each key
+
+| `SeoConfig` key              | Replacement                                                   |
+| ---------------------------- | ------------------------------------------------------------- |
+| `title`                      | `applyHeadTitleBinding`                                       |
+| `description`                | `applyDescriptionBinding`                                     |
+| `keywords`                   | `applyKeywordsBinding`                                        |
+| `robots`                     | `applyRobotsBinding` (takes a directive object, not a string) |
+| `icon`                       | `applyLinkBinding({ rel: 'icon', href })`                     |
+| `themeColor` / `colorScheme` | `applyMetaBinding({ name: 'theme-color' \| 'color-scheme' })` |
+| `canonical`                  | `applyCanonicalBinding`                                       |
+| `alternate`                  | `applyAlternateBinding` / `applyAlternateLanguagesBindings`   |
+| `og`                         | `applyOpenGraphBindings`                                      |
+| `twitter`                    | `applyTwitterCardBindings`                                    |
+| `facebook`                   | `applyOpenGraphBindings` (Facebook reads Open Graph)          |
+| any other key                | `applyMetaBinding({ name, content })`                         |
+
+## Example
+
+```ts
+// before
+@Component({ hostDirectives: [SeoDirective] })
+export class ArticleComponent {
+  private seo = inject(SeoDirective);
+
+  constructor() {
+    this.seo.updateConfig({
+      title: this.article$.pipe(map((a) => a.title)),
+      description: 'A brief description',
+      canonical: 'https://example.com/article',
+      og: { image: 'https://example.com/image.jpg' },
+    });
+  }
+}
+
+// after
+@Component({})
+export class ArticleComponent {
+  private article = toSignal(this.article$);
+
+  constructor() {
+    applyHeadTitleBinding(computed(() => this.article()?.title ?? ''));
+    applyDescriptionBinding('A brief description');
+    applyCanonicalBinding('https://example.com/article');
+    applyOpenGraphBindings({ images: ['https://example.com/image.jpg'] });
+  }
+}
+```
+
+## Two things to watch
+
+- A child component no longer re-declares its parent's config to override one key. Title parts
+  compose through the title store, and duplicate meta and link tags are deduplicated by selector.
+  Delete a re-declaration instead of porting it.
+- `robots` took a string and now takes a directive object, for example `{ index: true, follow: true }`.
+
+## When you are done
+
+Nothing may import `SeoDirective` or `SeoConfig` any more. Run the type check and the lint task of
+every project you changed.
+
+The full guide, with every binding and its options, is at <https://ethlete-sdk-docs.web.app/core/seo>.

package/migrations/surface-theme-regenerate.md

@@ -0,0 +1,20 @@
+# Regenerate the surface theme after the swatch change
+
+`SurfaceTheme['interactionColor']` is a swatch now: `{ color, onColor, inkColor }` instead of a single
+colour. `nx g @ethlete/core:migrate-surface-interaction-swatch` rewrites the theme definitions, but the
+generated stylesheet still holds the CSS variables of the old shape.
+
+Regenerate it with the same command that created it, in each app that has a surface theme:
+
+```bash
+nx g @ethlete/core:tailwind-4-surface-theme
+```
+
+The generator asks for the same answers as the first time. It overwrites the generated stylesheet, so
+check the diff: a hand-written override inside the generated file is lost.
+
+`onColor` and `inkColor` carry the two foreground colours an interaction surface needs. The codemod
+fills them from the old single colour, which keeps the rendering identical but is rarely the design
+intent. Read the swatch through with the designer once, then correct the values.
+
+The theming guide is at <https://ethlete-sdk-docs.web.app/core/theming>.

package/migrations.json

@@ -0,0 +1,43 @@
+{
+  "migrations": [
+    {
+      "name": "to-v5",
+      "version": "5.0.0-beta.11",
+      "kind": "auto",
+      "description": "Rewrite the v4 core API into its v5 shape.",
+      "generator": "@ethlete/core:migrate-to-v5"
+    },
+    {
+      "name": "provider-shape",
+      "version": "5.0.0-next.37",
+      "kind": "auto",
+      "description": "Rewrite destructured provider tuples into the tree-shakeable definition shape.",
+      "generator": "@ethlete/core:migrate-provider-shape",
+      "docs": "/core/providers"
+    },
+    {
+      "name": "seo-directive-removed",
+      "version": "5.0.0-next.41",
+      "kind": "assisted",
+      "description": "SeoDirective and SeoConfig are gone. Every call site moves to the apply*Binding function for its key.",
+      "instructions": "./migrations/seo-directive-removed.md",
+      "docs": "/core/seo"
+    },
+    {
+      "name": "surface-interaction-swatch",
+      "version": "5.0.0-next.46",
+      "kind": "auto",
+      "description": "Rewrite surface theme interactionColor maps into the { color, onColor, inkColor } swatch shape.",
+      "generator": "@ethlete/core:migrate-surface-interaction-swatch",
+      "docs": "/core/theming"
+    },
+    {
+      "name": "surface-theme-regenerate",
+      "version": "5.0.0-next.46",
+      "kind": "manual",
+      "description": "Regenerate the surface theme stylesheet, so the new swatch reaches the CSS variables.",
+      "instructions": "./migrations/surface-theme-regenerate.md",
+      "docs": "/core/theming"
+    }
+  ]
+}

package/package.json

@@ -1,24 +1,34 @@
 {
   "name": "@ethlete/core",
-  "version": "5.0.0-next.6",
+  "version": "5.0.0-next.61",
   "license": "MIT",
   "sideEffects": false,
   "peerDependencies": {
-    "@analogjs/vite-plugin-angular": "2.3.1",
-    "@angular/cdk": "21.2.1",
-    "@angular/common": "21.2.1",
-    "@angular/core": "21.2.1",
-    "@angular/forms": "21.2.1",
-    "@angular/platform-browser": "21.2.1",
-    "@angular/router": "21.2.1",
-    "@ethlete/types": "^2.0.0-next.0",
-    "@floating-ui/dom": "1.7.6",
-    "@nx/devkit": "22.5.4",
-    "@nx/vite": "22.5.4",
+    "@angular/common": "22.1.6",
+    "@angular/core": "22.1.6",
+    "@angular/forms": "22.1.6",
+    "@angular/platform-browser": "22.1.6",
+    "@angular/router": "22.1.6",
+    "@ethlete/types": "^2.0.0-beta.4",
+    "@floating-ui/dom": "1.8.0",
+    "@nx/devkit": "23.1.0",
     "rxjs": "7.8.2",
     "ts-morph": "21.0.1",
-    "typescript": "5.9.3",
-    "vite": "^7.0.0"
+    "typescript": "6.0.3"
+  },
+  "peerDependenciesMeta": {
+    "@nx/devkit": {
+      "optional": true
+    },
+    "ts-morph": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "ethlete": {
+    "migrations": "./migrations.json"
   },
   "generators": "./generators/generators.json",
   "module": "fesm2022/ethlete-core.mjs",
@@ -32,6 +42,7 @@
       "default": "./fesm2022/ethlete-core.mjs"
     }
   },
+  "type": "module",
   "dependencies": {
     "tslib": "^2.3.0"
   }