npm - @ingram-tech/nk-seo - Versions diffs - 0.2.0 - Mend

@ingram-tech/nk-seo 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,119 @@
+# @ingram-tech/nk-seo
+SEO primitives for Next.js sites, factored out of the patterns every Ingram site
+kept re-implementing:
+1. **`<JsonLd>`** + **typed schema.org builders** — `faqPage`, `breadcrumbList`,
+   `article`, `softwareApplication`, `organization`, `website`, and a
+   `createSeo` factory that resolves site-relative paths and injects your
+   publisher.
+2. **`createMetadata`** — a Next `Metadata` factory: canonical + OpenGraph +
+   Twitter card from one title/description/path.
+3. **`<HreflangLinks>`** — self-referencing canonical plus per-locale `hreflang`
+   alternates (query-param or path-prefix strategy).
+The package root (`@ingram-tech/nk-seo`) is **pure** — builders and the metadata
+factory, no React — so `sitemap.ts` and route handlers can import it freely. The
+components live at `@ingram-tech/nk-seo/components`.
+## Install
+```bash
+bun add @ingram-tech/nk-seo
+```
+`next` and `react` are optional peers (only the components need them).
+## Structured data
+```tsx
+import { JsonLd } from "@ingram-tech/nk-seo/components";
+import { createSeo } from "@ingram-tech/nk-seo";
+const seo = createSeo({
+	baseUrl: getServerUrl(),
+	organization: {
+		name: "Financica",
+		url: "https://financica.app",
+		logo: "https://financica.app/logo.png",
+		sameAs: ["https://linkedin.com/company/financica"],
+	},
+});
+// Homepage:
+<JsonLd
+	data={seo.softwareApplication({
+		name: "Financica",
+		applicationCategory: "BusinessApplication",
+		operatingSystem: "Web",
+		offers: { priceCurrency: "EUR", lowPrice: 59, highPrice: 299, offerCount: 2, url: "/pricing" },
+	})}
+/>
+<JsonLd data={seo.faqPage(faqs)} />
+// Blog post (path + image resolved, configured org used as publisher):
+<JsonLd data={seo.article({ path: `/blog/${slug}`, headline, datePublished, authors: [{ name: author }] })} />
+<JsonLd data={seo.breadcrumbs([{ name: "Home", path: "/" }, { name: "Blog", path: "/blog" }, { name: title, path: `/blog/${slug}` }])} />
+```
+Already have absolute URLs and don't want the factory? The standalone builders
+(`faqPage`, `article`, `breadcrumbList`, …) take absolute URLs directly.
+`<JsonLd data={...} />` accepts a single node or an array (e.g.
+`[organization(org), website(site)]` on the homepage).
+## Page metadata
+```ts
+// lib/metadata.ts
+import { createMetadata } from "@ingram-tech/nk-seo";
+export const pageMetadata = createMetadata({
+	baseUrl: "https://ingram.tech",
+	siteName: "Ingram Technologies",
+	defaultImage: "/images/og.png",
+	locale: "en_US",
+	twitterSite: "@IngramTech",
+});
+// app/services/page.tsx
+export const metadata = pageMetadata({
+	title: "Services",
+	description: "AI deployment and custom agents.",
+	path: "/services",
+});
+```
+Produces `title`, `description`, a self-referencing `alternates.canonical`,
+`openGraph`, and a `summary_large_image` Twitter card. Pass `noIndex`, `keywords`,
+`type: "article"`, or per-page `openGraph`/`twitter` overrides as needed.
+## Hreflang & canonical
+Render in `<head>` from the root layout. By default it reads the `x-pathname`
+request header — set it in middleware:
+```ts
+// middleware.ts
+const res = NextResponse.next();
+res.headers.set("x-pathname", req.nextUrl.pathname);
+```
+```tsx
+import { HreflangLinks } from "@ingram-tech/nk-seo/components";
+// Query-param locales (?hl=fr):
+<HreflangLinks baseUrl="https://financica.app" locales={["en", "fr", "nl"]} />
+// Path-prefix locales (/fr/about), default locale bare, regional hreflang tags:
+<HreflangLinks
+	baseUrl="https://malinamore.studio"
+	locales={["en", "fr", "nl"]}
+	strategy="prefix"
+	defaultLocale="en"
+	hrefLangTags={{ en: "en-BE", fr: "fr-BE", nl: "nl-BE" }}
+	canonical={false}
+/>
+```
+Pass `pathname` explicitly if you don't use the `x-pathname` header.

package/dist/components.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+export { JsonLd } from "./json-ld.js";
+export { HreflangLinks, type HreflangLinksProps } from "./hreflang.js";
+//# sourceMappingURL=components.d.ts.map

package/dist/components.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../src/components.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAC"}

package/dist/components.js ADDED Viewed

@@ -0,0 +1,5 @@
+// React entry: the rendering components. Kept out of the package root so server
+// code that only needs the builders/metadata never imports React or next/headers.
+export { JsonLd } from "./json-ld.js";
+export { HreflangLinks } from "./hreflang.js";
+//# sourceMappingURL=components.js.map

package/dist/components.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"components.js","sourceRoot":"","sources":["../src/components.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,kFAAkF;AAClF,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,aAAa,EAA2B,MAAM,eAAe,CAAC"}

