@ingram-tech/nk-seo 0.9.0 → 0.10.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 +34 -15
- package/dist/hreflang.d.ts +6 -3
- package/dist/hreflang.d.ts.map +1 -1
- package/dist/hreflang.js.map +1 -1
- package/dist/metadata.d.ts +22 -2
- package/dist/metadata.d.ts.map +1 -1
- package/dist/metadata.js +16 -2
- package/dist/metadata.js.map +1 -1
- package/package.json +2 -2
- package/src/hreflang.tsx +6 -3
- package/src/metadata.ts +40 -4
package/README.md
CHANGED
|
@@ -156,21 +156,35 @@ needed — each is merged into the generated object and wins on conflict. With
|
|
|
156
156
|
`titleTemplate` set, `pageMetadata.root()` emits `title.template`, so plain page
|
|
157
157
|
titles render as "Services | Acme" without every page appending the suffix.
|
|
158
158
|
|
|
159
|
-
On a localized site the
|
|
160
|
-
|
|
161
|
-
`<link rel="alternate" hreflang>`,
|
|
159
|
+
On a localized site give the factory the locale cluster once and every page
|
|
160
|
+
emits its `alternates.languages` (what Next renders as
|
|
161
|
+
`<link rel="alternate" hreflang>`, `x-default` included) and a canonical that
|
|
162
|
+
follows the address. `@ingram-tech/nk-i18n`'s routing object fits as-is:
|
|
162
163
|
|
|
163
164
|
```ts
|
|
164
|
-
|
|
165
|
+
export const pageMetadata = createMetadata({
|
|
166
|
+
baseUrl: routing.baseUrl,
|
|
167
|
+
siteName: "Acme",
|
|
168
|
+
hreflang: routing, // or { locales, strategy, param, hrefLangTags }
|
|
169
|
+
});
|
|
165
170
|
|
|
166
|
-
|
|
171
|
+
// A dynamic page: the URL locale makes the canonical self-reference /fr/about.
|
|
167
172
|
return pageMetadata({
|
|
168
|
-
title, description, path:
|
|
169
|
-
|
|
170
|
-
locale: "fr_BE",
|
|
173
|
+
title, description, path: "/about",
|
|
174
|
+
urlLocale: await getUrlLocale(routing), // from "@ingram-tech/nk-i18n/next"
|
|
175
|
+
locale: "fr_BE", // og:locale, overrides the site-wide one
|
|
171
176
|
});
|
|
177
|
+
|
|
178
|
+
// A static page (`force-static`): one document for every visitor, so no
|
|
179
|
+
// `urlLocale` — it canonicalizes to the bare, x-default address.
|
|
180
|
+
return pageMetadata({ title, description, path: `/posts/${slug}` });
|
|
172
181
|
```
|
|
173
182
|
|
|
183
|
+
This is the wiring to prefer over `<HreflangLinks>`: it needs no request
|
|
184
|
+
header, so it works on statically rendered routes, and there is nothing to
|
|
185
|
+
forget in middleware. Reach for the component, or the pure `hreflangAlternates`,
|
|
186
|
+
only on pages that don't go through `pageMetadata`.
|
|
187
|
+
|
|
174
188
|
## Sitemap & robots
|
|
175
189
|
|
|
176
190
|
```ts
|
|
@@ -295,9 +309,14 @@ return NextResponse.next({ request: { headers: requestHeaders } });
|
|
|
295
309
|
```
|
|
296
310
|
|
|
297
311
|
Copying `req.headers` first also overwrites any client-spoofed `x-pathname`.
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
312
|
+
Reading the header (`headers()`) opts the page into dynamic rendering, and on a
|
|
313
|
+
route that is already static (`force-static`, no request-time reads) the header
|
|
314
|
+
is simply empty — so a `<HreflangLinks>` in the root layout **throws under any
|
|
315
|
+
static page**. Sites with static routes should emit hreflang from metadata
|
|
316
|
+
instead (`createMetadata({ hreflang })`, above), which needs no header at all;
|
|
317
|
+
short of that, pass `pathname` explicitly from route params on the page itself
|
|
318
|
+
(React hoists `<link>` into `<head>` from anywhere in the tree) and keep the
|
|
319
|
+
header-reading instance out of layouts that static routes share.
|
|
301
320
|
|
|
302
321
|
```tsx
|
|
303
322
|
import { HreflangLinks } from "@ingram-tech/nk-seo/components";
|
|
@@ -342,11 +361,11 @@ Two rules of the road:
|
|
|
342
361
|
strategy can't see the query string server-side, so
|
|
343
362
|
[`hreflangConfigFor(routing)`](../nk-i18n/README.md) from
|
|
344
363
|
`@ingram-tech/nk-i18n/next` is the wiring that gets this right for you.
|
|
345
|
-
- Building metadata instead of rendering links?
|
|
346
|
-
|
|
364
|
+
- Building metadata instead of rendering links? `createMetadata({ hreflang })`
|
|
365
|
+
does it on every page; the pure `hreflangAlternates` (package root) returns
|
|
366
|
+
the same links for a hand-rolled `generateMetadata`:
|
|
347
367
|
`{ canonical, links, languages }`, where `languages` is already keyed by
|
|
348
|
-
hreflang for `Metadata.alternates.languages
|
|
349
|
-
per-page `alternates`).
|
|
368
|
+
hreflang for `Metadata.alternates.languages`.
|
|
350
369
|
|
|
351
370
|
## Verifying the cluster (`/verify`)
|
|
352
371
|
|
package/dist/hreflang.d.ts
CHANGED
|
@@ -11,9 +11,12 @@ export interface HreflangLinksProps extends HreflangConfig {
|
|
|
11
11
|
* return NextResponse.next({ request: { headers: requestHeaders } });
|
|
12
12
|
* ```
|
|
13
13
|
*
|
|
14
|
-
* Pass explicitly if you don't use that header (e.g. from route params)
|
|
15
|
-
*
|
|
16
|
-
*
|
|
14
|
+
* Pass explicitly if you don't use that header (e.g. from route params).
|
|
15
|
+
* On a statically rendered route the header is empty (and reading it would
|
|
16
|
+
* otherwise opt the page into dynamic rendering), so a header-reading
|
|
17
|
+
* instance cannot sit in a layout shared with static pages — prefer
|
|
18
|
+
* `createMetadata({ hreflang })`, which emits the same cluster from metadata
|
|
19
|
+
* without any request header.
|
|
17
20
|
*/
|
|
18
21
|
pathname?: string;
|
|
19
22
|
/**
|
package/dist/hreflang.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hreflang.d.ts","sourceRoot":"","sources":["../src/hreflang.tsx"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE1E,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACzD
|
|
1
|
+
{"version":3,"file":"hreflang.d.ts","sourceRoot":"","sources":["../src/hreflang.tsx"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE1E,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACzD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,EACnC,QAAQ,EACR,SAAgB,EAChB,GAAG,MAAM,EACT,EAAE,kBAAkB,wCA4BpB"}
|
package/dist/hreflang.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hreflang.js","sourceRoot":"","sources":["../src/hreflang.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAuB,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"hreflang.js","sourceRoot":"","sources":["../src/hreflang.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAuB,MAAM,iBAAiB,CAAC;AA8B1E;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EACnC,QAAQ,EACR,SAAS,GAAG,IAAI,EAChB,GAAG,MAAM,EACW;IACpB,MAAM,IAAI,GAAG,QAAQ,IAAI,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC7D,IAAI,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACd,wEAAwE;YACvE,kDAAkD;YAClD,kFAAkF;YAClF,4DAA4D;YAC5D,iFAAiF,CAClF,CAAC;IACH,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE5E,OAAO,CACN,8BACE,SAAS,CAAC,CAAC,CAAC,eAAM,GAAG,EAAC,WAAW,EAAC,IAAI,EAAE,YAAY,GAAI,CAAC,CAAC,CAAC,IAAI,EAC/D,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CACpB,eAIC,GAAG,EAAC,WAAW,EACf,QAAQ,EAAE,IAAI,CAAC,QAAQ,EACvB,IAAI,EAAE,IAAI,CAAC,IAAI,IAHV,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAInC,CACF,CAAC,IACA,CACH,CAAC;AACH,CAAC"}
|
package/dist/metadata.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Metadata } from "next";
|
|
2
|
+
import { type HreflangConfig } from "./alternates.js";
|
|
2
3
|
/**
|
|
3
4
|
* Per-site defaults for {@link createMetadata}. Set once, reuse on every page.
|
|
4
5
|
*/
|
|
@@ -25,6 +26,15 @@ export interface MetadataSiteConfig {
|
|
|
25
26
|
twitterSite?: string;
|
|
26
27
|
/** Twitter `@handle` for `creator`. */
|
|
27
28
|
twitterCreator?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Locale cluster for the site. When set, every `pageMetadata()` call emits
|
|
31
|
+
* the per-locale `alternates.languages` (plus `x-default`) and a canonical
|
|
32
|
+
* that follows the address — the same links `<HreflangLinks>` renders, but
|
|
33
|
+
* from metadata, so it works on statically rendered routes too (there is no
|
|
34
|
+
* request header to read there) and needs no middleware wiring.
|
|
35
|
+
* `@ingram-tech/nk-i18n`'s routing object fits directly: `hreflang: routing`.
|
|
36
|
+
*/
|
|
37
|
+
hreflang?: Omit<HreflangConfig, "baseUrl" | "currentLocale">;
|
|
28
38
|
}
|
|
29
39
|
/** Per-page inputs for the bound `pageMetadata` function. */
|
|
30
40
|
export interface PageMetadataInput {
|
|
@@ -42,11 +52,21 @@ export interface PageMetadataInput {
|
|
|
42
52
|
* on a multilingual site `og:locale` has to vary per page.
|
|
43
53
|
*/
|
|
44
54
|
locale?: string;
|
|
55
|
+
/**
|
|
56
|
+
* With `site.hreflang` set: the locale **the URL names** (not the one that
|
|
57
|
+
* rendered), so the canonical self-references the localized address. Get it
|
|
58
|
+
* from `getUrlLocale(routing)` (`@ingram-tech/nk-i18n/next`) on dynamic
|
|
59
|
+
* pages; leave it unset on the bare path and on static routes, which serve
|
|
60
|
+
* one document for every visitor and so canonicalize to the bare, `x-default`
|
|
61
|
+
* address. Under the prefix strategy a `/fr/…`-prefixed `path` implies it.
|
|
62
|
+
*/
|
|
63
|
+
urlLocale?: string;
|
|
45
64
|
/**
|
|
46
65
|
* Merged into the generated `alternates` (wins on conflict). The reason it
|
|
47
66
|
* exists: `alternates.languages` is per-page on a localized site, and
|
|
48
|
-
* spreading the result to bolt it on drops the rest of the object.
|
|
49
|
-
* `
|
|
67
|
+
* spreading the result to bolt it on drops the rest of the object. Prefer
|
|
68
|
+
* `site.hreflang`, which fills it in on every page; `hreflangAlternates()`
|
|
69
|
+
* returns a ready-made `languages` map for the hand-rolled case.
|
|
50
70
|
*/
|
|
51
71
|
alternates?: Partial<NonNullable<Metadata["alternates"]>>;
|
|
52
72
|
/** Merged into the generated `openGraph` (wins on conflict). */
|
package/dist/metadata.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAsB,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAG1E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,eAAe,CAAC,CAAC;CAC7D;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;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1D,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,mEAAmE;AACnE,MAAM,WAAW,iBAAiB;IACjC,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,kBAAkB;YAGzB,iBAAiB,GAAG,QAAQ;mBAgER,iBAAiB,KAAQ,QAAQ;EAalF;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAE7D,0CAA0C;AAC1C,MAAM,WAAW,oBAAoB;IACpC,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB;;;;;IAS1D"}
|
package/dist/metadata.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { hreflangAlternates } from "./alternates.js";
|
|
1
2
|
import { absoluteUrl } from "./url.js";
|
|
2
3
|
/**
|
|
3
4
|
* Returns a `pageMetadata(input)` builder that produces a Next `Metadata`
|
|
@@ -26,14 +27,27 @@ export function createMetadata(site) {
|
|
|
26
27
|
function pageMetadata(input) {
|
|
27
28
|
const imagePath = input.image ?? site.defaultImage;
|
|
28
29
|
const imageUrl = imagePath ? absolute(imagePath) : undefined;
|
|
29
|
-
|
|
30
|
+
// With a locale cluster the canonical is the current variant's own address
|
|
31
|
+
// (and og:url must agree with it); otherwise the path as given.
|
|
32
|
+
const hreflang = site.hreflang
|
|
33
|
+
? hreflangAlternates({
|
|
34
|
+
...site.hreflang,
|
|
35
|
+
baseUrl: site.baseUrl,
|
|
36
|
+
currentLocale: input.urlLocale,
|
|
37
|
+
}, input.path)
|
|
38
|
+
: undefined;
|
|
39
|
+
const url = hreflang?.canonical ?? absolute(input.path);
|
|
30
40
|
const locale = input.locale ?? site.locale;
|
|
31
41
|
return {
|
|
32
42
|
metadataBase: new URL(site.baseUrl),
|
|
33
43
|
title: input.title,
|
|
34
44
|
description: input.description,
|
|
35
45
|
...(input.keywords ? { keywords: input.keywords } : {}),
|
|
36
|
-
alternates: {
|
|
46
|
+
alternates: {
|
|
47
|
+
canonical: url,
|
|
48
|
+
...(hreflang ? { languages: hreflang.languages } : {}),
|
|
49
|
+
...input.alternates,
|
|
50
|
+
},
|
|
37
51
|
// noindex but follow: keep link equity flowing through the page. Use a
|
|
38
52
|
// full robots override in the page's own metadata for nofollow too.
|
|
39
53
|
...(input.noIndex ? { robots: { index: false, follow: true } } : {}),
|
package/dist/metadata.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAuB,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAuFvC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,cAAc,CAAC,IAAwB;IACtD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAE3E,SAAS,YAAY,CAAC,KAAwB;QAC7C,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,2EAA2E;QAC3E,gEAAgE;QAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ;YAC7B,CAAC,CAAC,kBAAkB,CAClB;gBACC,GAAG,IAAI,CAAC,QAAQ;gBAChB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,aAAa,EAAE,KAAK,CAAC,SAAS;aAC9B,EACD,KAAK,CAAC,IAAI,CACV;YACF,CAAC,CAAC,SAAS,CAAC;QACb,MAAM,GAAG,GAAG,QAAQ,EAAE,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAE3C,OAAO;YACN,YAAY,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;YACnC,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;gBACX,SAAS,EAAE,GAAG;gBACd,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtD,GAAG,KAAK,CAAC,UAAU;aACnB;YACD,uEAAuE;YACvE,oEAAoE;YACpE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpE,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,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,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;IAED,YAAY,CAAC,IAAI,GAAG,SAAS,YAAY,CAAC,KAAK,GAAsB,EAAE;QACtE,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC3C,OAAO;YACN,YAAY,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;YACnC,KAAK,EAAE,IAAI,CAAC,aAAa;gBACxB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE;gBAClD,CAAC,CAAC,KAAK;YACR,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,GAAG,KAAK,CAAC,SAAS;SAClB,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,YAAY,CAAC;AACrB,CAAC;AAoBD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,eAAe,CAAC,KAA2B;IAC1D,OAAO;QACN;YACC,GAAG,EAAE,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC;YAC3C,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI;YAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,GAAG;YAC3B,GAAG,EAAE,KAAK,CAAC,GAAG;SACd;KACD,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ingram-tech/nk-seo",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.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",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"react": "^19.2.8",
|
|
51
51
|
"typescript": "^7.0.2",
|
|
52
52
|
"vitest": "^4.1.10",
|
|
53
|
-
"@ingram-tech/nk-i18n": "0.5.
|
|
53
|
+
"@ingram-tech/nk-i18n": "0.5.1"
|
|
54
54
|
},
|
|
55
55
|
"peerDependencies": {
|
|
56
56
|
"next": ">=14.0.0",
|
package/src/hreflang.tsx
CHANGED
|
@@ -13,9 +13,12 @@ export interface HreflangLinksProps extends HreflangConfig {
|
|
|
13
13
|
* return NextResponse.next({ request: { headers: requestHeaders } });
|
|
14
14
|
* ```
|
|
15
15
|
*
|
|
16
|
-
* Pass explicitly if you don't use that header (e.g. from route params)
|
|
17
|
-
*
|
|
18
|
-
*
|
|
16
|
+
* Pass explicitly if you don't use that header (e.g. from route params).
|
|
17
|
+
* On a statically rendered route the header is empty (and reading it would
|
|
18
|
+
* otherwise opt the page into dynamic rendering), so a header-reading
|
|
19
|
+
* instance cannot sit in a layout shared with static pages — prefer
|
|
20
|
+
* `createMetadata({ hreflang })`, which emits the same cluster from metadata
|
|
21
|
+
* without any request header.
|
|
19
22
|
*/
|
|
20
23
|
pathname?: string;
|
|
21
24
|
/**
|
package/src/metadata.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Metadata } from "next";
|
|
2
|
+
import { hreflangAlternates, type HreflangConfig } from "./alternates.js";
|
|
2
3
|
import { absoluteUrl } from "./url.js";
|
|
3
4
|
|
|
4
5
|
/**
|
|
@@ -27,6 +28,15 @@ export interface MetadataSiteConfig {
|
|
|
27
28
|
twitterSite?: string;
|
|
28
29
|
/** Twitter `@handle` for `creator`. */
|
|
29
30
|
twitterCreator?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Locale cluster for the site. When set, every `pageMetadata()` call emits
|
|
33
|
+
* the per-locale `alternates.languages` (plus `x-default`) and a canonical
|
|
34
|
+
* that follows the address — the same links `<HreflangLinks>` renders, but
|
|
35
|
+
* from metadata, so it works on statically rendered routes too (there is no
|
|
36
|
+
* request header to read there) and needs no middleware wiring.
|
|
37
|
+
* `@ingram-tech/nk-i18n`'s routing object fits directly: `hreflang: routing`.
|
|
38
|
+
*/
|
|
39
|
+
hreflang?: Omit<HreflangConfig, "baseUrl" | "currentLocale">;
|
|
30
40
|
}
|
|
31
41
|
|
|
32
42
|
/** Per-page inputs for the bound `pageMetadata` function. */
|
|
@@ -45,11 +55,21 @@ export interface PageMetadataInput {
|
|
|
45
55
|
* on a multilingual site `og:locale` has to vary per page.
|
|
46
56
|
*/
|
|
47
57
|
locale?: string;
|
|
58
|
+
/**
|
|
59
|
+
* With `site.hreflang` set: the locale **the URL names** (not the one that
|
|
60
|
+
* rendered), so the canonical self-references the localized address. Get it
|
|
61
|
+
* from `getUrlLocale(routing)` (`@ingram-tech/nk-i18n/next`) on dynamic
|
|
62
|
+
* pages; leave it unset on the bare path and on static routes, which serve
|
|
63
|
+
* one document for every visitor and so canonicalize to the bare, `x-default`
|
|
64
|
+
* address. Under the prefix strategy a `/fr/…`-prefixed `path` implies it.
|
|
65
|
+
*/
|
|
66
|
+
urlLocale?: string;
|
|
48
67
|
/**
|
|
49
68
|
* Merged into the generated `alternates` (wins on conflict). The reason it
|
|
50
69
|
* exists: `alternates.languages` is per-page on a localized site, and
|
|
51
|
-
* spreading the result to bolt it on drops the rest of the object.
|
|
52
|
-
* `
|
|
70
|
+
* spreading the result to bolt it on drops the rest of the object. Prefer
|
|
71
|
+
* `site.hreflang`, which fills it in on every page; `hreflangAlternates()`
|
|
72
|
+
* returns a ready-made `languages` map for the hand-rolled case.
|
|
53
73
|
*/
|
|
54
74
|
alternates?: Partial<NonNullable<Metadata["alternates"]>>;
|
|
55
75
|
/** Merged into the generated `openGraph` (wins on conflict). */
|
|
@@ -95,7 +115,19 @@ export function createMetadata(site: MetadataSiteConfig) {
|
|
|
95
115
|
function pageMetadata(input: PageMetadataInput): Metadata {
|
|
96
116
|
const imagePath = input.image ?? site.defaultImage;
|
|
97
117
|
const imageUrl = imagePath ? absolute(imagePath) : undefined;
|
|
98
|
-
|
|
118
|
+
// With a locale cluster the canonical is the current variant's own address
|
|
119
|
+
// (and og:url must agree with it); otherwise the path as given.
|
|
120
|
+
const hreflang = site.hreflang
|
|
121
|
+
? hreflangAlternates(
|
|
122
|
+
{
|
|
123
|
+
...site.hreflang,
|
|
124
|
+
baseUrl: site.baseUrl,
|
|
125
|
+
currentLocale: input.urlLocale,
|
|
126
|
+
},
|
|
127
|
+
input.path,
|
|
128
|
+
)
|
|
129
|
+
: undefined;
|
|
130
|
+
const url = hreflang?.canonical ?? absolute(input.path);
|
|
99
131
|
const locale = input.locale ?? site.locale;
|
|
100
132
|
|
|
101
133
|
return {
|
|
@@ -103,7 +135,11 @@ export function createMetadata(site: MetadataSiteConfig) {
|
|
|
103
135
|
title: input.title,
|
|
104
136
|
description: input.description,
|
|
105
137
|
...(input.keywords ? { keywords: input.keywords } : {}),
|
|
106
|
-
alternates: {
|
|
138
|
+
alternates: {
|
|
139
|
+
canonical: url,
|
|
140
|
+
...(hreflang ? { languages: hreflang.languages } : {}),
|
|
141
|
+
...input.alternates,
|
|
142
|
+
},
|
|
107
143
|
// noindex but follow: keep link equity flowing through the page. Use a
|
|
108
144
|
// full robots override in the page's own metadata for nofollow too.
|
|
109
145
|
...(input.noIndex ? { robots: { index: false, follow: true } } : {}),
|