import type { ActiveHeadEntry, HeadEntryOptions, Unhead } from 'unhead/types' import type { AggregateOffer, AggregateRating, Article, Book, BookEdition, BreadcrumbList, Comment, Course, Dataset, DiscussionForumPosting, EmployerAggregateRating, Event, FoodEstablishment, HowTo, HowToStep, ImageObject, ItemList, JobPosting, ListItem, LocalBusiness, MathSolver, Movie, MusicAlbum, MusicGroup, MusicPlaylist, MusicRecording, Offer, OpeningHoursSpecification, Organization, Person, PodcastEpisode, PodcastSeason, PodcastSeries, PostalAddress, Product, Question, Quiz, ReadAction, Recipe, Review, SearchAction, Service, SoftwareApp, TVEpisode, TVSeason, TVSeries, VacationRental, VideoObject, WebPage, WebSite, } from './nodes' import type { Place } from './nodes/Place' import type { VirtualLocation } from './nodes/VirtualLocation' import type { Arrayable, SchemaOrgNodeDefinition, Thing } from './types' import { aggregateOfferResolver } from './nodes/AggregateOffer' import { aggregateRatingResolver } from './nodes/AggregateRating' import { articleResolver } from './nodes/Article' import { bookEditionResolver, bookResolver } from './nodes/Book' import { breadcrumbResolver } from './nodes/Breadcrumb' import { commentResolver } from './nodes/Comment' import { courseResolver } from './nodes/Course' import { datasetResolver } from './nodes/Dataset' import { discussionForumPostingResolver } from './nodes/DiscussionForumPosting' import { employerAggregateRatingResolver } from './nodes/EmployerAggregateRating' import { eventResolver } from './nodes/Event' import { foodEstablishmentResolver } from './nodes/FoodEstablishment' import { howToResolver } from './nodes/HowTo' import { howToStepResolver } from './nodes/HowTo/HowToStep' import { imageResolver } from './nodes/Image' import { itemListResolver } from './nodes/ItemList' import { jobPostingResolver } from './nodes/JobPosting' import { listItemResolver } from './nodes/ListItem' import { localBusinessResolver } from './nodes/LocalBusiness' import { mathSolverResolver } from './nodes/MathSolver' import { movieResolver } from './nodes/Movie' import { musicAlbumResolver } from './nodes/MusicAlbum' import { musicGroupResolver } from './nodes/MusicGroup' import { musicPlaylistResolver } from './nodes/MusicPlaylist' import { musicRecordingResolver } from './nodes/MusicRecording' import { offerResolver } from './nodes/Offer' import { openingHoursResolver } from './nodes/OpeningHours' import { organizationResolver } from './nodes/Organization' import { personResolver } from './nodes/Person' import { placeResolver } from './nodes/Place' import { podcastEpisodeResolver } from './nodes/PodcastEpisode' import { podcastSeasonResolver } from './nodes/PodcastSeason' import { podcastSeriesResolver } from './nodes/PodcastSeries' import { addressResolver } from './nodes/PostalAddress' import { productResolver } from './nodes/Product' import { questionResolver } from './nodes/Question' import { quizResolver } from './nodes/Quiz' import { recipeResolver } from './nodes/Recipe' import { reviewResolver } from './nodes/Review' import { serviceResolver } from './nodes/Service' import { softwareAppResolver } from './nodes/SoftwareApp' import { tvEpisodeResolver } from './nodes/TVEpisode' import { tvSeasonResolver } from './nodes/TVSeason' import { tvSeriesResolver } from './nodes/TVSeries' import { vacationRentalResolver } from './nodes/VacationRental' import { videoResolver } from './nodes/Video' import { virtualLocationResolver } from './nodes/VirtualLocation' import { webPageResolver } from './nodes/WebPage' import { readActionResolver } from './nodes/WebPage/ReadAction' import { webSiteResolver } from './nodes/WebSite' import { searchActionResolver } from './nodes/WebSite/SearchAction' import { UnheadSchemaOrg } from './plugin' type SchemaOrgDefinerInput = Input & (Input extends object ? ResolvedInput : unknown) type DefinedSchemaOrgNode = ( [Input] extends [undefined] ? Partial : ResolvedInput & Exclude ) & { _resolver?: SchemaOrgNodeDefinition } function provideResolver(input: Input | undefined, resolver?: SchemaOrgNodeDefinition): DefinedSchemaOrgNode { return { ...(input || {} as Input), _resolver: resolver } as DefinedSchemaOrgNode } export function defineAddress(input?: SchemaOrgDefinerInput) { return provideResolver(input, addressResolver) } export function defineAggregateOffer(input?: SchemaOrgDefinerInput) { return provideResolver(input, aggregateOfferResolver) } export function defineAggregateRating(input?: SchemaOrgDefinerInput) { return provideResolver(input, aggregateRatingResolver) } export function defineArticle(input?: SchemaOrgDefinerInput) { return provideResolver(input, articleResolver) } export function defineBreadcrumb(input?: SchemaOrgDefinerInput) { return provideResolver(input, breadcrumbResolver) } export function defineComment(input?: SchemaOrgDefinerInput) { return provideResolver(input, commentResolver) } export function defineDiscussionForumPosting(input?: SchemaOrgDefinerInput) { return provideResolver(input, discussionForumPostingResolver) } export function defineEmployerAggregateRating(input?: SchemaOrgDefinerInput) { return provideResolver(input, employerAggregateRatingResolver) } export function defineEvent(input?: SchemaOrgDefinerInput) { return provideResolver(input, eventResolver) } export function defineFoodEstablishment(input?: SchemaOrgDefinerInput) { return provideResolver(input, foodEstablishmentResolver) } export function defineVirtualLocation(input?: SchemaOrgDefinerInput) { return provideResolver(input, virtualLocationResolver) } export function definePlace(input?: SchemaOrgDefinerInput) { return provideResolver(input, placeResolver) } export function defineHowTo(input?: SchemaOrgDefinerInput) { return provideResolver(input, howToResolver) } export function defineHowToStep(input?: SchemaOrgDefinerInput) { return provideResolver(input, howToStepResolver) } export function defineImage(input?: SchemaOrgDefinerInput) { return provideResolver(input, imageResolver) } export function defineJobPosting(input?: SchemaOrgDefinerInput) { return provideResolver(input, jobPostingResolver) } export function defineLocalBusiness(input?: SchemaOrgDefinerInput) { return provideResolver(input, localBusinessResolver) } export function defineMathSolver(input?: SchemaOrgDefinerInput) { return provideResolver(input, mathSolverResolver) } export function defineOffer(input?: SchemaOrgDefinerInput) { return provideResolver(input, offerResolver) } export function defineOpeningHours(input?: SchemaOrgDefinerInput) { return provideResolver(input, openingHoursResolver) } export function defineOrganization(input?: SchemaOrgDefinerInput) { return provideResolver(input, organizationResolver) } export function definePerson(input?: SchemaOrgDefinerInput) { return provideResolver(input, personResolver) } export function defineProduct(input?: SchemaOrgDefinerInput) { return provideResolver(input, productResolver) } export function defineQuestion(input?: SchemaOrgDefinerInput) { return provideResolver(input, questionResolver) } export function defineQuiz(input?: SchemaOrgDefinerInput) { return provideResolver(input, quizResolver) } export function defineRecipe(input?: SchemaOrgDefinerInput) { return provideResolver(input, recipeResolver) } export function defineReview(input?: SchemaOrgDefinerInput) { return provideResolver(input, reviewResolver) } export function defineVideo(input?: SchemaOrgDefinerInput) { return provideResolver(input, videoResolver) } export function defineVacationRental(input?: SchemaOrgDefinerInput) { return provideResolver(input, vacationRentalResolver) } export function defineWebPage(input?: SchemaOrgDefinerInput) { return provideResolver(input, webPageResolver) } export function defineWebSite(input?: SchemaOrgDefinerInput) { return provideResolver(input, webSiteResolver) } export function defineBook(input?: SchemaOrgDefinerInput) { return provideResolver(input, bookResolver) } export function defineCourse(input?: SchemaOrgDefinerInput) { return provideResolver(input, courseResolver) } export function defineItemList(input?: SchemaOrgDefinerInput) { return provideResolver(input, itemListResolver) } export function defineListItem(input?: SchemaOrgDefinerInput) { return provideResolver(input, listItemResolver) } export function defineMovie(input?: SchemaOrgDefinerInput) { return provideResolver(input, movieResolver) } export function defineSearchAction(input?: SchemaOrgDefinerInput) { return provideResolver(input, searchActionResolver) } export function defineReadAction(input?: SchemaOrgDefinerInput) { return provideResolver(input, readActionResolver) } export function defineDataset(input?: SchemaOrgDefinerInput) { return provideResolver(input, datasetResolver) } export function defineMusicRecording(input?: SchemaOrgDefinerInput) { return provideResolver(input, musicRecordingResolver) } export function defineMusicAlbum(input?: SchemaOrgDefinerInput) { return provideResolver(input, musicAlbumResolver) } export function defineMusicGroup(input?: SchemaOrgDefinerInput) { return provideResolver(input, musicGroupResolver) } export function defineMusicPlaylist(input?: SchemaOrgDefinerInput) { return provideResolver(input, musicPlaylistResolver) } export function definePodcastSeries(input?: SchemaOrgDefinerInput) { return provideResolver(input, podcastSeriesResolver) } export function definePodcastEpisode(input?: SchemaOrgDefinerInput) { return provideResolver(input, podcastEpisodeResolver) } export function definePodcastSeason(input?: SchemaOrgDefinerInput) { return provideResolver(input, podcastSeasonResolver) } export function defineTVSeries(input?: SchemaOrgDefinerInput) { return provideResolver(input, tvSeriesResolver) } export function defineTVSeason(input?: SchemaOrgDefinerInput) { return provideResolver(input, tvSeasonResolver) } export function defineTVEpisode(input?: SchemaOrgDefinerInput) { return provideResolver(input, tvEpisodeResolver) } export function defineService(input?: SchemaOrgDefinerInput) { return provideResolver(input, serviceResolver) } /* simple-only */ export function defineSoftwareApp(input?: SchemaOrgDefinerInput) { return provideResolver(input, softwareAppResolver) } export function defineBookEdition(input?: SchemaOrgDefinerInput) { return provideResolver(input, bookEditionResolver) } /* end-simple-only */ export type UseSchemaOrgInput = Arrayable | null | undefined | false> export interface SchemaOrgHeadInput { script: [{ type: 'application/ld+json' key: 'schema-org-graph' nodes: T }] } interface ReadonlySchemaOrgHeadInput { readonly script: readonly [{ readonly type: 'application/ld+json' readonly key: 'schema-org-graph' readonly nodes: T }] } interface PotentialSchemaOrgHeadInput { readonly script: readonly { readonly type: string readonly key: string readonly nodes: unknown }[] } export function normalizeSchemaOrgInput>(input: Input): Input export function normalizeSchemaOrgInput(input: Input): Input | SchemaOrgHeadInput export function normalizeSchemaOrgInput(input: T): SchemaOrgHeadInput export function normalizeSchemaOrgInput(input: unknown): SchemaOrgHeadInput { // avoid over normalizing const script = (input as PotentialSchemaOrgHeadInput | null)?.script const graph = script?.[0] if (Array.isArray(script) && script.length === 1 && graph && typeof graph === 'object' && graph.type === 'application/ld+json' && graph.key === 'schema-org-graph' && 'nodes' in graph) { return input as SchemaOrgHeadInput } return { script: [ { type: 'application/ld+json', key: 'schema-org-graph', // nullish or falsy input is a no-op, keep nodes truthy so the tag is still collected nodes: input || [], }, ], } } export function useSchemaOrg(unhead: Unhead, input: UseSchemaOrgInput = [], options: HeadEntryOptions = {}): ActiveHeadEntry { unhead.use(UnheadSchemaOrg()) const entry = (unhead as unknown as Unhead>).push( normalizeSchemaOrgInput(input), options, ) const corePatch = entry.patch const publicEntry = entry as unknown as ActiveHeadEntry publicEntry.patch = input => corePatch(normalizeSchemaOrgInput(input)) return publicEntry }