package/dist/hreflang.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+export interface HreflangLinksProps {
+    /** Absolute site origin, e.g. "https://financica.app". */
+    baseUrl: string;
+    /** Locales to emit `<link rel="alternate" hreflang>` for, e.g. ["en", "fr", "nl"]. */
+    locales: readonly string[];
+    /**
+     * Path being rendered. Defaults to the `x-pathname` request header (set it in
+     * middleware: `headers.set("x-pathname", req.nextUrl.pathname)`). Pass
+     * explicitly if you don't use that header (e.g. from route params).
+     */
+    pathname?: string;
+    /**
+     * How locale is encoded in the alternate URLs:
+     *  - `"query"` (default): `${baseUrl}${path}?${param}=${locale}` for every locale.
+     *  - `"prefix"`: the default locale stays at the bare path; others get
+     *    `/${locale}${path}` (matches a localized-rewrite setup).
+     */
+    strategy?: "query" | "prefix";
+    /** Query-param name for the `"query"` strategy. Default `"hl"`. */
+    param?: string;
+    /** Default (unprefixed) locale for the `"prefix"` strategy. */
+    defaultLocale?: string;
+    /** Optional locale → hreflang tag map, e.g. `{ en: "en-BE", fr: "fr-BE" }`. */
+    hrefLangTags?: Record<string, string>;
+    /** Emit a self-referencing `<link rel="canonical">`. Default `true`. */
+    canonical?: boolean;
+}
+/**
+ * Emits `<link rel="canonical">` plus per-locale `<link rel="alternate" hreflang>`
+ * (and an `x-default`) for the current path. Render inside `<head>` (e.g. from
+ * the root layout). Server component — reads the `x-pathname` header by default.
+ */
+export declare function HreflangLinks({ baseUrl, locales, pathname, strategy, param, defaultLocale, hrefLangTags, canonical, }: HreflangLinksProps): Promise<import("react").JSX.Element>;
+//# sourceMappingURL=hreflang.d.ts.map

package/dist/hreflang.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"hreflang.d.ts","sourceRoot":"","sources":["../src/hreflang.tsx"],"names":[],"mappings":"AAEA,MAAM,WAAW,kBAAkB;IAClC,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,wEAAwE;IACxE,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,EACnC,OAAO,EACP,OAAO,EACP,QAAQ,EACR,QAAkB,EAClB,KAAY,EACZ,aAAa,EACb,YAAY,EACZ,SAAgB,GAChB,EAAE,kBAAkB,wCA6BpB"}

package/dist/hreflang.js ADDED Viewed

@@ -0,0 +1,23 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import { headers } from "next/headers";
+/**
+ * Emits `<link rel="canonical">` plus per-locale `<link rel="alternate" hreflang>`
+ * (and an `x-default`) for the current path. Render inside `<head>` (e.g. from
+ * the root layout). Server component — reads the `x-pathname` header by default.
+ */
+export async function HreflangLinks({ baseUrl, locales, pathname, strategy = "query", param = "hl", defaultLocale, hrefLangTags, canonical = true, }) {
+    const path = pathname ?? (await headers()).get("x-pathname") ?? "/";
+    const canonicalUrl = `${baseUrl}${path}`;
+    const hrefFor = (locale) => {
+        if (strategy === "prefix") {
+            if (defaultLocale && locale === defaultLocale) {
+                return canonicalUrl;
+            }
+            const clean = path === "/" ? "" : path;
+            return `${baseUrl}/${locale}${clean}`;
+        }
+        return `${canonicalUrl}?${param}=${locale}`;
+    };
+    return (_jsxs(_Fragment, { children: [canonical ? _jsx("link", { rel: "canonical", href: canonicalUrl }) : null, locales.map((locale) => (_jsx("link", { rel: "alternate", hrefLang: hrefLangTags?.[locale] ?? locale, href: hrefFor(locale) }, locale))), _jsx("link", { rel: "alternate", hrefLang: "x-default", href: canonicalUrl })] }));
+}
+//# sourceMappingURL=hreflang.js.map

