@unhead/schema-org 0.5.0 → 0.6.0

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/dist/index.d.ts CHANGED
@@ -1520,13 +1520,14 @@ interface SchemaOrgGraph {
1520
1520
  resolveGraph: (meta: MetaInput) => SchemaOrgNode[];
1521
1521
  find: <T extends Thing>(id: Id | string) => T | null;
1522
1522
  }
1523
- declare const createSchemaOrgGraph: () => SchemaOrgGraph;
1523
+ declare function createSchemaOrgGraph(): SchemaOrgGraph;
1524
1524
 
1525
1525
  /**
1526
1526
  * Dedupe, flatten and a collection of nodes. Will also sort node keys and remove meta keys.
1527
1527
  * @param nodes
1528
1528
  */
1529
- declare const dedupeNodes: (nodes: SchemaOrgNode[]) => SchemaOrgNode[];
1529
+ declare function dedupeNodes(nodes: SchemaOrgNode[]): SchemaOrgNode[];
1530
+ declare function normaliseNodes(nodes: SchemaOrgNode[]): SchemaOrgNode[];
1530
1531
 
1531
1532
  interface ResolverOptions {
1532
1533
  /**
@@ -1544,47 +1545,47 @@ interface ResolverOptions {
1544
1545
  afterResolve?: (node: any) => void;
1545
1546
  }
1546
1547
 
1547
- declare const resolveMeta: (meta: MetaInput) => ResolvedMeta;
1548
- declare const resolveNode: <T extends Thing>(node: T, ctx: SchemaOrgGraph, resolver: SchemaOrgNodeDefinition<T>) => T;
1549
- declare const resolveNodeId: <T extends Thing>(node: T, ctx: SchemaOrgGraph, resolver: SchemaOrgNodeDefinition<T>, resolveAsRoot?: boolean) => T;
1548
+ declare function resolveMeta(meta: MetaInput): ResolvedMeta;
1549
+ declare function resolveNode<T extends Thing>(node: T, ctx: SchemaOrgGraph, resolver: SchemaOrgNodeDefinition<T>): T;
1550
+ declare function resolveNodeId<T extends Thing>(node: T, ctx: SchemaOrgGraph, resolver: SchemaOrgNodeDefinition<T>, resolveAsRoot?: boolean): T;
1550
1551
  declare function resolveRelation(input: Arrayable<any>, ctx: SchemaOrgGraph, fallbackResolver?: SchemaOrgNodeDefinition<any>, options?: ResolverOptions): any;
1551
1552
 
1552
1553
  declare function SchemaOrgUnheadPlugin(config: MetaInput, meta: () => Record<string, any>): any;
1553
1554
 
1554
- declare const defineAddress: <T extends Record<string, any>>(input?: (PostalAddress & T) | undefined) => PostalAddress & T;
1555
- declare const defineAggregateOffer: <T extends Record<string, any>>(input?: (AggregateOffer & T) | undefined) => AggregateOffer & T;
1556
- declare const defineAggregateRating: <T extends Record<string, any>>(input?: (AggregateRating & T) | undefined) => AggregateRating & T;
1557
- declare const defineArticle: <T extends Record<string, any>>(input?: (Article & T) | undefined) => Article & T;
1558
- declare const defineBreadcrumb: <T extends Record<string, any>>(input?: (BreadcrumbList & T) | undefined) => BreadcrumbList & T;
1559
- declare const defineComment: <T extends Record<string, any>>(input?: (Comment$1 & T) | undefined) => Comment$1 & T;
1560
- declare const defineEvent: <T extends Record<string, any>>(input?: (Event & T) | undefined) => Event & T;
1561
- declare const defineVirtualLocation: <T extends Record<string, any>>(input?: (VirtualLocation & T) | undefined) => VirtualLocation & T;
1562
- declare const definePlace: <T extends Record<string, any>>(input?: (Place & T) | undefined) => Place & T;
1563
- declare const defineHowTo: <T extends Record<string, any>>(input?: (HowTo & T) | undefined) => HowTo & T;
1564
- declare const defineHowToStep: <T extends Record<string, any>>(input?: (HowToStep & T) | undefined) => HowToStep & T;
1565
- declare const defineImage: <T extends Record<string, any>>(input?: (ImageObject & T) | undefined) => ImageObject & T;
1566
- declare const defineJobPosting: <T extends Record<string, any>>(input?: (JobPosting & T) | undefined) => JobPosting & T;
1567
- declare const defineLocalBusiness: <T extends Record<string, any>>(input?: (LocalBusiness & T) | undefined) => LocalBusiness & T;
1568
- declare const defineOffer: <T extends Record<string, any>>(input?: (Offer & T) | undefined) => Offer & T;
1569
- declare const defineOpeningHours: <T extends Record<string, any>>(input?: (OpeningHoursSpecification & T) | undefined) => OpeningHoursSpecification & T;
1570
- declare const defineOrganization: <T extends Record<string, any>>(input?: (Organization & T) | undefined) => Organization & T;
1571
- declare const definePerson: <T extends Record<string, any>>(input?: (Person & T) | undefined) => Person & T;
1572
- declare const defineProduct: <T extends Record<string, any>>(input?: (Product & T) | undefined) => Product & T;
1573
- declare const defineQuestion: <T extends Record<string, any>>(input?: (Question & T) | undefined) => Question & T;
1574
- declare const defineRecipe: <T extends Record<string, any>>(input?: (Recipe & T) | undefined) => Recipe & T;
1575
- declare const defineReview: <T extends Record<string, any>>(input?: (Review & T) | undefined) => Review & T;
1576
- declare const defineVideo: <T extends Record<string, any>>(input?: (VideoObject & T) | undefined) => VideoObject & T;
1577
- declare const defineWebPage: <T extends Record<string, any>>(input?: (WebPage & T) | undefined) => WebPage & T;
1578
- declare const defineWebSite: <T extends Record<string, any>>(input?: (WebSite & T) | undefined) => WebSite & T;
1579
- declare const defineBook: <T extends Record<string, any>>(input?: (Book & T) | undefined) => Book & T;
1580
- declare const defineCourse: <T extends Record<string, any>>(input?: (Course & T) | undefined) => Course & T;
1581
- declare const defineItemList: <T extends Record<string, any>>(input?: (ItemList & T) | undefined) => ItemList & T;
1582
- declare const defineListItem: <T extends Record<string, any>>(input?: (ListItem & T) | undefined) => ListItem & T;
1583
- declare const defineMovie: <T extends Record<string, any>>(input?: (Movie & T) | undefined) => Movie & T;
1584
- declare const defineSearchAction: <T extends Record<string, any>>(input?: (SearchAction & T) | undefined) => SearchAction & T;
1585
- declare const defineReadAction: <T extends Record<string, any>>(input?: (ReadAction & T) | undefined) => ReadAction & T;
1586
- declare const defineSoftwareApp: <T extends Record<string, any>>(input?: (SoftwareApp & T) | undefined) => SoftwareApp & T;
1587
- declare const defineBookEdition: <T extends Record<string, any>>(input?: (BookEdition & T) | undefined) => BookEdition & T;
1555
+ declare function defineAddress<T extends Record<string, any>>(input?: PostalAddress & T): PostalAddress & T;
1556
+ declare function defineAggregateOffer<T extends Record<string, any>>(input?: AggregateOffer & T): AggregateOffer & T;
1557
+ declare function defineAggregateRating<T extends Record<string, any>>(input?: AggregateRating & T): AggregateRating & T;
1558
+ declare function defineArticle<T extends Record<string, any>>(input?: Article & T): Article & T;
1559
+ declare function defineBreadcrumb<T extends Record<string, any>>(input?: BreadcrumbList & T): BreadcrumbList & T;
1560
+ declare function defineComment<T extends Record<string, any>>(input?: Comment$1 & T): Comment$1 & T;
1561
+ declare function defineEvent<T extends Record<string, any>>(input?: Event & T): Event & T;
1562
+ declare function defineVirtualLocation<T extends Record<string, any>>(input?: VirtualLocation & T): VirtualLocation & T;
1563
+ declare function definePlace<T extends Record<string, any>>(input?: Place & T): Place & T;
1564
+ declare function defineHowTo<T extends Record<string, any>>(input?: HowTo & T): HowTo & T;
1565
+ declare function defineHowToStep<T extends Record<string, any>>(input?: HowToStep & T): HowToStep & T;
1566
+ declare function defineImage<T extends Record<string, any>>(input?: ImageObject & T): ImageObject & T;
1567
+ declare function defineJobPosting<T extends Record<string, any>>(input?: JobPosting & T): JobPosting & T;
1568
+ declare function defineLocalBusiness<T extends Record<string, any>>(input?: LocalBusiness & T): LocalBusiness & T;
1569
+ declare function defineOffer<T extends Record<string, any>>(input?: Offer & T): Offer & T;
1570
+ declare function defineOpeningHours<T extends Record<string, any>>(input?: OpeningHoursSpecification & T): OpeningHoursSpecification & T;
1571
+ declare function defineOrganization<T extends Record<string, any>>(input?: Organization & T): Organization & T;
1572
+ declare function definePerson<T extends Record<string, any>>(input?: Person & T): Person & T;
1573
+ declare function defineProduct<T extends Record<string, any>>(input?: Product & T): Product & T;
1574
+ declare function defineQuestion<T extends Record<string, any>>(input?: Question & T): Question & T;
1575
+ declare function defineRecipe<T extends Record<string, any>>(input?: Recipe & T): Recipe & T;
1576
+ declare function defineReview<T extends Record<string, any>>(input?: Review & T): Review & T;
1577
+ declare function defineVideo<T extends Record<string, any>>(input?: VideoObject & T): VideoObject & T;
1578
+ declare function defineWebPage<T extends Record<string, any>>(input?: WebPage & T): WebPage & T;
1579
+ declare function defineWebSite<T extends Record<string, any>>(input?: WebSite & T): WebSite & T;
1580
+ declare function defineBook<T extends Record<string, any>>(input?: Book & T): Book & T;
1581
+ declare function defineCourse<T extends Record<string, any>>(input?: Course & T): Course & T;
1582
+ declare function defineItemList<T extends Record<string, any>>(input?: ItemList & T): ItemList & T;
1583
+ declare function defineListItem<T extends Record<string, any>>(input?: ListItem & T): ListItem & T;
1584
+ declare function defineMovie<T extends Record<string, any>>(input?: Movie & T): Movie & T;
1585
+ declare function defineSearchAction<T extends Record<string, any>>(input?: SearchAction & T): SearchAction & T;
1586
+ declare function defineReadAction<T extends Record<string, any>>(input?: ReadAction & T): ReadAction & T;
1587
+ declare function defineSoftwareApp<T extends Record<string, any>>(input?: SoftwareApp & T): SoftwareApp & T;
1588
+ declare function defineBookEdition<T extends Record<string, any>>(input?: BookEdition & T): BookEdition & T;
1588
1589
  declare function useSchemaOrg(input?: any): any;
1589
1590
 
1590
- 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 };
1591
+ 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, normaliseNodes, offerResolver, openingHoursResolver, organizationResolver, personResolver, placeResolver, productResolver, questionResolver, ratingResolver, readActionResolver, recipeResolver, resolveMeta, resolveNode, resolveNodeId, resolveRelation, reviewResolver, searchActionResolver, softwareAppResolver, useSchemaOrg, videoResolver, virtualLocationResolver, webPageResolver, webSiteResolver };