@ingram-tech/nk-seo 0.8.1 → 0.9.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.
package/README.md CHANGED
@@ -316,21 +316,12 @@ import { HreflangLinks } from "@ingram-tech/nk-seo/components";
316
316
  />
317
317
  ```
318
318
 
319
- Sites that prefix **every** locale — where `/about` redirects to `/en/about`
320
- and no bare path exists — pass `prefixDefaultLocale`, which prefixes the default
321
- locale too and points `x-default` at that prefixed URL. Without it the bare path
322
- is emitted for both `en` and `x-default`, annotating URLs that redirect (Google
323
- wants every hreflang target to answer 200 directly).
324
-
325
- ```tsx
326
- <HreflangLinks
327
- baseUrl="https://example.com"
328
- locales={["en", "fr", "nl"]}
329
- strategy="prefix"
330
- defaultLocale="en"
331
- prefixDefaultLocale
332
- />
333
- ```
319
+ The cluster's **shape** is fixed and not configurable: every locale gets its own
320
+ address, the default included, and the bare path belongs to no locale — it is
321
+ the negotiating entry point that `x-default` names. `strategy` picks only the
322
+ encoding. `@ingram-tech/nk-i18n`'s `defineLocaleRouting` produces a valid config
323
+ for this, and `hreflangConfigFor(routing)` fills in `currentLocale` and the
324
+ pathname header correctly; prefer that over assembling a config by hand.
334
325
 
335
326
  Pass `pathname` explicitly if you don't use the `x-pathname` header. When
336
327
  neither is available the component **throws** instead of guessing — a silent
@@ -10,42 +10,35 @@ export interface HreflangConfig {
10
10
  locales: readonly string[];
11
11
  /**
12
12
  * How locale is encoded in the alternate URLs:
13
- * - `"query"` (default): `${baseUrl}${path}?${param}=${locale}` for every locale.
14
- * - `"prefix"`: the default locale stays at the bare path; others get
15
- * `/${locale}${path}` (matches a localized-rewrite setup). Set
16
- * {@link HreflangConfig.prefixDefaultLocale} for sites that prefix every
17
- * locale instead.
13
+ * - `"query"` (default): `${baseUrl}${path}?${param}=${locale}`
14
+ * - `"prefix"`: `/${locale}${path}`
15
+ *
16
+ * The cluster's SHAPE is the same either way and is not configurable: every
17
+ * locale gets its own address, the default included, and the bare path
18
+ * belongs to no locale — it is the negotiating entry point that `x-default`
19
+ * names. `@ingram-tech/nk-i18n`'s `defineLocaleRouting` produces a valid
20
+ * config for this; prefer passing that over assembling one by hand.
18
21
  */
19
22
  strategy?: "query" | "prefix";
20
23
  /** Query-param name for the `"query"` strategy. Default `"hl"`. */
21
24
  param?: string;
22
- /** Default locale. Required for `"prefix"`; it is what `x-default` resolves to. */
23
- defaultLocale?: string;
24
- /**
25
- * `"prefix"` only: prefix the default locale too (`/en/about`, never
26
- * `/about`), and point `x-default` at that prefixed URL. For sites whose
27
- * locale negotiation redirects every bare path — emitting the bare path as
28
- * an alternate would annotate a URL that 3xx-redirects, which is the bug the
29
- * mandatory `defaultLocale` exists to prevent.
30
- */
31
- prefixDefaultLocale?: boolean;
32
25
  /**
33
26
  * The locale **the URL names**, which is not always the locale that rendered.
34
27
  * It determines the self-referencing canonical, and a canonical is a claim
35
- * about an address: under `"query"`, `/pricing` canonicalizes to `/pricing`
36
- * even while content negotiation renders it in French for a French visitor,
37
- * because `/pricing` is the negotiating entry point and belongs to no locale.
38
- * Passing the negotiated locale here instead makes the bare path claim to be
39
- * the French URL, and the real French URL then looks like a duplicate.
28
+ * about an address: `/pricing` canonicalizes to `/pricing` even while content
29
+ * negotiation renders it in French for a French visitor, because `/pricing`
30
+ * belongs to no locale. Passing the negotiated locale here instead makes the
31
+ * bare path claim to be the French URL, and the real French URL then looks
32
+ * like a duplicate of it.
40
33
  *
41
- * Leave it unset on a negotiating bare path. Under `"prefix"` it is detected
42
- * from the pathname; under `"query"` the server cannot see the query string,
43
- * so pass it — `hreflangConfigFor(routing)` from
44
- * "@ingram-tech/nk-i18n/next" fills it in correctly.
34
+ * Leave it unset on the bare path. Under `"prefix"` it is detected from the
35
+ * pathname; under `"query"` the server cannot see the query string, so pass
36
+ * it — `hreflangConfigFor(routing)` from "@ingram-tech/nk-i18n/next" fills it
37
+ * in correctly.
45
38
  */
46
39
  currentLocale?: string;
47
40
  /** Optional locale → hreflang tag map, e.g. `{ en: "en-BE", fr: "fr-BE" }`. */
48
- hrefLangTags?: Record<string, string>;
41
+ hrefLangTags?: Readonly<Partial<Record<string, string>>>;
49
42
  }
50
43
  export interface HreflangLink {
51
44
  /** The `hreflang` attribute value ("fr-BE", "x-default", …). */
@@ -1 +1 @@
1
- {"version":3,"file":"alternates.d.ts","sourceRoot":"","sources":["../src/alternates.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IAClC,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,MAAM,GACd,kBAAkB,CAuFpB"}
1
+ {"version":3,"file":"alternates.d.ts","sourceRoot":"","sources":["../src/alternates.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,YAAY,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,YAAY;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IAClC,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,cAAc,EACtB,QAAQ,EAAE,MAAM,GACd,kBAAkB,CAuDpB"}
@@ -4,18 +4,10 @@ import { absoluteUrl } from "./url.js";
4
4
  * URLs (and an `x-default`) for `pathname`.
5
5
  */
6
6
  export function hreflangAlternates(config, pathname) {
7
- const { strategy = "query", param = "hl", defaultLocale, prefixDefaultLocale, hrefLangTags, } = config;
8
- if (strategy === "prefix" && !defaultLocale) {
9
- // Without it canonical/x-default point at a bare path that is no
10
- // locale's URL — a silent SEO bug. (With `prefixDefaultLocale` no bare
11
- // path is emitted at all, but x-default still has to resolve to *some*
12
- // locale, so the requirement stands.)
13
- throw new Error("hreflangAlternates: `defaultLocale` is required for the prefix strategy.");
14
- }
15
- // Prefix strategy: accept both the bare and the locale-prefixed form of the
16
- // path (middleware's `x-pathname` carries the latter on a real localized
17
- // route — blindly prepending would emit /fr/fr/about) and detect the
18
- // current locale from it.
7
+ const { strategy = "query", param = "hl", hrefLangTags } = config;
8
+ // Accept both the bare and the locale-prefixed form of the path (middleware's
9
+ // `x-pathname` carries the latter on a real localized route — blindly
10
+ // prepending would emit /fr/fr/about) and detect the current locale from it.
19
11
  let basePath = pathname;
20
12
  let currentLocale = config.currentLocale;
21
13
  if (strategy === "prefix") {
@@ -26,46 +18,30 @@ export function hreflangAlternates(config, pathname) {
26
18
  break;
27
19
  }
28
20
  }
29
- currentLocale ??= defaultLocale;
21
+ // Deliberately no fallback to a default locale: a bare path names none.
30
22
  }
31
- /** The bare (locale-free) URL of the path. */
23
+ /** The bare (locale-free) URL — the negotiating entry point, `x-default`. */
32
24
  const bareUrl = absoluteUrl(basePath, config.baseUrl);
33
- const prefixedUrl = (locale) => absoluteUrl(`/${locale}${basePath === "/" ? "" : basePath}`, config.baseUrl);
25
+ /** Every locale has its own address, the default included. */
34
26
  const hrefFor = (locale) => {
35
27
  if (strategy === "prefix") {
36
- if (locale === defaultLocale && !prefixDefaultLocale)
37
- return bareUrl;
38
- return prefixedUrl(locale);
28
+ return absoluteUrl(`/${locale}${basePath === "/" ? "" : basePath}`, config.baseUrl);
39
29
  }
40
30
  return `${bareUrl}${bareUrl.includes("?") ? "&" : "?"}${param}=${locale}`;
41
31
  };
42
- /** x-default: the default locale's own URL, prefixed or not. */
43
- const defaultUrl = strategy === "prefix" && prefixDefaultLocale && defaultLocale
44
- ? prefixedUrl(defaultLocale)
45
- : bareUrl;
46
- // Self-referencing canonical: the current variant's own URL. Canonicalizing
47
- // a localized variant to the bare path makes Google treat the variants as
48
- // duplicates and ignore the hreflang annotations entirely.
49
- //
50
- // Whether the default locale has a URL of its own is strategy-dependent, and
51
- // conflating the two is a silent way to delete the default locale from the
52
- // cluster. Under `"prefix"` it shares the bare path (unless every locale is
53
- // prefixed), so its canonical IS the bare path. Under `"query"` every locale
54
- // gets its own `?param=` address and the bare path belongs to none of them:
55
- // it is the negotiating entry point that `x-default` names. So `?hl=en` must
56
- // canonicalize to `?hl=en`, never to the bare path.
57
- const defaultLocaleOwnsBarePath = strategy === "prefix" && !prefixDefaultLocale;
58
- const canonical = currentLocale &&
59
- config.locales.includes(currentLocale) &&
60
- !(defaultLocaleOwnsBarePath && currentLocale === defaultLocale)
32
+ // Self-referencing canonical: the current variant's own URL, or the bare path
33
+ // when the URL names no locale. Canonicalizing a localized variant to the
34
+ // bare path makes Google treat the variants as duplicates and ignore the
35
+ // hreflang annotations entirely.
36
+ const canonical = currentLocale && config.locales.includes(currentLocale)
61
37
  ? hrefFor(currentLocale)
62
- : defaultUrl;
38
+ : bareUrl;
63
39
  const links = [
64
40
  ...config.locales.map((locale) => ({
65
41
  hrefLang: hrefLangTags?.[locale] ?? locale,
66
42
  href: hrefFor(locale),
67
43
  })),
68
- { hrefLang: "x-default", href: defaultUrl },
44
+ { hrefLang: "x-default", href: bareUrl },
69
45
  ];
70
46
  return {
71
47
  canonical,
@@ -1 +1 @@
1
- {"version":3,"file":"alternates.js","sourceRoot":"","sources":["../src/alternates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAuEvC;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CACjC,MAAsB,EACtB,QAAgB;IAEhB,MAAM,EACL,QAAQ,GAAG,OAAO,EAClB,KAAK,GAAG,IAAI,EACZ,aAAa,EACb,mBAAmB,EACnB,YAAY,GACZ,GAAG,MAAM,CAAC;IACX,IAAI,QAAQ,KAAK,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7C,iEAAiE;QACjE,uEAAuE;QACvE,uEAAuE;QACvE,sCAAsC;QACtC,MAAM,IAAI,KAAK,CACd,0EAA0E,CAC1E,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,yEAAyE;IACzE,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,QAAQ,GAAG,QAAQ,CAAC;IACxB,IAAI,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;IACzC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC3B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,QAAQ,KAAK,IAAI,MAAM,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrE,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC;gBACpD,aAAa,KAAK,MAAM,CAAC;gBACzB,MAAM;YACP,CAAC;QACF,CAAC;QACD,aAAa,KAAK,aAAa,CAAC;IACjC,CAAC;IAED,8CAA8C;IAC9C,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAEtD,MAAM,WAAW,GAAG,CAAC,MAAc,EAAU,EAAE,CAC9C,WAAW,CAAC,IAAI,MAAM,GAAG,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAE9E,MAAM,OAAO,GAAG,CAAC,MAAc,EAAU,EAAE;QAC1C,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,MAAM,KAAK,aAAa,IAAI,CAAC,mBAAmB;gBAAE,OAAO,OAAO,CAAC;YACrE,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,IAAI,MAAM,EAAE,CAAC;IAC3E,CAAC,CAAC;IAEF,gEAAgE;IAChE,MAAM,UAAU,GACf,QAAQ,KAAK,QAAQ,IAAI,mBAAmB,IAAI,aAAa;QAC5D,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC;QAC5B,CAAC,CAAC,OAAO,CAAC;IAEZ,4EAA4E;IAC5E,0EAA0E;IAC1E,2DAA2D;IAC3D,EAAE;IACF,6EAA6E;IAC7E,2EAA2E;IAC3E,4EAA4E;IAC5E,6EAA6E;IAC7E,4EAA4E;IAC5E,6EAA6E;IAC7E,oDAAoD;IACpD,MAAM,yBAAyB,GAAG,QAAQ,KAAK,QAAQ,IAAI,CAAC,mBAAmB,CAAC;IAChF,MAAM,SAAS,GACd,aAAa;QACb,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;QACtC,CAAC,CAAC,yBAAyB,IAAI,aAAa,KAAK,aAAa,CAAC;QAC9D,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QACxB,CAAC,CAAC,UAAU,CAAC;IAEf,MAAM,KAAK,GAAG;QACb,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAClC,QAAQ,EAAE,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,MAAM;YAC1C,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;SACrB,CAAC,CAAC;QACH,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE;KAC3C,CAAC;IAEF,OAAO;QACN,SAAS;QACT,KAAK;QACL,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;KAC9E,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"alternates.js","sourceRoot":"","sources":["../src/alternates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAgEvC;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CACjC,MAAsB,EACtB,QAAgB;IAEhB,MAAM,EAAE,QAAQ,GAAG,OAAO,EAAE,KAAK,GAAG,IAAI,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IAElE,8EAA8E;IAC9E,sEAAsE;IACtE,6EAA6E;IAC7E,IAAI,QAAQ,GAAG,QAAQ,CAAC;IACxB,IAAI,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;IACzC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC3B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,QAAQ,KAAK,IAAI,MAAM,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrE,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC;gBACpD,aAAa,KAAK,MAAM,CAAC;gBACzB,MAAM;YACP,CAAC;QACF,CAAC;QACD,wEAAwE;IACzE,CAAC;IAED,6EAA6E;IAC7E,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAEtD,8DAA8D;IAC9D,MAAM,OAAO,GAAG,CAAC,MAAc,EAAU,EAAE;QAC1C,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,WAAW,CACjB,IAAI,MAAM,GAAG,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,EAC/C,MAAM,CAAC,OAAO,CACd,CAAC;QACH,CAAC;QACD,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,IAAI,MAAM,EAAE,CAAC;IAC3E,CAAC,CAAC;IAEF,8EAA8E;IAC9E,0EAA0E;IAC1E,yEAAyE;IACzE,iCAAiC;IACjC,MAAM,SAAS,GACd,aAAa,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;QACtD,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QACxB,CAAC,CAAC,OAAO,CAAC;IAEZ,MAAM,KAAK,GAAG;QACb,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAClC,QAAQ,EAAE,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,MAAM;YAC1C,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;SACrB,CAAC,CAAC;QACH,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;KACxC,CAAC;IAEF,OAAO;QACN,SAAS;QACT,KAAK;QACL,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;KAC9E,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ingram-tech/nk-seo",
3
- "version": "0.8.1",
3
+ "version": "0.9.0",
4
4
  "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.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -43,14 +43,14 @@
43
43
  "test": "vitest run"
44
44
  },
45
45
  "devDependencies": {
46
- "@ingram-tech/nk-dev": "0.12.0",
46
+ "@ingram-tech/nk-dev": "0.13.0",
47
47
  "@types/node": "^26.2.0",
48
48
  "@types/react": "^19.2.18",
49
49
  "next": "^16.3.1",
50
50
  "react": "^19.2.8",
51
51
  "typescript": "^7.0.2",
52
52
  "vitest": "^4.1.10",
53
- "@ingram-tech/nk-i18n": "0.4.1"
53
+ "@ingram-tech/nk-i18n": "0.5.0"
54
54
  },
55
55
  "peerDependencies": {
56
56
  "next": ">=14.0.0",
package/src/alternates.ts CHANGED
@@ -12,42 +12,35 @@ export interface HreflangConfig {
12
12
  locales: readonly string[];
13
13
  /**
14
14
  * How locale is encoded in the alternate URLs:
15
- * - `"query"` (default): `${baseUrl}${path}?${param}=${locale}` for every locale.
16
- * - `"prefix"`: the default locale stays at the bare path; others get
17
- * `/${locale}${path}` (matches a localized-rewrite setup). Set
18
- * {@link HreflangConfig.prefixDefaultLocale} for sites that prefix every
19
- * locale instead.
15
+ * - `"query"` (default): `${baseUrl}${path}?${param}=${locale}`
16
+ * - `"prefix"`: `/${locale}${path}`
17
+ *
18
+ * The cluster's SHAPE is the same either way and is not configurable: every
19
+ * locale gets its own address, the default included, and the bare path
20
+ * belongs to no locale — it is the negotiating entry point that `x-default`
21
+ * names. `@ingram-tech/nk-i18n`'s `defineLocaleRouting` produces a valid
22
+ * config for this; prefer passing that over assembling one by hand.
20
23
  */
21
24
  strategy?: "query" | "prefix";
22
25
  /** Query-param name for the `"query"` strategy. Default `"hl"`. */
23
26
  param?: string;
24
- /** Default locale. Required for `"prefix"`; it is what `x-default` resolves to. */
25
- defaultLocale?: string;
26
- /**
27
- * `"prefix"` only: prefix the default locale too (`/en/about`, never
28
- * `/about`), and point `x-default` at that prefixed URL. For sites whose
29
- * locale negotiation redirects every bare path — emitting the bare path as
30
- * an alternate would annotate a URL that 3xx-redirects, which is the bug the
31
- * mandatory `defaultLocale` exists to prevent.
32
- */
33
- prefixDefaultLocale?: boolean;
34
27
  /**
35
28
  * The locale **the URL names**, which is not always the locale that rendered.
36
29
  * It determines the self-referencing canonical, and a canonical is a claim
37
- * about an address: under `"query"`, `/pricing` canonicalizes to `/pricing`
38
- * even while content negotiation renders it in French for a French visitor,
39
- * because `/pricing` is the negotiating entry point and belongs to no locale.
40
- * Passing the negotiated locale here instead makes the bare path claim to be
41
- * the French URL, and the real French URL then looks like a duplicate.
30
+ * about an address: `/pricing` canonicalizes to `/pricing` even while content
31
+ * negotiation renders it in French for a French visitor, because `/pricing`
32
+ * belongs to no locale. Passing the negotiated locale here instead makes the
33
+ * bare path claim to be the French URL, and the real French URL then looks
34
+ * like a duplicate of it.
42
35
  *
43
- * Leave it unset on a negotiating bare path. Under `"prefix"` it is detected
44
- * from the pathname; under `"query"` the server cannot see the query string,
45
- * so pass it — `hreflangConfigFor(routing)` from
46
- * "@ingram-tech/nk-i18n/next" fills it in correctly.
36
+ * Leave it unset on the bare path. Under `"prefix"` it is detected from the
37
+ * pathname; under `"query"` the server cannot see the query string, so pass
38
+ * it — `hreflangConfigFor(routing)` from "@ingram-tech/nk-i18n/next" fills it
39
+ * in correctly.
47
40
  */
48
41
  currentLocale?: string;
49
42
  /** Optional locale → hreflang tag map, e.g. `{ en: "en-BE", fr: "fr-BE" }`. */
50
- hrefLangTags?: Record<string, string>;
43
+ hrefLangTags?: Readonly<Partial<Record<string, string>>>;
51
44
  }
52
45
 
53
46
  export interface HreflangLink {
@@ -77,27 +70,11 @@ export function hreflangAlternates(
77
70
  config: HreflangConfig,
78
71
  pathname: string,
79
72
  ): HreflangAlternates {
80
- const {
81
- strategy = "query",
82
- param = "hl",
83
- defaultLocale,
84
- prefixDefaultLocale,
85
- hrefLangTags,
86
- } = config;
87
- if (strategy === "prefix" && !defaultLocale) {
88
- // Without it canonical/x-default point at a bare path that is no
89
- // locale's URL — a silent SEO bug. (With `prefixDefaultLocale` no bare
90
- // path is emitted at all, but x-default still has to resolve to *some*
91
- // locale, so the requirement stands.)
92
- throw new Error(
93
- "hreflangAlternates: `defaultLocale` is required for the prefix strategy.",
94
- );
95
- }
73
+ const { strategy = "query", param = "hl", hrefLangTags } = config;
96
74
 
97
- // Prefix strategy: accept both the bare and the locale-prefixed form of the
98
- // path (middleware's `x-pathname` carries the latter on a real localized
99
- // route — blindly prepending would emit /fr/fr/about) and detect the
100
- // current locale from it.
75
+ // Accept both the bare and the locale-prefixed form of the path (middleware's
76
+ // `x-pathname` carries the latter on a real localized route — blindly
77
+ // prepending would emit /fr/fr/about) and detect the current locale from it.
101
78
  let basePath = pathname;
102
79
  let currentLocale = config.currentLocale;
103
80
  if (strategy === "prefix") {
@@ -108,54 +85,38 @@ export function hreflangAlternates(
108
85
  break;
109
86
  }
110
87
  }
111
- currentLocale ??= defaultLocale;
88
+ // Deliberately no fallback to a default locale: a bare path names none.
112
89
  }
113
90
 
114
- /** The bare (locale-free) URL of the path. */
91
+ /** The bare (locale-free) URL — the negotiating entry point, `x-default`. */
115
92
  const bareUrl = absoluteUrl(basePath, config.baseUrl);
116
93
 
117
- const prefixedUrl = (locale: string): string =>
118
- absoluteUrl(`/${locale}${basePath === "/" ? "" : basePath}`, config.baseUrl);
119
-
94
+ /** Every locale has its own address, the default included. */
120
95
  const hrefFor = (locale: string): string => {
121
96
  if (strategy === "prefix") {
122
- if (locale === defaultLocale && !prefixDefaultLocale) return bareUrl;
123
- return prefixedUrl(locale);
97
+ return absoluteUrl(
98
+ `/${locale}${basePath === "/" ? "" : basePath}`,
99
+ config.baseUrl,
100
+ );
124
101
  }
125
102
  return `${bareUrl}${bareUrl.includes("?") ? "&" : "?"}${param}=${locale}`;
126
103
  };
127
104
 
128
- /** x-default: the default locale's own URL, prefixed or not. */
129
- const defaultUrl =
130
- strategy === "prefix" && prefixDefaultLocale && defaultLocale
131
- ? prefixedUrl(defaultLocale)
132
- : bareUrl;
133
-
134
- // Self-referencing canonical: the current variant's own URL. Canonicalizing
135
- // a localized variant to the bare path makes Google treat the variants as
136
- // duplicates and ignore the hreflang annotations entirely.
137
- //
138
- // Whether the default locale has a URL of its own is strategy-dependent, and
139
- // conflating the two is a silent way to delete the default locale from the
140
- // cluster. Under `"prefix"` it shares the bare path (unless every locale is
141
- // prefixed), so its canonical IS the bare path. Under `"query"` every locale
142
- // gets its own `?param=` address and the bare path belongs to none of them:
143
- // it is the negotiating entry point that `x-default` names. So `?hl=en` must
144
- // canonicalize to `?hl=en`, never to the bare path.
145
- const defaultLocaleOwnsBarePath = strategy === "prefix" && !prefixDefaultLocale;
105
+ // Self-referencing canonical: the current variant's own URL, or the bare path
106
+ // when the URL names no locale. Canonicalizing a localized variant to the
107
+ // bare path makes Google treat the variants as duplicates and ignore the
108
+ // hreflang annotations entirely.
146
109
  const canonical =
147
- currentLocale &&
148
- config.locales.includes(currentLocale) &&
149
- !(defaultLocaleOwnsBarePath && currentLocale === defaultLocale)
110
+ currentLocale && config.locales.includes(currentLocale)
150
111
  ? hrefFor(currentLocale)
151
- : defaultUrl;
112
+ : bareUrl;
152
113
 
153
114
  const links = [
154
115
  ...config.locales.map((locale) => ({
155
116
  hrefLang: hrefLangTags?.[locale] ?? locale,
156
117
  href: hrefFor(locale),
157
118
  })),
158
- { hrefLang: "x-default", href: defaultUrl },
119
+ { hrefLang: "x-default", href: bareUrl },
159
120
  ];
160
121
 
161
122
  return {