package/dist/hreflang.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"hreflang.js","sourceRoot":"","sources":["../src/hreflang.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AA8BvC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EACnC,OAAO,EACP,OAAO,EACP,QAAQ,EACR,QAAQ,GAAG,OAAO,EAClB,KAAK,GAAG,IAAI,EACZ,aAAa,EACb,YAAY,EACZ,SAAS,GAAG,IAAI,GACI;IACpB,MAAM,IAAI,GAAG,QAAQ,IAAI,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC;IACpE,MAAM,YAAY,GAAG,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;IAEzC,MAAM,OAAO,GAAG,CAAC,MAAc,EAAU,EAAE;QAC1C,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,aAAa,IAAI,MAAM,KAAK,aAAa,EAAE,CAAC;gBAC/C,OAAO,YAAY,CAAC;YACrB,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACvC,OAAO,GAAG,OAAO,IAAI,MAAM,GAAG,KAAK,EAAE,CAAC;QACvC,CAAC;QACD,OAAO,GAAG,YAAY,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;IAC7C,CAAC,CAAC;IAEF,OAAO,CACN,8BACE,SAAS,CAAC,CAAC,CAAC,eAAM,GAAG,EAAC,WAAW,EAAC,IAAI,EAAE,YAAY,GAAI,CAAC,CAAC,CAAC,IAAI,EAC/D,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CACxB,eAEC,GAAG,EAAC,WAAW,EACf,QAAQ,EAAE,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,MAAM,EAC1C,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAHhB,MAAM,CAIV,CACF,CAAC,EACF,eAAM,GAAG,EAAC,WAAW,EAAC,QAAQ,EAAC,WAAW,EAAC,IAAI,EAAE,YAAY,GAAI,IAC/D,CACH,CAAC;AACH,CAAC"}

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+export { article, type ArticleAuthor, type ArticleInput, breadcrumbList, type BreadcrumbItem, type BreadcrumbPath, createSeo, faqPage, type FaqItem, type JsonLdNode, type OfferInput, organization, type OrganizationInput, type Seo, type SeoConfig, softwareApplication, type SoftwareApplicationInput, website, type WebsiteInput, } from "./schema.js";
+export { createMetadata, type MetadataSiteConfig, type PageMetadata, type PageMetadataInput, } from "./metadata.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EACN,OAAO,EACP,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,cAAc,EACd,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,SAAS,EACT,OAAO,EACP,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,GAAG,EACR,KAAK,SAAS,EACd,mBAAmB,EACnB,KAAK,wBAAwB,EAC7B,OAAO,EACP,KAAK,YAAY,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,cAAc,EACd,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,iBAAiB,GACtB,MAAM,eAAe,CAAC"}

package/dist/index.js ADDED Viewed

@@ -0,0 +1,7 @@
+// Server entry: pure schema.org builders + the Metadata factory. No React, so
+// route handlers / sitemap.ts can import these without pulling in the renderer.
+// The <JsonLd> and <HreflangLinks> components live at
+// "@ingram-tech/nk-seo/components".
+export { article, breadcrumbList, createSeo, faqPage, organization, softwareApplication, website, } from "./schema.js";
+export { createMetadata, } from "./metadata.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,gFAAgF;AAChF,sDAAsD;AACtD,oCAAoC;AACpC,OAAO,EACN,OAAO,EAGP,cAAc,EAGd,SAAS,EACT,OAAO,EAIP,YAAY,EAIZ,mBAAmB,EAEnB,OAAO,GAEP,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,cAAc,GAId,MAAM,eAAe,CAAC"}

package/dist/json-ld.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+/**
+ * Renders one or more schema.org JSON-LD nodes into a
+ * `<script type="application/ld+json">`. Works in server and client components.
+ *
+ * The payload is trusted, server-built structured data (never user input), so
+ * serialising it into the script body is safe — that is how JSON-LD ships.
+ *
+ * @example
+ * <JsonLd data={faqPage(items)} />
+ * <JsonLd data={[organization(org), website(site)]} />
+ */
+export declare function JsonLd({ data }: {
+    data: object | object[];
+}): import("react").JSX.Element;
+//# sourceMappingURL=json-ld.d.ts.map

package/dist/json-ld.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"json-ld.d.ts","sourceRoot":"","sources":["../src/json-ld.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAAE,+BAQ3D"}

package/dist/json-ld.js ADDED Viewed

@@ -0,0 +1,18 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * Renders one or more schema.org JSON-LD nodes into a
+ * `<script type="application/ld+json">`. Works in server and client components.
+ *
+ * The payload is trusted, server-built structured data (never user input), so
+ * serialising it into the script body is safe — that is how JSON-LD ships.
+ *
+ * @example
+ * <JsonLd data={faqPage(items)} />
+ * <JsonLd data={[organization(org), website(site)]} />
+ */
+export function JsonLd({ data }) {
+    return (_jsx("script", { type: "application/ld+json",
+        // oxlint-disable-next-line no-danger -- trusted, server-built structured data, not user input
+        dangerouslySetInnerHTML: { __html: JSON.stringify(data) } }));
+}
+//# sourceMappingURL=json-ld.js.map

package/dist/json-ld.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"json-ld.js","sourceRoot":"","sources":["../src/json-ld.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,MAAM,CAAC,EAAE,IAAI,EAA+B;IAC3D,OAAO,CACN,iBACC,IAAI,EAAC,qBAAqB;QAC1B,8FAA8F;QAC9F,uBAAuB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,GACxD,CACF,CAAC;AACH,CAAC"}

package/dist/metadata.d.ts ADDED Viewed

