@segha/schemaorg

Schemas for Schema.org

Requirements

• zod

Installation

pnpm add @segha/schemaorg

Usage

import { TextSchema, ThingSchema, URLSchema } from '@segha/schemaorg';

// Validate data
const result = ThingSchema.parse(data);

// Infer TypeScript types
type Thing = z.infer<typeof ThingSchema>;

You can also import specific submodules:

import { ThingSchema } from '@segha/schemaorg/thing';

Schemas

• Text
• Thing
• URL

API Reference

Text

Data type: Text.

String.

Thing

The most generic type of item.

Object containing the following properties:

| Property | Description | Type | | :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ | | additionalType | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide. | Text or URL (nullable) | | alternateName | An alias for the item. | string (nullable) | | description | A description of the item. | string (nullable) | | disambiguatingDescription | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. | string (nullable) | | identifier | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. | Text or URL (nullable) | | image | An image of the item. This can be a URL or a fully described ImageObject. | string (url) (nullable) | | mainEntityOfPage | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity | string (url) (nullable) | | name | The name of the item. | string (nullable) | | sameAs | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. | string (url) (nullable) | | url | URL of the item. | string (url) (nullable) |

All properties are optional.

URL

Data type: URL.

String which is a valid URL.