@unhead/schema-org 1.8.9 → 1.8.11

package/dist/shared/{schema-org.320d2e5d.d.mts → schema-org.6b61657a.d.mts}

@@ -1,29 +1,136 @@
 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;
+    /**
+     * 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>;
+
+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: number | QuantitativeValue;
+}
+interface MonetaryAmount extends MonetaryAmountSimple {
+}
+interface QuantitativeSimple extends Thing {
+    value?: number;
+    minValue?: number;
+    maxValue?: number;
+    unitCode?: string;
+    unitText?: 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+}
+interface QuantitativeValue extends QuantitativeSimple {
+}
+
+interface ShippingDeliveryTime extends Thing {
+    /**
+     * The typical delay between the receipt of the order and the goods leaving the warehouse.
+     */
+    handlingTime?: QuantitativeValue;
+    /**
+     * The typical delay between when the order has been sent for delivery and when the goods reach the final customer.
+     */
+    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';
+    /**
+     * The total delay between the receipt of the order and the goods reaching the final customer.
+     */
+    'deliveryTime': ShippingDeliveryTime;
+    'shippingDestination': DefinedRegion;
+    /**
+     * Information about the cost of shipping to the specified destination. At least one of shippingRate.value or shippingRate.maxValue must be specified, along with shippingRate.currency.
+     *
+     * You can only specify one shippingRate per OfferShippingDetails property. To indicate multiple rates for your product, specify multiple OfferShippingDetail properties.
+     */
+    'shippingRate': MonetaryAmount;
+}
+
 type ItemAvailability = 'BackOrder' | 'Discontinued' | 'InStock' | 'InStoreOnly' | 'LimitedAvailability' | 'OnlineOnly' | 'OutOfStock' | 'PreOrder' | 'PreSale' | 'SoldOut';
+type OfferItemCondition = 'NewCondition' | 'RefurbishedCondition' | 'UsedCondition';
 interface OfferSimple extends Thing {
     '@type'?: 'Offer';
+    /**
+     * Condition of the item offered for sale.
+     */
+    'itemCondition'?: OptionalSchemaOrgPrefix<OfferItemCondition>;
     /**
      * A schema.org URL representing a schema itemAvailability value (e.g., https://schema.org/OutOfStock).
      */
-    availability?: OptionalSchemaOrgPrefix<ItemAvailability>;
+    'availability'?: OptionalSchemaOrgPrefix<ItemAvailability>;
     /**
      * The price, omitting any currency symbols, and using '.' to indicate a decimal place.
      */
-    price: number | string;
+    'price': number | string;
     /**
      * The currency used to describe the product price, in three-letter ISO 4217 format.
      */
-    priceCurrency?: string;
+    'priceCurrency'?: string;
     /**
      * @todo A PriceSpecification object, including a valueAddedTaxIncluded property (of either true or false).
      */
-    priceSpecification?: unknown;
+    'priceSpecification'?: unknown;
     /**
      * The date after which the price is no longer available.
      */
-    priceValidUntil?: ResolvableDate;
-    url?: string;
+    'priceValidUntil'?: ResolvableDate;
+    'url'?: string;
+    /**
+     * Nested information about the return policies associated with an Offer. If you decide to add hasMerchantReturnPolicy, add the required and recommended MerchantReturnPolicy properties.
+     */
+    'hasMerchantReturnPolicy'?: NodeRelation<OpeningHoursSpecification>;
+    /**
+     * Nested information about the shipping policies and options associated with an Offer. If you decide to add shippingDetails, add the required and recommended OfferShippingDetails properties.
+     */
+    'shippingDetails'?: OfferShippingDetails;
 }
 interface Offer extends OfferSimple {
 }
@@ -60,11 +167,11 @@ interface AggregateRatingSimple extends Thing {
     /**
      * The total number of ratings for the item on your site. At least one of ratingCount or reviewCount is required.
      */
-    ratingCount?: number | string;
+    'ratingCount'?: number | string;
     /**
      * Specifies the number of people who provided a review with or without an accompanying rating. At least one of ratingCount or reviewCount is required.
      */
-    reviewCount?: number | string;
+    'reviewCount'?: number | string;
     /**
      * A numerical quality rating for the item, either a number, fraction, or percentage
      * (for example, "4", "60%", or "6 / 10").
@@ -73,15 +180,15 @@ interface AggregateRatingSimple extends Thing {
      * The default scale for numbers is a 5-point scale, where 1 is the lowest value and 5 is the highest value.
      * If another scale is intended, use bestRating and worstRating.
      */
-    ratingValue: number | string;
+    'ratingValue': number | string;
     /**
      * The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.
      */
-    bestRating?: number | string;
+    'bestRating'?: number | string;
     /**
      * The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.
      */
-    worstRating?: number | string;
+    'worstRating'?: number | string;
 }
 interface AggregateRating extends AggregateRatingSimple {
 }