@@ -0,0 +1,54 @@
+import type { Metadata } from "next";
+/**
+ * Per-site defaults for {@link createMetadata}. Set once, reuse on every page.
+ */
+export interface MetadataSiteConfig {
+    /** Absolute site origin, e.g. "https://ingram.tech". */
+    baseUrl: string;
+    /** OpenGraph `siteName`. */
+    siteName: string;
+    /** Site-relative or absolute default OG/Twitter image. */
+    defaultImage?: string;
+    defaultImageWidth?: number;
+    defaultImageHeight?: number;
+    /** OpenGraph locale, e.g. "en_US". */
+    locale?: string;
+    /** Twitter `@handle` for `site`. */
+    twitterSite?: string;
+    /** Twitter `@handle` for `creator`. */
+    twitterCreator?: string;
+}
+/** Per-page inputs for the bound `pageMetadata` function. */
+export interface PageMetadataInput {
+    title: string;
+    description: string;
+    /** Site-relative path of the page, e.g. "/blog/post". Used for canonical + OG url. */
+    path: string;
+    /** Overrides the site default image (site-relative or absolute). */
+    image?: string;
+    type?: "website" | "article";
+    keywords?: Metadata["keywords"];
+    noIndex?: boolean;
+    /** Merged into the generated `openGraph` (wins on conflict). */
+    openGraph?: Partial<NonNullable<Metadata["openGraph"]>>;
+    /** Merged into the generated `twitter` (wins on conflict). */
+    twitter?: Partial<NonNullable<Metadata["twitter"]>>;
+}
+/**
+ * Returns a `pageMetadata(input)` builder that produces a Next `Metadata`
+ * object with a self-referencing canonical, OpenGraph, and Twitter card from
+ * one title/description/path. Collapses the boilerplate every site repeats.
+ *
+ * @example
+ * export const metadata = createMetadata({
+ *   baseUrl: "https://ingram.tech",
+ *   siteName: "Ingram Technologies",
+ *   defaultImage: "/images/og.png",
+ *   twitterSite: "@IngramTech",
+ * });
+ * // in a page:
+ * export const metadata = pageMetadata({ title, description, path: "/services" });
+ */
+export declare function createMetadata(site: MetadataSiteConfig): (input: PageMetadataInput) => Metadata;
+export type PageMetadata = ReturnType<typeof createMetadata>;
+//# sourceMappingURL=metadata.d.ts.map

package/dist/metadata.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,6DAA6D;AAC7D,MAAM,WAAW,iBAAiB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,sFAAsF;IACtF,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC7B,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gEAAgE;IAChE,SAAS,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IACxD,8DAA8D;IAC9D,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;CACpD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,kBAAkB,IAIzB,OAAO,iBAAiB,KAAG,QAAQ,CA2ChE;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/metadata.js ADDED Viewed

@@ -0,0 +1,61 @@
+/**
+ * Returns a `pageMetadata(input)` builder that produces a Next `Metadata`
+ * object with a self-referencing canonical, OpenGraph, and Twitter card from
+ * one title/description/path. Collapses the boilerplate every site repeats.
+ *
+ * @example
+ * export const metadata = createMetadata({
+ *   baseUrl: "https://ingram.tech",
+ *   siteName: "Ingram Technologies",
+ *   defaultImage: "/images/og.png",
+ *   twitterSite: "@IngramTech",
+ * });
+ * // in a page:
+ * export const metadata = pageMetadata({ title, description, path: "/services" });
+ */
+export function createMetadata(site) {
+    const absolute = (path) => /^https?:\/\//.test(path) ? path : new URL(path, site.baseUrl).toString();
+    return function pageMetadata(input) {
+        const imagePath = input.image ?? site.defaultImage;
+        const imageUrl = imagePath ? absolute(imagePath) : undefined;
+        const url = absolute(input.path);
+        return {
+            title: input.title,
+            description: input.description,
+            ...(input.keywords ? { keywords: input.keywords } : {}),
+            alternates: { canonical: url },
+            ...(input.noIndex ? { robots: { index: false, follow: false } } : {}),
+            openGraph: {
+                title: input.title,
+                description: input.description,
+                type: input.type ?? "website",
+                url,
+                siteName: site.siteName,
+                ...(site.locale ? { locale: site.locale } : {}),
+                ...(imageUrl
+                    ? {
+                        images: [
+                            {
+                                url: imageUrl,
+                                width: site.defaultImageWidth ?? 1200,
+                                height: site.defaultImageHeight ?? 630,
+                                alt: input.title,
+                            },
+                        ],
+                    }
+                    : {}),
+                ...input.openGraph,
+            },
+            twitter: {
+                card: "summary_large_image",
+                title: input.title,
+                description: input.description,
+                ...(site.twitterSite ? { site: site.twitterSite } : {}),
+                ...(site.twitterCreator ? { creator: site.twitterCreator } : {}),
+                ...(imageUrl ? { images: [imageUrl] } : {}),
+                ...input.twitter,
+            },
+        };
+    };
+}
+//# sourceMappingURL=metadata.js.map

package/dist/metadata.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAuCA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAAC,IAAwB;IACtD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CACzC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE3E,OAAO,SAAS,YAAY,CAAC,KAAwB;QACpD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC;QACnD,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7D,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEjC,OAAO;YACN,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,UAAU,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE;YAC9B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,SAAS,EAAE;gBACV,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS;gBAC7B,GAAG;gBACH,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/C,GAAG,CAAC,QAAQ;oBACX,CAAC,CAAC;wBACA,MAAM,EAAE;4BACP;gCACC,GAAG,EAAE,QAAQ;gCACb,KAAK,EAAE,IAAI,CAAC,iBAAiB,IAAI,IAAI;gCACrC,MAAM,EAAE,IAAI,CAAC,kBAAkB,IAAI,GAAG;gCACtC,GAAG,EAAE,KAAK,CAAC,KAAK;6BAChB;yBACD;qBACD;oBACF,CAAC,CAAC,EAAE,CAAC;gBACN,GAAG,KAAK,CAAC,SAAS;aAClB;YACD,OAAO,EAAE;gBACR,IAAI,EAAE,qBAAqB;gBAC3B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvD,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3C,GAAG,KAAK,CAAC,OAAO;aAChB;SACD,CAAC;IACH,CAAC,CAAC;AACH,CAAC"}

