@rimelight/seo 0.0.6 → 0.0.8

package/src/assets.ts

@@ -0,0 +1,137 @@
+import sharp from "sharp"
+
+export interface GeneratePngOptions {
+  width: number
+  height: number
+  background?: string
+}
+
+export interface GenerateMaskableOptions {
+  size?: number
+  background?: string
+  paddingRatio?: number
+}
+
+export interface GenerateOgCardOptions {
+  width?: number
+  height?: number
+  background?: string
+  logoBuffer?: Buffer | Uint8Array | string | null
+}
+
+/**
+ * Generate a PNG buffer resized to specific dimensions from an SVG or image buffer.
+ */
+export async function generatePng(
+  source: Buffer | Uint8Array | string,
+  options: { width: number; height: number }
+): Promise<Buffer> {
+  return sharp(source)
+    .resize(options.width, options.height, {
+      fit: "contain",
+      background: { r: 0, g: 0, b: 0, alpha: 0 }
+    })
+    .png()
+    .toBuffer()
+}
+
+/**
+ * Generate a maskable PWA PNG icon with safe-zone padding and solid background. The standard
+ * recommendation is to place the master icon in the inner 80% safe zone.
+ */
+export async function generateMaskablePng(
+  source: Buffer | Uint8Array | string,
+  options: GenerateMaskableOptions = {}
+): Promise<Buffer> {
+  const { size = 512, background = "#ffffff", paddingRatio = 0.15 } = options
+  const innerSize = Math.round(size * (1 - paddingRatio * 2))
+  const pad = Math.floor((size - innerSize) / 2)
+
+  const innerPng = await sharp(source)
+    .resize(innerSize, innerSize, {
+      fit: "contain",
+      background: { r: 0, g: 0, b: 0, alpha: 0 }
+    })
+    .png()
+    .toBuffer()
+
+  return sharp(innerPng)
+    .extend({
+      top: pad,
+      bottom: size - innerSize - pad,
+      left: pad,
+      right: size - innerSize - pad,
+      background
+    })
+    .png()
+    .toBuffer()
+}
+
+/**
+ * Generate a valid .ico buffer containing a 32x32 PNG image according to the Windows ICO
+ * specification.
+ */
+export async function generateIco(
+  source: Buffer | Uint8Array | string,
+  size = 32
+): Promise<Buffer> {
+  const pngBuffer = await generatePng(source, { width: size, height: size })
+
+  const header = Buffer.alloc(22)
+  // Reserved (2 bytes)
+  header.writeUInt16LE(0, 0)
+  // Image type (1 = ICO) (2 bytes)
+  header.writeUInt16LE(1, 2)
+  // Number of images (2 bytes)
+  header.writeUInt16LE(1, 4)
+
+  // Directory entry (16 bytes)
+  header.writeUInt8(size === 256 ? 0 : size, 6) // Width
+  header.writeUInt8(size === 256 ? 0 : size, 7) // Height
+  header.writeUInt8(0, 8) // Palette size (0 = no palette)
+  header.writeUInt8(0, 9) // Reserved
+  header.writeUInt16LE(1, 10) // Color planes
+  header.writeUInt16LE(32, 12) // Bits per pixel (32bpp)
+  header.writeUInt32LE(pngBuffer.length, 14) // Image size in bytes
+  header.writeUInt32LE(22, 18) // Offset of image data (header size = 22)
+
+  return Buffer.concat([header, pngBuffer])
+}
+
+/**
+ * Generate a standard 1200x630 branded Open Graph card from a master logo and background color.
+ */
+export async function generateOgCard(options: GenerateOgCardOptions = {}): Promise<Buffer> {
+  const { width = 1200, height = 630, background = "#0a0a0a", logoBuffer } = options
+
+  if (logoBuffer) {
+    const logoSize = Math.min(Math.round(height * 0.45), 280)
+    const logoPng = await generatePng(logoBuffer, { width: logoSize, height: logoSize })
+    const topPad = Math.floor((height - logoSize) / 2)
+    const bottomPad = height - logoSize - topPad
+    const leftPad = Math.floor((width - logoSize) / 2)
+    const rightPad = width - logoSize - leftPad
+
+    return sharp(logoPng)
+      .extend({
+        top: topPad,
+        bottom: bottomPad,
+        left: leftPad,
+        right: rightPad,
+        background
+      })
+      .png()
+      .toBuffer()
+  }
+
+  return sharp({
+    create: {
+      width,
+      height,
+      channels: 4,
+      background
+    }
+  })
+    .png()
+    .toBuffer()
+}

package/src/catalog.test.ts

@@ -0,0 +1,26 @@
+import { describe, it, expect } from "vite-plus/test"
+import { buildApiCatalog } from "./catalog.js"
+
+describe("buildApiCatalog", () => {
+  it("builds linkset api-catalog object", () => {
+    const catalog = buildApiCatalog({
+      items: [
+        {
+          rel: "self",
+          href: "/.well-known/api-catalog",
+          type: "application/linkset+json"
+        },
+        {
+          rel: "alternate",
+          href: "/sitemap.xml",
+          type: "application/xml"
+        }
+      ]
+    })
+
+    const items = catalog["api-catalog"]
+    expect(items).toHaveLength(2)
+    expect(items[0]?.rel).toBe("self")
+    expect(items[1]?.href).toBe("/sitemap.xml")
+  })
+})

