@rimelight/seo 0.0.4 → 0.0.6

package/dist/routes/sitemap.xml.mjs

@@ -0,0 +1,27 @@
+import { buildSitemapUrls, buildSitemapXml } from "../sitemap.mjs";
+import * as siteConfigMod from "virtual:rimelight-seo/site-config";
+import seoOptions from "virtual:rimelight-seo/options";
+import * as seoConfig from "virtual:rimelight-seo/config";
+//#region src/routes/sitemap.xml.ts
+const GET = async ({ site, url }) => {
+	const sitemapOpts = typeof seoOptions?.sitemap === "object" ? seoOptions.sitemap : {};
+	const siteUrl = site ? site.toString() : siteConfigMod.siteConfig?.url || url.origin;
+	let entries = [];
+	if (typeof sitemapOpts.entries === "function") entries = await sitemapOpts.entries();
+	else if (typeof seoConfig.seoEntries === "function") entries = await seoConfig.seoEntries();
+	const locales = sitemapOpts.locales || seoConfig.SEO_LOCALES || (siteUrl ? {
+		site: siteUrl.replace(/\/$/, ""),
+		locales: { en: "en-US" },
+		defaultLocale: "en",
+		trailingSlash: "never"
+	} : void 0);
+	let urls = sitemapOpts.urls || [];
+	if (urls.length === 0 && entries.length > 0 && locales) urls = buildSitemapUrls(entries, locales);
+	const xml = buildSitemapXml(urls);
+	return new Response(xml, { headers: {
+		"Content-Type": "application/xml; charset=utf-8",
+		"Cache-Control": "public, max-age=3600, stale-while-revalidate=86400"
+	} });
+};
+//#endregion
+export { GET };

package/dist/rss.d.mts

@@ -0,0 +1,8 @@
+import { RssFeedOptions } from "./types.mjs";
+//#region src/rss.d.ts
+export declare function escapeXml(str: string): string;
+/**
+ * Builds standard RSS 2.0 feed XML document with Atom namespace link.
+ */
+export declare function buildRssXml(options: RssFeedOptions): string;
+//#endregion

package/dist/rss.mjs

@@ -0,0 +1,44 @@
+//#region src/rss.ts
+function escapeXml(str) {
+	return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
+}
+/**
+* Builds standard RSS 2.0 feed XML document with Atom namespace link.
+*/
+function buildRssXml(options) {
+	const siteUrl = (options.site || "").replace(/\/$/, "");
+	const feedUrl = options.feedUrl || `${siteUrl}/rss.xml`;
+	const language = options.language || "en-US";
+	const lastBuildDate = (/* @__PURE__ */ new Date()).toUTCString();
+	const itemXmls = (options.items || []).map((item) => {
+		const itemLink = item.link.startsWith("http://") || item.link.startsWith("https://") ? item.link : `${siteUrl}${item.link.startsWith("/") ? "" : "/"}${item.link}`;
+		const pubDate = new Date(item.pubDate).toUTCString();
+		const guid = item.guid || itemLink;
+		const lines = [
+			"    <item>",
+			`      <title>${escapeXml(item.title)}</title>`,
+			`      <link>${escapeXml(itemLink)}</link>`,
+			`      <guid isPermaLink="${guid.startsWith("http") ? "true" : "false"}">${escapeXml(guid)}</guid>`,
+			`      <pubDate>${pubDate}</pubDate>`
+		];
+		if (item.description) lines.push(`      <description>${escapeXml(item.description)}</description>`);
+		if (item.author) lines.push(`      <author>${escapeXml(item.author)}</author>`);
+		if (item.content) lines.push(`      <content:encoded><![CDATA[${item.content}]]></content:encoded>`);
+		lines.push("    </item>");
+		return lines.join("\n");
+	});
+	return `<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/">
+  <channel>
+    <title>${escapeXml(options.title || "")}</title>
+    <description>${escapeXml(options.description || "")}</description>
+    <link>${escapeXml(siteUrl)}</link>
+    <language>${escapeXml(language)}</language>
+    <lastBuildDate>${lastBuildDate}</lastBuildDate>
+    <atom:link href="${escapeXml(feedUrl)}" rel="self" type="application/rss+xml"/>
+${itemXmls.join("\n")}
+  </channel>
+</rss>`;
+}
+//#endregion
+export { buildRssXml, escapeXml };