package/dist/schema.d.ts ADDED Viewed

@@ -0,0 +1,133 @@
+/**
+ * Typed schema.org JSON-LD builders. Each returns a plain object ready to hand
+ * to `<JsonLd>` (from "@ingram-tech/nk-seo/components").
+ *
+ * The standalone builders take values as-is: pass **absolute** URLs for
+ * `url`/`image`/`logo` fields. If your pages work in site-relative paths and
+ * share one Organization, prefer {@link createSeo}, which resolves paths against
+ * a base URL and injects the publisher/provider for you.
+ */
+/** A schema.org node. Hand it to `<JsonLd data={...} />`. */
+export type JsonLdNode = Record<string, unknown>;
+export interface FaqItem {
+    question: string;
+    answer: string;
+}
+/** FAQPage: marks up a list of question/answer pairs for FAQ rich results. */
+export declare function faqPage(items: FaqItem[]): JsonLdNode;
+export interface BreadcrumbItem {
+    name: string;
+    /** Absolute URL of the crumb. */
+    url: string;
+}
+/** BreadcrumbList: the trail of links Google shows in place of the raw URL. */
+export declare function breadcrumbList(items: BreadcrumbItem[]): JsonLdNode;
+export interface OrganizationInput {
+    name: string;
+    /** Absolute URL of the organization's site. */
+    url?: string;
+    /** Absolute URL of the logo image. */
+    logo?: string;
+    description?: string;
+    email?: string;
+    /** Profile/social URLs that corroborate the entity (LinkedIn, Crunchbase…). */
+    sameAs?: string[];
+}
+/** Organization: the entity behind the site (for the knowledge panel). */
+export declare function organization(input: OrganizationInput): JsonLdNode;
+export interface WebsiteInput {
+    name: string;
+    /** Absolute URL of the site root. */
+    url: string;
+    publisher?: OrganizationInput;
+}
+/** WebSite: identifies the site as an entity; pair with {@link organization}. */
+export declare function website(input: WebsiteInput): JsonLdNode;
+export interface OfferInput {
+    priceCurrency: string;
+    /** Single price. Mutually exclusive with low/high (which emit an AggregateOffer). */
+    price?: string | number;
+    lowPrice?: string | number;
+    highPrice?: string | number;
+    offerCount?: string | number;
+    /** Absolute URL of the pricing/offer page. */
+    url?: string;
+}
+export interface SoftwareApplicationInput {
+    name: string;
+    description?: string;
+    /** Absolute URL of the app/marketing page. */
+    url?: string;
+    /** e.g. "BusinessApplication", "FinanceApplication". */
+    applicationCategory?: string;
+    /** e.g. "Web". */
+    operatingSystem?: string;
+    offers?: OfferInput;
+}
+/** SoftwareApplication: marks a product page as an app for rich results. */
+export declare function softwareApplication(input: SoftwareApplicationInput): JsonLdNode;
+export interface ArticleAuthor {
+    name: string;
+    /** Absolute URL of the author's profile/page. */
+    url?: string;
+}
+export interface ArticleInput {
+    headline: string;
+    /** Absolute canonical URL of the article. */
+    url: string;
+    description?: string;
+    type?: "Article" | "BlogPosting" | "NewsArticle" | "ScholarlyArticle";
+    datePublished?: string;
+    /** Defaults to `datePublished` when omitted. */
+    dateModified?: string;
+    authors?: ArticleAuthor[];
+    /** Absolute URL of the lead image. */
+    image?: string;
+    keywords?: string[];
+    publisher?: OrganizationInput;
+}
+/** Article (or BlogPosting/NewsArticle/ScholarlyArticle) for editorial pages. */
+export declare function article(input: ArticleInput): JsonLdNode;
+export interface SeoConfig {
+    /** Absolute site origin, e.g. "https://financica.app". */
+    baseUrl: string;
+    /** Shared publisher/provider, injected into article()/website()/organization(). */
+    organization?: OrganizationInput;
+}
+/** A path-aware version of a crumb: `path` is resolved against the base URL. */
+export interface BreadcrumbPath {
+    name: string;
+    path: string;
+}
+/**
+ * Binds the builders to a site so callers pass site-relative paths instead of
+ * absolute URLs, and the configured Organization is injected automatically.
+ *
+ * @example
+ * const seo = createSeo({ baseUrl: getServerUrl(), organization: ORG });
+ * <JsonLd data={seo.article({ path: `/blog/${slug}`, headline, datePublished })} />
+ */
+export declare function createSeo(config: SeoConfig): {
+    /** Resolve a site-relative path to an absolute URL. */
+    absolute: (path: string) => string;
+    /** FAQPage (path-free). */
+    faqPage: typeof faqPage;
+    /** BreadcrumbList from site-relative paths. */
+    breadcrumbs(items: BreadcrumbPath[]): JsonLdNode;
+    /** Organization from config (with optional per-call overrides). */
+    organization(overrides?: Partial<OrganizationInput>): JsonLdNode;
+    /** WebSite from config, defaulting name/url/publisher to the configured org. */
+    website(input?: Partial<WebsiteInput>): JsonLdNode;
+    /** SoftwareApplication; `path` (default "/") is resolved to an absolute URL. */
+    softwareApplication(input: Omit<SoftwareApplicationInput, "url"> & {
+        path?: string;
+    }): JsonLdNode;
+    /** Article; `path`/`image` are resolved and the configured org becomes publisher. */
+    article(input: Omit<ArticleInput, "url" | "image" | "publisher"> & {
+        path: string;
+        image?: string;
+        publisher?: OrganizationInput;
+    }): JsonLdNode;
+};
+export type Seo = ReturnType<typeof createSeo>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,6DAA6D;AAC7D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAIjD,MAAM,WAAW,OAAO;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,8EAA8E;AAC9E,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAUpD;AAID,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,+EAA+E;AAC/E,wBAAgB,cAAc,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,UAAU,CAWlE;AAID,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAeD,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU,CAEjE;AAID,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC9B;AAED,iFAAiF;AACjF,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,CAQvD;AAID,MAAM,WAAW,UAAU;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AA4BD,MAAM,WAAW,wBAAwB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,UAAU,CAAC;CACpB;AAED,4EAA4E;AAC5E,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,UAAU,CAa/E;AAID,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,aAAa,GAAG,kBAAkB,CAAC;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC9B;AAED,iFAAiF;AACjF,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,CAwBvD;AAID,MAAM,WAAW,SAAS;IACzB,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,mFAAmF;IACnF,YAAY,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,SAAS;IAKzC,uDAAuD;qBAJhC,MAAM,KAAG,MAAM;IAMtC,2BAA2B;;IAE3B,+CAA+C;uBAC5B,cAAc,EAAE,GAAG,UAAU;IAKhD,mEAAmE;6BAC1C,OAAO,CAAC,iBAAiB,CAAC,GAAG,UAAU;IAQhE,gFAAgF;oBAChE,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU;IAalD,gFAAgF;+BAExE,IAAI,CAAC,wBAAwB,EAAE,KAAK,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9D,UAAU;IAIb,qFAAqF;mBAE7E,IAAI,CAAC,YAAY,EAAE,KAAK,GAAG,OAAO,GAAG,WAAW,CAAC,GAAG;QAC1D,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,iBAAiB,CAAC;KAC9B,GACC,UAAU;EAUd;AAED,MAAM,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC"}