@@ -303,7 +410,7 @@ interface 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 | {
+    'target': SearchTarget | {
         '@type'?: 'EntryPoint';
         'urlTemplate'?: SearchTarget;
     };
@@ -438,17 +545,17 @@ 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 | Thing;
+    'item'?: string | Thing;
     /**
      *  An integer (starting at 1), counting the 'depth' of the page from (including) the homepage.
      */
-    position?: number;
+    'position'?: number;
 }
 interface ListItem extends ListItemSimple {
 }
@@ -536,7 +643,7 @@ interface ReadAction {
      * 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: string[];
+    'target': string[];
 }
 declare const readActionResolver: SchemaOrgNodeDefinition<ReadAction>;
 
@@ -740,10 +847,10 @@ declare const courseResolver: SchemaOrgNodeDefinition<Course>;
 
 interface PlaceSimple extends Thing {
     '@type'?: 'Place';
-    name: string;
-    address: NodeRelation<PostalAddress | string>;
-    latitude?: number | string;
-    longitude?: number | string;
+    'name': string;
+    'address': NodeRelation<PostalAddress | string>;
+    'latitude'?: number | string;
+    'longitude'?: number | string;
 }
 interface Place extends PlaceSimple {
 }
@@ -754,7 +861,7 @@ declare const placeResolver: SchemaOrgNodeDefinition<Place>;
 
 interface VirtualLocationSimple extends Thing {
     '@type'?: 'VirtualLocation';
-    url: string;
+    'url': string;
 }
 interface VirtualLocation extends VirtualLocationSimple {
 }
@@ -833,78 +940,49 @@ declare const PrimaryEventId = "#event";
  */
 declare const eventResolver: SchemaOrgNodeDefinition<Event>;
 
-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 ValidLocalBusinessSubTypes = 'AnimalShelter' | 'ArchiveOrganization' | 'AutomotiveBusiness' | 'ChildCare' | 'Dentist' | 'DryCleaningOrLaundry' | 'EmergencyService' | 'EmploymentAgency' | 'EntertainmentBusiness' | 'FinancialService' | 'FoodEstablishment' | 'GovernmentOffice' | 'HealthAndBeautyBusiness' | 'HomeAndConstructionBusiness' | 'InternetCafe' | 'LegalService' | 'Library' | 'LodgingBusiness' | 'MedicalBusiness' | 'ProfessionalService' | 'RadioStation' | 'RealEstateAgent' | 'RecyclingCenter' | 'SelfStorage' | 'ShoppingCenter' | 'SportsActivityLocation' | 'Store' | 'TelevisionStation' | 'TouristInformationCenter' | 'TravelAgency';
 interface LocalBusinessSimple extends Organization {
     '@type'?: ['Organization', 'LocalBusiness'] | ['Organization', 'LocalBusiness', ValidLocalBusinessSubTypes] | ValidLocalBusinessSubTypes;
     /**
      * The primary public telephone number of the business.
      */
-    telephone?: string;
+    'telephone'?: string;
     /**
      * The primary public email address of the business.
      */
-    email?: string;
+    'email'?: string;
     /**
      * The primary public fax number of the business.
      */
-    faxNumber?: string;
+    'faxNumber'?: string;
     /**
      * The price range of the business, represented by a string of dollar symbols (e.g., $, $$, or $$$ ).
      */
-    priceRange?: string;
+    'priceRange'?: string;
     /**
      * An array of GeoShape, Place or string definitions.
      */
-    areaServed?: unknown;
+    'areaServed'?: unknown;
     /**
      * A GeoCoordinates object.
      */
-    geo?: unknown;
+    'geo'?: unknown;
     /**
      * The VAT ID of the business.
      */
-    vatID?: string;
+    'vatID'?: string;
     /**
      * The tax ID of the business.
      */
-    taxID?: string;
+    'taxID'?: string;
     /**
      * The currency accepted.
      */
-    currenciesAccepted?: string;
+    'currenciesAccepted'?: string;
     /**
      * The operating hours of the business.
      */
-    openingHoursSpecification?: NodeRelations<OpeningHoursSpecification>;
+    'openingHoursSpecification'?: NodeRelations<OpeningHoursSpecification>;
 }
 interface LocalBusiness extends LocalBusinessSimple {
 }