package/dist/schema-C8v69blQ.d.mts

@@ -0,0 +1,28 @@
+//#region src/schema.d.ts
+interface ArticleSchemaOptions {
+  type?: "TechArticle" | "Article" | "BlogPosting";
+  title: string;
+  description?: string;
+  url: string;
+  datePublished?: string | Date;
+  dateModified?: string | Date;
+  authorName?: string;
+  authorUrl?: string;
+  image?: string;
+  publisherName?: string;
+  publisherLogo?: string;
+}
+interface BreadcrumbItem {
+  name: string;
+  url: string;
+}
+/**
+ * Builds Schema.org Article / TechArticle / BlogPosting JSON-LD.
+ */
+declare function buildArticleSchema(options: ArticleSchemaOptions): Record<string, any>;
+/**
+ * Builds Schema.org BreadcrumbList JSON-LD.
+ */
+declare function buildBreadcrumbSchema(items: BreadcrumbItem[]): Record<string, any>;
+//#endregion
+export { buildBreadcrumbSchema as i, BreadcrumbItem as n, buildArticleSchema as r, ArticleSchemaOptions as t };

package/dist/schema.d.mts

@@ -0,0 +1,2 @@
+import { i as buildBreadcrumbSchema, n as BreadcrumbItem, r as buildArticleSchema, t as ArticleSchemaOptions } from "./schema-C8v69blQ.mjs";
+export { ArticleSchemaOptions, BreadcrumbItem, buildArticleSchema, buildBreadcrumbSchema };

package/dist/schema.mjs

@@ -0,0 +1,52 @@
+//#region src/schema.ts
+/**
+* Builds Schema.org Article / TechArticle / BlogPosting JSON-LD.
+*/
+function buildArticleSchema(options) {
+	const { type = "TechArticle", title, description, url, datePublished, dateModified, authorName, authorUrl, image, publisherName = "Rimelight Entertainment", publisherLogo } = options;
+	const schema = {
+		"@context": "https://schema.org",
+		"@type": type,
+		"headline": title,
+		"mainEntityOfPage": {
+			"@type": "WebPage",
+			"@id": url
+		}
+	};
+	if (description) schema["description"] = description;
+	if (image) schema["image"] = image;
+	if (datePublished) schema["datePublished"] = datePublished instanceof Date ? datePublished.toISOString() : datePublished;
+	if (dateModified) schema["dateModified"] = dateModified instanceof Date ? dateModified.toISOString() : dateModified;
+	else if (datePublished) schema["dateModified"] = schema["datePublished"];
+	if (authorName) schema["author"] = {
+		"@type": "Person",
+		"name": authorName,
+		...authorUrl ? { url: authorUrl } : {}
+	};
+	if (publisherName) schema["publisher"] = {
+		"@type": "Organization",
+		"name": publisherName,
+		...publisherLogo ? { logo: {
+			"@type": "ImageObject",
+			"url": publisherLogo
+		} } : {}
+	};
+	return schema;
+}
+/**
+* Builds Schema.org BreadcrumbList JSON-LD.
+*/
+function buildBreadcrumbSchema(items) {
+	return {
+		"@context": "https://schema.org",
+		"@type": "BreadcrumbList",
+		"itemListElement": items.map((item, index) => ({
+			"@type": "ListItem",
+			"position": index + 1,
+			"name": item.name,
+			"item": item.url
+		}))
+	};
+}
+//#endregion
+export { buildArticleSchema, buildBreadcrumbSchema };

package/dist/sitemap.d.mts

@@ -1,20 +1,19 @@
-import { r as LocaleConfig, s as SeoEntry, u as SitemapUrl } from "./types-e7gqYZwc.mjs";
+import { LocaleConfig, SeoEntry, SitemapUrl } from "./types.mjs";
 //#region src/sitemap.d.ts
 /**
  * Build fully-resolved sitemap URLs from entries and locale config
  */
-declare function buildSitemapUrls(entries: SeoEntry[], config: LocaleConfig): SitemapUrl[];
+export declare function buildSitemapUrls(entries: SeoEntry[], config: LocaleConfig): SitemapUrl[];
 /**
  * Build sitemap XML from resolved URLs
  */
