@seo-partner/adapters 0.0.0-stage → 1.0.3

package/src/php-native-adapter.ts

@@ -0,0 +1,46 @@
+export interface PhpNativeMetaFields {
+  title?: string;
+  description?: string;
+  canonical?: string;
+}
+
+export function patchPhpNativeTemplate(
+  sourceCode: string,
+  meta: PhpNativeMetaFields,
+): string {
+  let result = sourceCode;
+
+  const vars: string[] = [];
+  if (meta.title && !/\$pageTitle\s*=/i.test(result)) {
+    vars.push(`$pageTitle = '${meta.title.replace(/'/g, "\\'")}';`);
+  }
+  if (meta.description && !/\$metaDescription\s*=/i.test(result)) {
+    vars.push(`$metaDescription = '${meta.description.replace(/'/g, "\\'")}';`);
+  }
+  if (meta.canonical && !/\$canonicalUrl\s*=/i.test(result)) {
+    vars.push(`$canonicalUrl = '${meta.canonical.replace(/'/g, "\\'")}';`);
+  }
+
+  if (vars.length === 0) {
+    return result;
+  }
+
+  const varsBlock = vars.join('\n') + '\n';
+
+  // If file starts with <?php, inject before any header include
+  if (/<\?php/i.test(result)) {
+    if (/(include|require|include_once|require_once)\s*['"][^'"]*header[^'"]*['"]/i.test(result)) {
+      result = result.replace(
+        /((?:include|require|include_once|require_once)\s*['"][^'"]*header[^'"]*['"])/i,
+        `${varsBlock}$1`,
+      );
+    } else {
+      result = result.replace(/(<\?php\s*\n)/i, `$1${varsBlock}`);
+    }
+  } else {
+    result = `<?php\n${varsBlock}?>\n` + result;
+  }
+
+  return result;
+}
+

package/src/remix-adapter.ts

@@ -0,0 +1,123 @@
+import type { DiscoveredRoute, ExtractedRouteData } from '@seo-partner/core';
+import type { AdapterCapabilities, AdapterVersion, FrameworkAdapter } from './contract.js';
+import { parseRemixRoute } from './parsers/remix-parser.js';
+import { normalizeRoutePattern } from './parsers/route-normalizer.js';
+import { LayoutResolver } from './parsers/layout-resolver.js';
+
+export class RemixAdapter implements FrameworkAdapter {
+  public readonly id = 'remix';
+  public readonly name = 'Remix / React Router v7';
+  public readonly version: AdapterVersion = '1.0';
+  public readonly capabilities: AdapterCapabilities = {
+    routes: true,
+    metadata: true,
+    headings: true,
+    internalLinks: true,
+    jsonLd: true,
+    images: true,
+    robotsAndSitemap: true,
+  };
+
+  private readonly layoutResolver = new LayoutResolver();
+
+  public async detect(
+    projectRoot: string,
+    filePaths: ReadonlyArray<string>,
+    contentsByPath: ReadonlyMap<string, string>,
+  ): Promise<boolean> {
+    for (const filePath of filePaths) {
+      const normalized = filePath.replace(/\\/g, '/');
+      if (
+        normalized === 'remix.config.js' ||
+        normalized === 'remix.config.ts' ||
+        normalized === 'remix.config.mjs' ||
+        normalized === 'react-router.config.ts' ||
+        normalized === 'react-router.config.js'
+      ) {
+        return true;
+      }
+      if (normalized === 'package.json') {
+        const content = contentsByPath.get(filePath) ?? '';
+        if (
+          content.includes('"@remix-run/') ||
+          content.includes('"react-router"')
+        ) {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  public async discoverRoutes(
+    projectRoot: string,
+    filePaths: ReadonlyArray<string>,
+    contentsByPath: ReadonlyMap<string, string>,
+    sitemapPaths: ReadonlySet<string>,
+  ): Promise<ReadonlyArray<DiscoveredRoute>> {
+    const routes: DiscoveredRoute[] = [];
+
+    // Pre-cache root layout from app/root.tsx
+    for (const filePath of filePaths) {
+      const normalized = filePath.replace(/\\/g, '/');
+      if (normalized === 'app/root.tsx' || normalized === 'app/root.jsx') {
+        const content = contentsByPath.get(filePath) ?? '';
+        const parsed = parseRemixRoute(
+          {
+            pattern: '',
+            filePath,
+            routerKind: 'remix',
+            renderingMode: 'ssr-ssg',
+            isPrivate: false,
+            inSitemap: false,
+          },
+          content,
+        );
+        this.layoutResolver.registerLayout({
+          filePath,
+          htmlLang: parsed.htmlLang,
+          title: parsed.title,
+          description: parsed.description,
+          canonical: parsed.canonical,
+          robots: parsed.robots,
+        });
+      }
+    }
+
+    for (const filePath of filePaths) {
+      const normalized = filePath.replace(/\\/g, '/');
+      if (!normalized.startsWith('app/routes/')) continue;
+      if (!/\.(tsx|jsx|ts|js)$/i.test(normalized)) continue;
+
+      const relativeInsideRoutes = normalized.slice('app/routes/'.length);
+      const pattern = normalizeRoutePattern(relativeInsideRoutes, 'remix');
+      const inSitemap = sitemapPaths.has(pattern);
+
+      routes.push({
+        pattern,
+        filePath,
+        routerKind: 'remix',
+        renderingMode: 'ssr-ssg',
+        isPrivate: false,
+        inSitemap,
+      });
+    }
+
+    return routes;
+  }
+
+  public async extractRoute(
+    projectRoot: string,
+    route: DiscoveredRoute,
+    fileContent: string,
+  ): Promise<ExtractedRouteData> {
+    let extracted = parseRemixRoute(route, fileContent);
+
+    // Apply root layout inheritance
+    const layoutCandidates = ['app/root.tsx', 'app/root.jsx'];
+    extracted = this.layoutResolver.applyInheritance(extracted, layoutCandidates);
+
+    return extracted;
+  }
+}
+

package/src/sitemap-builder.ts

@@ -0,0 +1,57 @@
+export interface SitemapRouteEntry {
+  pattern: string;
+  isPrivate: boolean;
+  lastmod?: string;
+  changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+  priority?: number;
+}
+
+export function buildSitemapXml(
+  routes: ReadonlyArray<SitemapRouteEntry>,
+  siteUrl: string,
+): string {
+  const cleanBase = siteUrl.replace(/\/+$/, '');
+  const publicRoutes = routes.filter((r) => !r.isPrivate);
+
+  const urlEntries = publicRoutes.map((r) => {
+    const cleanPattern = r.pattern.startsWith('/') ? r.pattern : `/${r.pattern}`;
+    const loc = `${cleanBase}${cleanPattern === '/' ? '' : cleanPattern}`;
+    const lastmodTag = r.lastmod ? `\n    <lastmod>${r.lastmod}</lastmod>` : '';
+    const changefreqTag = r.changefreq ? `\n    <changefreq>${r.changefreq}</changefreq>` : '';
+    const priorityTag = typeof r.priority === 'number' ? `\n    <priority>${r.priority.toFixed(1)}</priority>` : '';
+
+    return `  <url>\n    <loc>${loc}</loc>${lastmodTag}${changefreqTag}${priorityTag}\n  </url>`;
+  });
+
+  return [
+    '<?xml version="1.0" encoding="UTF-8"?>',
+    '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">',
+    ...urlEntries,
+    '</urlset>',
+  ].join('\n');
+}
+
+export function buildNextJsAppSitemap(
+  routes: ReadonlyArray<SitemapRouteEntry>,
+  siteUrl: string,
+): string {
+  const cleanBase = siteUrl.replace(/\/+$/, '');
+  const publicRoutes = routes.filter((r) => !r.isPrivate);
+
+  const items = publicRoutes.map((r) => {
+    const cleanPattern = r.pattern.startsWith('/') ? r.pattern : `/${r.pattern}`;
+    const loc = `${cleanBase}${cleanPattern === '/' ? '' : cleanPattern}`;
+    return `    {\n      url: '${loc}',\n      lastModified: new Date(),\n      changeFrequency: 'weekly',\n      priority: ${cleanPattern === '/' ? '1.0' : '0.8'},\n    },`;
+  });
+
+  return [
+    "import type { MetadataRoute } from 'next';",
+    '',
+    'export default function sitemap(): MetadataRoute.Sitemap {',
+    '  return [',
+    ...items,
+    '  ];',
+    '}',
+  ].join('\n');
+}
+

package/src/skeleton-detector.ts

@@ -0,0 +1,56 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export interface SeoFileInventory {
+  robots: {
+    appRobotsTs?: string;
+    publicRobotsTxt?: string;
+    hasConflict: boolean;
+  };
+  sitemap: {
+    appSitemapTs?: string;
+    publicSitemapXml?: string;
+    hasConflict: boolean;
+  };
+}
+
+export function detectSeoFileInventory(projectRoot: string): SeoFileInventory {
+  const checkExists = (rel: string) => {
+    const full = path.join(projectRoot, rel);
+    return fs.existsSync(full) ? rel : undefined;
+  };
+
+  const appRobotsTs =
+    checkExists('app/robots.ts') ||
+    checkExists('app/robots.js') ||
+    checkExists('src/app/robots.ts') ||
+    checkExists('src/app/robots.js');
+
+  const publicRobotsTxt =
+    checkExists('public/robots.txt') ||
+    checkExists('robots.txt');
+
+  const appSitemapTs =
+    checkExists('app/sitemap.ts') ||
+    checkExists('app/sitemap.js') ||
+    checkExists('src/app/sitemap.ts') ||
+    checkExists('src/app/sitemap.js');
+
+  const publicSitemapXml =
+    checkExists('public/sitemap.xml') ||
+    checkExists('sitemap.xml');
+
+  return {
+    robots: {
+      appRobotsTs,
+      publicRobotsTxt,
+      hasConflict: Boolean(appRobotsTs && publicRobotsTxt),
+    },
+    sitemap: {
+      appSitemapTs,
+      publicSitemapXml,
+      hasConflict: Boolean(appSitemapTs && publicSitemapXml),
+    },
+  };
+}
+

package/src/static-adapter.ts

@@ -0,0 +1,62 @@
+import type { DiscoveredRoute, ExtractedRouteData } from '@seo-partner/core';
+import type { AdapterCapabilities, FrameworkAdapter } from './contract.js';
+import { isPrivateRoutePattern } from './nextjs-adapter.js';
+import { parseStaticHtmlOrMarkdown } from './parsers/html-parser.js';
+
+export class StaticAdapter implements FrameworkAdapter {
+  public readonly id = 'static-html';
+  public readonly name = 'Static HTML & Markdown';
+  public readonly version = '1.0' as const;
+  public readonly capabilities: AdapterCapabilities = {
+    routes: true,
+    metadata: true,
+    headings: true,
+    internalLinks: true,
+    jsonLd: true,
+    images: true,
+    robotsAndSitemap: true,
+  };
+
+  public async detect(
+    _projectRoot: string,
+    filePaths: ReadonlyArray<string>,
+  ): Promise<boolean> {
+    return filePaths.some((p) => p.endsWith('.html'));
+  }
+
+  public async discoverRoutes(
+    _projectRoot: string,
+    filePaths: ReadonlyArray<string>,
+    _contentsByPath: ReadonlyMap<string, string>,
+    sitemapPaths: ReadonlySet<string>,
+  ): Promise<ReadonlyArray<DiscoveredRoute>> {
+    const routes: DiscoveredRoute[] = [];
+    for (const filePath of filePaths) {
+      if (filePath.endsWith('.html')) {
+        const clean = filePath
+          .replace(/^public\//, '')
+          .replace(/index\.html$/, '')
+          .replace(/\.html$/, '');
+        const pattern = clean.startsWith('/') ? clean : `/${clean}`;
+        routes.push({
+          pattern: pattern === '' ? '/' : pattern,
+          filePath,
+          routerKind: 'static-html',
+          renderingMode: 'static',
+          isPrivate: isPrivateRoutePattern(pattern),
+          inSitemap: sitemapPaths.has(pattern),
+        });
+      }
+    }
+    return routes;
+  }
+
+  public async extractRoute(
+    _projectRoot: string,
+    route: DiscoveredRoute,
+    fileContent: string,
+  ): Promise<ExtractedRouteData> {
+    return parseStaticHtmlOrMarkdown(route, fileContent);
+  }
+}
+

package/src/sveltekit-adapter.ts

@@ -0,0 +1,160 @@
+import type { DiscoveredRoute, ExtractedRouteData } from '@seo-partner/core';
+import type { AdapterCapabilities, AdapterVersion, FrameworkAdapter } from './contract.js';
+import { parseSvelteComponent } from './parsers/svelte-parser.js';
+import { normalizeRoutePattern } from './parsers/route-normalizer.js';
+import { LayoutResolver } from './parsers/layout-resolver.js';
+
+export class SvelteKitAdapter implements FrameworkAdapter {
+  public readonly id = 'sveltekit';
+  public readonly name = 'SvelteKit';
+  public readonly version: AdapterVersion = '1.0';
+  public readonly capabilities: AdapterCapabilities = {
+    routes: true,
+    metadata: true,
+    headings: true,
+    internalLinks: true,
+    jsonLd: true,
+    images: true,
+    robotsAndSitemap: true,
+  };
+
+  private readonly layoutResolver = new LayoutResolver();
+
+  public async detect(
+    projectRoot: string,
+    filePaths: ReadonlyArray<string>,
+    contentsByPath: ReadonlyMap<string, string>,
+  ): Promise<boolean> {
+    for (const filePath of filePaths) {
+      const normalized = filePath.replace(/\\/g, '/');
+      if (
+        normalized === 'svelte.config.js' ||
+        normalized === 'svelte.config.ts' ||
+        normalized === 'svelte.config.mjs' ||
+        normalized === 'svelte.config.cjs'
+      ) {
+        return true;
+      }
+      if (normalized === 'package.json') {
+        const content = contentsByPath.get(filePath) ?? '';
+        if (content.includes('"@sveltejs/kit"')) {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  public async discoverRoutes(
+    projectRoot: string,
+    filePaths: ReadonlyArray<string>,
+    contentsByPath: ReadonlyMap<string, string>,
+    sitemapPaths: ReadonlySet<string>,
+  ): Promise<ReadonlyArray<DiscoveredRoute>> {
+    const routes: DiscoveredRoute[] = [];
+
+    // Pre-cache layouts from src/routes/**/+layout.svelte
+    for (const filePath of filePaths) {
+      const normalized = filePath.replace(/\\/g, '/');
+      if (normalized.startsWith('src/routes/') && normalized.endsWith('+layout.svelte')) {
+        const content = contentsByPath.get(filePath) ?? '';
+        const parsed = parseSvelteComponent(
+          {
+            pattern: '',
+            filePath,
+            routerKind: 'sveltekit',
+            renderingMode: 'ssr-ssg',
+            isPrivate: false,
+            inSitemap: false,
+          },
+          content,
+        );
+        this.layoutResolver.registerLayout({
+          filePath,
+          htmlLang: parsed.htmlLang,
+          title: parsed.title,
+          description: parsed.description,
+          canonical: parsed.canonical,
+          robots: parsed.robots,
+        });
+      }
+    }
+
+    for (const filePath of filePaths) {
+      const normalized = filePath.replace(/\\/g, '/');
+      if (!normalized.startsWith('src/routes/')) continue;
+      if (!normalized.endsWith('+page.svelte')) continue;
+
+      const relativeInsideRoutes = normalized.slice('src/routes/'.length);
+      const pattern = normalizeRoutePattern(relativeInsideRoutes, 'sveltekit');
+      const inSitemap = sitemapPaths.has(pattern);
+
+      routes.push({
+        pattern,
+        filePath,
+        routerKind: 'sveltekit',
+        renderingMode: 'ssr-ssg',
+        isPrivate: false,
+        inSitemap,
+      });
+    }
+
+    return routes;
+  }
+
+  public async extractRoute(
+    projectRoot: string,
+    route: DiscoveredRoute,
+    fileContent: string,
+  ): Promise<ExtractedRouteData> {
+    let extracted = parseSvelteComponent(route, fileContent);
+
+    // Apply hierarchical layout inheritance from leaf up to root
+    const parentLayouts = this.layoutResolver.findSvelteKitLayoutPaths(route.filePath);
+    extracted = this.layoutResolver.applyInheritance(extracted, parentLayouts);
+
+    return extracted;
+  }
+}
+
+
+export interface SvelteKitMetaFields {
+  title?: string;
+  description?: string;
+  canonical?: string;
+}
+
+export function patchSvelteKitTemplate(
+  sourceCode: string,
+  meta: SvelteKitMetaFields,
+): string {
+  let result = sourceCode;
+
+  if (/<svelte:head>/i.test(result)) {
+    if (meta.title && !/<title>/i.test(result)) {
+      result = result.replace(/(<svelte:head>\s*\n)/i, `$1  <title>${meta.title}</title>\n`);
+    }
+    if (meta.description && !/<meta\s+name=["']description["']/i.test(result)) {
+      result = result.replace(
+        /(<svelte:head>\s*\n)/i,
+        `$1  <meta name="description" content="${meta.description.replace(/"/g, '&quot;')}" />\n`,
+      );
+    }
+  } else {
+    const headLines: string[] = ['<svelte:head>'];
+    if (meta.title) {
+      headLines.push(`  <title>${meta.title}</title>`);
+    }
+    if (meta.description) {
+      headLines.push(`  <meta name="description" content="${meta.description.replace(/"/g, '&quot;')}" />`);
+    }
+    if (meta.canonical) {
+      headLines.push(`  <link rel="canonical" href="${meta.canonical}" />`);
+    }
+    headLines.push('</svelte:head>\n\n');
+
+    result = headLines.join('\n') + result;
+  }
+
+  return result;
+}

package/src/symfony-adapter.ts

@@ -0,0 +1,33 @@
+export interface SymfonyMetaFields {
+  title?: string;
+  description?: string;
+  canonical?: string;
+}
+
+export function patchSymfonyTwigTemplate(
+  sourceCode: string,
+  meta: SymfonyMetaFields,
+): string {
+  let result = sourceCode;
+
+  if (meta.title && !/{%\s*block\s+title\s*%}/i.test(result)) {
+    const titleBlock = `{% block title %}${meta.title}{% endblock %}\n`;
+    if (/{%\s*extends[^%]+%}/i.test(result)) {
+      result = result.replace(/({%\s*extends[^%]+%}\s*\n)/i, `$1${titleBlock}`);
+    } else {
+      result = titleBlock + result;
+    }
+  }
+
+  if (meta.description && !/<meta\s+name=["']description["']/i.test(result)) {
+    const descTag = `<meta name="description" content="${meta.description.replace(/"/g, '&quot;')}">\n`;
+    if (/{%\s*block\s+title\s*%}[\s\S]*?{%\s*endblock\s*%}/i.test(result)) {
+      result = result.replace(/({%\s*block\s+title\s*%}[\s\S]*?{%\s*endblock\s*%}\s*\n)/i, `$1${descTag}`);
+    } else {
+      result = descTag + result;
+    }
+  }
+
+  return result;
+}
+

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"]
+}
+

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.