@unhead/schema-org 1.10.4 → 1.11.0-beta.2

package/dist/shared/{schema-org.397d7cf9.d.cts → schema-org.d2b719c3.d.cts}

@@ -1,33 +1,21 @@
 import * as _unhead_schema from '@unhead/schema';
 
-type DayOfWeek = 'Friday' | 'Monday' | 'PublicHolidays' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday';
-type Time = `${number}${number}:${number}${number}`;
-interface OpeningHoursSimple extends Thing {
-    '@type'?: 'OpeningHoursSpecification';
-    /**
-     * The day of the week for which these opening hours are valid.
-     */
-    'dayOfWeek': Arrayable<DayOfWeek>;
-    /**
-     * The opening hour of the place or service on the given day(s) of the week.
-     */
-    'opens'?: Time;
+interface DefinedRegion extends Thing {
     /**
-     * The closing hour of the place or service on the given day(s) of the week.
+     * The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1) format.
      */
-    'closes'?: Time;
+    addressCountry: string;
     /**
-     * The date when the item becomes valid.
+     * If you include this property, the region must be a 2- or 3-digit ISO 3166-2 subdivision code, without country prefix. Currently, Google Search only supports the US, Australia, and Japan. Examples: "NY" (for US, state of New York), "NSW" (for Australia, state of New South Wales), or "03" (for Japan, Iwate prefecture).
+     *
+     * Do not provide both a region and postal code information.
      */
-    'validFrom'?: ResolvableDate;
+    addressRegion?: string;
     /**
-     * The date after when the item is not valid. For example, the end of an offer, salary period, or a period of opening hours.
+     * The postal code. For example, 94043. Currently postal codes are supported for Australia, Canada, and the US.
      */
-    'validThrough'?: ResolvableDate;
-}
-interface OpeningHoursSpecification extends OpeningHoursSimple {
+    postalCode?: string;
 }
-declare const openingHoursResolver: SchemaOrgNodeDefinition<OpeningHoursSpecification>;
 
 interface MonetaryAmountSimple extends Thing {
     /**
@@ -62,23 +50,6 @@ interface ShippingDeliveryTime extends Thing {
     transitTime?: QuantitativeValue;
 }
 
-interface DefinedRegion extends Thing {
-    /**
-     * The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1) format.
-     */
-    addressCountry: string;
-    /**
-     * If you include this property, the region must be a 2- or 3-digit ISO 3166-2 subdivision code, without country prefix. Currently, Google Search only supports the US, Australia, and Japan. Examples: "NY" (for US, state of New York), "NSW" (for Australia, state of New South Wales), or "03" (for Japan, Iwate prefecture).
-     *
-     * Do not provide both a region and postal code information.
-     */
-    addressRegion?: string;
-    /**
-     * The postal code. For example, 94043. Currently postal codes are supported for Australia, Canada, and the US.
-     */
-    postalCode?: string;
-}
-
 interface OfferShippingDetails extends Thing {
     '@type'?: 'OfferShippingDetails';
     /**
@@ -94,6 +65,35 @@ interface OfferShippingDetails extends Thing {
     'shippingRate': MonetaryAmount;
 }
 
+type DayOfWeek = 'Friday' | 'Monday' | 'PublicHolidays' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday';
+type Time = `${number}${number}:${number}${number}`;
+interface OpeningHoursSimple extends Thing {
+    '@type'?: 'OpeningHoursSpecification';
+    /**
+     * The day of the week for which these opening hours are valid.
+     */
+    'dayOfWeek': Arrayable<DayOfWeek>;
+    /**
+     * The opening hour of the place or service on the given day(s) of the week.
+     */
+    'opens'?: Time;
+    /**
+     * The closing hour of the place or service on the given day(s) of the week.
+     */
+    'closes'?: Time;
+    /**
+     * The date when the item becomes valid.
+     */
+    'validFrom'?: ResolvableDate;
+    /**
+     * The date after when the item is not valid. For example, the end of an offer, salary period, or a period of opening hours.
+     */
+    'validThrough'?: ResolvableDate;
+}
+interface OpeningHoursSpecification extends OpeningHoursSimple {
+}
+declare const openingHoursResolver: SchemaOrgNodeDefinition<OpeningHoursSpecification>;
+
 type ItemAvailability = 'BackOrder' | 'Discontinued' | 'InStock' | 'InStoreOnly' | 'LimitedAvailability' | 'OnlineOnly' | 'OutOfStock' | 'PreOrder' | 'PreSale' | 'SoldOut';
 type OfferItemCondition = 'NewCondition' | 'RefurbishedCondition' | 'UsedCondition';
 interface OfferSimple extends Thing {
@@ -395,75 +395,68 @@ declare const PrimaryArticleId = "#article";
  */
 declare const articleResolver: SchemaOrgNodeDefinition<Article>;
 
-type SearchTarget = string | `${string}{search_term_string}${string | undefined}`;
-interface SearchActionInput {
-    /**
-     * An object of type EntryPoint, with a relative URL which describes the URL pattern of the internal search function
-     * (e.g., /search?query={search_term_string}).
-     */
-    target?: SearchTarget;
-    /**
-     * Alias: The search term string as described in the target (e.g., search_term_string).
-     * @default search_term_string
-     */
-    queryInput?: string;
-}
-interface SearchAction {
-    '@type'?: 'SearchAction';
-    /**
-     * An object of type EntryPoint, with a relative URL which describes the URL pattern of the internal search function
-     * (e.g., /search?query={search_term_string}).
-     */
-    'target': SearchTarget | {
-        '@type'?: 'EntryPoint';
-        'urlTemplate'?: SearchTarget;
-    };
-    /**
-     * The search term string as described in the target (e.g., search_term_string).
-     */
-    'query-input'?: {
-        '@type'?: 'PropertyValueSpecification';
-        'valueRequired'?: boolean;
-        'valueName'?: 'search_term_string';
-    };
-}
-declare const searchActionResolver: SchemaOrgNodeDefinition<SearchAction>;
-
 /**
- * A WebSite is a set of related web pages and other items typically served from a single web domain and accessible via URLs.
+ * A list item, e.g. a step in a checklist or how-to description.
  */
-interface WebSiteSimple extends Thing {
+interface ListItemSimple extends Thing {
+    '@type'?: 'ListItem';
     /**
-     * The site's home URL (excluding a trailing slash).
+     *  The name of the page in question, as it appears in the breadcrumb navigation.
      */
-    url?: string;
+    'name'?: string;
     /**
-     * The name of the website.
+     * 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
      */
-    name: string;
+    'item'?: string | Thing;
     /**
-     * A description of the website (e.g., the site's tagline).
+     *  An integer (starting at 1), counting the 'depth' of the page from (including) the homepage.
      */
-    description?: string;
+    'position'?: number;
+}
+interface ListItem extends ListItemSimple {
+}
+declare const listItemResolver: SchemaOrgNodeDefinition<ListItem>;
+
+interface ItemListSimple extends Thing {
     /**
-     * A reference-by-ID to the Organization which publishes the WebSite
-     * (or an array of Organization and Person in the case that the website represents an individual).
+     * Resolved item list
      */
-    publisher?: NodeRelations<Identity>;
+    itemListElement: NodeRelations<ListItem>;
     /**
-     * A SearchAction object describing the site's internal search.
+     * Type of ordering (e.g. Ascending, Descending, Unordered).
+     *
+     * @default undefined
      */
-    potentialAction?: Arrayable<(SearchAction | unknown)>;
+    itemListOrder?: 'Ascending' | 'Descending' | 'Unordered';
     /**
-     * The language code for the WebSite; e.g., en-GB.
-     * If the website is available in multiple languages, then output an array of inLanguage values.
+     * The number of items in an ItemList.
+     * Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination);
+     * in such cases, the numberOfItems would be for the entire list.
+     *
+     * @default undefined
      */
-    inLanguage?: Arrayable<string>;
+    numberOfItems?: number;
 }
-interface WebSite extends WebSiteSimple {
+interface ItemList extends ItemListSimple {
 }
-declare const PrimaryWebSiteId = "#website";
-declare const webSiteResolver: SchemaOrgNodeDefinition<WebSite>;
+declare const itemListResolver: SchemaOrgNodeDefinition<ItemList>;
+
+/**
+ * A BreadcrumbList is an ItemList consisting of a chain of linked Web pages,
+ * typically described using at least their URL and their name, and typically ending with the current page.
+ */
+interface BreadcrumbSimple extends ItemList {
+    '@type'?: 'BreadcrumbList';
+}
+interface BreadcrumbList extends BreadcrumbSimple {
+}
+declare const PrimaryBreadcrumbId = "#breadcrumb";
+/**
+ * Describes the hierarchical position a WebPage within a WebSite.
+ */
+declare const breadcrumbResolver: SchemaOrgNodeDefinition<BreadcrumbList>;
 
 interface PostalAddressSimple extends Thing {
     /**
@@ -542,101 +535,108 @@ interface Organization extends OrganizationSimple {
 declare const organizationResolver: SchemaOrgNodeDefinition<Organization>;
 
 /**
- * A list item, e.g. a step in a checklist or how-to description.
+ * A person (alive, dead, undead, or fictional).
  */
-interface ListItemSimple extends Thing {
-    '@type'?: 'ListItem';
-    /**
-     *  The name of the page in question, as it appears in the breadcrumb navigation.
-     */
-    'name'?: string;
+interface PersonSimple extends Thing {
     /**
-     * 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
+     * The full name of the Person.
      */
-    'item'?: string | Thing;
+    name: string;
     /**
-     *  An integer (starting at 1), counting the 'depth' of the page from (including) the homepage.
+     * The user bio, truncated to 250 characters.
      */
-    'position'?: number;
-}
-interface ListItem extends ListItemSimple {
-}
-declare const listItemResolver: SchemaOrgNodeDefinition<ListItem>;
-
-interface ItemListSimple extends Thing {
+    description?: string;
     /**
-     * Resolved item list
+     * An array of URLs representing declared social/authoritative profiles of the person
+     * (e.g., a Wikipedia page, or Facebook profile).
      */
-    itemListElement: NodeRelations<ListItem>;
+    sameAs?: Arrayable<string>;
     /**
-     * Type of ordering (e.g. Ascending, Descending, Unordered).
-     *
-     * @default undefined
+     * An array of images which represent the person, referenced by ID.
      */
-    itemListOrder?: 'Ascending' | 'Descending' | 'Unordered';
+    image?: NodeRelations<ImageObject | string>;
     /**
-     * The number of items in an ItemList.
-     * Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination);
-     * in such cases, the numberOfItems would be for the entire list.
-     *
-     * @default undefined
+     * The URL of the users' profile page (if they're affiliated with the site in question),
+     * or to their personal homepage/website.
      */
-    numberOfItems?: number;
+    url?: string;
 }
-interface ItemList extends ItemListSimple {
+interface Person extends PersonSimple {
 }
-declare const itemListResolver: SchemaOrgNodeDefinition<ItemList>;
-
 /**
- * A BreadcrumbList is an ItemList consisting of a chain of linked Web pages,
- * typically described using at least their URL and their name, and typically ending with the current page.
+ * Describes an individual person. Most commonly used to identify the author of a piece of content (such as an Article or Comment).
  */
-interface BreadcrumbSimple extends ItemList {
-    '@type'?: 'BreadcrumbList';
+declare const personResolver: SchemaOrgNodeDefinition<Person>;
+
+type SearchTarget = string | `${string}{search_term_string}${string | undefined}`;
+interface SearchActionInput {
+    /**
+     * An object of type EntryPoint, with a relative URL which describes the URL pattern of the internal search function
+     * (e.g., /search?query={search_term_string}).
+     */
+    target?: SearchTarget;
+    /**
+     * Alias: The search term string as described in the target (e.g., search_term_string).
+     * @default search_term_string
+     */
+    queryInput?: string;
 }
-interface BreadcrumbList extends BreadcrumbSimple {
+interface SearchAction {
+    '@type'?: 'SearchAction';
+    /**
+     * An object of type EntryPoint, with a relative URL which describes the URL pattern of the internal search function
+     * (e.g., /search?query={search_term_string}).
+     */
+    'target': SearchTarget | {
+        '@type'?: 'EntryPoint';
+        'urlTemplate'?: SearchTarget;
+    };
+    /**
+     * The search term string as described in the target (e.g., search_term_string).
+     */
+    'query-input'?: {
+        '@type'?: 'PropertyValueSpecification';
+        'valueRequired'?: boolean;
+        'valueName'?: 'search_term_string';
+    };
 }
-declare const PrimaryBreadcrumbId = "#breadcrumb";
-/**
- * Describes the hierarchical position a WebPage within a WebSite.
- */
-declare const breadcrumbResolver: SchemaOrgNodeDefinition<BreadcrumbList>;
+declare const searchActionResolver: SchemaOrgNodeDefinition<SearchAction>;
 
 /**
- * A person (alive, dead, undead, or fictional).
+ * A WebSite is a set of related web pages and other items typically served from a single web domain and accessible via URLs.
  */
-interface PersonSimple extends Thing {
+interface WebSiteSimple extends Thing {
     /**
-     * The full name of the Person.
+     * The site's home URL (excluding a trailing slash).
+     */
+    url?: string;
+    /**
+     * The name of the website.
      */
     name: string;
     /**
-     * The user bio, truncated to 250 characters.
+     * A description of the website (e.g., the site's tagline).
      */
     description?: string;
     /**
-     * An array of URLs representing declared social/authoritative profiles of the person
-     * (e.g., a Wikipedia page, or Facebook profile).
+     * A reference-by-ID to the Organization which publishes the WebSite
+     * (or an array of Organization and Person in the case that the website represents an individual).
      */
-    sameAs?: Arrayable<string>;
+    publisher?: NodeRelations<Identity>;
     /**
-     * An array of images which represent the person, referenced by ID.
+     * A SearchAction object describing the site's internal search.
      */
-    image?: NodeRelations<ImageObject | string>;
+    potentialAction?: Arrayable<(SearchAction | unknown)>;
     /**
-     * The URL of the users' profile page (if they're affiliated with the site in question),
-     * or to their personal homepage/website.
+     * The language code for the WebSite; e.g., en-GB.
+     * If the website is available in multiple languages, then output an array of inLanguage values.
      */
-    url?: string;
+    inLanguage?: Arrayable<string>;
 }
-interface Person extends PersonSimple {
+interface WebSite extends WebSiteSimple {
 }
-/**
- * Describes an individual person. Most commonly used to identify the author of a piece of content (such as an Article or Comment).
- */
-declare const personResolver: SchemaOrgNodeDefinition<Person>;
+declare const PrimaryWebSiteId = "#website";
+declare const webSiteResolver: SchemaOrgNodeDefinition<WebSite>;
 
 interface ReadActionInput {
     target?: string[];
@@ -1588,6 +1588,14 @@ interface Thing {
      * - Must be of the following formats+file extensions: .jpg, .png, .gif ,or .webp.
      */
     'image'?: NodeRelations<ImageObject | string>;
+    /**
+     * The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”.
+     */
+    'translationOfWork'?: NodeRelations<Thing>;
+    /**
+     * A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo.
+     */
+    'workTranslation'?: NodeRelations<Thing>;
     /**
      * Allow any arbitrary keys
      */
@@ -1603,7 +1611,7 @@ interface IdReference {
     /** IRI identifying the canonical address of this object. */
     '@id': string;
 }
-type Id = `#${string}` | `https://${string}#${string}`;
+type Id = string | `#${string}` | `https://${string}#${string}`;
 
 interface SchemaOrgGraph {
     nodes: SchemaOrgNode[];
@@ -1630,4 +1638,4 @@ declare function PluginSchemaOrg(options?: PluginSchemaOrgOptions & {
  */
 declare function SchemaOrgUnheadPlugin(config: MetaInput, meta: () => Partial<MetaInput> | Promise<Partial<MetaInput>>, options?: PluginSchemaOrgOptions): _unhead_schema.HeadPluginInput;
 
-export { PrimaryBookId as $, type Arrayable as A, type BreadcrumbList as B, type Comment$1 as C, aggregateOfferResolver as D, type Event as E, type FoodEstablishment as F, type AggregateRatingSimple as G, type HowTo as H, type ImageObject as I, type JobPosting as J, aggregateRatingResolver as K, type LocalBusiness as L, type MetaInput as M, type ArticleSimple as N, type Offer as O, type PostalAddress as P, type Question as Q, type ResolvedMeta as R, type SchemaOrgNodeDefinition as S, type Thing as T, PrimaryArticleId as U, type VirtualLocation as V, type WebPage as W, articleResolver as X, type BookSimple as Y, type BookEditionSimple as Z, bookEditionResolver as _, type SchemaOrgNode as a, videoResolver as a$, bookResolver as a0, type BreadcrumbSimple as a1, PrimaryBreadcrumbId as a2, breadcrumbResolver as a3, type CommentSimple as a4, commentResolver as a5, type CourseSimple as a6, courseResolver as a7, type EventSimple as a8, PrimaryEventId as a9, type OfferSimple as aA, offerResolver as aB, type OpeningHoursSimple as aC, openingHoursResolver as aD, type OrganizationSimple as aE, organizationResolver as aF, type PersonSimple as aG, personResolver as aH, type PostalAddressSimple as aI, addressResolver as aJ, type ProductSimple as aK, ProductId as aL, productResolver as aM, type QuestionSimple as aN, questionResolver as aO, type RatingSimple as aP, type Rating as aQ, ratingResolver as aR, type RecipeSimple as aS, type NutritionInformation as aT, RecipeId as aU, recipeResolver as aV, type SoftwareAppSimple as aW, softwareAppResolver as aX, type ReviewSimple as aY, reviewResolver as aZ, type VideoSimple as a_, eventResolver as aa, type VirtualLocationSimple as ab, virtualLocationResolver as ac, type PlaceSimple as ad, placeResolver as ae, type FoodEstablishmentSimple as af, foodEstablishmentResolver as ag, type HowToSimple as ah, HowToId as ai, howToResolver as aj, type HowToStepSimple as ak, howToStepResolver as al, type HowToDirection as am, howToStepDirectionResolver as an, type ItemListSimple as ao, itemListResolver as ap, type ImageSimple as aq, imageResolver as ar, type JobPostingSimple as as, jobPostingResolver as at, type ListItemSimple as au, listItemResolver as av, type LocalBusinessSimple as aw, localBusinessResolver as ax, type MovieSimple as ay, movieResolver as az, type SchemaOrgGraph as b, type WebPageSimple as b0, PrimaryWebPageId as b1, webPageResolver as b2, type ReadActionInput as b3, readActionResolver as b4, type WebSiteSimple as b5, PrimaryWebSiteId as b6, webSiteResolver as b7, type SearchActionInput as b8, searchActionResolver as b9, type PluginSchemaOrgOptions as ba, UnheadSchemaOrg as bb, PluginSchemaOrg as bc, SchemaOrgUnheadPlugin as bd, type NodeRelation as be, type NodeRelations as bf, type Identity as bg, type ResolvableDate as bh, type OptionalSchemaOrgPrefix as bi, type UserConfig as bj, type WithResolver as bk, type IdReference as bl, type Id as bm, type AggregateOffer as c, type AggregateRating as d, type Article as e, type Place as f, type HowToStep as g, type OpeningHoursSpecification as h, type Organization as i, type Person as j, type Product as k, type Recipe as l, type Review as m, type VideoObject as n, type WebSite as o, type Book as p, type Course as q, type ItemList as r, type ListItem as s, type Movie as t, type SearchAction as u, type ReadAction as v, type SoftwareApp as w, type BookEdition as x, createSchemaOrgGraph as y, type AggregateOfferSimple as z };
+export { PrimaryBookId as $, type Arrayable as A, type BreadcrumbList as B, type Comment$1 as C, aggregateOfferResolver as D, type Event as E, type FoodEstablishment as F, type AggregateRatingSimple as G, type HowTo as H, type ImageObject as I, type JobPosting as J, aggregateRatingResolver as K, type LocalBusiness as L, type MetaInput as M, type ArticleSimple as N, type Offer as O, type PostalAddress as P, type Question as Q, type ResolvedMeta as R, type SchemaOrgNodeDefinition as S, type Thing as T, PrimaryArticleId as U, type VirtualLocation as V, type WebPage as W, articleResolver as X, type BookSimple as Y, type BookEditionSimple as Z, bookEditionResolver as _, type SchemaOrgGraph as a, videoResolver as a$, bookResolver as a0, type BreadcrumbSimple as a1, PrimaryBreadcrumbId as a2, breadcrumbResolver as a3, type CommentSimple as a4, commentResolver as a5, type CourseSimple as a6, courseResolver as a7, type EventSimple as a8, PrimaryEventId as a9, type OfferSimple as aA, offerResolver as aB, type OpeningHoursSimple as aC, openingHoursResolver as aD, type OrganizationSimple as aE, organizationResolver as aF, type PersonSimple as aG, personResolver as aH, type PostalAddressSimple as aI, addressResolver as aJ, type ProductSimple as aK, ProductId as aL, productResolver as aM, type QuestionSimple as aN, questionResolver as aO, type RatingSimple as aP, type Rating as aQ, ratingResolver as aR, type RecipeSimple as aS, type NutritionInformation as aT, RecipeId as aU, recipeResolver as aV, type ReviewSimple as aW, reviewResolver as aX, type SoftwareAppSimple as aY, softwareAppResolver as aZ, type VideoSimple as a_, eventResolver as aa, type PlaceSimple as ab, placeResolver as ac, type VirtualLocationSimple as ad, virtualLocationResolver as ae, type FoodEstablishmentSimple as af, foodEstablishmentResolver as ag, type HowToSimple as ah, HowToId as ai, howToResolver as aj, type HowToStepSimple as ak, howToStepResolver as al, type HowToDirection as am, howToStepDirectionResolver as an, type ImageSimple as ao, imageResolver as ap, type ItemListSimple as aq, itemListResolver as ar, type JobPostingSimple as as, jobPostingResolver as at, type ListItemSimple as au, listItemResolver as av, type LocalBusinessSimple as aw, localBusinessResolver as ax, type MovieSimple as ay, movieResolver as az, type SchemaOrgNode as b, type WebPageSimple as b0, PrimaryWebPageId as b1, webPageResolver as b2, type ReadActionInput as b3, readActionResolver as b4, type WebSiteSimple as b5, PrimaryWebSiteId as b6, webSiteResolver as b7, type SearchActionInput as b8, searchActionResolver as b9, type PluginSchemaOrgOptions as ba, UnheadSchemaOrg as bb, PluginSchemaOrg as bc, SchemaOrgUnheadPlugin as bd, type NodeRelation as be, type NodeRelations as bf, type Identity as bg, type ResolvableDate as bh, type OptionalSchemaOrgPrefix as bi, type UserConfig as bj, type WithResolver as bk, type IdReference as bl, type Id as bm, type AggregateOffer as c, type AggregateRating as d, type Article as e, type Place as f, type HowToStep as g, type OpeningHoursSpecification as h, type Organization as i, type Person as j, type Product as k, type Recipe as l, type Review as m, type VideoObject as n, type WebSite as o, type Book as p, type Course as q, type ItemList as r, type ListItem as s, type Movie as t, type SearchAction as u, type ReadAction as v, type SoftwareApp as w, type BookEdition as x, createSchemaOrgGraph as y, type AggregateOfferSimple as z };