-declare function buildSitemapXml(urls: SitemapUrl[]): string;
+export declare function buildSitemapXml(urls: SitemapUrl[]): string;
 /**
  * Build sitemap index XML from sitemap URLs
  */
-declare function buildSitemapIndexXml(sitemapUrls: string[]): string;
+export declare function buildSitemapIndexXml(sitemapUrls: string[]): string;
 /**
  * Chunk sitemap URLs into multiple sitemaps (max 50k URLs per sitemap)
  */
-declare function chunkSitemapUrls(urls: SitemapUrl[], limit?: number): SitemapUrl[][];
-//#endregion
-export { buildSitemapIndexXml, buildSitemapUrls, buildSitemapXml, chunkSitemapUrls };
+export declare function chunkSitemapUrls(urls: SitemapUrl[], limit?: number): SitemapUrl[][];
+//#endregion

package/dist/types.d.mts

@@ -1,2 +1,354 @@
-import { _ as ArticleSchemaOptions, a as RSSFeed, c as SiteConfig, d as UserAgentRule, f as LlmsFullTxtOptions, i as OGImage, l as SitemapAlternate, m as LlmsTxtOptions, n as HeadProps, o as RobotsOptions, p as LlmsPage, r as LocaleConfig, s as SeoEntry, t as ChangeFreq, u as SitemapUrl, v as BreadcrumbItem } from "./types-e7gqYZwc.mjs";
-export { type ArticleSchemaOptions, type BreadcrumbItem, ChangeFreq, HeadProps, type LlmsFullTxtOptions, type LlmsPage, type LlmsTxtOptions, LocaleConfig, OGImage, RSSFeed, RobotsOptions, SeoEntry, SiteConfig, SitemapAlternate, SitemapUrl, UserAgentRule };
+import { n as BreadcrumbItem, t as ArticleSchemaOptions } from "./schema-C8v69blQ.mjs";
+import { n as LlmsPage, r as LlmsTxtOptions$1, t as LlmsFullTxtOptions$1 } from "./llms-BVLxzjr-.mjs";
+//#region src/types.d.ts
+/**
+ * Change frequency for sitemap entries
+ */
+export type ChangeFreq = "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
+/**
+ * SEO entry — a single page to include in sitemaps
+ */
+export interface SeoEntry {
+  /**
+   * Locale-less path, e.g. "/company/blog/hello". Leading slash required.
+   */
+  path: string;
+  lastmod?: Date;
+  changefreq?: ChangeFreq;
+  priority?: number;
+  /**
+   * Restrict to a subset of locales; defaults to all configured locales.
+   */
+  locales?: readonly string[];
+}
+/**
+ * Locale configuration for SEO builders
+ */
+export interface LocaleConfig {
+  /**
+   * Absolute origin, e.g. "https://rimelight.com"
+   */
+  site: string;
+  /**
+   * Map of locale segment -> hreflang, e.g. { en: "en-US", pt: "pt-BR" }
+   */
+  locales: Record<string, string>;
+  defaultLocale: string;
+  /**
+   * Emit the default locale without a prefix. Default: false.
+   */
+  prefixDefaultLocale?: boolean;
+  trailingSlash?: "always" | "never";
+}
+/**
+ * Fully resolved sitemap URL with alternates
+ */
+export interface SitemapUrl {
+  loc: string;
+  lastmod?: string;
+  changefreq?: ChangeFreq;
+  priority?: number;
+  alternates?: SitemapAlternate[];
+}
+/**
+ * Language alternate for a sitemap URL
+ */
+export interface SitemapAlternate {
+  hreflang: string;
+  href: string;
+}
+/**
+ * Options for robots.txt generation
+ */
+export interface RobotsOptions {
+  /**
+   * The sitemap URL to reference
+   */
+  sitemapUrl: string;
+  /**
+   * Paths to disallow for all user agents
+   */
+  disallow?: string[];
+  /**
+   * Paths to allow for all user agents
+   */
+  allow?: string[];
+  /**
+   * User-agent specific rules
+   */
+  userAgentRules?: UserAgentRule[];
+}
+/**
+ * User-agent specific robots.txt rule
+ */
+export interface UserAgentRule {
+  userAgent: string;
+  disallow?: string[];
+  allow?: string[];
+}
+export interface OpenGraphMeta {
+  type?: string;
+  locale?: string;
+  url?: string;
+  title?: string;
+  description?: string;
+  images?: OGImage[] | OGImage;
+  siteName?: string;
+  [key: string]: unknown;
+}
+export interface TwitterMeta {
+  card?: "summary" | "summary_large_image" | "player" | "app";
+  site?: string;
+  creator?: string;
+  title?: string;
+  description?: string;
+  images?: OGImage[] | OGImage | string;
+  [key: string]: unknown;
+}
+/**
+ * Site identity and SEO defaults shared across all Rimelight Astro sites. The UI-specific overrides
+ * (component themes, shortcuts, etc.) live in UIConfig (packages/ui) and are passed directly to the
+ * ui() integration.
+ */
+export interface SiteConfig {
+  id: string;
+  name: string;
+  description: string;
+  url: string;
+  ogImage: string;
+  author: string;
+  email: string;
+  branding: {
+    logo: {
+      alt: string;
+    };
+    favicon: {
+      svg: string;
+    };
+    colors: {
+      themeColor: string;
+      backgroundColor: string;
+    };
+  };
+  seo: {
+    titleTemplate: string;
+    ogImageFallback: string;
+    maxDescriptionLength: number;
+    authorHandle?: string;
+  };
+  openGraph?: OpenGraphMeta;
+  twitter?: TwitterMeta;
+}
+/**
+ * Open Graph image with alt text
+ */
+export interface OGImage {
+  /**
+   * Image URL (relative or absolute)
+   */
+  src: string;
+  /**
+   * Alt text for the image
+   */
+  alt: string;
+}
+/**
+ * RSS feed link configuration
+ */
+export interface RSSFeed {
+  /**
+   * RSS feed URL
+   */
+  href: string;
+  /**
+   * Feed title (defaults to "RSS")
+   */
+  title?: string;
+}
+/**
+ * Props for the RLAHead Astro component. Defined here so consumers can construct head props without
+ * importing @rimelight/ui.
+ */
+export interface HeadProps {
+  /**
+   * Page title
+   */
+  title?: string;
+  /**
+   * Page description
+   */
+  description?: string;
+  /**
+   * Open Graph image with alt text
+   */
+  ogImage?: OGImage;
+  /**
+   * Open Graph type (e.g., "website", "article")
+   */
+  ogType?: string;
+  /**
+   * Open Graph locale (defaults to "en_US")
+   */
+  ogLocale?: string;
+  /**
+   * Whether to prevent indexing
+   */
+  noindex?: boolean;
+  /**
+   * Whether this is a 404 page
+   */
+  is404?: boolean;
+  /**
+   * Robots metadata (overrides noindex/is404 logic if provided)
+   */
+  robots?: string;
+  /**
+   * Canonical URL
+   */
+  canonical?: string;
+  /**
+   * Language alternates for i18n
+   */
+  languageAlternates?: Array<{
+    hreflang: string;
+    href: string;
+  }>;
+  /**
+   * Custom favicon SVG or image path (overrides config.branding.favicon.svg)
+   */
+  favicon?: string;
+  /**
+   * Site configuration for defaults
+   */
+  config?: SiteConfig;
+  /**
+   * Whether to enable View Transitions (ClientRouter)
+   */
+  transitions?: boolean;
+  /**
+   * Meta charset
+   */
+  charset?: string;
+  /**
+   * Meta viewport
+   */
+  viewport?: string;
+  /**
+   * RSS feed configuration
+   */
+  rssFeed?: RSSFeed;
+  /**
+   * Article or BlogPosting JSON-LD configuration
+   */
+  articleSchema?: ArticleSchemaOptions;
+  /**
+   * Breadcrumb list for JSON-LD structured data
+   */
+  breadcrumbs?: BreadcrumbItem[];
+  /**
+   * URL for this page's raw Markdown alternate twin
+   */
+  markdownUrl?: string;
+  /**
+   * Version alternates for multi-version documentation
+   */
+  versionAlternates?: Array<{
+    version: string;
+    href: string;
+  }>;
+  /**
+   * Whether the title should bypass site title template
+   */
+  absolute?: boolean;
+  /**
+   * Twitter card type
+   */
+  twitterCard?: "summary" | "summary_large_image" | "player" | "app";
+  /**
+   * Open Graph metadata overrides
+   */
+  openGraph?: OpenGraphMeta;
+  /**
+   * Twitter metadata overrides
+   */
+  twitter?: TwitterMeta;
+}
+export interface RssItem {
+  title: string;
+  link: string;
+  pubDate: Date | string | number;
+  description?: string;
+  content?: string;
+  guid?: string;
+  author?: string;
+}
+export interface RssFeedOptions {
+  title: string;
+  description: string;
+  site: string;
+  feedUrl?: string;
+  language?: string;
+  items: RssItem[];
+}
+export interface RssOptions extends Partial<RssFeedOptions> {
+  /**
+   * Custom RSS route pattern (default: "/rss.xml")
+   */
+  path?: string;
+  /**
+   * Custom items loader
+   */
+  items?: RssItem[];
+}
+export interface SitemapOptions {
+  /**
+   * Sitemap route pattern (default: "/sitemap.xml")
+   */
+  path?: string;
+  urls?: SitemapUrl[];
+  entries?: () => Promise<SeoEntry[]> | SeoEntry[];
+  locales?: LocaleConfig;
+  [key: string]: unknown;
+}
+export interface RobotsRouteOptions extends Partial<RobotsOptions> {
+  /**
+   * Route pattern (default: "/robots.txt")
+   */
+  path?: string;
+}
+export interface LlmsRouteOptions extends Partial<LlmsTxtOptions> {
+  /**
+   * Route pattern (default: "/llms.txt")
+   */
+  path?: string;
+}
+export interface LlmsFullRouteOptions extends Partial<LlmsFullTxtOptions> {
+  /**
+   * Route pattern (default: "/llms-full.txt")
+   */
+  path?: string;
+}
+export interface RimelightSeoOptions {
+  /**
+   * Sitemap configuration or false to disable automatic /sitemap.xml (default: true)
+   */
+  sitemap?: boolean | SitemapOptions;
+  /**
+   * Robots.txt configuration or false to disable automatic /robots.txt (default: true)
+   */
+  robots?: boolean | RobotsRouteOptions;
+  /**
+   * RSS feed configuration or false to disable automatic /rss.xml (default: true)
+   */
+  rss?: boolean | RssOptions;
+  /**
+   * LLMs.txt configuration or false to disable automatic /llms.txt (default: true)
+   */
+  llms?: boolean | LlmsRouteOptions;
+  /**
+   * LLMs-full.txt configuration or false to disable automatic /llms-full.txt (default: true)
+   */
+  llmsFull?: boolean | LlmsFullRouteOptions;
+}
+//#endregion
+export type { ArticleSchemaOptions, BreadcrumbItem, LlmsFullTxtOptions$1 as LlmsFullTxtOptions, LlmsPage, LlmsTxtOptions$1 as LlmsTxtOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimelight/seo",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "private": false,
   "description": "Rimelight Entertainment's SEO Package",
   "homepage": "https://rimelight.com/docs",
@@ -37,22 +37,41 @@
       "types": "./dist/robots.d.mts",
       "import": "./dist/robots.mjs"
     },
+    "./integration": {
+      "types": "./dist/integration.d.mts",
+      "import": "./dist/integration.mjs"
+    },
+    "./rss": {
+      "types": "./dist/rss.d.mts",
+      "import": "./dist/rss.mjs"
+    },
+    "./og": {
+      "types": "./dist/og.d.mts",
+      "import": "./dist/og.mjs"
+    },
     "./components/*": "./src/components/*",
+    "./routes/*": "./src/routes/*",
     "./*": "./src/*"
   },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@rimelight/config": "0.0.5",
-    "astro": "7.3.1",
+    "@rimelight/config": "0.0.8",
+    "astro": "7.3.2",
     "typescript": "6.0.3"
   },
   "peerDependencies": {
-    "astro": ">=7.0.0"
+    "astro": ">=7.0.0",
+    "takumi-js": ">=2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "takumi-js": {
+      "optional": true
+    }
   },
   "engines": {
-    "node": ">=26.7.0"
+    "node": ">=26.8.2"
   },
   "scripts": {
     "build": "vp pack",