package/dist/schema.js ADDED Viewed

@@ -0,0 +1,183 @@
+/**
+ * Typed schema.org JSON-LD builders. Each returns a plain object ready to hand
+ * to `<JsonLd>` (from "@ingram-tech/nk-seo/components").
+ *
+ * The standalone builders take values as-is: pass **absolute** URLs for
+ * `url`/`image`/`logo` fields. If your pages work in site-relative paths and
+ * share one Organization, prefer {@link createSeo}, which resolves paths against
+ * a base URL and injects the publisher/provider for you.
+ */
+const CONTEXT = "https://schema.org";
+/** FAQPage: marks up a list of question/answer pairs for FAQ rich results. */
+export function faqPage(items) {
+    return {
+        "@context": CONTEXT,
+        "@type": "FAQPage",
+        mainEntity: items.map((item) => ({
+            "@type": "Question",
+            name: item.question,
+            acceptedAnswer: { "@type": "Answer", text: item.answer },
+        })),
+    };
+}
+/** BreadcrumbList: the trail of links Google shows in place of the raw URL. */
+export function breadcrumbList(items) {
+    return {
+        "@context": CONTEXT,
+        "@type": "BreadcrumbList",
+        itemListElement: items.map((item, index) => ({
+            "@type": "ListItem",
+            position: index + 1,
+            name: item.name,
+            item: item.url,
+        })),
+    };
+}
+/** Organization node without `@context`, for embedding as publisher/provider. */
+function organizationNode(input) {
+    return {
+        "@type": "Organization",
+        name: input.name,
+        ...(input.url ? { url: input.url } : {}),
+        ...(input.logo ? { logo: { "@type": "ImageObject", url: input.logo } } : {}),
+        ...(input.description ? { description: input.description } : {}),
+        ...(input.email ? { email: input.email } : {}),
+        ...(input.sameAs?.length ? { sameAs: input.sameAs } : {}),
+    };
+}
+/** Organization: the entity behind the site (for the knowledge panel). */
+export function organization(input) {
+    return { "@context": CONTEXT, ...organizationNode(input) };
+}
+/** WebSite: identifies the site as an entity; pair with {@link organization}. */
+export function website(input) {
+    return {
+        "@context": CONTEXT,
+        "@type": "WebSite",
+        name: input.name,
+        url: input.url,
+        ...(input.publisher ? { publisher: organizationNode(input.publisher) } : {}),
+    };
+}
+function offerNode(offer) {
+    const isAggregate = offer.lowPrice !== undefined || offer.highPrice !== undefined;
+    if (isAggregate) {
+        return {
+            "@type": "AggregateOffer",
+            priceCurrency: offer.priceCurrency,
+            ...(offer.lowPrice !== undefined
+                ? { lowPrice: String(offer.lowPrice) }
+                : {}),
+            ...(offer.highPrice !== undefined
+                ? { highPrice: String(offer.highPrice) }
+                : {}),
+            ...(offer.offerCount !== undefined
+                ? { offerCount: String(offer.offerCount) }
+                : {}),
+            ...(offer.url ? { url: offer.url } : {}),
+        };
+    }
+    return {
+        "@type": "Offer",
+        priceCurrency: offer.priceCurrency,
+        ...(offer.price !== undefined ? { price: String(offer.price) } : {}),
+        ...(offer.url ? { url: offer.url } : {}),
+    };
+}
+/** SoftwareApplication: marks a product page as an app for rich results. */
+export function softwareApplication(input) {
+    return {
+        "@context": CONTEXT,
+        "@type": "SoftwareApplication",
+        name: input.name,
+        ...(input.applicationCategory
+            ? { applicationCategory: input.applicationCategory }
+            : {}),
+        ...(input.operatingSystem ? { operatingSystem: input.operatingSystem } : {}),
+        ...(input.url ? { url: input.url } : {}),
+        ...(input.description ? { description: input.description } : {}),
+        ...(input.offers ? { offers: offerNode(input.offers) } : {}),
+    };
+}
+/** Article (or BlogPosting/NewsArticle/ScholarlyArticle) for editorial pages. */
+export function article(input) {
+    const dateModified = input.dateModified ?? input.datePublished;
+    return {
+        "@context": CONTEXT,
+        "@type": input.type ?? "Article",
+        headline: input.headline,
+        url: input.url,
+        mainEntityOfPage: input.url,
+        ...(input.description ? { description: input.description } : {}),
+        ...(input.authors?.length
+            ? {
+                author: input.authors.map((author) => ({
+                    "@type": "Person",
+                    name: author.name,
+                    ...(author.url ? { url: author.url } : {}),
+                })),
+            }
+            : {}),
+        ...(input.publisher ? { publisher: organizationNode(input.publisher) } : {}),
+        ...(input.datePublished ? { datePublished: input.datePublished } : {}),
+        ...(dateModified ? { dateModified } : {}),
+        ...(input.image ? { image: input.image } : {}),
+        ...(input.keywords?.length ? { keywords: input.keywords } : {}),
+    };
+}
+/**
+ * Binds the builders to a site so callers pass site-relative paths instead of
+ * absolute URLs, and the configured Organization is injected automatically.
+ *
+ * @example
+ * const seo = createSeo({ baseUrl: getServerUrl(), organization: ORG });
+ * <JsonLd data={seo.article({ path: `/blog/${slug}`, headline, datePublished })} />
+ */
+export function createSeo(config) {
+    const absolute = (path) => /^https?:\/\//.test(path) ? path : new URL(path, config.baseUrl).toString();
+    return {
+        /** Resolve a site-relative path to an absolute URL. */
+        absolute,
+        /** FAQPage (path-free). */
+        faqPage,
+        /** BreadcrumbList from site-relative paths. */
+        breadcrumbs(items) {
+            return breadcrumbList(items.map((item) => ({ name: item.name, url: absolute(item.path) })));
+        },
+        /** Organization from config (with optional per-call overrides). */
+        organization(overrides) {
+            if (!config.organization) {
+                throw new Error("createSeo: organization() needs `organization` in config");
+            }
+            return organization({ ...config.organization, ...overrides });
+        },
+        /** WebSite from config, defaulting name/url/publisher to the configured org. */
+        website(input) {
+            const name = input?.name ?? config.organization?.name;
+            if (!name) {
+                throw new Error("createSeo: website() needs a name or configured organization");
+            }
+            return website({
+                name,
+                url: input?.url ?? config.baseUrl,
+                publisher: input?.publisher ?? config.organization,
+            });
+        },
+        /** SoftwareApplication; `path` (default "/") is resolved to an absolute URL. */
+        softwareApplication(input) {
+            const { path, ...rest } = input;
+            return softwareApplication({ ...rest, url: absolute(path ?? "/") });
+        },
+        /** Article; `path`/`image` are resolved and the configured org becomes publisher. */
+        article(input) {
+            const { path, image, publisher, ...rest } = input;
+            return article({
+                ...rest,
+                url: absolute(path),
+                ...(image ? { image: absolute(image) } : {}),
+                publisher: publisher ?? config.organization,
+            });
+        },
+    };
+}
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAYrC,8EAA8E;AAC9E,MAAM,UAAU,OAAO,CAAC,KAAgB;IACvC,OAAO;QACN,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,SAAS;QAClB,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAChC,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,cAAc,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;SACxD,CAAC,CAAC;KACH,CAAC;AACH,CAAC;AAUD,+EAA+E;AAC/E,MAAM,UAAU,cAAc,CAAC,KAAuB;IACrD,OAAO;QACN,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,gBAAgB;QACzB,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAC5C,OAAO,EAAE,UAAU;YACnB,QAAQ,EAAE,KAAK,GAAG,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,GAAG;SACd,CAAC,CAAC;KACH,CAAC;AACH,CAAC;AAgBD,iFAAiF;AACjF,SAAS,gBAAgB,CAAC,KAAwB;IACjD,OAAO;QACN,OAAO,EAAE,cAAc;QACvB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACzD,CAAC;AACH,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,YAAY,CAAC,KAAwB;IACpD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC;AAWD,iFAAiF;AACjF,MAAM,UAAU,OAAO,CAAC,KAAmB;IAC1C,OAAO;QACN,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,SAAS;QAClB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5E,CAAC;AACH,CAAC;AAeD,SAAS,SAAS,CAAC,KAAiB;IACnC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;IAClF,IAAI,WAAW,EAAE,CAAC;QACjB,OAAO;YACN,OAAO,EAAE,gBAAgB;YACzB,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,GAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS;gBAC/B,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;gBACtC,CAAC,CAAC,EAAE,CAAC;YACN,GAAG,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS;gBAChC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;gBACxC,CAAC,CAAC,EAAE,CAAC;YACN,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS;gBACjC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;gBAC1C,CAAC,CAAC,EAAE,CAAC;YACN,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxC,CAAC;IACH,CAAC;IACD,OAAO;QACN,OAAO,EAAE,OAAO;QAChB,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACxC,CAAC;AACH,CAAC;AAcD,4EAA4E;AAC5E,MAAM,UAAU,mBAAmB,CAAC,KAA+B;IAClE,OAAO;QACN,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,qBAAqB;QAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,CAAC,KAAK,CAAC,mBAAmB;YAC5B,CAAC,CAAC,EAAE,mBAAmB,EAAE,KAAK,CAAC,mBAAmB,EAAE;YACpD,CAAC,CAAC,EAAE,CAAC;QACN,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAC;AACH,CAAC;AA0BD,iFAAiF;AACjF,MAAM,UAAU,OAAO,CAAC,KAAmB;IAC1C,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,aAAa,CAAC;IAC/D,OAAO;QACN,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS;QAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,gBAAgB,EAAE,KAAK,CAAC,GAAG;QAC3B,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM;YACxB,CAAC,CAAC;gBACA,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;oBACtC,OAAO,EAAE,QAAQ;oBACjB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C,CAAC,CAAC;aACH;YACF,CAAC,CAAC,EAAE,CAAC;QACN,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC/D,CAAC;AACH,CAAC;AAiBD;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,MAAiB;IAC1C,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CACzC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAE7E,OAAO;QACN,uDAAuD;QACvD,QAAQ;QACR,2BAA2B;QAC3B,OAAO;QACP,+CAA+C;QAC/C,WAAW,CAAC,KAAuB;YAClC,OAAO,cAAc,CACpB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CACpE,CAAC;QACH,CAAC;QACD,mEAAmE;QACnE,YAAY,CAAC,SAAsC;YAClD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CACd,0DAA0D,CAC1D,CAAC;YACH,CAAC;YACD,OAAO,YAAY,CAAC,EAAE,GAAG,MAAM,CAAC,YAAY,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,gFAAgF;QAChF,OAAO,CAAC,KAA6B;YACpC,MAAM,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC;YACtD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CACd,8DAA8D,CAC9D,CAAC;YACH,CAAC;YACD,OAAO,OAAO,CAAC;gBACd,IAAI;gBACJ,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,MAAM,CAAC,OAAO;gBACjC,SAAS,EAAE,KAAK,EAAE,SAAS,IAAI,MAAM,CAAC,YAAY;aAClD,CAAC,CAAC;QACJ,CAAC;QACD,gFAAgF;QAChF,mBAAmB,CAClB,KAAgE;YAEhE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YAChC,OAAO,mBAAmB,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,qFAAqF;QACrF,OAAO,CACN,KAIC;YAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YAClD,OAAO,OAAO,CAAC;gBACd,GAAG,IAAI;gBACP,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC;gBACnB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5C,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,YAAY;aAC3C,CAAC,CAAC;QACJ,CAAC;KACD,CAAC;AACH,CAAC"}

