@ethlete/contentful 4.0.0-next.1 → 4.0.0-next.10

package/generators/migrate-to-contentful-v5/migration.js

@@ -0,0 +1,256 @@
+import { formatFiles, installPackagesTask, readJson, updateJson } from '@nx/devkit';
+import { createMigrationScope } from './migration-scope.js';
+export const CONTENTFUL_V5_REPORT_PATH = 'contentful-v5-migration-tasks.md';
+const COMPONENTS_PACKAGE = '@ethlete/components';
+const COMPONENTS_VERSION = '^1.0.0-next.32';
+/** Inputs that v5 dropped — the picture element now only carries static `et-picture-*` classes. */
+const REMOVED_CLASS_INPUTS = ['imgClass', 'figureClass', 'figcaptionClass', 'pictureClass'];
+/** Renderer internals that are no longer exported from `@ethlete/contentful`. */
+const REMOVED_EXPORTS = [
+    'RENDER_COMMAND_TYPE',
+    'RENDER_COMMAND_POSITION',
+    'HTML_OPEN_RENDER_COMMAND_POSITION',
+    'HTML_CLOSE_RENDER_COMMAND_POSITION',
+    'TEXT_RENDER_COMMAND_POSITION',
+    'COMPONENT_RENDER_COMMAND_POSITION',
+    'RENDER_INSTRUCTION_POSITION',
+    'RENDER_INSTRUCTION_TYPE',
+    'isHtmlOpenRenderCommand',
+    'isHtmlCloseRenderCommand',
+    'isTextRenderCommand',
+    'isComponentRenderCommand',
+    'getRenderCommandId',
+    'isExecutedComponentCommandCacheItem',
+    'isExecutedHtmlOrTextCommandCacheItem',
+    'isExecutedTextCommandCacheItem',
+];
+const INLINE_TEMPLATE_REGEX = /template\s*:\s*`([\s\S]*?)`/g;
+const CONTENTFUL_NAMED_REFERENCE_REGEX = /(?:import|export)\s+(?:type\s+)?(?:[\w$]+\s*,\s*)?\{([\s\S]*?)\}\s+from\s+['"]@ethlete\/contentful['"]/g;
+const CONTENTFUL_NAMESPACE_REFERENCE_REGEX = /(?:import\s+\*\s+as\s+([\w$]+)|export\s+\*)\s+from\s+['"]@ethlete\/contentful['"]/g;
+const lineOf = (source, index) => source.slice(0, index).split('\n').length;
+const replaceImageTags = (source, replace) => {
+    const tagStart = '<et-contentful-image';
+    let result = '';
+    let cursor = 0;
+    while (cursor < source.length) {
+        const start = source.indexOf(tagStart, cursor);
+        if (start === -1) {
+            result += source.slice(cursor);
+            break;
+        }
+        const boundary = source[start + tagStart.length];
+        if (boundary && !/[\s/>]/.test(boundary)) {
+            result += source.slice(cursor, start + tagStart.length);
+            cursor = start + tagStart.length;
+            continue;
+        }
+        let quote = null;
+        let end = start + tagStart.length;
+        for (; end < source.length; end++) {
+            const character = source[end];
+            if (quote) {
+                if (character === quote)
+                    quote = null;
+            }
+            else if (character === '"' || character === "'" || character === '`') {
+                quote = character;
+            }
+            else if (character === '>') {
+                break;
+            }
+        }
+        if (end === source.length) {
+            result += source.slice(cursor);
+            break;
+        }
+        result += source.slice(cursor, start) + replace(source.slice(start, end + 1), start);
+        cursor = end + 1;
+    }
+    return result;
+};
+/** Renames `hasPriority` to `priority` and collects removed class inputs, on `et-contentful-image` only. */
+const migrateTemplate = (template) => {
+    let changed = false;
+    const classInputHits = [];
+    const content = replaceImageTags(template, (tag, offset) => {
+        const foundInputs = REMOVED_CLASS_INPUTS.filter((input) => new RegExp(`(^|[\\s[])${input}(\\]|=|(?=[\\s/>]))`).test(tag));
+        if (foundInputs.length > 0) {
+            classInputHits.push({ line: lineOf(template, offset), inputs: foundInputs });
+        }
+        const next = tag
+            .replace(/\[hasPriority\]=/g, '[priority]=')
+            .replace(/(^|\s)hasPriority(=|(?=[\s/>]))/g, '$1priority$2');
+        if (next !== tag)
+            changed = true;
+        return next;
+    });
+    return { content, changed, classInputHits };
+};
+const migrateHtmlFile = (filePath, source) => {
+    const { content, changed, classInputHits } = migrateTemplate(source);
+    return { content, changed, tasks: classInputHits.map((hit) => createClassInputTask(filePath, hit)) };
+};
+const createClassInputTask = (filePath, hit) => ({
+    id: `image-class-input:${filePath}:${hit.line}`,
+    file: filePath,
+    line: hit.line,
+    message: `\`et-contentful-image\` still sets ${hit.inputs
+        .map((input) => `\`${input}\``)
+        .join(', ')}. Those inputs were removed — the rendered picture now only carries static \`et-picture-*\` classes. Drop the binding and target the \`et-picture-*\` classes from your own CSS instead.`,
+});
+const USE_TAILWIND_CLASSES_REGEX = /^[ \t]*useTailwindClasses\s*:\s*(?:true|false|[\w.$]+)\s*,?[ \t]*\r?\n|\buseTailwindClasses\s*:\s*(?:true|false|[\w.$]+)\s*,[ \t]*|,\s*useTailwindClasses\s*:\s*(?:true|false|[\w.$]+)(?=\s*[}\n])/gm;
+const migrateTsFile = (filePath, source) => {
+    const tasks = [];
+    let changed = false;
+    source = source.replace(USE_TAILWIND_CLASSES_REGEX, () => {
+        changed = true;
+        return '';
+    });
+    const content = source.replace(INLINE_TEMPLATE_REGEX, (match, template, offset) => {
+        const result = migrateTemplate(template);
+        const templateStartLine = lineOf(source, offset + match.indexOf('`'));
+        for (const hit of result.classInputHits) {
+            tasks.push(createClassInputTask(filePath, { ...hit, line: templateStartLine + hit.line - 1 }));
+        }
+        if (!result.changed)
+            return match;
+        changed = true;
+        return match.replace(template, () => result.content);
+    });
+    for (const importMatch of source.matchAll(CONTENTFUL_NAMED_REFERENCE_REGEX)) {
+        const symbols = (importMatch[1] ?? '')
+            .split(',')
+            .map((specifier) => specifier
+            .trim()
+            .replace(/^type\s+/, '')
+            .split(/\s+as\s+/)[0]
+            ?.trim() ?? '')
+            .filter(Boolean);
+        for (const symbol of symbols) {
+            if (!REMOVED_EXPORTS.includes(symbol))
+                continue;
+            tasks.push({
+                id: `removed-export:${filePath}:${symbol}`,
+                file: filePath,
+                line: lineOf(source, importMatch.index ?? 0),
+                message: `\`${symbol}\` is no longer public API. The render pipeline moved to plain objects internally, so the renderer command helpers are gone. Remove the usage, or vendor the logic into your own code.`,
+            });
+        }
+    }
+    for (const namespaceMatch of source.matchAll(CONTENTFUL_NAMESPACE_REFERENCE_REGEX)) {
+        const namespace = namespaceMatch[1] ?? '*';
+        tasks.push({
+            id: `removed-export:${filePath}:${namespace}`,
+            file: filePath,
+            line: lineOf(source, namespaceMatch.index ?? 0),
+            message: `The ${namespace === '*' ? 'star re-export' : `\`${namespace}\` namespace import`} may reference renderer internals that are no longer public API. Replace it with explicit supported imports and remove any command-helper usage.`,
+        });
+    }
+    return { content, changed, tasks };
+};
+const migratePackageJson = (tree, filePath) => {
+    const tasks = [];
+    let changed = false;
+    const source = tree.read(filePath, 'utf-8');
+    if (!source) {
+        return { changed, tasks };
+    }
+    if (!source.includes('@ethlete/contentful')) {
+        return { changed, tasks };
+    }
+    const json = readJson(tree, filePath);
+    const dependencies = json['dependencies'];
+    const peerDependencies = json['peerDependencies'];
+    const section = dependencies?.['@ethlete/contentful']
+        ? 'dependencies'
+        : peerDependencies?.['@ethlete/contentful']
+            ? 'peerDependencies'
+            : null;
+    if (!section) {
+        return { changed, tasks };
+    }
+    const hasComponents = Boolean(dependencies?.[COMPONENTS_PACKAGE] ?? peerDependencies?.[COMPONENTS_PACKAGE]);
+    if (!hasComponents) {
+        updateJson(tree, filePath, (packageJson) => {
+            packageJson[section] = { ...packageJson[section], [COMPONENTS_PACKAGE]: COMPONENTS_VERSION };
+            return packageJson;
+        });
+        changed = true;
+        console.log(`   ✓ ${filePath}: added ${COMPONENTS_PACKAGE}@${COMPONENTS_VERSION} to ${section}`);
+    }
+    if (dependencies?.['@ethlete/cdk'] ?? peerDependencies?.['@ethlete/cdk']) {
+        tasks.push({
+            id: `cdk-dependency:${filePath}`,
+            file: filePath,
+            message: '`@ethlete/contentful` no longer depends on `@ethlete/cdk`. The dependency was left in place because you may use it directly — if nothing in this project imports `@ethlete/cdk`, remove it.',
+        });
+    }
+    return { changed, tasks };
+};
+const renderReport = (tasks) => [
+    '# @ethlete/contentful v5 migration tasks',
+    '',
+    'The codemod renamed the `et-contentful-image` `hasPriority` input to `priority`, removed the dropped',
+    '`useTailwindClasses` config option and made sure `@ethlete/components` is declared. The sites below',
+    'need a decision a codemod cannot make.',
+    '',
+    'Recipes:',
+    '',
+    '- Removed class inputs (`imgClass`, `figureClass`, `figcaptionClass`, `pictureClass`): the picture markup',
+    '  now carries static `et-picture-*` classes. Delete the binding and style those classes from your CSS.',
+    '- Removed renderer internals: the render pipeline is plain objects internally now. Drop the usage, or copy',
+    '  the helper into your own codebase.',
+    '- A leftover `@ethlete/cdk` dependency: remove it unless your own code imports it.',
+    '',
+    ...tasks.map((task) => [`## \`${task.id}\``, '', `- ${task.file}${task.line ? `:${task.line}` : ''}`, `- ${task.message}`, ''].join('\n')),
+].join('\n');
+export default async function migrateToContentfulV5(tree, schema) {
+    console.log('\n🔄 Migrating to @ethlete/contentful v5...');
+    const scope = createMigrationScope(tree, schema);
+    console.log(`   Scope: ${scope.describe()}`);
+    const tasks = [];
+    let filesChanged = 0;
+    let dependenciesChanged = false;
+    scope.visit(tree, (filePath) => {
+        if (filePath === CONTENTFUL_V5_REPORT_PATH)
+            return;
+        if (filePath.endsWith('package.json')) {
+            const result = migratePackageJson(tree, filePath);
+            tasks.push(...result.tasks);
+            if (result.changed)
+                filesChanged++;
+            if (result.changed)
+                dependenciesChanged = true;
+            return;
+        }
+        const isHtml = filePath.endsWith('.html');
+        const isTs = filePath.endsWith('.ts') && !filePath.endsWith('.d.ts');
+        if (!isHtml && !isTs)
+            return;
+        const before = tree.read(filePath, 'utf-8');
+        if (!before)
+            return;
+        const result = isHtml ? migrateHtmlFile(filePath, before) : migrateTsFile(filePath, before);
+        tasks.push(...result.tasks);
+        if (result.changed) {
+            tree.write(filePath, result.content);
+            filesChanged++;
+            console.log(`   ✓ ${filePath}`);
+        }
+    });
+    if (tasks.length > 0) {
+        tree.write(CONTENTFUL_V5_REPORT_PATH, renderReport(tasks));
+    }
+    if (!schema.skipFormat) {
+        await formatFiles(tree);
+    }
+    console.log(`\n✅ Updated ${filesChanged} file(s).`);
+    if (tasks.length > 0) {
+        console.log(`⚠️  ${tasks.length} site(s) need a manual decision — see ${CONTENTFUL_V5_REPORT_PATH}.`);
+    }
+    if (dependenciesChanged) {
+        return (() => installPackagesTask(tree, true));
+    }
+    return undefined;
+}
+//# sourceMappingURL=migration.js.map

package/generators/migrate-to-contentful-v5/schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "migrate-to-contentful-v5",
+  "title": "Migrate to @ethlete/contentful v5",
+  "type": "object",
+  "properties": {
+    "projects": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Nx projects to migrate. Defaults to every project in the workspace. Every site is rewritten independently, so any scope is safe — use this to keep the diff reviewable.",
+      "alias": "project"
+    },
+    "include": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Path prefixes to migrate, relative to the workspace root (e.g. 'libs/ui'). Unioned with `projects`. Defaults to the whole workspace.",
+      "alias": "includePath"
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "description": "Skip formatting files after migration",
+      "default": false
+    }
+  },
+  "required": []
+}

