@openactive/models-ts

// This file was generated import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as oa from '../oa'; import * as schema from '../schema'; /** * Brand * * This type is derived from https://schema.org/Brand, which means that any of this type's properties within schema.org may also be used. */ export type Brand = { '@type': 'Brand'; '@context'?: string | string[]; /** * A local non-URI identifier for the resource * * ```json * "identifier": "BR1234" * ``` */ identifier?: number | string | oa.PropertyValueOrSubClass | oa.PropertyValueOrSubClass[]; /** * The name of the brand. * * ```json * "name": "Play Ball!" * ``` */ name?: string; /** * A plain text description for the brand, which must not include HTML or other markup. * * ```json * "description": "Play Ball! is a series of games for people of all abilities." * ``` */ description?: string; /** * A unique url based identifier for the record */ '@id'?: string; /** * The logo associated with the brand. * * ```json * "logo": { * "@type": "ImageObject", * "url": "http://example.com/static/image/speedball_large.jpg" * } * ``` */ logo?: oa.ImageObjectOrSubClass; /** * A url where further information can be found for the brand. * * ```json * "url": "http://example.com/play_ball" * ``` */ url?: string; /** * [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.] * Sometimes a description is stored with formatting (e.g. href, bold, italics, embedded YouTube videos). This formatting can be useful for data consumers. This property must contain HTML. * * If you are using this property, please join the discussion at proposal [#276](https://github.com/openactive/modelling-opportunity-data/issues/276). */ 'beta:formattedDescription'?: string; /** * [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.] * A related video object. * * If you are using this property, please join the discussion at proposal [#88](https://github.com/openactive/modelling-opportunity-data/issues/88). */ 'beta:video'?: oa.VideoObjectOrSubClass[]; /** * The overall rating, based on a collection of reviews or ratings, of the item. */ aggregateRating?: schema.AggregateRatingOrSubClass | string; /** * A review of the item. */ review?: schema.ReviewOrSubClass | string; /** * A slogan or motto associated with the item. */ slogan?: string; /** * 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. */ sameAs?: string; /** * A CreativeWork or Event about this Thing. */ subjectOf?: schema.Event_OrSubClass | schema.CreativeWorkOrSubClass | string; /** * Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. */ potentialAction?: schema.ActionOrSubClass | string; /** * Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details. */ mainEntityOfPage?: schema.CreativeWorkOrSubClass | string; /** * 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. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. */ additionalType?: string; /** * An alias for the item. */ alternateName?: string; /** * An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. */ image?: schema.ImageObjectOrSubClass | string; /** * 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. */ disambiguatingDescription?: string; }; /** * Brand * * This type is derived from https://schema.org/Brand, which means that any of this type's properties within schema.org may also be used. * * This differs from Brand because it also allows for objects that have the type of a model that * sub-classes this model. e.g. `Event_OrSubClass` allows `Event`s as well as `ScheduledSession`s, `SessionSeries`, * etc. */ export type BrandOrSubClass = | Brand ; /** * Brand - Validation schema (w/ JOI) * * This type is derived from https://schema.org/Brand, which means that any of this type's properties within schema.org may also be used. */ export const BrandJoiSchema = Joi.object({ '@type': Joi.string().valid('Brand').required(), '@context': Joi.alternatives().try([Joi.string(), Joi.array().items(Joi.string())]), identifier: Joi.alternatives().try(Joi.number().integer(), Joi.string(), Joi.lazy(() => oa.PropertyValueOrSubClassJoiSchema), Joi.array().items(Joi.lazy(() => oa.PropertyValueOrSubClassJoiSchema))), name: Joi.string(), description: Joi.string(), '@id': Joi.string().uri(), logo: Joi.lazy(() => oa.ImageObjectOrSubClassJoiSchema), url: Joi.string().uri(), 'beta:formattedDescription': Joi.string(), 'beta:video': Joi.array().items(Joi.lazy(() => oa.VideoObjectOrSubClassJoiSchema)), aggregateRating: Joi.alternatives().try(Joi.lazy(() => schema.AggregateRatingOrSubClassJoiSchema), Joi.string().uri()), review: Joi.alternatives().try(Joi.lazy(() => schema.ReviewOrSubClassJoiSchema), Joi.string().uri()), slogan: Joi.string(), sameAs: Joi.string().uri(), subjectOf: Joi.alternatives().try(Joi.lazy(() => schema.Event_OrSubClassJoiSchema), Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), potentialAction: Joi.alternatives().try(Joi.lazy(() => schema.ActionOrSubClassJoiSchema), Joi.string().uri()), mainEntityOfPage: Joi.alternatives().try(Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), additionalType: Joi.string().uri(), alternateName: Joi.string(), image: Joi.alternatives().try(Joi.lazy(() => schema.ImageObjectOrSubClassJoiSchema), Joi.string().uri()), disambiguatingDescription: Joi.string(), }); /** * Brand - Validation schema (w/ JOI) * * This type is derived from https://schema.org/Brand, which means that any of this type's properties within schema.org may also be used. * * This differs from BrandJoiSchema because it also allows for objects that have the type of a model that * sub-classes this model. e.g. `Event.OrSubClassJoiSchema` allows `Event`s as well as `ScheduledSession`s, * `SessionSeries`, etc. */ export const BrandOrSubClassJoiSchema = Joi.alternatives().try([ BrandJoiSchema, ]); /** * Runtime validator for Brand. * * If some data has a structure which matches a Brand, it will be returned with the correct type. * Otherwise, this function returns an OAValidationError with details about why the data does not match. * * Use this to e.g. check a JSON object received in an HTTP request. Example usage (for an express request handler): * * ```ts * const maybeBrand = validateBrand(req.body); // `req.body` will have type `any` or `unknown` * if (maybeBrand instanceof OaValidationError) { * // From this point on, `maybeBrand` will have type `OaValidationError` * const error = maybeBrand; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybeBrand` will have type `Brand` * const brand = maybeBrand; * ``` */ export function validateBrand(maybeBrand: unknown): Brand | OaValidationError { const { value, error } = BrandJoiSchema.validate(maybeBrand); if (error) { return new OaValidationError('Brand', maybeBrand, error); } /* Joi does not implement TS Type Guards, so TS does not implicitly know that this has now been validated to have the right type. Therefore, we just cast it to the right type. */ return value as Brand; }