@easy-web/seo 1.0.0

package/README.md

@@ -0,0 +1,35 @@
+# @easy-web/seo
+
+Shared SEO primitives for the `@easy-web/*` ecosystem.
+
+## Usage
+
+```ts
+// astro.config.mjs
+import easyWebSeo from '@easy-web/seo';
+
+export default defineConfig({
+  site: 'https://yoursite.example',
+  integrations: [
+    easyWebSeo({
+      sitemapLocales: { de: 'de-DE', en: 'en-US' },
+      // noIndex: true  // set on staging/dev sites
+    }),
+  ],
+});
+```
+
+```astro
+// In your Base layout:
+import SeoHead from '@easy-web/seo/components/SeoHead.astro';
+
+<SeoHead
+  title={title}
+  description={description}
+  pathname={pathname}
+  locale={locale}
+  siteName="My Site"
+/>
+```
+
+Full implementation: see package source.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import type { AstroIntegration } from 'astro';
+export type Options = {
+    noIndex?: boolean;
+    sitemapLocales?: Record<string, string>;
+    filter?: (page: string) => boolean;
+};
+export default function easyWebSeo(options?: Options): AstroIntegration;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAG9C,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,OAAO,GAAE,OAAY,GAAG,gBAAgB,CA0D1E"}

package/dist/index.js

