@better-seo/assets
v0.0.2
Published
Optional Node-side asset helpers for Better SEO: generate Open Graph PNGs (1200x630) from titles and themes with Satori and Resvg, embed logos, render light or dark card templates, and build favicon.ico plus PWA icon sizes and manifest data from a single
Readme
@better-seo/assets
Optional Node-side helpers for Better SEO: Open Graph PNGs (1200×630) via Satori + Resvg (built-in card + optional compiled .js / .mjs template), and icons + PWA manifest from a source image (Sharp, to-ico favicon). Intended for build scripts, servers, and @better-seo/cli—not for Edge or lightweight client bundles.
Docs: Monorepo README · OG recipe · Icons recipe
Install
npm install @better-seo/assetsBrings in React, Satori, Sharp, Resvg, etc. Keep this dependency out of hot browser/Edge paths.
Main capabilities
| API | Purpose |
| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| generateOG | Render OG PNG; OGConfig (title, theme, logo, optional template path to .js/.mjs module exporting a Satori component with OgCardProps) |
| generateIcons | PNG sizes + favicon.ico + Apple / maskable assets from SVG or raster |
| buildWebAppManifest, formatWebManifest, defaultWebManifestIcons | PWA manifest.json data |
Types: OgCardProps, OgCardPalette, and related exports — see src/index.ts.
CLI
Most teams invoke the same stack via npx @better-seo/cli (og, icons) — see @better-seo/cli.
Scripts (monorepo)
From packages/better-seo-assets:
npm run build
npm run test
npm run test:coverage
npm run lint
npm run typecheckCoverage
vitest.config.ts enforces V8 coverage on implementation files under src/ (excluding tests, barrel index.ts, types.ts).
| Metric | Minimum | | -------------- | ------- | | Lines | 85% | | Statements | 85% | | Functions | 85% | | Branches | 75% |
Runtime
Requires Node >= 20. Sharp uses native binaries; CI covers Linux; local dev on Windows/macOS is supported by Sharp’s prebuilds.
License
MIT — see LICENSE.
