@rimelight/seo 0.0.5 → 0.0.7

package/src/types.ts

@@ -1,3 +1,5 @@
+import type { LlmsTxtOptions, LlmsFullTxtOptions } from "./llms.js"
+
 /**
  * Change frequency for sitemap entries
  */
@@ -121,16 +123,17 @@ export interface SiteConfig {
   name: string
   description: string
   url: string
-  ogImage: string
+  ogImage?: string
   author: string
   email: string
   branding: {
     logo: {
       alt: string
     }
-    favicon: {
+    favicon?: {
       svg: string
     }
+    icon?: string
     colors: {
       themeColor: string
       backgroundColor: string
@@ -138,7 +141,7 @@ export interface SiteConfig {
   }
   seo: {
     titleTemplate: string
-    ogImageFallback: string
+    ogImageFallback?: string
     maxDescriptionLength: number
     authorHandle?: string
   }
@@ -277,5 +280,285 @@ export interface HeadProps {
   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 RssCollectionConfig {
+  name: string
+  pathPrefix?: string
+}
+
+export interface RssOptions extends Omit<Partial<RssFeedOptions>, "items"> {
+  /**
+   * Custom RSS route pattern (default: "/rss.xml")
+   */
+  path?: string
+  /**
+   * Custom items loader or static items array
+   */
+  items?: RssItem[] | (() => Promise<RssItem[]> | RssItem[])
+  /**
+   * Collections to include in RSS feed (defaults to ["blog", "posts", "news", "articles"])
+   */
+  collections?: (string | RssCollectionConfig)[]
+}
+
+export interface SitemapOptions {
+  /**
+   * Sitemap route pattern (default: "/sitemap.xml")
+   */
+  path?: string
+  urls?: SitemapUrl[]
+  entries?: () => Promise<SeoEntry[]> | SeoEntry[]
+  locales?: LocaleConfig
+  [key: string]: unknown
+}
+
+export interface SecurityTxtOptions {
+  /**
+   * Contact URI or list of contact URIs (e.g. "mailto:security@example.com") - REQUIRED by RFC 9116
+   */
+  contact: string | string[]
+  /**
+   * Expiration date/time (ISO 8601 string or Date) - REQUIRED by RFC 9116
+   */
+  expires?: Date | string
+  /**
+   * URI to PGP/GPG public key
+   */
+  encryption?: string | string[]
+  /**
+   * URI to security acknowledgments / hall of fame
+   */
+  acknowledgments?: string | string[]
+  /**
+   * Comma-separated list of preferred languages (e.g. "en, pt")
+   */
+  preferredLanguages?: string
+  /**
+   * Canonical URI of the security.txt file
+   */
+  canonical?: string
+  /**
+   * URI to security policy
+   */
+  policy?: string
+  /**
+   * URI to security hiring page
+   */
+  hiring?: string
+  /**
+   * URI to Common Security Advisory Framework (CSAF) provider
+   */
+  csaf?: string
+}
+
+export interface SecurityRouteOptions extends Partial<SecurityTxtOptions> {
+  /**
+   * Route pattern (default: "/.well-known/security.txt")
+   */
+  path?: string
+  /**
+   * Whether to also inject legacy fallback route at "/security.txt" (default: true)
+   */
+  legacyRoute?: boolean
+}
+
+export interface WebManifestIcon {
+  src: string
+  sizes: string
+  type: string
+  purpose?: "any" | "maskable" | "monochrome"
+}
+
+export interface WebManifestShortcut {
+  name: string
+  url: string
+  short_name?: string
+  description?: string
+  icons?: WebManifestIcon[]
+}
+
+export interface WebManifest {
+  name: string
+  short_name?: string
+  description?: string
+  start_url: string
+  display: "fullscreen" | "standalone" | "minimal-ui" | "browser"
+  background_color: string
+  theme_color: string
+  icons: WebManifestIcon[]
+  shortcuts?: WebManifestShortcut[]
+  categories?: string[]
+  lang?: string
+  dir?: "auto" | "ltr" | "rtl"
+  orientation?: "any" | "natural" | "landscape" | "portrait"
+  scope?: string
+  [key: string]: unknown
+}
+
+export interface WebManifestOptions {
+  name: string
+  shortName?: string
+  description?: string
+  startUrl?: string
+  display?: "fullscreen" | "standalone" | "minimal-ui" | "browser"
+  backgroundColor?: string
+  themeColor?: string
+  icons?: WebManifestIcon[]
+  shortcuts?: WebManifestShortcut[]
+  categories?: string[]
+  lang?: string
+  dir?: "auto" | "ltr" | "rtl"
+  orientation?: "any" | "natural" | "landscape" | "portrait"
+  scope?: string
+}
+
+export interface ManifestRouteOptions extends Partial<WebManifestOptions> {
+  /**
+   * Route pattern (default: "/site.webmanifest")
+   */
+  path?: string
+}
+
+export interface ApiCatalogItem {
+  rel: string
+  href: string
+  type?: string
+  title?: string
+  [key: string]: unknown
+}
+
+export interface ApiCatalog {
+  "api-catalog": ApiCatalogItem[]
+}
+
+export interface ApiCatalogOptions {
+  items: ApiCatalogItem[]
+}
+
+export interface ApiCatalogRouteOptions extends Partial<ApiCatalogOptions> {
+  /**
+   * Route pattern (default: "/.well-known/api-catalog")
+   */
+  path?: string
+}
+
+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 AssetRouteOptions {
+  /**
+   * Path to the master SVG/PNG icon file (relative to project root or absolute). If omitted, will
+   * search in src/assets/logos/ or siteConfig.branding.icon.
+   */
+  icon?: string
+  /**
+   * Background color for maskable icons (defaults to siteConfig.branding.colors.backgroundColor or
+   * #ffffff)
+   */
+  backgroundColor?: string
+  /**
+   * Whether to inject /favicon.ico (default: true)
+   */
+  faviconIco?: boolean
+  /**
+   * Whether to inject /apple-touch-icon.png (default: true)
+   */
+  appleTouchIcon?: boolean
+  /**
+   * Whether to inject /icon-192.png (default: true)
+   */
+  icon192?: boolean
+  /**
+   * Whether to inject /icon-512.png (default: true)
+   */
+  icon512?: boolean
+  /**
+   * Whether to inject /icon-maskable-512.png (default: true)
+   */
+  iconMaskable?: boolean
+  /**
+   * Whether to generate and emit /og.png branded card (default: true)
+   */
+  ogImage?: boolean
+}
+
+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
+  /**
+   * Security.txt configuration or false to disable automatic /.well-known/security.txt (default:
+   * true)
+   */
+  security?: boolean | SecurityRouteOptions
+  /**
+   * RFC 9652 API Catalog configuration or false to disable automatic /.well-known/api-catalog
+   * (default: true)
+   */
+  apiCatalog?: boolean | ApiCatalogRouteOptions
+  /**
+   * Web App Manifest configuration or false to disable automatic /site.webmanifest (default: true)
+   */
+  manifest?: boolean | ManifestRouteOptions
+  /**
+   * Automatic generation of compliant public image assets (favicon.ico, apple-touch-icon.png, PWA
+   * icons) from a single master icon (default: true)
+   */
+  assets?: boolean | AssetRouteOptions
+}
+
 export type { LlmsPage, LlmsTxtOptions, LlmsFullTxtOptions } from "./llms.js"
 export type { ArticleSchemaOptions, BreadcrumbItem } from "./schema.js"