@openactive/models-ts/src/schema/URL.ts

JavaScript/TypeScript implementation of OpenActive's data model

// This file was generated
import * as Joi from 'joi';
import { OaValidationError } from '../oaValidationError';
import * as oa from '../oa';
import * as schema from '../schema';

/**
 * schema:URL
 */
export type URL = {
  '@type': 'URL';
  '@context'?: string | string[];
  /**
   * A unique url based identifier for the record
   */
  '@id'?: string;
};

/**
 * schema:URL
 *
 * This differs from URL 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 URLOrSubClass =
  | URL
  ;

/**
 * schema:URL - Validation schema (w/ JOI)
 */
export const URLJoiSchema = Joi.object({
  '@type': Joi.string().valid('URL').required(),
  '@context': Joi.alternatives().try([Joi.string(), Joi.array().items(Joi.string())]),
  '@id': Joi.string().uri(),
});

/**
 * schema:URL - Validation schema (w/ JOI)
 *
 * This differs from URLJoiSchema 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 URLOrSubClassJoiSchema = Joi.alternatives().try([
  URLJoiSchema,
]);

/**
 * Runtime validator for schema:URL.
 *
 * If some data has a structure which matches a schema:URL, 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 maybeURL = validateURL(req.body); // `req.body` will have type `any` or `unknown`
 * if (maybeURL instanceof OaValidationError) {
 *   // From this point on, `maybeURL` will have type `OaValidationError`
 *   const error = maybeURL;
 *   // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
 * }
 * // From this point on, `maybeURL` will have type `URL`
 * const uRL = maybeURL;
 * ```
 */
export function validateURL(maybeURL: unknown): URL | OaValidationError {
  const { value, error } = URLJoiSchema.validate(maybeURL);
  if (error) {
    return new OaValidationError('URL', maybeURL, 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 URL;
}