package/package.json ADDED Viewed

@@ -0,0 +1,54 @@
+{
+	"name": "@ingram-tech/nk-seo",
+	"version": "0.2.0",
+	"description": "SEO primitives for Next.js sites: typed schema.org JSON-LD builders, a <JsonLd> tag, a Metadata factory (canonical + OG + Twitter), and configurable hreflang alternates.",
+	"license": "MIT",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ingram-technologies/nextkit.git",
+		"directory": "packages/nk-seo"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		},
+		"./components": {
+			"types": "./dist/components.d.ts",
+			"import": "./dist/components.js"
+		}
+	},
+	"scripts": {
+		"build": "tsc -p tsconfig.json",
+		"type-check": "tsc -p tsconfig.json --noEmit",
+		"test": "vitest run"
+	},
+	"devDependencies": {
+		"@ingram-tech/nk-dev": "0.2.4",
+		"@types/node": "^26.0.1",
+		"@types/react": "^19.2.17",
+		"next": "^16.0.0",
+		"react": "^19.2.7",
+		"typescript": "^6.0.3",
+		"vitest": "^4.1.9"
+	},
+	"peerDependencies": {
+		"next": ">=14.0.0",
+		"react": "^18.0.0 || ^19.0.0"
+	},
+	"peerDependenciesMeta": {
+		"next": {
+			"optional": true
+		},
+		"react": {
+			"optional": true
+		}
+	}
+}