@coldbydefault/next-seo-lite 1.0.0

package/README.md

@@ -0,0 +1,198 @@
+# next-seo-lite
+
+> **Stop writing 50 lines of Meta tags. Do it in 5.**
+
+A tiny, zero-runtime-dependency SEO helper for [Next.js](https://nextjs.org/) App Router.  
+It turns simple props into the full `Metadata` object Next.js expects — including `openGraph`, `twitter`, and automatic canonical URLs.
+
+---
+
+## Features
+
+- **Title suffixing** — `"Home"` becomes `"Home | MyBrand"` automatically.
+- **OpenGraph** — fills `og:title`, `og:description`, and `og:image` in one call.
+- **Twitter Cards** — maps your image to `summary_large_image` by default.
+- **Canonical URLs** — combine a `baseUrl` with a page `path` and you're done.
+- **Default fallback image** — set once at the root, used everywhere you don't override it.
+- **Zero runtime dependencies** — only `next` as a peer dep (for types).
+
+---
+
+## Installation
+
+This package is published to **both npm and GitHub Packages** — use whichever fits your workflow.
+
+### Option A — npm (recommended, zero friction)
+
+```bash
+npm install @coldbydefault/next-seo-lite
+# or
+yarn add @coldbydefault/next-seo-lite
+# or
+pnpm add @coldbydefault/next-seo-lite
+```
+
+No auth, no `.npmrc` changes needed. ✅
+
+---
+
+### Option B — GitHub Packages
+
+Useful if you're already inside a GitHub org/Actions workflow.
+
+**1. Add to your project's `.npmrc`:**
+
+```
+@coldbydefault:registry=https://npm.pkg.github.com
+```
+
+**2. Authenticate once** with a GitHub [Personal Access Token](https://github.com/settings/tokens) that has `read:packages` scope:
+
+```bash
+npm login --registry=https://npm.pkg.github.com --scope=@coldbydefault
+```
+
+**3. Install** (same command as npm):
+
+```bash
+npm install @coldbydefault/next-seo-lite
+```
+
+---
+
+## Quick Start
+
+### 1. One-liner per page (standalone)
+
+```tsx
+// app/about/page.tsx
+import { defineSEO } from "@coldbydefault/next-seo-lite";
+import type { Metadata } from "next";
+
+export const metadata: Metadata = defineSEO({
+  title: "About Us",
+  description: "Learn more about our team.",
+  siteName: "MyBrand",
+  image: "https://mysite.com/about-og.png",
+  baseUrl: "https://mysite.com",
+  path: "/about",
+});
+```
+
+That one call replaces this:
+
+```tsx
+export const metadata: Metadata = {
+  title: "About Us | MyBrand",
+  description: "Learn more about our team.",
+  openGraph: {
+    title: "About Us | MyBrand",
+    description: "Learn more about our team.",
+    images: [{ url: "https://mysite.com/about-og.png" }],
+    type: "website",
+    siteName: "MyBrand",
+    url: "https://mysite.com/about",
+  },
+  twitter: {
+    card: "summary_large_image",
+    title: "About Us | MyBrand",
+    description: "Learn more about our team.",
+    images: ["https://mysite.com/about-og.png"],
+  },
+  alternates: {
+    canonical: "https://mysite.com/about",
+  },
+};
+```
+
+---
+
+### 2. Global defaults with `createSEOConfig` (recommended)
+
+Define your globals once, then call the returned function on every page.
+
+```ts
+// lib/seo.ts
+import { createSEOConfig } from "@coldbydefault/next-seo-lite";
+
+export const defineSEO = createSEOConfig({
+  siteName: "MyBrand",
+  baseUrl: "https://mysite.com",
+  defaultImage: "https://mysite.com/og-default.png",
+});
+```
+
+```tsx
+// app/layout.tsx
+import { defineSEO } from "@/lib/seo";
+import type { Metadata } from "next";
+
+export const metadata: Metadata = defineSEO({
+  title: "Home",
+  description: "Welcome to MyBrand.",
+  path: "/",
+});
+```
+
+```tsx
+// app/blog/[slug]/page.tsx
+import { defineSEO } from "@/lib/seo";
+
+export async function generateMetadata({
+  params,
+}: {
+  params: { slug: string };
+}) {
+  const post = await getPost(params.slug);
+
+  return defineSEO({
+    title: post.title,
+    description: post.summary,
+    image: post.coverImage, // overrides the global defaultImage
+    path: `/blog/${params.slug}`,
+  });
+}
+```
+
+---
+
+## API Reference
+
+### `defineSEO(props: SEOProps): Metadata`
+
+Standalone helper — no global config needed.
+
+### `createSEOConfig(config: SEOConfig): (props: SEOProps) => Metadata`
+
+Returns a `defineSEO` function pre-loaded with your global defaults.  
+Page-level props always win over the global config.
+
+---
+
+### `SEOConfig`
+
+| Prop           | Type     | Description                                                          |
+| -------------- | -------- | -------------------------------------------------------------------- | ----------- |
+| `siteName`     | `string` | Appended to every title: `"Page                                      | SiteName"`. |
+| `baseUrl`      | `string` | Absolute base URL for canonical links, e.g. `"https://example.com"`. |
+| `defaultImage` | `string` | Fallback OG / Twitter image URL.                                     |
+
+---
+
+### `SEOProps`
+
+| Prop           | Type     | Required | Description                                                        |
+| -------------- | -------- | -------- | ------------------------------------------------------------------ |
+| `title`        | `string` | ✅       | Page title (without suffix).                                       |
+| `description`  | `string` | ✅       | Short page description.                                            |
+| `image`        | `string` | —        | Overrides `defaultImage`.                                          |
+| `path`         | `string` | —        | Slug appended to `baseUrl` for the canonical URL, e.g. `"/about"`. |
+| `siteName`     | `string` | —        | Overrides global `siteName`. Pass `""` to suppress the suffix.     |
+| `baseUrl`      | `string` | —        | Overrides global `baseUrl`.                                        |
+| `defaultImage` | `string` | —        | Overrides global `defaultImage` for this call.                     |
+
+---
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,76 @@
+import { Metadata } from 'next';
+
+/**
+ * Global defaults applied to every page when you don't override them.
+ * Pass this once at the root layout level via `createSEOConfig`.
+ */
+interface SEOConfig {
+    /** Your brand / product name, appended to every page title. */
+    siteName?: string;
+    /** Absolute base URL used for canonical links, e.g. "https://example.com". */
+    baseUrl?: string;
+    /** Fallback OG/Twitter image URL used when a page omits its own image. */
+    defaultImage?: string;
+}
+/**
+ * Per-page SEO props passed to `defineSEO`.
+ */
+interface SEOProps {
+    /** Page-level title (without the site name suffix). */
+    title: string;
+    /** Short description shown in search results and social previews. */
+    description: string;
+    /**
+     * Absolute or relative path for this page's OG/Twitter image.
+     * Falls back to `SEOConfig.defaultImage` when omitted.
+     */
+    image?: string;
+    /**
+     * Slug / path appended to `SEOConfig.baseUrl` to build the canonical URL,
+     * e.g. "/about". Ignored when no `baseUrl` is configured.
+     */
+    path?: string;
+    /**
+     * Override the global `siteName` for this specific page.
+     * Set to `""` (empty string) to suppress the suffix entirely.
+     */
+    siteName?: string;
+    /**
+     * Override the global `baseUrl` for this specific page.
+     */
+    baseUrl?: string;
+    /**
+     * Override the global `defaultImage` for this page.
+     */
+    defaultImage?: string;
+}
+/**
+ * Creates a `defineSEO` function pre-loaded with your global defaults.
+ *
+ * @example
+ * // lib/seo.ts
+ * import { createSEOConfig } from 'next-seo-lite';
+ *
+ * export const defineSEO = createSEOConfig({
+ *   siteName: 'MyBrand',
+ *   baseUrl: 'https://mybrand.com',
+ *   defaultImage: 'https://mybrand.com/og-default.png',
+ * });
+ */
+declare function createSEOConfig(config?: SEOConfig): (props: SEOProps) => Metadata;
+/**
+ * One-shot helper when you don't need global defaults.
+ *
+ * @example
+ * // app/page.tsx
+ * import { defineSEO } from 'next-seo-lite';
+ *
+ * export const metadata = defineSEO({
+ *   title: 'Home',
+ *   description: 'Welcome to my site.',
+ *   siteName: 'MyBrand',
+ * });
+ */
+declare function defineSEO(props: SEOProps): Metadata;
+
+export { type SEOConfig, type SEOProps, createSEOConfig, defineSEO };

package/dist/index.d.ts

@@ -0,0 +1,76 @@
+import { Metadata } from 'next';
+
+/**
+ * Global defaults applied to every page when you don't override them.
+ * Pass this once at the root layout level via `createSEOConfig`.
+ */
+interface SEOConfig {
+    /** Your brand / product name, appended to every page title. */
+    siteName?: string;
+    /** Absolute base URL used for canonical links, e.g. "https://example.com". */
+    baseUrl?: string;
+    /** Fallback OG/Twitter image URL used when a page omits its own image. */
+    defaultImage?: string;
+}
+/**
+ * Per-page SEO props passed to `defineSEO`.
+ */
+interface SEOProps {
+    /** Page-level title (without the site name suffix). */
+    title: string;
+    /** Short description shown in search results and social previews. */
+    description: string;
+    /**
+     * Absolute or relative path for this page's OG/Twitter image.
+     * Falls back to `SEOConfig.defaultImage` when omitted.
+     */
+    image?: string;
+    /**
+     * Slug / path appended to `SEOConfig.baseUrl` to build the canonical URL,
+     * e.g. "/about". Ignored when no `baseUrl` is configured.
+     */
+    path?: string;
+    /**
+     * Override the global `siteName` for this specific page.
+     * Set to `""` (empty string) to suppress the suffix entirely.
+     */
+    siteName?: string;
+    /**
+     * Override the global `baseUrl` for this specific page.
+     */
+    baseUrl?: string;
+    /**
+     * Override the global `defaultImage` for this page.
+     */
+    defaultImage?: string;
+}
+/**
+ * Creates a `defineSEO` function pre-loaded with your global defaults.
+ *
+ * @example
+ * // lib/seo.ts
+ * import { createSEOConfig } from 'next-seo-lite';
+ *
+ * export const defineSEO = createSEOConfig({
+ *   siteName: 'MyBrand',
+ *   baseUrl: 'https://mybrand.com',
+ *   defaultImage: 'https://mybrand.com/og-default.png',
+ * });
+ */
+declare function createSEOConfig(config?: SEOConfig): (props: SEOProps) => Metadata;
+/**
+ * One-shot helper when you don't need global defaults.
+ *
+ * @example
+ * // app/page.tsx
+ * import { defineSEO } from 'next-seo-lite';
+ *
+ * export const metadata = defineSEO({
+ *   title: 'Home',
+ *   description: 'Welcome to my site.',
+ *   siteName: 'MyBrand',
+ * });
+ */
+declare function defineSEO(props: SEOProps): Metadata;
+
+export { type SEOConfig, type SEOProps, createSEOConfig, defineSEO };

package/dist/index.js

@@ -0,0 +1,79 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createSEOConfig: () => createSEOConfig,
+  defineSEO: () => defineSEO
+});
+module.exports = __toCommonJS(index_exports);
+function createSEOConfig(config = {}) {
+  return function defineSEO2(props) {
+    return buildMetadata(props, config);
+  };
+}
+function defineSEO(props) {
+  return buildMetadata(props, {});
+}
+function buildMetadata(props, config) {
+  const siteName = props.siteName !== void 0 ? props.siteName : config.siteName;
+  const baseUrl = props.baseUrl ?? config.baseUrl;
+  const image = props.image ?? props.defaultImage ?? config.defaultImage;
+  const fullTitle = siteName !== void 0 && siteName !== "" ? `${props.title} | ${siteName}` : props.title;
+  let canonical;
+  if (baseUrl) {
+    const base = baseUrl.replace(/\/$/, "");
+    const normalized = props.path ? props.path.replace(/^\//, "") : "";
+    const slug = normalized ? `/${normalized}` : "";
+    canonical = `${base}${slug}`;
+  }
+  const ogImages = image ? [{ url: image }] : [];
+  const twitterImages = image ? [image] : [];
+  const metadata = {
+    title: fullTitle,
+    description: props.description,
+    openGraph: {
+      title: fullTitle,
+      description: props.description,
+      ...ogImages.length > 0 && { images: ogImages },
+      type: "website",
+      ...siteName && { siteName },
+      ...canonical && { url: canonical }
+    },
+    twitter: {
+      card: "summary_large_image",
+      title: fullTitle,
+      description: props.description,
+      ...twitterImages.length > 0 && { images: twitterImages }
+    },
+    ...canonical && {
+      alternates: {
+        canonical
+      }
+    }
+  };
+  return metadata;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createSEOConfig,
+  defineSEO
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Metadata } from \"next\";\r\n\r\n// ---------------------------------------------------------------------------\r\n// Types\r\n// ---------------------------------------------------------------------------\r\n\r\n/**\r\n * Global defaults applied to every page when you don't override them.\r\n * Pass this once at the root layout level via `createSEOConfig`.\r\n */\r\nexport interface SEOConfig {\r\n  /** Your brand / product name, appended to every page title. */\r\n  siteName?: string;\r\n  /** Absolute base URL used for canonical links, e.g. \"https://example.com\". */\r\n  baseUrl?: string;\r\n  /** Fallback OG/Twitter image URL used when a page omits its own image. */\r\n  defaultImage?: string;\r\n}\r\n\r\n/**\r\n * Per-page SEO props passed to `defineSEO`.\r\n */\r\nexport interface SEOProps {\r\n  /** Page-level title (without the site name suffix). */\r\n  title: string;\r\n  /** Short description shown in search results and social previews. */\r\n  description: string;\r\n  /**\r\n   * Absolute or relative path for this page's OG/Twitter image.\r\n   * Falls back to `SEOConfig.defaultImage` when omitted.\r\n   */\r\n  image?: string;\r\n  /**\r\n   * Slug / path appended to `SEOConfig.baseUrl` to build the canonical URL,\r\n   * e.g. \"/about\". Ignored when no `baseUrl` is configured.\r\n   */\r\n  path?: string;\r\n  /**\r\n   * Override the global `siteName` for this specific page.\r\n   * Set to `\"\"` (empty string) to suppress the suffix entirely.\r\n   */\r\n  siteName?: string;\r\n  /**\r\n   * Override the global `baseUrl` for this specific page.\r\n   */\r\n  baseUrl?: string;\r\n  /**\r\n   * Override the global `defaultImage` for this page.\r\n   */\r\n  defaultImage?: string;\r\n}\r\n\r\n// ---------------------------------------------------------------------------\r\n// Factory\r\n// ---------------------------------------------------------------------------\r\n\r\n/**\r\n * Creates a `defineSEO` function pre-loaded with your global defaults.\r\n *\r\n * @example\r\n * // lib/seo.ts\r\n * import { createSEOConfig } from 'next-seo-lite';\r\n *\r\n * export const defineSEO = createSEOConfig({\r\n *   siteName: 'MyBrand',\r\n *   baseUrl: 'https://mybrand.com',\r\n *   defaultImage: 'https://mybrand.com/og-default.png',\r\n * });\r\n */\r\nexport function createSEOConfig(config: SEOConfig = {}) {\r\n  return function defineSEO(props: SEOProps): Metadata {\r\n    return buildMetadata(props, config);\r\n  };\r\n}\r\n\r\n// ---------------------------------------------------------------------------\r\n// Standalone helper (zero-config)\r\n// ---------------------------------------------------------------------------\r\n\r\n/**\r\n * One-shot helper when you don't need global defaults.\r\n *\r\n * @example\r\n * // app/page.tsx\r\n * import { defineSEO } from 'next-seo-lite';\r\n *\r\n * export const metadata = defineSEO({\r\n *   title: 'Home',\r\n *   description: 'Welcome to my site.',\r\n *   siteName: 'MyBrand',\r\n * });\r\n */\r\nexport function defineSEO(props: SEOProps): Metadata {\r\n  return buildMetadata(props, {});\r\n}\r\n\r\n// ---------------------------------------------------------------------------\r\n// Core builder\r\n// ---------------------------------------------------------------------------\r\n\r\nfunction buildMetadata(props: SEOProps, config: SEOConfig): Metadata {\r\n  // ---- Resolve values (page-level wins over global config) ----------------\r\n  const siteName =\r\n    props.siteName !== undefined ? props.siteName : config.siteName;\r\n  const baseUrl = props.baseUrl ?? config.baseUrl;\r\n  const image = props.image ?? props.defaultImage ?? config.defaultImage;\r\n\r\n  // ---- Title --------------------------------------------------------------\r\n  const fullTitle =\r\n    siteName !== undefined && siteName !== \"\"\r\n      ? `${props.title} | ${siteName}`\r\n      : props.title;\r\n\r\n  // ---- Canonical URL ------------------------------------------------------\r\n  let canonical: string | undefined;\r\n  if (baseUrl) {\r\n    const base = baseUrl.replace(/\\/$/, \"\");\r\n    const normalized = props.path ? props.path.replace(/^\\//, \"\") : \"\";\r\n    const slug = normalized ? `/${normalized}` : \"\";\r\n    canonical = `${base}${slug}`;\r\n  }\r\n\r\n  // ---- OG images ----------------------------------------------------------\r\n  const ogImages: { url: string }[] = image ? [{ url: image }] : [];\r\n\r\n  // ---- Twitter images -----------------------------------------------------\r\n  const twitterImages: string[] = image ? [image] : [];\r\n\r\n  // ---- Assemble Metadata --------------------------------------------------\r\n  const metadata: Metadata = {\r\n    title: fullTitle,\r\n    description: props.description,\r\n    openGraph: {\r\n      title: fullTitle,\r\n      description: props.description,\r\n      ...(ogImages.length > 0 && { images: ogImages }),\r\n      type: \"website\",\r\n      ...(siteName && { siteName }),\r\n      ...(canonical && { url: canonical }),\r\n    },\r\n    twitter: {\r\n      card: \"summary_large_image\",\r\n      title: fullTitle,\r\n      description: props.description,\r\n      ...(twitterImages.length > 0 && { images: twitterImages }),\r\n    },\r\n    ...(canonical && {\r\n      alternates: {\r\n        canonical,\r\n      },\r\n    }),\r\n  };\r\n\r\n  return metadata;\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAqEO,SAAS,gBAAgB,SAAoB,CAAC,GAAG;AACtD,SAAO,SAASA,WAAU,OAA2B;AACnD,WAAO,cAAc,OAAO,MAAM;AAAA,EACpC;AACF;AAmBO,SAAS,UAAU,OAA2B;AACnD,SAAO,cAAc,OAAO,CAAC,CAAC;AAChC;AAMA,SAAS,cAAc,OAAiB,QAA6B;AAEnE,QAAM,WACJ,MAAM,aAAa,SAAY,MAAM,WAAW,OAAO;AACzD,QAAM,UAAU,MAAM,WAAW,OAAO;AACxC,QAAM,QAAQ,MAAM,SAAS,MAAM,gBAAgB,OAAO;AAG1D,QAAM,YACJ,aAAa,UAAa,aAAa,KACnC,GAAG,MAAM,KAAK,MAAM,QAAQ,KAC5B,MAAM;AAGZ,MAAI;AACJ,MAAI,SAAS;AACX,UAAM,OAAO,QAAQ,QAAQ,OAAO,EAAE;AACtC,UAAM,aAAa,MAAM,OAAO,MAAM,KAAK,QAAQ,OAAO,EAAE,IAAI;AAChE,UAAM,OAAO,aAAa,IAAI,UAAU,KAAK;AAC7C,gBAAY,GAAG,IAAI,GAAG,IAAI;AAAA,EAC5B;AAGA,QAAM,WAA8B,QAAQ,CAAC,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC;AAGhE,QAAM,gBAA0B,QAAQ,CAAC,KAAK,IAAI,CAAC;AAGnD,QAAM,WAAqB;AAAA,IACzB,OAAO;AAAA,IACP,aAAa,MAAM;AAAA,IACnB,WAAW;AAAA,MACT,OAAO;AAAA,MACP,aAAa,MAAM;AAAA,MACnB,GAAI,SAAS,SAAS,KAAK,EAAE,QAAQ,SAAS;AAAA,MAC9C,MAAM;AAAA,MACN,GAAI,YAAY,EAAE,SAAS;AAAA,MAC3B,GAAI,aAAa,EAAE,KAAK,UAAU;AAAA,IACpC;AAAA,IACA,SAAS;AAAA,MACP,MAAM;AAAA,MACN,OAAO;AAAA,MACP,aAAa,MAAM;AAAA,MACnB,GAAI,cAAc,SAAS,KAAK,EAAE,QAAQ,cAAc;AAAA,IAC1D;AAAA,IACA,GAAI,aAAa;AAAA,MACf,YAAY;AAAA,QACV;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":["defineSEO"]}

