WebPage builder

Le builder WebPage crée une entité WebPage, injecte son @type, valide les données de manière synchrone et rejette les propriétés inconnues.

Import

// Astro — shown first when Astro is selected
import { WebPage } from '@unschema-graph/astro';

// Svelte 5
import { WebPage } from '@unschema-graph/svelte';

// Core / Node.js
import { WebPage } from '@unschema-graph/core';
import { WebPageSchema } from '@unschema-graph/core';

Le schéma Zod WebPageSchema est également exporté pour la composition et la validation avancées.

Types TypeScript

import {
  WebPageSchema,
  type SchemaInput,
  type SchemaOutput,
} from '@unschema-graph/core';

type WebPageInput = SchemaInput<typeof WebPageSchema>;
type WebPageOutput = SchemaOutput<typeof WebPageSchema, 'WebPage'>;

Propriétés d’entrée

Propriété	Type d’entrée	Obligatoire	Valeur par défaut / contraintes
@id	string	Non	non-empty
name	string	Non	—
url	string	Non	—
headline	string	Non	—
description	string	Non	—
inLanguage	string	Non	—
speakable	string | Array | object	Non	—
isPartOf	string | object	Non	—
breadcrumb	string | object	Non	—

Les alias ci-dessus restent la référence exacte, notamment pour les objets imbriqués. Le builder accepte aussi une configuration de validation en second argument et possède une sortie dont le @type vaut toujours WebPage.

Exemple minimal

import { WebPage } from '@unschema-graph/core';

const entity = WebPage({
  "name": "About Acme",
  "url": "https://example.com/about"
});

Sortie

{
  "@type": "WebPage",
  "name": "About Acme",
  "url": "https://example.com/about"
}

Relations et recettes

• Builders liés : Article, BlogPosting, NewsArticle, Recipe
• Utilisé par : Blog et média, Site d’entreprise
• Sources externes : Schema.org WebPage

Erreurs fréquentes

• Passer une propriété inconnue au builder strict.
• Utiliser une donnée source privée d’une propriété obligatoire.
• Supposer qu’un Schema.org valide garantit un affichage dans la recherche.

Validation

Utilisez WebPage.safeParse(input) pour les données externes. Pour une extension Schema.org non encore modélisée, validez d’abord l’entité puis utilisez withAdditionalProperties(). N’ajoutez jamais une propriété inventée au builder.