@@ -0,0 +1,53 @@
+import sitemap from '@astrojs/sitemap';
+export default function easyWebSeo(options = {}) {
+    return {
+        name: '@easy-web/seo',
+        hooks: {
+            'astro:config:setup': ({ config, updateConfig, injectRoute, logger }) => {
+                // 1. Validate site URL
+                if (!config.site) {
+                    logger.error('@easy-web/seo: astro.config.mjs must set `site` (a full https:// URL). ' +
+                        'Example: site: "https://yoursite.example"');
+                    throw new Error('@easy-web/seo: `site` is required in astro.config.mjs');
+                }
+                // 2. Build BCP-47 locale map for sitemap
+                let sitemapI18n;
+                if (config.i18n && config.i18n.locales.length > 0) {
+                    const localeMap = options.sitemapLocales ?? {};
+                    if (!options.sitemapLocales) {
+                        // Auto-generate BCP-47 tags: 'de' → 'de-DE', 'en' → 'en-US'
+                        for (const locale of config.i18n.locales) {
+                            const id = typeof locale === 'string' ? locale : locale.path;
+                            localeMap[id] = `${id}-${id.toUpperCase()}`;
+                        }
+                        logger.warn('@easy-web/seo: auto-generated BCP-47 locale tags (' +
+                            Object.entries(localeMap).map(([k, v]) => `${k}→${v}`).join(', ') +
+                            '). Provide the `sitemapLocales` option for region-specific tags (e.g. { de: "de-DE", en: "en-US" }).');
+                    }
+                    sitemapI18n = {
+                        defaultLocale: config.i18n.defaultLocale,
+                        locales: localeMap,
+                    };
+                }
+                // 3. Compose @astrojs/sitemap via updateConfig
+                updateConfig({
+                    integrations: [
+                        sitemap({
+                            ...(sitemapI18n ? { i18n: sitemapI18n } : {}),
+                            ...(options.filter ? { filter: options.filter } : {}),
+                        }),
+                    ],
+                });
+                // 4. Pass noIndex flag to the robots.txt route handler via env
+                process.env.EASY_WEB_SEO_NO_INDEX = String(options.noIndex ?? false);
+                // 5. Inject dynamic robots.txt route
+                injectRoute({
+                    pattern: '/robots.txt',
+                    entrypoint: new URL('./routes/robots-txt.js', import.meta.url),
+                    prerender: true,
+                });
+            },
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,kBAAkB,CAAC;AAQvC,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,UAAmB,EAAE;IACtD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE;YACL,oBAAoB,EAAE,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE;gBACtE,uBAAuB;gBACvB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBACjB,MAAM,CAAC,KAAK,CACV,yEAAyE;wBACzE,2CAA2C,CAC5C,CAAC;oBACF,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;gBAC3E,CAAC;gBAED,yCAAyC;gBACzC,IAAI,WAAmF,CAAC;gBACxF,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClD,MAAM,SAAS,GAA2B,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC;oBACvE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;wBAC5B,4DAA4D;wBAC5D,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;4BACzC,MAAM,EAAE,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;4BAC7D,SAAS,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;wBAC9C,CAAC;wBACD,MAAM,CAAC,IAAI,CACT,oDAAoD;4BACpD,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;4BACjE,sGAAsG,CACvG,CAAC;oBACJ,CAAC;oBACD,WAAW,GAAG;wBACZ,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa;wBACxC,OAAO,EAAE,SAAS;qBACnB,CAAC;gBACJ,CAAC;gBAED,+CAA+C;gBAC/C,YAAY,CAAC;oBACX,YAAY,EAAE;wBACZ,OAAO,CAAC;4BACN,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;4BAC7C,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;yBACtD,CAAC;qBACH;iBACF,CAAC,CAAC;gBAEH,+DAA+D;gBAC/D,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;gBAErE,qCAAqC;gBACrC,WAAW,CAAC;oBACV,OAAO,EAAE,aAAa;oBACtB,UAAU,EAAE,IAAI,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;oBAC9D,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC;YACL,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/robots-txt.d.ts

@@ -0,0 +1,15 @@
+import type { APIRoute } from 'astro';
+/**
+ * Dynamic robots.txt endpoint injected by @easy-web/seo integration.
+ *
+ * Behavior:
+ * - noIndex mode (process.env.EASY_WEB_SEO_NO_INDEX === 'true'):
+ *   Emits Disallow: / (blocks all crawlers — for auth-gated/staging sites)
+ * - Public mode (default):
+ *   Emits Disallow: /admin/, Allow: /, Sitemap: <site>/sitemap-index.xml
+ *
+ * The noIndex flag is set by the integration factory in astro:config:setup
+ * via process.env.EASY_WEB_SEO_NO_INDEX before this route is injected.
+ */
+export declare const GET: APIRoute;
+//# sourceMappingURL=robots-txt.d.ts.map

package/dist/routes/robots-txt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"robots-txt.d.ts","sourceRoot":"","sources":["../../src/routes/robots-txt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,GAAG,EAAE,QA2BjB,CAAC"}

package/dist/routes/robots-txt.js

@@ -0,0 +1,38 @@
+/**
+ * Dynamic robots.txt endpoint injected by @easy-web/seo integration.
+ *
+ * Behavior:
+ * - noIndex mode (process.env.EASY_WEB_SEO_NO_INDEX === 'true'):
+ *   Emits Disallow: / (blocks all crawlers — for auth-gated/staging sites)
+ * - Public mode (default):
+ *   Emits Disallow: /admin/, Allow: /, Sitemap: <site>/sitemap-index.xml
+ *
+ * The noIndex flag is set by the integration factory in astro:config:setup
+ * via process.env.EASY_WEB_SEO_NO_INDEX before this route is injected.
+ */
+export const GET = ({ site }) => {
+    const noIndex = process.env.EASY_WEB_SEO_NO_INDEX === 'true';
+    if (!site) {
+        // Fail safe: if site is not configured, block all crawlers
+        return new Response('User-agent: *\nDisallow: /\n', {
+            status: 500,
+            headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+        });
+    }
+    const lines = ['User-agent: *'];
+    if (noIndex) {
+        // Auth-gated / staging / dev site — block all crawlers
+        lines.push('Disallow: /');
+    }
+    else {
+        // Public site — allow all, block CMS admin, link sitemap
+        lines.push('Disallow: /admin/');
+        lines.push('Allow: /');
+        lines.push('');
+        lines.push(`Sitemap: ${new URL('sitemap-index.xml', site).href}`);
+    }
+    return new Response(lines.join('\n') + '\n', {
+        headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+    });
+};
+//# sourceMappingURL=robots-txt.js.map

package/dist/routes/robots-txt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"robots-txt.js","sourceRoot":"","sources":["../../src/routes/robots-txt.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,GAAG,GAAa,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACxC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,KAAK,MAAM,CAAC;IAE7D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,2DAA2D;QAC3D,OAAO,IAAI,QAAQ,CAAC,8BAA8B,EAAE;YAClD,MAAM,EAAE,GAAG;YACX,OAAO,EAAE,EAAE,cAAc,EAAE,2BAA2B,EAAE;SACzD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAa,CAAC,eAAe,CAAC,CAAC;IAE1C,IAAI,OAAO,EAAE,CAAC;QACZ,uDAAuD;QACvD,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,yDAAyD;QACzD,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE;QAC3C,OAAO,EAAE,EAAE,cAAc,EAAE,2BAA2B,EAAE;KACzD,CAAC,CAAC;AACL,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@easy-web/seo",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Shared SEO primitives for @easy-web/* consumer instances — Astro integration wrapping @astrojs/sitemap with i18n hreflang, dynamic robots.txt route with noIndex mode, and <SeoHead> component (canonical, OpenGraph, Twitter Cards, hreflang, theme-color, manifest).",
+  "keywords": [
+    "astro-integration",
+    "astro-component",
+    "seo",
+    "sitemap",
+    "robots.txt",
+    "opengraph",
+    "hreflang",
+    "canonical"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./components/*": "./src/components/*.astro"
+  },
+  "files": [
+    "dist",
+    "src/components",
+    "src/routes",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "lint": "eslint src",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "astro": ">=6.0.0 <8.0.0",
+    "@easy-web/i18n": ">=1.0.0"
+  },
+  "dependencies": {
+    "@astrojs/sitemap": "^3.7.3"
+  },
+  "devDependencies": {
+    "astro": "^6.4.0",
+    "@easy-web/i18n": "workspace:*",
+    "vitest": "^3.2.4",
+    "@vitest/coverage-v8": "^3.2.4",
+    "typescript": "^5.5.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/achimismaili/easy-web.git",
+    "directory": "packages/seo"
+  },
+  "license": "MIT"
+}

package/src/components/SeoHead.astro

@@ -0,0 +1,76 @@
+---
+export interface AlternateLink {
+  hreflang: string;
+  href: string;
+}
+
+export interface Props {
+  title: string;
+  description?: string;
+  pathname: string;
+  locale: string;
+  siteName: string;
+  ogType?: 'website' | 'article';
+  ogImage?: string;
+  themeColor?: string;
+  manifest?: string;
+  noIndex?: boolean;
+  twitterCard?: 'summary' | 'summary_large_image';
+  twitterSite?: string;
+  alternates?: AlternateLink[];
+}
+
+const {
+  title,
+  description,
+  pathname,
+  locale,
+  siteName,
+  ogType = 'website',
+  ogImage,
+  themeColor,
+  manifest,
+  noIndex = false,
+  twitterCard = 'summary',
+  twitterSite,
+  alternates = [],
+} = Astro.props;
+
+const site = Astro.site;
+if (!site) {
+  throw new Error(
+    '@easy-web/seo: <SeoHead> requires astro.config.mjs to set `site` (a full https:// URL).'
+  );
+}
+
+const canonical = new URL(pathname, site).href;
+const absoluteOgImage = ogImage ? new URL(ogImage, site).href : undefined;
+// Map locale to OG locale format: 'de' → 'de_DE', 'en' → 'en_US'
+const ogLocale = locale === 'en' ? 'en_US' : locale === 'de' ? 'de_DE' : locale.replace('-', '_');
+const ogLocaleAlternate = locale === 'en' ? 'de_DE' : 'en_US';
+---
+<title>{title}</title>
+{description && <meta name="description" content={description} />}
+<link rel="canonical" href={canonical} />
+{noIndex && <meta name="robots" content="noindex, nofollow" />}
+{themeColor && <meta name="theme-color" content={themeColor} />}
+{manifest && <link rel="manifest" href={manifest} />}
+<!-- Open Graph -->
+<meta property="og:title" content={title} />
+{description && <meta property="og:description" content={description} />}
+<meta property="og:url" content={canonical} />
+<meta property="og:type" content={ogType} />
+<meta property="og:locale" content={ogLocale} />
+<meta property="og:locale:alternate" content={ogLocaleAlternate} />
+<meta property="og:site_name" content={siteName} />
+{absoluteOgImage && <meta property="og:image" content={absoluteOgImage} />}
+<!-- Twitter Cards -->
+<meta name="twitter:card" content={twitterCard} />
+<meta name="twitter:title" content={title} />
+{description && <meta name="twitter:description" content={description} />}
+{absoluteOgImage && <meta name="twitter:image" content={absoluteOgImage} />}
+{twitterSite && <meta name="twitter:site" content={twitterSite} />}
+<!-- hreflang alternates -->
+{alternates.map((link) => (
+  <link rel="alternate" hreflang={link.hreflang} href={link.href} />
+))}

package/src/routes/robots-txt.ts

@@ -0,0 +1,42 @@
+import type { APIRoute } from 'astro';
+
+/**
+ * Dynamic robots.txt endpoint injected by @easy-web/seo integration.
+ *
+ * Behavior:
+ * - noIndex mode (process.env.EASY_WEB_SEO_NO_INDEX === 'true'):
+ *   Emits Disallow: / (blocks all crawlers — for auth-gated/staging sites)
+ * - Public mode (default):
+ *   Emits Disallow: /admin/, Allow: /, Sitemap: <site>/sitemap-index.xml
+ *
+ * The noIndex flag is set by the integration factory in astro:config:setup
+ * via process.env.EASY_WEB_SEO_NO_INDEX before this route is injected.
+ */
+export const GET: APIRoute = ({ site }) => {
+  const noIndex = process.env.EASY_WEB_SEO_NO_INDEX === 'true';
+
+  if (!site) {
+    // Fail safe: if site is not configured, block all crawlers
+    return new Response('User-agent: *\nDisallow: /\n', {
+      status: 500,
+      headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+    });
+  }
+
+  const lines: string[] = ['User-agent: *'];
+
+  if (noIndex) {
+    // Auth-gated / staging / dev site — block all crawlers
+    lines.push('Disallow: /');
+  } else {
+    // Public site — allow all, block CMS admin, link sitemap
+    lines.push('Disallow: /admin/');
+    lines.push('Allow: /');
+    lines.push('');
+    lines.push(`Sitemap: ${new URL('sitemap-index.xml', site).href}`);
+  }
+
+  return new Response(lines.join('\n') + '\n', {
+    headers: { 'Content-Type': 'text/plain; charset=utf-8' },
+  });
+};