@jdevalk/seo-graph-core 0.5.0 → 0.5.2
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/AGENTS.md
CHANGED
|
@@ -512,6 +512,30 @@ untyped form. The generic gives you autocomplete for every property on the
|
|
|
512
512
|
chosen type, making it much harder to miss recommended fields like
|
|
513
513
|
`potentialAction`, `geo`, or `offers`.
|
|
514
514
|
|
|
515
|
+
### Overriding `@id`
|
|
516
|
+
|
|
517
|
+
Every dedicated builder computes an `@id` from the `IdFactory` (e.g.
|
|
518
|
+
`ids.website`, `ids.article(url)`). You can override it by passing `'@id'`
|
|
519
|
+
directly — the explicit value wins:
|
|
520
|
+
|
|
521
|
+
```ts
|
|
522
|
+
buildBreadcrumbList(
|
|
523
|
+
{
|
|
524
|
+
url,
|
|
525
|
+
items: [
|
|
526
|
+
{ name: 'Home', url: siteUrl },
|
|
527
|
+
{ name: 'Blog', url: blogUrl },
|
|
528
|
+
],
|
|
529
|
+
'@id': `${blogUrl}#breadcrumb`, // overrides ids.breadcrumb(url)
|
|
530
|
+
},
|
|
531
|
+
ids,
|
|
532
|
+
);
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
This works on all builders: `buildWebSite`, `buildWebPage`, `buildArticle`,
|
|
536
|
+
`buildBreadcrumbList`, `buildImageObject`, `buildVideoObject`, and
|
|
537
|
+
`buildSiteNavigationElement`.
|
|
538
|
+
|
|
515
539
|
### assembleGraph
|
|
516
540
|
|
|
517
541
|
Wraps pieces in a `{ "@context": "https://schema.org", "@graph": [...] }`
|
|
@@ -5,6 +5,8 @@ export interface BreadcrumbItem {
|
|
|
5
5
|
name: string;
|
|
6
6
|
/** URL for this crumb. */
|
|
7
7
|
url: string;
|
|
8
|
+
/** Optional @id override. When set, the `item` value uses this @id instead of the URL. */
|
|
9
|
+
id?: string;
|
|
8
10
|
}
|
|
9
11
|
interface BreadcrumbListCoreFields {
|
|
10
12
|
/** The URL of the page this breadcrumb belongs to. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"breadcrumb.d.ts","sourceRoot":"","sources":["../../src/pieces/breadcrumb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAG3C,MAAM,WAAW,cAAc;IAC3B,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;CACf;AAED,UAAU,wBAAwB;IAC9B,sDAAsD;IACtD,GAAG,EAAE,MAAM,CAAC;IACZ,uDAAuD;IACvD,KAAK,EAAE,SAAS,cAAc,EAAE,CAAC;CACpC;AAED,MAAM,MAAM,mBAAmB,GAAG,wBAAwB,GACtD,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,wBAAwB,GAAG,OAAO,CAAC,CAAC;AAIhF;;GAEG;AACH,wBAAgB,mBAAmB,CAC/B,KAAK,EAAE,mBAAmB,EAC1B,GAAG,EAAE,SAAS,GACf,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"breadcrumb.d.ts","sourceRoot":"","sources":["../../src/pieces/breadcrumb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAG3C,MAAM,WAAW,cAAc;IAC3B,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,wBAAwB;IAC9B,sDAAsD;IACtD,GAAG,EAAE,MAAM,CAAC;IACZ,uDAAuD;IACvD,KAAK,EAAE,SAAS,cAAc,EAAE,CAAC;CACpC;AAED,MAAM,MAAM,mBAAmB,GAAG,wBAAwB,GACtD,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,wBAAwB,GAAG,OAAO,CAAC,CAAC;AAIhF;;GAEG;AACH,wBAAgB,mBAAmB,CAC/B,KAAK,EAAE,mBAAmB,EAC1B,GAAG,EAAE,SAAS,GACf,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAsBzB"}
|
|
@@ -9,7 +9,11 @@ export function buildBreadcrumbList(input, ids) {
|
|
|
9
9
|
'@type': 'ListItem',
|
|
10
10
|
position: index + 1,
|
|
11
11
|
name: item.name,
|
|
12
|
-
item:
|
|
12
|
+
item: item.id
|
|
13
|
+
? { '@id': item.id }
|
|
14
|
+
: index === lastIndex
|
|
15
|
+
? { '@id': ids.webPage(item.url) }
|
|
16
|
+
: item.url,
|
|
13
17
|
}));
|
|
14
18
|
const piece = {
|
|
15
19
|
'@type': 'BreadcrumbList',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"breadcrumb.js","sourceRoot":"","sources":["../../src/pieces/breadcrumb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"breadcrumb.js","sourceRoot":"","sources":["../../src/pieces/breadcrumb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAqBxD,MAAM,YAAY,GAAG,IAAI,GAAG,CAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAC/B,KAA0B,EAC1B,GAAc;IAEd,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACzC,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACtD,OAAO,EAAE,UAAU;QACnB,QAAQ,EAAE,KAAK,GAAG,CAAC;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,EAAE;YACT,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;YACpB,CAAC,CAAC,KAAK,KAAK,SAAS;gBACnB,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAClC,CAAC,CAAC,IAAI,CAAC,GAAG;KACnB,CAAC,CAAC,CAAC;IAEJ,MAAM,KAAK,GAA4B;QACnC,OAAO,EAAE,gBAAgB;QACzB,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC;QAChC,eAAe;KAClB,CAAC;IAEF,yBAAyB,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IAEtD,OAAO,KAAK,CAAC;AACjB,CAAC"}
|