@unhead/schema-org 0.1.1 → 0.2.0

package/dist/index.cjs

@@ -261,7 +261,7 @@ const webSiteResolver = defineSchemaOrgResolver({
   }
 });
 
-const resolveListItem = defineSchemaOrgResolver({
+const listItemResolver = defineSchemaOrgResolver({
   cast(node) {
     if (typeof node === "string") {
       node = {
@@ -276,6 +276,8 @@ const resolveListItem = defineSchemaOrgResolver({
   resolve(node, ctx) {
     if (typeof node.item === "string")
       node.item = resolveWithBase(ctx.meta.host, node.item);
+    else if (typeof node.item === "object")
+      node.item = resolveRelation(node.item, ctx);
     return node;
   }
 });
@@ -289,7 +291,7 @@ const breadcrumbResolver = defineSchemaOrgResolver({
   resolve(breadcrumb, ctx) {
     if (breadcrumb.itemListElement) {
       let index = 1;
-      breadcrumb.itemListElement = resolveRelation(breadcrumb.itemListElement, ctx, resolveListItem, {
+      breadcrumb.itemListElement = resolveRelation(breadcrumb.itemListElement, ctx, listItemResolver, {
         array: true,
         afterResolve(node) {
           setIfEmpty(node, "position", index++);
@@ -770,7 +772,7 @@ const itemListResolver = defineSchemaOrgResolver({
   resolve(node, ctx) {
     if (node.itemListElement) {
       let index = 1;
-      node.itemListElement = resolveRelation(node.itemListElement, ctx, resolveListItem, {
+      node.itemListElement = resolveRelation(node.itemListElement, ctx, listItemResolver, {
         array: true,
         afterResolve(node2) {
           setIfEmpty(node2, "position", index++);
@@ -1545,6 +1547,8 @@ function loadResolver(resolver) {
       return courseResolver;
     case "itemList":
       return itemListResolver;
+    case "listItem":
+      return listItemResolver;
     case "movie":
       return movieResolver;
     case "searchAction":
@@ -1581,6 +1585,7 @@ const resolveMeta = (meta) => {
     meta.url = meta.canonicalUrl;
   meta.url = joinURL(meta.host, meta.path);
   return {
+    ...meta,
     host: meta.host,
     url: meta.url,
     currency: meta.currency,
@@ -1832,6 +1837,7 @@ const defineWebSite = (input) => provideResolver(input, "webSite");
 const defineBook = (input) => provideResolver(input, "book");
 const defineCourse = (input) => provideResolver(input, "course");
 const defineItemList = (input) => provideResolver(input, "itemList");
+const defineListItem = (input) => provideResolver(input, "listItem");
 const defineMovie = (input) => provideResolver(input, "movie");
 const defineSearchAction = (input) => provideResolver(input, "searchAction");
 const defineReadAction = (input) => provideResolver(input, "readAction");
@@ -1884,6 +1890,7 @@ exports.defineHowTo = defineHowTo;
 exports.defineHowToStep = defineHowToStep;
 exports.defineImage = defineImage;
 exports.defineItemList = defineItemList;
+exports.defineListItem = defineListItem;
 exports.defineLocalBusiness = defineLocalBusiness;
 exports.defineMovie = defineMovie;
 exports.defineOffer = defineOffer;
@@ -1909,6 +1916,7 @@ exports.howToStepDirectionResolver = howToStepDirectionResolver;
 exports.howToStepResolver = howToStepResolver;
 exports.imageResolver = imageResolver;
 exports.itemListResolver = itemListResolver;
+exports.listItemResolver = listItemResolver;
 exports.localBusinessResolver = localBusinessResolver;
 exports.movieResolver = movieResolver;
 exports.offerResolver = offerResolver;
@@ -1921,7 +1929,6 @@ exports.questionResolver = questionResolver;
 exports.ratingResolver = ratingResolver;
 exports.readActionResolver = readActionResolver;
 exports.recipeResolver = recipeResolver;
-exports.resolveListItem = resolveListItem;
 exports.resolveMeta = resolveMeta;
 exports.resolveNode = resolveNode;
 exports.resolveNodeId = resolveNodeId;

package/dist/index.d.ts

@@ -189,7 +189,7 @@ interface VideoObject extends VideoSimple {
  */
 declare const videoResolver: SchemaOrgNodeDefinition<VideoObject>;
 
-type ValidArticleSubTypes = 'Article' | 'AdvertiserContentArticle' | 'NewsArticle' | 'Report' | 'SatiricalArticle' | 'ScholarlyArticle' | 'SocialMediaPosting' | 'TechArticle';
+type ValidArticleSubTypes = 'Article' | 'BlogPosting' | 'AdvertiserContentArticle' | 'NewsArticle' | 'Report' | 'SatiricalArticle' | 'ScholarlyArticle' | 'SocialMediaPosting' | 'TechArticle';
 interface ArticleSimple extends Thing {
     ['@type']?: Arrayable<ValidArticleSubTypes>;
     /**
@@ -436,13 +436,13 @@ interface ListItemSimple extends Thing {
     /**
      *  The name of the page in question, as it appears in the breadcrumb navigation.
      */
-    name: string;
+    name?: string;
     /**
      * The unmodified canonical URL of the page in question.
      * - If a relative path is provided, it will be resolved to absolute.
      * - Item is not required for the last entry
      */
-    item?: string;
+    item?: string | Thing;
     /**
      *  An integer (starting at 1), counting the 'depth' of the page from (including) the homepage.
      */
@@ -450,7 +450,7 @@ interface ListItemSimple extends Thing {
 }
 interface ListItem extends ListItemSimple {
 }
-declare const resolveListItem: SchemaOrgNodeDefinition<ListItem>;
+declare const listItemResolver: SchemaOrgNodeDefinition<ListItem>;
 
 interface ItemListSimple extends Thing {
     /**
@@ -1489,6 +1489,7 @@ declare const defineWebSite: <T extends Record<string, any>>(input?: (WebSite &
 declare const defineBook: <T extends Record<string, any>>(input?: (Book & T) | undefined) => Book & T;
 declare const defineCourse: <T extends Record<string, any>>(input?: (Course & T) | undefined) => Course & T;
 declare const defineItemList: <T extends Record<string, any>>(input?: (ItemList & T) | undefined) => ItemList & T;
+declare const defineListItem: <T extends Record<string, any>>(input?: (ListItem & T) | undefined) => ListItem & T;
 declare const defineMovie: <T extends Record<string, any>>(input?: (Movie & T) | undefined) => Movie & T;
 declare const defineSearchAction: <T extends Record<string, any>>(input?: (SearchAction & T) | undefined) => SearchAction & T;
 declare const defineReadAction: <T extends Record<string, any>>(input?: (ReadAction & T) | undefined) => ReadAction & T;
@@ -1496,4 +1497,4 @@ declare const defineSoftwareApp: <T extends Record<string, any>>(input?: (Softwa
 declare const defineBookEdition: <T extends Record<string, any>>(input?: (BookEdition & T) | undefined) => BookEdition & T;
 declare function useSchemaOrg(input?: any): any;
 
-export { AggregateOffer, AggregateOfferSimple, AggregateRating, AggregateRatingSimple, Arrayable, Article, ArticleSimple, Book, BookEdition, BookEditionSimple, BookSimple, BreadcrumbList, BreadcrumbSimple, Comment$1 as Comment, CommentSimple, Course, CourseSimple, Event, EventSimple, HowTo, HowToDirection, HowToId, HowToSimple, HowToStep, HowToStepSimple, Id, IdReference, Identity, ImageObject, ImageSimple, ItemList, ItemListSimple, ListItem, ListItemSimple, LocalBusiness, LocalBusinessSimple, MetaInput, Movie, MovieSimple, NodeRelation, NodeRelations, NutritionInformation, Offer, OfferSimple, OpeningHoursSimple, OpeningHoursSpecification, OptionalSchemaOrgPrefix, Organization, OrganizationSimple, Person, PersonSimple, Place, PlaceSimple, PostalAddress, PostalAddressSimple, PrimaryArticleId, PrimaryBookId, PrimaryBreadcrumbId, PrimaryEventId, PrimaryWebPageId, PrimaryWebSiteId, Product, ProductId, ProductSimple, Question, QuestionSimple, Rating, RatingSimple, ReadAction, ReadActionInput, Recipe, RecipeId, RecipeSimple, ResolvableDate, ResolvedMeta, Review, ReviewSimple, SchemaOrgGraph, SchemaOrgNode, SchemaOrgNodeDefinition, SchemaOrgUnheadPlugin, SearchAction, SearchActionInput, SoftwareApp, SoftwareAppSimple, Thing, UserConfig, VideoObject, VideoSimple, VirtualLocation, VirtualLocationSimple, WebPage, WebPageSimple, WebSite, WebSiteSimple, WithResolver, addressResolver, aggregateOfferResolver, aggregateRatingResolver, articleResolver, bookEditionResolver, bookResolver, breadcrumbResolver, commentResolver, courseResolver, createSchemaOrgGraph, dedupeNodes, defineAddress, defineAggregateOffer, defineAggregateRating, defineArticle, defineBook, defineBookEdition, defineBreadcrumb, defineComment, defineCourse, defineEvent, defineHowTo, defineHowToStep, defineImage, defineItemList, defineLocalBusiness, defineMovie, defineOffer, defineOpeningHours, defineOrganization, definePerson, definePlace, defineProduct, defineQuestion, defineReadAction, defineRecipe, defineReview, defineSchemaOrgResolver, defineSearchAction, defineSoftwareApp, defineVideo, defineVirtualLocation, defineWebPage, defineWebSite, eventResolver, howToResolver, howToStepDirectionResolver, howToStepResolver, imageResolver, itemListResolver, localBusinessResolver, movieResolver, offerResolver, openingHoursResolver, organizationResolver, personResolver, placeResolver, productResolver, questionResolver, ratingResolver, readActionResolver, recipeResolver, resolveListItem, resolveMeta, resolveNode, resolveNodeId, resolveRelation, reviewResolver, searchActionResolver, softwareAppResolver, useSchemaOrg, videoResolver, virtualLocationResolver, webPageResolver, webSiteResolver };
+export { AggregateOffer, AggregateOfferSimple, AggregateRating, AggregateRatingSimple, Arrayable, Article, ArticleSimple, Book, BookEdition, BookEditionSimple, BookSimple, BreadcrumbList, BreadcrumbSimple, Comment$1 as Comment, CommentSimple, Course, CourseSimple, Event, EventSimple, HowTo, HowToDirection, HowToId, HowToSimple, HowToStep, HowToStepSimple, Id, IdReference, Identity, ImageObject, ImageSimple, ItemList, ItemListSimple, ListItem, ListItemSimple, LocalBusiness, LocalBusinessSimple, MetaInput, Movie, MovieSimple, NodeRelation, NodeRelations, NutritionInformation, Offer, OfferSimple, OpeningHoursSimple, OpeningHoursSpecification, OptionalSchemaOrgPrefix, Organization, OrganizationSimple, Person, PersonSimple, Place, PlaceSimple, PostalAddress, PostalAddressSimple, PrimaryArticleId, PrimaryBookId, PrimaryBreadcrumbId, PrimaryEventId, PrimaryWebPageId, PrimaryWebSiteId, Product, ProductId, ProductSimple, Question, QuestionSimple, Rating, RatingSimple, ReadAction, ReadActionInput, Recipe, RecipeId, RecipeSimple, ResolvableDate, ResolvedMeta, Review, ReviewSimple, SchemaOrgGraph, SchemaOrgNode, SchemaOrgNodeDefinition, SchemaOrgUnheadPlugin, SearchAction, SearchActionInput, SoftwareApp, SoftwareAppSimple, Thing, UserConfig, VideoObject, VideoSimple, VirtualLocation, VirtualLocationSimple, WebPage, WebPageSimple, WebSite, WebSiteSimple, WithResolver, addressResolver, aggregateOfferResolver, aggregateRatingResolver, articleResolver, bookEditionResolver, bookResolver, breadcrumbResolver, commentResolver, courseResolver, createSchemaOrgGraph, dedupeNodes, defineAddress, defineAggregateOffer, defineAggregateRating, defineArticle, defineBook, defineBookEdition, defineBreadcrumb, defineComment, defineCourse, defineEvent, defineHowTo, defineHowToStep, defineImage, defineItemList, defineListItem, defineLocalBusiness, defineMovie, defineOffer, defineOpeningHours, defineOrganization, definePerson, definePlace, defineProduct, defineQuestion, defineReadAction, defineRecipe, defineReview, defineSchemaOrgResolver, defineSearchAction, defineSoftwareApp, defineVideo, defineVirtualLocation, defineWebPage, defineWebSite, eventResolver, howToResolver, howToStepDirectionResolver, howToStepResolver, imageResolver, itemListResolver, listItemResolver, localBusinessResolver, movieResolver, offerResolver, openingHoursResolver, organizationResolver, personResolver, placeResolver, productResolver, questionResolver, ratingResolver, readActionResolver, recipeResolver, resolveMeta, resolveNode, resolveNodeId, resolveRelation, reviewResolver, searchActionResolver, softwareAppResolver, useSchemaOrg, videoResolver, virtualLocationResolver, webPageResolver, webSiteResolver };

package/dist/index.mjs

@@ -259,7 +259,7 @@ const webSiteResolver = defineSchemaOrgResolver({
   }
 });
 
-const resolveListItem = defineSchemaOrgResolver({
+const listItemResolver = defineSchemaOrgResolver({
   cast(node) {
     if (typeof node === "string") {
       node = {
@@ -274,6 +274,8 @@ const resolveListItem = defineSchemaOrgResolver({
   resolve(node, ctx) {
     if (typeof node.item === "string")
       node.item = resolveWithBase(ctx.meta.host, node.item);
+    else if (typeof node.item === "object")
+      node.item = resolveRelation(node.item, ctx);
     return node;
   }
 });
@@ -287,7 +289,7 @@ const breadcrumbResolver = defineSchemaOrgResolver({
   resolve(breadcrumb, ctx) {
     if (breadcrumb.itemListElement) {
       let index = 1;
-      breadcrumb.itemListElement = resolveRelation(breadcrumb.itemListElement, ctx, resolveListItem, {
+      breadcrumb.itemListElement = resolveRelation(breadcrumb.itemListElement, ctx, listItemResolver, {
         array: true,
         afterResolve(node) {
           setIfEmpty(node, "position", index++);
@@ -768,7 +770,7 @@ const itemListResolver = defineSchemaOrgResolver({
   resolve(node, ctx) {
     if (node.itemListElement) {
       let index = 1;
-      node.itemListElement = resolveRelation(node.itemListElement, ctx, resolveListItem, {
+      node.itemListElement = resolveRelation(node.itemListElement, ctx, listItemResolver, {
         array: true,
         afterResolve(node2) {
           setIfEmpty(node2, "position", index++);
@@ -1543,6 +1545,8 @@ function loadResolver(resolver) {
       return courseResolver;
     case "itemList":
       return itemListResolver;
+    case "listItem":
+      return listItemResolver;
     case "movie":
       return movieResolver;
     case "searchAction":
@@ -1579,6 +1583,7 @@ const resolveMeta = (meta) => {
     meta.url = meta.canonicalUrl;
   meta.url = joinURL(meta.host, meta.path);
   return {
+    ...meta,
     host: meta.host,
     url: meta.url,
     currency: meta.currency,
@@ -1830,6 +1835,7 @@ const defineWebSite = (input) => provideResolver(input, "webSite");
 const defineBook = (input) => provideResolver(input, "book");
 const defineCourse = (input) => provideResolver(input, "course");
 const defineItemList = (input) => provideResolver(input, "itemList");
+const defineListItem = (input) => provideResolver(input, "listItem");
 const defineMovie = (input) => provideResolver(input, "movie");
 const defineSearchAction = (input) => provideResolver(input, "searchAction");
 const defineReadAction = (input) => provideResolver(input, "readAction");
@@ -1847,4 +1853,4 @@ function useSchemaOrg(input) {
   }, { mode: process.env.NODE_ENV === "development" ? "all" : "server" });
 }
 
-export { HowToId, PrimaryArticleId, PrimaryBookId, PrimaryBreadcrumbId, PrimaryEventId, PrimaryWebPageId, PrimaryWebSiteId, ProductId, RecipeId, SchemaOrgUnheadPlugin, addressResolver, aggregateOfferResolver, aggregateRatingResolver, articleResolver, bookEditionResolver, bookResolver, breadcrumbResolver, commentResolver, courseResolver, createSchemaOrgGraph, dedupeNodes, defineAddress, defineAggregateOffer, defineAggregateRating, defineArticle, defineBook, defineBookEdition, defineBreadcrumb, defineComment, defineCourse, defineEvent, defineHowTo, defineHowToStep, defineImage, defineItemList, defineLocalBusiness, defineMovie, defineOffer, defineOpeningHours, defineOrganization, definePerson, definePlace, defineProduct, defineQuestion, defineReadAction, defineRecipe, defineReview, defineSchemaOrgResolver, defineSearchAction, defineSoftwareApp, defineVideo, defineVirtualLocation, defineWebPage, defineWebSite, eventResolver, howToResolver, howToStepDirectionResolver, howToStepResolver, imageResolver, itemListResolver, localBusinessResolver, movieResolver, offerResolver, openingHoursResolver, organizationResolver, personResolver, placeResolver, productResolver, questionResolver, ratingResolver, readActionResolver, recipeResolver, resolveListItem, resolveMeta, resolveNode, resolveNodeId, resolveRelation, reviewResolver, searchActionResolver, softwareAppResolver, useSchemaOrg, videoResolver, virtualLocationResolver, webPageResolver, webSiteResolver };
+export { HowToId, PrimaryArticleId, PrimaryBookId, PrimaryBreadcrumbId, PrimaryEventId, PrimaryWebPageId, PrimaryWebSiteId, ProductId, RecipeId, SchemaOrgUnheadPlugin, addressResolver, aggregateOfferResolver, aggregateRatingResolver, articleResolver, bookEditionResolver, bookResolver, breadcrumbResolver, commentResolver, courseResolver, createSchemaOrgGraph, dedupeNodes, defineAddress, defineAggregateOffer, defineAggregateRating, defineArticle, defineBook, defineBookEdition, defineBreadcrumb, defineComment, defineCourse, defineEvent, defineHowTo, defineHowToStep, defineImage, defineItemList, defineListItem, defineLocalBusiness, defineMovie, defineOffer, defineOpeningHours, defineOrganization, definePerson, definePlace, defineProduct, defineQuestion, defineReadAction, defineRecipe, defineReview, defineSchemaOrgResolver, defineSearchAction, defineSoftwareApp, defineVideo, defineVirtualLocation, defineWebPage, defineWebSite, eventResolver, howToResolver, howToStepDirectionResolver, howToStepResolver, imageResolver, itemListResolver, listItemResolver, localBusinessResolver, movieResolver, offerResolver, openingHoursResolver, organizationResolver, personResolver, placeResolver, productResolver, questionResolver, ratingResolver, readActionResolver, recipeResolver, resolveMeta, resolveNode, resolveNodeId, resolveRelation, reviewResolver, searchActionResolver, softwareAppResolver, useSchemaOrg, videoResolver, virtualLocationResolver, webPageResolver, webSiteResolver };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unhead/schema-org",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "packageManager": "pnpm@7.8.0",
   "description": "Node Schema.org for Simple and Automated Google Rich Results",
   "author": "Harlan Wilton <harlan@harlanzw.com>",