@@ -924,15 +1002,15 @@ interface RatingSimple extends Thing {
      * The default scale for numbers is a 5-point scale, where 1 is the lowest value and 5 is the highest value.
      * If another scale is intended, use bestRating and worstRating.
      */
-    ratingValue: number | string;
+    'ratingValue': number | string;
     /**
      * The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.
      */
-    bestRating?: number;
+    'bestRating'?: number;
     /**
      * The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.
      */
-    worstRating?: number;
+    'worstRating'?: number;
 }
 interface Rating extends RatingSimple {
 }
@@ -944,19 +1022,19 @@ interface FoodEstablishmentSimple extends Omit<LocalBusiness, '@type'> {
     /**
      * Indicates whether a FoodEstablishment accepts reservations.
      */
-    acceptsReservations?: string | boolean;
+    'acceptsReservations'?: string | boolean;
     /**
      * URL of the menu.
      */
-    hasMenu?: string;
+    'hasMenu'?: string;
     /**
      * The cuisine of the restaurant.
      */
-    servesCuisine?: string;
+    'servesCuisine'?: string;
     /**
      * An official rating for a lodging business or food establishment
      */
-    starRating?: NodeRelations<Rating>;
+    'starRating'?: NodeRelations<Rating>;
 }
 interface FoodEstablishment extends FoodEstablishmentSimple {
 }
@@ -1068,27 +1146,6 @@ 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 {
-}
-
 /**
  * A listing that describes a job opening in a certain organization.
  */
@@ -1397,7 +1454,7 @@ interface NutritionInformation extends Thing {
     /**
      * A calorie count as a string (e.g., "270 calories").
      */
-    calories: string;
+    'calories': string;
 }
 declare const RecipeId = "#recipe";
 declare const recipeResolver: SchemaOrgNodeDefinition<Recipe>;
@@ -1408,29 +1465,29 @@ interface SoftwareAppSimple extends Thing {
     /**
      * The name of the app.
      */
-    name?: string;
+    'name'?: string;
     /**
      * An offer to sell the app.
      * For developers, offers can indicate the marketplaces that carry the application.
      * For marketplaces, use offers to indicate the price of the app for a specific app instance.
      */
-    offers: NodeRelations<Offer>;
+    'offers': NodeRelations<Offer>;
     /**
      * The average review score of the app.
      */
-    aggregateRating?: NodeRelation<AggregateRating>;
+    'aggregateRating'?: NodeRelation<AggregateRating>;
     /**
      * A single review of the app.
      */
-    review?: NodeRelation<Review>;
+    'review'?: NodeRelation<Review>;
     /**
      * The type of app (for example, BusinessApplication or GameApplication). The value must be a supported app type.
      */
-    applicationCategory?: ApplicationCategory;
+    'applicationCategory'?: ApplicationCategory;
     /**
      * The operating system(s) required to use the app (for example, Windows 7, OSX 10.6, Android 1.6)
      */
-    operatingSystem?: string;
+    'operatingSystem'?: string;
 }
 interface SoftwareApp extends SoftwareAppSimple {
 }
@@ -1516,17 +1573,17 @@ interface Thing {
     /**
      * A reference-by-ID to the WebPage node.
      */
-    mainEntityOfPage?: Arrayable<IdReference>;
+    'mainEntityOfPage'?: Arrayable<IdReference>;
     /**
      * A reference-by-ID to the WebPage node.
      */
-    mainEntity?: Arrayable<IdReference>;
+    'mainEntity'?: Arrayable<IdReference>;
     /**
      * An image object or referenced by ID.
      * - Must be at least 696 pixels wide.
      * - Must be of the following formats+file extensions: .jpg, .png, .gif ,or .webp.
      */
-    image?: NodeRelations<ImageObject | string>;
+    'image'?: NodeRelations<ImageObject | string>;
     /**
      * Allow any arbitrary keys
      */