package/src/catalog.ts

@@ -0,0 +1,11 @@
+import type { ApiCatalog, ApiCatalogOptions } from "./types.js"
+
+/**
+ * Build RFC 9652 Application Linkset API Catalog. https://www.rfc-editor.org/rfc/rfc9652
+ */
+export function buildApiCatalog(options: ApiCatalogOptions): ApiCatalog {
+  const { items } = options
+  return {
+    "api-catalog": items
+  }
+}

package/src/components/SEOHead.astro

@@ -39,7 +39,7 @@ const {
 // Resolve defaults from config if available
 const siteName = config?.name || 'Rimelight'
 const siteDescription = config?.description || ''
-const ogImageFallback = config?.seo?.ogImageFallback || config?.ogImage || ''
+const ogImageFallback = config?.seo?.ogImageFallback || config?.ogImage || '/og.png'
 const themeColor = config?.branding?.colors?.themeColor
 const favicon = customFavicon || config?.branding?.favicon?.svg || '/favicon.svg'
 const faviconType = favicon.endsWith('.ico')

package/src/env.d.ts

@@ -1,33 +1,55 @@
-declare module "*.astro" {
-  export default {} as import("astro/runtime/server").AstroComponentFactory
-}
-
-declare module "virtual:rimelight-seo-config" {
-  const config: import("./integration.js").RimelightSeoOptions
-  export default config
-}
-
-declare module "virtual:rimelight-seo/options" {
-  const config: import("./integration.js").RimelightSeoOptions
-  export default config
-}
-
-declare module "virtual:rimelight-seo/config" {
-  export const SEO_LOCALES: import("./types.js").LocaleConfig | undefined
-  export const PRIVATE_PATH_PREFIXES: string[] | undefined
-  export const seoEntries: (() => Promise<import("./types.js").SeoEntry[]>) | undefined
-  export const rssEntries: (() => Promise<import("./types.js").RssItem[]>) | undefined
-}
-
-declare module "virtual:rimelight-seo/site-config" {
-  export const siteConfig: import("./types.js").SiteConfig | Record<string, any>
-}
-
-declare module "virtual:rimelight-seo/db" {
-  export const db: any
-  export const pages: any
-}
-
-declare module "virtual:rimelight-seo/corpus" {
-  export const corpusPages: any[]
-}
+declare module "virtual:rimelight-seo-config" {
+  const config: import("./integration.js").RimelightSeoOptions
+  export default config
+}
+
+declare module "virtual:rimelight-seo/options" {
+  const config: import("./integration.js").RimelightSeoOptions
+  export default config
+}
+
+declare module "virtual:rimelight-seo/config" {
+  export const SEO_LOCALES: import("./types.js").LocaleConfig | undefined
+  export const PRIVATE_PATH_PREFIXES: string[] | undefined
+  export const seoEntries: (() => Promise<import("./types.js").SeoEntry[]>) | undefined
+  export const rssEntries: (() => Promise<import("./types.js").RssItem[]>) | undefined
+}
+
+declare module "virtual:rimelight-seo/site-config" {
+  export const siteConfig: import("./types.js").SiteConfig | Record<string, any>
+}
+
+declare module "virtual:rimelight-seo/db" {
+  export const db: any
+  export const pages: any
+}
+
+declare module "virtual:rimelight-seo/corpus" {
+  export const corpusPages: any[]
+}
+
+declare module "#db/schema" {
+  export const pages: any
+}
+
+declare module "drizzle-orm" {
+  export const and: (...args: any[]) => any
+  export const isNull: (column: any) => any
+  export const isNotNull: (column: any) => any
+  export const sql: any
+  export const eq: (column: any, value: any) => any
+}
+
+declare module "@rimelight/cms" {
+  export const renderCorpusMarkdown: (db: any, options: any) => Promise<string>
+}
+
+declare module "astro:content" {
+  export const getCollection: (collection: string) => Promise<any[]>
+}
+
+declare module "virtual:rimelight-seo/assets" {
+  export const masterIconBuffer: Buffer | null
+  export const isSvg: boolean
+  export const backgroundColor: string
+}

package/src/index.ts

@@ -14,6 +14,7 @@ export type {
   RssItem,
   RssFeedOptions,
   RssOptions,
+  RssCollectionConfig,
   HeadProps,
   OpenGraphMeta,
   TwitterMeta,
@@ -23,7 +24,19 @@ export type {
   LlmsRouteOptions,
   LlmsFullRouteOptions,
   ArticleSchemaOptions,
-  BreadcrumbItem
+  BreadcrumbItem,
+  SecurityTxtOptions,
+  SecurityRouteOptions,
+  WebManifestIcon,
+  WebManifestShortcut,
+  WebManifest,
+  WebManifestOptions,
+  ManifestRouteOptions,
+  ApiCatalogItem,
+  ApiCatalog,
+  ApiCatalogOptions,
+  ApiCatalogRouteOptions,
+  AssetRouteOptions
 } from "./types.js"
 
 export {
@@ -47,7 +60,11 @@ 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 { generatePng, generateMaskablePng, generateIco, generateOgCard } from "./assets.js"
 export type { OgFontConfig, OgLayoutOptions, OgRenderConfig } from "./og.js"
 
 import { rimelightSeo } from "./integration.js"