@unhead/schema-org 0.3.0 → 0.4.1

package/dist/index.cjs

@@ -321,6 +321,7 @@ const imageResolver = defineSchemaOrgResolver({
     "@type": "ImageObject"
   },
   inheritMeta: [
+    // @todo possibly only do if there's a caption
     "inLanguage"
   ],
   idPrefix: "host",
@@ -635,7 +636,8 @@ const placeResolver = defineSchemaOrgResolver({
     "@type": "Place"
   },
   resolve(node, ctx) {
-    node.address = resolveRelation(node.address, ctx, addressResolver);
+    if (typeof node.address !== "string")
+      node.address = resolveRelation(node.address, ctx, addressResolver);
     return node;
   }
 });
@@ -783,6 +785,35 @@ const itemListResolver = defineSchemaOrgResolver({
   }
 });
 
+const quantitativeValueResolver = defineSchemaOrgResolver({
+  defaults: {
+    "@type": "QuantitativeValue"
+  }
+});
+const monetaryAmountResolver = defineSchemaOrgResolver({
+  defaults: {
+    "@type": "MonetaryAmount"
+  },
+  resolve(node, ctx) {
+    node.value = resolveRelation(node.value, ctx, quantitativeValueResolver);
+    return node;
+  }
+});
+
+const jobPostingResolver = defineSchemaOrgResolver({
+  defaults: {
+    "@type": "JobPosting"
+  },
+  resolve(node, ctx) {
+    node.datePosted = resolvableDateToIso(node.datePosted);
+    node.hiringOrganization = resolveRelation(node.hiringOrganization, ctx, organizationResolver);
+    node.jobLocation = resolveRelation(node.jobLocation, ctx, placeResolver);
+    node.baseSalary = resolveRelation(node.baseSalary, ctx, monetaryAmountResolver);
+    node.validThrough = resolvableDateToIso(node.validThrough);
+    return node;
+  }
+});
+
 const openingHoursResolver = defineSchemaOrgResolver({
   defaults: {
     "@type": "OpeningHoursSpecification",
@@ -1549,6 +1580,8 @@ function loadResolver(resolver) {
       return courseResolver;
     case "itemList":
       return itemListResolver;
+    case "jobPosting":
+      return jobPostingResolver;
     case "listItem":
       return listItemResolver;
     case "movie":
@@ -1830,6 +1863,7 @@ const definePlace = (input) => provideResolver(input, "place");
 const defineHowTo = (input) => provideResolver(input, "howTo");
 const defineHowToStep = (input) => provideResolver(input, "howToStep");
 const defineImage = (input) => provideResolver(input, "image");
+const defineJobPosting = (input) => provideResolver(input, "jobPosting");
 const defineLocalBusiness = (input) => provideResolver(input, "localBusiness");
 const defineOffer = (input) => provideResolver(input, "offer");
 const defineOpeningHours = (input) => provideResolver(input, "openingHours");
@@ -1898,6 +1932,7 @@ exports.defineHowTo = defineHowTo;
 exports.defineHowToStep = defineHowToStep;
 exports.defineImage = defineImage;
 exports.defineItemList = defineItemList;
+exports.defineJobPosting = defineJobPosting;
 exports.defineListItem = defineListItem;
 exports.defineLocalBusiness = defineLocalBusiness;
 exports.defineMovie = defineMovie;
@@ -1924,6 +1959,7 @@ exports.howToStepDirectionResolver = howToStepDirectionResolver;
 exports.howToStepResolver = howToStepResolver;
 exports.imageResolver = imageResolver;
 exports.itemListResolver = itemListResolver;
+exports.jobPostingResolver = jobPostingResolver;
 exports.listItemResolver = listItemResolver;
 exports.localBusinessResolver = localBusinessResolver;
 exports.movieResolver = movieResolver;

package/dist/index.d.ts

@@ -739,7 +739,9 @@ declare const courseResolver: SchemaOrgNodeDefinition<Course>;
 interface PlaceSimple extends Thing {
     '@type'?: 'Place';
     name: string;
-    address: NodeRelation<PostalAddress>;
+    address: NodeRelation<PostalAddress | string>;
+    latitude?: number | string;
+    longitude?: number | string;
 }
 interface Place extends PlaceSimple {
 }
@@ -931,6 +933,83 @@ declare const HowToId = "#howto";
  */
 declare const howToResolver: SchemaOrgNodeDefinition<HowTo>;
 
+interface MonetaryAmountSimple extends Thing {
+    /**
+     * The currency in which the monetary amount is expressed.
+     */
+    currency: string;
+    /**
+     * The value of the quantitative value or property value node.
+     */
+    value: QuantitativeValue;
+}
+interface MonetaryAmount extends MonetaryAmountSimple {
+}
+interface QuantitativeSimple extends Thing {
+    value?: number;
+    minValue?: number;
+    maxValue?: number;
+    unitText: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+}
+interface QuantitativeValue extends QuantitativeSimple {
+}
+
+interface JobPostingSimple extends Thing {
+    /**
+     * The original date that employer posted the job in ISO 8601 format.
+     * For example, "2017-01-24" or "2017-01-24T19:33:17+00:00".
+     */
+    datePosted: ResolvableDate;
+    /**
+     * The full description of the job in HTML format.
+     *
+     * The description must be a complete representation of the job, including job responsibilities, qualifications,
+     * skills, working hours, education requirements, and experience requirements. The description can't be the same as
+     * the title
+     */
+    description: string;
+    /**
+     * The organization offering the job position. This must be the name of the company (for example, "Starbucks, Inc"),
+     * and not the specific location that is hiring (for example, "Starbucks on Main Street").
+     */
+    hiringOrganization: NodeRelation<Organization>;
+    /**
+     * The physical location(s) of the business where the employee will report to work (such as an office or worksite),
+     * not the location where the job was posted. Include as many properties as possible. The more properties you provide,
+     * the higher quality the job posting is to our users. Note that you must include the addressCountry property.
+     */
+    jobLocation: NodeRelation<Place>;
+    /**
+     * The title of the job (not the title of the posting). For example, "Software Engineer" or "Barista"
+     */
+    title: string;
+    /**
+     * The actual base salary for the job, as provided by the employer (not an estimate).
+     */
+    baseSalary?: MonetaryAmount;
+    /**
+     * Type of employment
+     */
+    employmentType?: EmploymentType | EmploymentType[];
+    /**
+     * The date when the job posting will expire in ISO 8601 format. For example, "2017-02-24"
+     * or "2017-02-24T19:33:17+00:00".
+     */
+    validThrough?: ResolvableDate;
+    /**
+     * A description of the job location (e.g. TELECOMMUTE for telecommute jobs).
+     */
+    jobLocationType?: 'TELECOMMUTE';
+    /**
+     * Indicates whether the URL that's associated with this job posting enables direct application for the job.
+     */
+    directApply?: boolean;
+}
+interface JobPosting extends JobPostingSimple {
+}
+declare const jobPostingResolver: SchemaOrgNodeDefinition<JobPosting>;
+type EmploymentType = 'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'TEMPORARY' | 'INTERN' | 'VOLUNTEER' | 'PER_DIEM' | 'OTHER';
+
 type DayOfWeek = 'Friday' | 'Monday' | 'PublicHolidays' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday';
 type Time = `${number}${number}:${number}${number}`;
 interface OpeningHoursSimple extends Thing {
@@ -1484,6 +1563,7 @@ declare const definePlace: <T extends Record<string, any>>(input?: (Place & T) |
 declare const defineHowTo: <T extends Record<string, any>>(input?: (HowTo & T) | undefined) => HowTo & T;
 declare const defineHowToStep: <T extends Record<string, any>>(input?: (HowToStep & T) | undefined) => HowToStep & T;
 declare const defineImage: <T extends Record<string, any>>(input?: (ImageObject & T) | undefined) => ImageObject & T;
+declare const defineJobPosting: <T extends Record<string, any>>(input?: (JobPosting & T) | undefined) => JobPosting & T;
 declare const defineLocalBusiness: <T extends Record<string, any>>(input?: (LocalBusiness & T) | undefined) => LocalBusiness & T;
 declare const defineOffer: <T extends Record<string, any>>(input?: (Offer & T) | undefined) => Offer & T;
 declare const defineOpeningHours: <T extends Record<string, any>>(input?: (OpeningHoursSpecification & T) | undefined) => OpeningHoursSpecification & T;
@@ -1507,4 +1587,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, 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 };
+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, JobPosting, JobPostingSimple, 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, defineJobPosting, 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, jobPostingResolver, 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

@@ -319,6 +319,7 @@ const imageResolver = defineSchemaOrgResolver({
     "@type": "ImageObject"
   },
   inheritMeta: [
+    // @todo possibly only do if there's a caption
     "inLanguage"
   ],
   idPrefix: "host",
@@ -633,7 +634,8 @@ const placeResolver = defineSchemaOrgResolver({
     "@type": "Place"
   },
   resolve(node, ctx) {
-    node.address = resolveRelation(node.address, ctx, addressResolver);
+    if (typeof node.address !== "string")
+      node.address = resolveRelation(node.address, ctx, addressResolver);
     return node;
   }
 });
@@ -781,6 +783,35 @@ const itemListResolver = defineSchemaOrgResolver({
   }
 });
 
+const quantitativeValueResolver = defineSchemaOrgResolver({
+  defaults: {
+    "@type": "QuantitativeValue"
+  }
+});
+const monetaryAmountResolver = defineSchemaOrgResolver({
+  defaults: {
+    "@type": "MonetaryAmount"
+  },
+  resolve(node, ctx) {
+    node.value = resolveRelation(node.value, ctx, quantitativeValueResolver);
+    return node;
+  }
+});
+
+const jobPostingResolver = defineSchemaOrgResolver({
+  defaults: {
+    "@type": "JobPosting"
+  },
+  resolve(node, ctx) {
+    node.datePosted = resolvableDateToIso(node.datePosted);
+    node.hiringOrganization = resolveRelation(node.hiringOrganization, ctx, organizationResolver);
+    node.jobLocation = resolveRelation(node.jobLocation, ctx, placeResolver);
+    node.baseSalary = resolveRelation(node.baseSalary, ctx, monetaryAmountResolver);
+    node.validThrough = resolvableDateToIso(node.validThrough);
+    return node;
+  }
+});
+
 const openingHoursResolver = defineSchemaOrgResolver({
   defaults: {
     "@type": "OpeningHoursSpecification",
@@ -1547,6 +1578,8 @@ function loadResolver(resolver) {
       return courseResolver;
     case "itemList":
       return itemListResolver;
+    case "jobPosting":
+      return jobPostingResolver;
     case "listItem":
       return listItemResolver;
     case "movie":
@@ -1828,6 +1861,7 @@ const definePlace = (input) => provideResolver(input, "place");
 const defineHowTo = (input) => provideResolver(input, "howTo");
 const defineHowToStep = (input) => provideResolver(input, "howToStep");
 const defineImage = (input) => provideResolver(input, "image");
+const defineJobPosting = (input) => provideResolver(input, "jobPosting");
 const defineLocalBusiness = (input) => provideResolver(input, "localBusiness");
 const defineOffer = (input) => provideResolver(input, "offer");
 const defineOpeningHours = (input) => provideResolver(input, "openingHours");
@@ -1861,4 +1895,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, 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 };
+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, defineJobPosting, 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, jobPostingResolver, 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.3.0",
+  "version": "0.4.1",
   "packageManager": "pnpm@7.8.0",
   "description": "Node Schema.org for Simple and Automated Google Rich Results",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
@@ -38,7 +38,7 @@
   },
   "devDependencies": {
     "ufo": "^1.0.1",
-    "unhead": "^1.0.14"
+    "unhead": "^1.0.20"
   },
   "scripts": {
     "build": "unbuild .",