package/dist/index.mjs

@@ -0,0 +1,53 @@
+// src/index.ts
+function createSEOConfig(config = {}) {
+  return function defineSEO2(props) {
+    return buildMetadata(props, config);
+  };
+}
+function defineSEO(props) {
+  return buildMetadata(props, {});
+}
+function buildMetadata(props, config) {
+  const siteName = props.siteName !== void 0 ? props.siteName : config.siteName;
+  const baseUrl = props.baseUrl ?? config.baseUrl;
+  const image = props.image ?? props.defaultImage ?? config.defaultImage;
+  const fullTitle = siteName !== void 0 && siteName !== "" ? `${props.title} | ${siteName}` : props.title;
+  let canonical;
+  if (baseUrl) {
+    const base = baseUrl.replace(/\/$/, "");
+    const normalized = props.path ? props.path.replace(/^\//, "") : "";
+    const slug = normalized ? `/${normalized}` : "";
+    canonical = `${base}${slug}`;
+  }
+  const ogImages = image ? [{ url: image }] : [];
+  const twitterImages = image ? [image] : [];
+  const metadata = {
+    title: fullTitle,
+    description: props.description,
+    openGraph: {
+      title: fullTitle,
+      description: props.description,
+      ...ogImages.length > 0 && { images: ogImages },
+      type: "website",
+      ...siteName && { siteName },
+      ...canonical && { url: canonical }
+    },
+    twitter: {
+      card: "summary_large_image",
+      title: fullTitle,
+      description: props.description,
+      ...twitterImages.length > 0 && { images: twitterImages }
+    },
+    ...canonical && {
+      alternates: {
+        canonical
+      }
+    }
+  };
+  return metadata;
+}
+export {
+  createSEOConfig,
+  defineSEO
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Metadata } from \"next\";\r\n\r\n// ---------------------------------------------------------------------------\r\n// Types\r\n// ---------------------------------------------------------------------------\r\n\r\n/**\r\n * Global defaults applied to every page when you don't override them.\r\n * Pass this once at the root layout level via `createSEOConfig`.\r\n */\r\nexport interface SEOConfig {\r\n  /** Your brand / product name, appended to every page title. */\r\n  siteName?: string;\r\n  /** Absolute base URL used for canonical links, e.g. \"https://example.com\". */\r\n  baseUrl?: string;\r\n  /** Fallback OG/Twitter image URL used when a page omits its own image. */\r\n  defaultImage?: string;\r\n}\r\n\r\n/**\r\n * Per-page SEO props passed to `defineSEO`.\r\n */\r\nexport interface SEOProps {\r\n  /** Page-level title (without the site name suffix). */\r\n  title: string;\r\n  /** Short description shown in search results and social previews. */\r\n  description: string;\r\n  /**\r\n   * Absolute or relative path for this page's OG/Twitter image.\r\n   * Falls back to `SEOConfig.defaultImage` when omitted.\r\n   */\r\n  image?: string;\r\n  /**\r\n   * Slug / path appended to `SEOConfig.baseUrl` to build the canonical URL,\r\n   * e.g. \"/about\". Ignored when no `baseUrl` is configured.\r\n   */\r\n  path?: string;\r\n  /**\r\n   * Override the global `siteName` for this specific page.\r\n   * Set to `\"\"` (empty string) to suppress the suffix entirely.\r\n   */\r\n  siteName?: string;\r\n  /**\r\n   * Override the global `baseUrl` for this specific page.\r\n   */\r\n  baseUrl?: string;\r\n  /**\r\n   * Override the global `defaultImage` for this page.\r\n   */\r\n  defaultImage?: string;\r\n}\r\n\r\n// ---------------------------------------------------------------------------\r\n// Factory\r\n// ---------------------------------------------------------------------------\r\n\r\n/**\r\n * Creates a `defineSEO` function pre-loaded with your global defaults.\r\n *\r\n * @example\r\n * // lib/seo.ts\r\n * import { createSEOConfig } from 'next-seo-lite';\r\n *\r\n * export const defineSEO = createSEOConfig({\r\n *   siteName: 'MyBrand',\r\n *   baseUrl: 'https://mybrand.com',\r\n *   defaultImage: 'https://mybrand.com/og-default.png',\r\n * });\r\n */\r\nexport function createSEOConfig(config: SEOConfig = {}) {\r\n  return function defineSEO(props: SEOProps): Metadata {\r\n    return buildMetadata(props, config);\r\n  };\r\n}\r\n\r\n// ---------------------------------------------------------------------------\r\n// Standalone helper (zero-config)\r\n// ---------------------------------------------------------------------------\r\n\r\n/**\r\n * One-shot helper when you don't need global defaults.\r\n *\r\n * @example\r\n * // app/page.tsx\r\n * import { defineSEO } from 'next-seo-lite';\r\n *\r\n * export const metadata = defineSEO({\r\n *   title: 'Home',\r\n *   description: 'Welcome to my site.',\r\n *   siteName: 'MyBrand',\r\n * });\r\n */\r\nexport function defineSEO(props: SEOProps): Metadata {\r\n  return buildMetadata(props, {});\r\n}\r\n\r\n// ---------------------------------------------------------------------------\r\n// Core builder\r\n// ---------------------------------------------------------------------------\r\n\r\nfunction buildMetadata(props: SEOProps, config: SEOConfig): Metadata {\r\n  // ---- Resolve values (page-level wins over global config) ----------------\r\n  const siteName =\r\n    props.siteName !== undefined ? props.siteName : config.siteName;\r\n  const baseUrl = props.baseUrl ?? config.baseUrl;\r\n  const image = props.image ?? props.defaultImage ?? config.defaultImage;\r\n\r\n  // ---- Title --------------------------------------------------------------\r\n  const fullTitle =\r\n    siteName !== undefined && siteName !== \"\"\r\n      ? `${props.title} | ${siteName}`\r\n      : props.title;\r\n\r\n  // ---- Canonical URL ------------------------------------------------------\r\n  let canonical: string | undefined;\r\n  if (baseUrl) {\r\n    const base = baseUrl.replace(/\\/$/, \"\");\r\n    const normalized = props.path ? props.path.replace(/^\\//, \"\") : \"\";\r\n    const slug = normalized ? `/${normalized}` : \"\";\r\n    canonical = `${base}${slug}`;\r\n  }\r\n\r\n  // ---- OG images ----------------------------------------------------------\r\n  const ogImages: { url: string }[] = image ? [{ url: image }] : [];\r\n\r\n  // ---- Twitter images -----------------------------------------------------\r\n  const twitterImages: string[] = image ? [image] : [];\r\n\r\n  // ---- Assemble Metadata --------------------------------------------------\r\n  const metadata: Metadata = {\r\n    title: fullTitle,\r\n    description: props.description,\r\n    openGraph: {\r\n      title: fullTitle,\r\n      description: props.description,\r\n      ...(ogImages.length > 0 && { images: ogImages }),\r\n      type: \"website\",\r\n      ...(siteName && { siteName }),\r\n      ...(canonical && { url: canonical }),\r\n    },\r\n    twitter: {\r\n      card: \"summary_large_image\",\r\n      title: fullTitle,\r\n      description: props.description,\r\n      ...(twitterImages.length > 0 && { images: twitterImages }),\r\n    },\r\n    ...(canonical && {\r\n      alternates: {\r\n        canonical,\r\n      },\r\n    }),\r\n  };\r\n\r\n  return metadata;\r\n}\r\n"],"mappings":";AAqEO,SAAS,gBAAgB,SAAoB,CAAC,GAAG;AACtD,SAAO,SAASA,WAAU,OAA2B;AACnD,WAAO,cAAc,OAAO,MAAM;AAAA,EACpC;AACF;AAmBO,SAAS,UAAU,OAA2B;AACnD,SAAO,cAAc,OAAO,CAAC,CAAC;AAChC;AAMA,SAAS,cAAc,OAAiB,QAA6B;AAEnE,QAAM,WACJ,MAAM,aAAa,SAAY,MAAM,WAAW,OAAO;AACzD,QAAM,UAAU,MAAM,WAAW,OAAO;AACxC,QAAM,QAAQ,MAAM,SAAS,MAAM,gBAAgB,OAAO;AAG1D,QAAM,YACJ,aAAa,UAAa,aAAa,KACnC,GAAG,MAAM,KAAK,MAAM,QAAQ,KAC5B,MAAM;AAGZ,MAAI;AACJ,MAAI,SAAS;AACX,UAAM,OAAO,QAAQ,QAAQ,OAAO,EAAE;AACtC,UAAM,aAAa,MAAM,OAAO,MAAM,KAAK,QAAQ,OAAO,EAAE,IAAI;AAChE,UAAM,OAAO,aAAa,IAAI,UAAU,KAAK;AAC7C,gBAAY,GAAG,IAAI,GAAG,IAAI;AAAA,EAC5B;AAGA,QAAM,WAA8B,QAAQ,CAAC,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC;AAGhE,QAAM,gBAA0B,QAAQ,CAAC,KAAK,IAAI,CAAC;AAGnD,QAAM,WAAqB;AAAA,IACzB,OAAO;AAAA,IACP,aAAa,MAAM;AAAA,IACnB,WAAW;AAAA,MACT,OAAO;AAAA,MACP,aAAa,MAAM;AAAA,MACnB,GAAI,SAAS,SAAS,KAAK,EAAE,QAAQ,SAAS;AAAA,MAC9C,MAAM;AAAA,MACN,GAAI,YAAY,EAAE,SAAS;AAAA,MAC3B,GAAI,aAAa,EAAE,KAAK,UAAU;AAAA,IACpC;AAAA,IACA,SAAS;AAAA,MACP,MAAM;AAAA,MACN,OAAO;AAAA,MACP,aAAa,MAAM;AAAA,MACnB,GAAI,cAAc,SAAS,KAAK,EAAE,QAAQ,cAAc;AAAA,IAC1D;AAAA,IACA,GAAI,aAAa;AAAA,MACf,YAAY;AAAA,QACV;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":["defineSEO"]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@coldbydefault/next-seo-lite",
+  "version": "1.0.0",
+  "description": "Stop writing 50 lines of Meta tags. Do it in 5. A zero-dependency SEO helper for Next.js.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coldbydefault/next-seo-lite.git"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build",
+    "publish:npm": "npm publish --access public --registry https://registry.npmjs.org",
+    "publish:github": "npm publish --access public --registry https://npm.pkg.github.com",
+    "release": "npm run test && npm run publish:npm && npm run publish:github"
+  },
+  "keywords": [
+    "next.js",
+    "seo",
+    "metadata",
+    "opengraph",
+    "twitter-card",
+    "canonical"
+  ],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "next": ">=13.0.0"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "next": "^15.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^2.0.0"
+  }
+}