@rimelight/seo 0.0.5 → 0.0.7

package/src/index.ts

@@ -2,21 +2,41 @@ export type {
   ChangeFreq,
   LocaleConfig,
   RobotsOptions,
+  RobotsRouteOptions,
   SeoEntry,
   SitemapAlternate,
   SitemapUrl,
+  SitemapOptions,
   UserAgentRule,
   SiteConfig,
   OGImage,
   RSSFeed,
+  RssItem,
+  RssFeedOptions,
+  RssOptions,
+  RssCollectionConfig,
   HeadProps,
   OpenGraphMeta,
   TwitterMeta,
   LlmsPage,
   LlmsTxtOptions,
   LlmsFullTxtOptions,
+  LlmsRouteOptions,
+  LlmsFullRouteOptions,
   ArticleSchemaOptions,
-  BreadcrumbItem
+  BreadcrumbItem,
+  SecurityTxtOptions,
+  SecurityRouteOptions,
+  WebManifestIcon,
+  WebManifestShortcut,
+  WebManifest,
+  WebManifestOptions,
+  ManifestRouteOptions,
+  ApiCatalogItem,
+  ApiCatalog,
+  ApiCatalogOptions,
+  ApiCatalogRouteOptions,
+  AssetRouteOptions
 } from "./types.js"
 
 export {
@@ -28,6 +48,8 @@ export {
 
 export { buildRobotsTxt } from "./robots.js"
 
+export { buildRssXml, escapeXml } from "./rss.js"
+
 export {
   buildCanonicalUrl,
   buildPageTitle,
@@ -38,5 +60,14 @@ export {
 } from "./meta.js"
 
 export { buildLlmsTxt, buildLlmsFullTxt } from "./llms.js"
+export { buildSecurityTxt } from "./security.js"
+export { buildWebManifest } from "./manifest.js"
+export { buildApiCatalog } from "./catalog.js"
 export { buildArticleSchema, buildBreadcrumbSchema } from "./schema.js"
-export { rimelightSeo, type RimelightSeoOptions } from "./integration.js"
+export { generatePng, generateMaskablePng, generateIco, generateOgCard } from "./assets.js"
+export type { OgFontConfig, OgLayoutOptions, OgRenderConfig } from "./og.js"
+
+import { rimelightSeo } from "./integration.js"
+export type { RimelightSeoOptions } from "./integration.js"
+export { rimelightSeo }
+export default rimelightSeo

package/src/integration.ts

@@ -1,67 +1,344 @@
 import type { AstroIntegration } from "astro"
-import type { RobotsOptions, SitemapUrl, LlmsTxtOptions } from "./types.js"
-
-export interface RimelightSeoOptions {
-  /**
-   * Sitemap configuration or false to disable automatic /sitemap.xml
-   */
-  sitemap?:
-    | boolean
-    | {
-        urls?: SitemapUrl[]
-        [key: string]: any
-      }
-  /**
-   * Robots.txt configuration or false to disable automatic /robots.txt
-   */
-  robots?: boolean | RobotsOptions
-  /**
-   * LLMs.txt configuration or false to disable automatic /llms.txt
-   */
-  llms?: boolean | LlmsTxtOptions
-}
+import path from "node:path"
+import fs from "node:fs"
+import { fileURLToPath } from "node:url"
+import type { RimelightSeoOptions } from "./types.js"
+import { generateIco, generatePng, generateMaskablePng, generateOgCard } from "./assets.js"
+
+export { type RimelightSeoOptions } from "./types.js"
 
 export function rimelightSeo(options: RimelightSeoOptions = {}): AstroIntegration {
   return {
     name: "@rimelight/seo",
     hooks: {
-      "astro:config:setup": ({ injectRoute, updateConfig }) => {
+      "astro:config:setup": ({ injectRoute, updateConfig, config }) => {
+        const rootDir = fileURLToPath(config.root)
+
+        // Resolve site files
+        const findFile = (candidates: string[]): string | null => {
+          for (const c of candidates) {
+            const resolved = path.resolve(rootDir, c)
+            if (fs.existsSync(resolved)) return resolved
+          }
+          return null
+        }
+
+        const seoConfigPath = findFile([
+          "src/config/seo.config.ts",
+          "src/config/seo.config.js",
+          "src/config/seo.config.mjs"
+        ])
+
+        const siteConfigPath = findFile([
+          "src/config/site.config.ts",
+          "src/config/site.config.js",
+          "src/config/site.config.mjs"
+        ])
+
+        const dbPath = findFile(["src/db/index.ts", "src/db/index.js", "src/db/index.mjs"])
+
+        const corpusPath = findFile([
+          "src/config/llms.corpus.ts",
+          "src/config/llms.corpus.js",
+          "src/config/llms.corpus.mjs"
+        ])
+
+        // Master Icon Discovery for dynamic public asset generation
+        const assetOpts = typeof options.assets === "object" ? options.assets : {}
+        const explicitIcon = assetOpts.icon ? path.resolve(rootDir, assetOpts.icon) : null
+        const masterIconPath =
+          explicitIcon && fs.existsSync(explicitIcon)
+            ? explicitIcon
+            : findFile([
+                "src/assets/logos/logomark_color.svg",
+                "src/assets/logos/logo_color.svg",
+                "src/assets/logos/logomark.svg",
+                "src/assets/logos/logo.svg",
+                "src/assets/icon.svg",
+                "src/assets/logo.svg",
+                "src/assets/icon.png",
+                "public/favicon.svg"
+              ])
+
+        let masterIconBuffer: Buffer | null = null
+        let isSvg = false
+        if (masterIconPath && fs.existsSync(masterIconPath)) {
+          masterIconBuffer = fs.readFileSync(masterIconPath)
+          isSvg = masterIconPath.endsWith(".svg")
+        }
+
+        const bgColor = assetOpts.backgroundColor || "#ffffff"
+
+        // Inject standard routes
         if (options.robots !== false) {
+          const pattern =
+            typeof options.robots === "object" && options.robots.path
+              ? options.robots.path
+              : "/robots.txt"
           injectRoute({
-            pattern: "/robots.txt",
+            pattern,
             entrypoint: "@rimelight/seo/routes/robots.txt.ts"
           })
         }
 
         if (options.sitemap !== false) {
+          const pattern =
+            typeof options.sitemap === "object" && options.sitemap.path
+              ? options.sitemap.path
+              : "/sitemap.xml"
           injectRoute({
-            pattern: "/sitemap.xml",
+            pattern,
             entrypoint: "@rimelight/seo/routes/sitemap.xml.ts"
           })
         }
 
+        if (options.rss !== false) {
+          const pattern =
+            typeof options.rss === "object" && options.rss.path ? options.rss.path : "/rss.xml"
+          injectRoute({
+            pattern,
+            entrypoint: "@rimelight/seo/routes/rss.xml.ts"
+          })
+        }
+
         if (options.llms !== false) {
+          const pattern =
+            typeof options.llms === "object" && options.llms.path ? options.llms.path : "/llms.txt"
           injectRoute({
-            pattern: "/llms.txt",
+            pattern,
             entrypoint: "@rimelight/seo/routes/llms.txt.ts"
           })
         }
 
+        if (options.llmsFull !== false) {
+          const pattern =
+            typeof options.llmsFull === "object" && options.llmsFull.path
+              ? options.llmsFull.path
+              : "/llms-full.txt"
+          injectRoute({
+            pattern,
+            entrypoint: "@rimelight/seo/routes/llms-full.txt.ts"
+          })
+        }
+
+        if (options.security !== false) {
+          const pattern =
+            typeof options.security === "object" && options.security.path
+              ? options.security.path
+              : "/.well-known/security.txt"
+          injectRoute({
+            pattern,
+            entrypoint: "@rimelight/seo/routes/security.txt.ts"
+          })
+
+          const legacyRoute =
+            typeof options.security === "object" ? options.security.legacyRoute !== false : true
+          if (legacyRoute && pattern === "/.well-known/security.txt") {
+            injectRoute({
+              pattern: "/security.txt",
+              entrypoint: "@rimelight/seo/routes/security.txt.ts"
+            })
+          }
+        }
+
+        if (options.apiCatalog !== false) {
+          const pattern =
+            typeof options.apiCatalog === "object" && options.apiCatalog.path
+              ? options.apiCatalog.path
+              : "/.well-known/api-catalog"
+          injectRoute({
+            pattern,
+            entrypoint: "@rimelight/seo/routes/api-catalog.ts"
+          })
+        }
+
+        if (options.manifest !== false) {
+          const pattern =
+            typeof options.manifest === "object" && options.manifest.path
+              ? options.manifest.path
+              : "/site.webmanifest"
+          injectRoute({
+            pattern,
+            entrypoint: "@rimelight/seo/routes/site.webmanifest.ts"
+          })
+        }
+
         updateConfig({
           vite: {
             plugins: [
+              {
+                name: "vite-plugin-rimelight-seo-assets",
+                configureServer(server) {
+                  if (!masterIconBuffer) return
+                  server.middlewares.use(async (req, res, next) => {
+                    const url = req.url?.split("?")[0]
+                    if (url === "/favicon.ico" && assetOpts.faviconIco !== false) {
+                      const ico = await generateIco(masterIconBuffer, 32)
+                      res.setHeader("Content-Type", "image/x-icon")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(ico)
+                      return
+                    }
+                    if (url === "/apple-touch-icon.png" && assetOpts.appleTouchIcon !== false) {
+                      const png = await generatePng(masterIconBuffer, { width: 180, height: 180 })
+                      res.setHeader("Content-Type", "image/png")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(png)
+                      return
+                    }
+                    if (url === "/icon-192.png" && assetOpts.icon192 !== false) {
+                      const png = await generatePng(masterIconBuffer, { width: 192, height: 192 })
+                      res.setHeader("Content-Type", "image/png")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(png)
+                      return
+                    }
+                    if (url === "/icon-512.png" && assetOpts.icon512 !== false) {
+                      const png = await generatePng(masterIconBuffer, { width: 512, height: 512 })
+                      res.setHeader("Content-Type", "image/png")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(png)
+                      return
+                    }
+                    if (url === "/icon-maskable-512.png" && assetOpts.iconMaskable !== false) {
+                      const png = await generateMaskablePng(masterIconBuffer, {
+                        size: 512,
+                        background: bgColor
+                      })
+                      res.setHeader("Content-Type", "image/png")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(png)
+                      return
+                    }
+                    if (url === "/favicon.svg" && isSvg) {
+                      res.setHeader("Content-Type", "image/svg+xml")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(masterIconBuffer)
+                      return
+                    }
+                    if (url === "/og.png" && assetOpts.ogImage !== false) {
+                      const og = await generateOgCard({
+                        logoBuffer: masterIconBuffer,
+                        background: bgColor
+                      })
+                      res.setHeader("Content-Type", "image/png")
+                      res.setHeader("Cache-Control", "no-cache")
+                      res.end(og)
+                      return
+                    }
+                    next()
+                  })
+                },
+                async generateBundle() {
+                  if (options.assets === false || !masterIconBuffer) return
+
+                  if (assetOpts.faviconIco !== false) {
+                    const ico = await generateIco(masterIconBuffer, 32)
+                    this.emitFile({ type: "asset", fileName: "favicon.ico", source: ico })
+                  }
+                  if (assetOpts.appleTouchIcon !== false) {
+                    const png = await generatePng(masterIconBuffer, { width: 180, height: 180 })
+                    this.emitFile({ type: "asset", fileName: "apple-touch-icon.png", source: png })
+                  }
+                  if (assetOpts.icon192 !== false) {
+                    const png = await generatePng(masterIconBuffer, { width: 192, height: 192 })
+                    this.emitFile({ type: "asset", fileName: "icon-192.png", source: png })
+                  }
+                  if (assetOpts.icon512 !== false) {
+                    const png = await generatePng(masterIconBuffer, { width: 512, height: 512 })
+                    this.emitFile({ type: "asset", fileName: "icon-512.png", source: png })
+                  }
+                  if (assetOpts.iconMaskable !== false) {
+                    const png = await generateMaskablePng(masterIconBuffer, {
+                      size: 512,
+                      background: bgColor
+                    })
+                    this.emitFile({
+                      type: "asset",
+                      fileName: "icon-maskable-512.png",
+                      source: png
+                    })
+                  }
+                  if (assetOpts.ogImage !== false) {
+                    const og = await generateOgCard({
+                      logoBuffer: masterIconBuffer,
+                      background: bgColor
+                    })
+                    this.emitFile({
+                      type: "asset",
+                      fileName: "og.png",
+                      source: og
+                    })
+                  }
+                  if (isSvg) {
+                    this.emitFile({
+                      type: "asset",
+                      fileName: "favicon.svg",
+                      source: masterIconBuffer
+                    })
+                  }
+                }
+              },
               {
                 name: "vite-plugin-rimelight-seo",
                 resolveId(id) {
-                  if (id === "virtual:rimelight-seo-config") {
-                    return "\0virtual:rimelight-seo-config"
+                  if (
+                    id === "virtual:rimelight-seo-config" ||
+                    id === "virtual:rimelight-seo/options"
+                  ) {
+                    return "\0virtual:rimelight-seo/options"
+                  }
+                  if (id === "virtual:rimelight-seo/config") {
+                    return "\0virtual:rimelight-seo/config"
+                  }
+                  if (id === "virtual:rimelight-seo/site-config") {
+                    return "\0virtual:rimelight-seo/site-config"
+                  }
+                  if (id === "virtual:rimelight-seo/db") {
+                    return "\0virtual:rimelight-seo/db"
+                  }
+                  if (id === "virtual:rimelight-seo/corpus") {
+                    return "\0virtual:rimelight-seo/corpus"
                   }
                   return null
                 },
                 load(id) {
-                  if (id === "\0virtual:rimelight-seo-config") {
+                  if (id === "\0virtual:rimelight-seo/options") {
                     return `export default ${JSON.stringify(options)};`
                   }
+                  if (id === "\0virtual:rimelight-seo/config") {
+                    if (seoConfigPath) {
+                      return `import * as customConfig from ${JSON.stringify(seoConfigPath)};
+export const SEO_LOCALES = customConfig.SEO_LOCALES;
+export const PRIVATE_PATH_PREFIXES = customConfig.PRIVATE_PATH_PREFIXES || [];
+export const seoEntries = customConfig.seoEntries;
+export const rssEntries = customConfig.rssEntries;
+export default customConfig;`
+                    }
+                    return `export const SEO_LOCALES = undefined;
+export const PRIVATE_PATH_PREFIXES = [];
+export const seoEntries = async () => [];
+export const rssEntries = undefined;`
+                  }
+                  if (id === "\0virtual:rimelight-seo/site-config") {
+                    if (siteConfigPath) {
+                      return `export * from ${JSON.stringify(siteConfigPath)};`
+                    }
+                    return `export const siteConfig = { name: "Site", description: "", url: "" };`
+                  }
+                  if (id === "\0virtual:rimelight-seo/db") {
+                    if (dbPath) {
+                      return `export * from ${JSON.stringify(dbPath)};`
+                    }
+                    return `export const db = null;
+export const pages = null;`
+                  }
+                  if (id === "\0virtual:rimelight-seo/corpus") {
+                    if (corpusPath) {
+                      return `export * from ${JSON.stringify(corpusPath)};`
+                    }
+                    return `export const corpusPages = [];`
+                  }
                   return null
                 }
               }
@@ -72,3 +349,5 @@ export function rimelightSeo(options: RimelightSeoOptions = {}): AstroIntegratio
     }
   }
 }
+
+export default rimelightSeo

package/src/manifest.test.ts

@@ -0,0 +1,41 @@
+import { describe, it, expect } from "vite-plus/test"
+import { buildWebManifest } from "./manifest.js"
+
+describe("buildWebManifest", () => {
+  it("generates standard web manifest with sensible defaults", () => {
+    const manifest = buildWebManifest({
+      name: "My Application"
+    })
+
+    expect(manifest.name).toBe("My Application")
+    expect(manifest.short_name).toBe("My Application")
+    expect(manifest.start_url).toBe("/")
+    expect(manifest.display).toBe("standalone")
+    expect(manifest.background_color).toBe("#ffffff")
+    expect(manifest.theme_color).toBe("#ffffff")
+    expect(manifest.icons).toHaveLength(3)
+  })
+
+  it("customizes theme, icons and shortcuts", () => {
+    const manifest = buildWebManifest({
+      name: "Custom App",
+      shortName: "App",
+      description: "A custom web application",
+      themeColor: "#000000",
+      backgroundColor: "#111111",
+      shortcuts: [
+        {
+          name: "Dashboard",
+          url: "/dashboard"
+        }
+      ]
+    })
+
+    expect(manifest.name).toBe("Custom App")
+    expect(manifest.short_name).toBe("App")
+    expect(manifest.description).toBe("A custom web application")
+    expect(manifest.theme_color).toBe("#000000")
+    expect(manifest.background_color).toBe("#111111")
+    expect(manifest.shortcuts).toHaveLength(1)
+  })
+})

package/src/manifest.ts

@@ -0,0 +1,59 @@
+import type { WebManifest, WebManifestOptions } from "./types.js"
+
+/**
+ * Build web app manifest (site.webmanifest) compliant with W3C Web App Manifest.
+ */
+export function buildWebManifest(options: WebManifestOptions): WebManifest {
+  const {
+    name,
+    shortName = name,
+    description = "",
+    startUrl = "/",
+    display = "standalone",
+    backgroundColor = "#ffffff",
+    themeColor = "#ffffff",
+    icons = [
+      {
+        src: "/icon-192.png",
+        sizes: "192x192",
+        type: "image/png",
+        purpose: "any"
+      },
+      {
+        src: "/icon-512.png",
+        sizes: "512x512",
+        type: "image/png",
+        purpose: "any"
+      },
+      {
+        src: "/icon-maskable-512.png",
+        sizes: "512x512",
+        type: "image/png",
+        purpose: "maskable"
+      }
+    ],
+    shortcuts,
+    categories,
+    lang,
+    dir,
+    orientation,
+    scope
+  } = options
+
+  return {
+    name,
+    short_name: shortName,
+    ...(description ? { description } : {}),
+    start_url: startUrl,
+    display,
+    background_color: backgroundColor,
+    theme_color: themeColor,
+    icons,
+    ...(shortcuts ? { shortcuts } : {}),
+    ...(categories ? { categories } : {}),
+    ...(lang ? { lang } : {}),
+    ...(dir ? { dir } : {}),
+    ...(orientation ? { orientation } : {}),
+    ...(scope ? { scope } : {})
+  }
+}