package/migrations.json

@@ -0,0 +1,12 @@
+{
+  "migrations": [
+    {
+      "name": "to-contentful-v5",
+      "version": "4.0.0-next.7",
+      "kind": "auto",
+      "description": "Move to the components picture, the renamed image inputs and the removed renderer internals.",
+      "generator": "@ethlete/contentful:migrate-to-contentful-v5",
+      "docs": "/contentful/"
+    }
+  ]
+}

package/package.json

@@ -1,22 +1,27 @@
 {
   "name": "@ethlete/contentful",
-  "version": "4.0.0-next.1",
+  "version": "4.0.0-next.10",
   "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/router": "21.2.1",
-    "@contentful/rich-text-types": "17.2.5",
-    "@ethlete/cdk": "^5.0.0-next.0",
-    "@ethlete/core": "^5.0.0-next.0",
-    "@ethlete/query": "^6.0.0-next.0",
-    "@nx/vite": "22.5.4",
-    "rxjs": "7.8.2",
-    "vite": "^7.0.0"
+    "@angular/common": "22.1.6",
+    "@angular/core": "22.1.6",
+    "@angular/router": "22.1.6",
+    "@contentful/rich-text-types": "17.2.7",
+    "@ethlete/components": "^1.0.0-next.32",
+    "@ethlete/core": "^5.0.0-beta.11",
+    "@ethlete/query": "^6.0.0-beta.8",
+    "@nx/devkit": "23.1.0"
   },
+  "peerDependenciesMeta": {
+    "@nx/devkit": {
+      "optional": true
+    }
+  },
+  "ethlete": {
+    "migrations": "./migrations.json"
+  },
+  "generators": "./generators/generators.json",
   "module": "fesm2022/ethlete-contentful.mjs",
   "typings": "types/ethlete-contentful.d.ts",
   "exports": {
@@ -28,6 +33,7 @@
       "default": "./fesm2022/ethlete-contentful.mjs"
     }
   },
+  "type": "module",
   "dependencies": {
     "tslib": "^2.3.0"
   }