Aller au contenu

SoftwareApplication builder

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

// Astro — shown first when Astro is selected
import { SoftwareApplication } from '@unschema-graph/astro';
// Svelte 5
import { SoftwareApplication } from '@unschema-graph/svelte';
// Core / Node.js
import { SoftwareApplication } from '@unschema-graph/core';
import { SoftwareApplicationSchema } from '@unschema-graph/core';

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

import {
SoftwareApplicationSchema,
type SchemaInput,
type SchemaOutput,
} from '@unschema-graph/core';
type SoftwareApplicationInput = SchemaInput<typeof SoftwareApplicationSchema>;
type SoftwareApplicationOutput = SchemaOutput<typeof SoftwareApplicationSchema, 'SoftwareApplication'>;
Propriété Type d’entrée Obligatoire Valeur par défaut / contraintes
@id string Non non-empty
name string Oui non-empty
operatingSystem string Non —
applicationCategory string Non —
offers Offer | AggregateOffer | Array<Offer | AggregateOffer> Non —
aggregateRating AggregateRating Non —
review Review | Array<Review> Non —
screenshot string | ImageObject | Array<string | ImageObject> Non non-empty
softwareVersion string Non —
downloadUrl string Non —
fileSize string Non —
description string 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 SoftwareApplication.

import { SoftwareApplication } from '@unschema-graph/core';
const entity = SoftwareApplication({
"name": "Acme Editor",
"operatingSystem": "Web",
"applicationCategory": "DeveloperApplication"
});
{
"@type": "SoftwareApplication",
"name": "Acme Editor",
"operatingSystem": "Web",
"applicationCategory": "DeveloperApplication"
}
  • 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.

Utilisez SoftwareApplication.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.