unleash.unleash/src/lib/openapi/validate.ts

import Ajv, { type ErrorObject } from 'ajv';
import { type SchemaId, schemas } from './index';
import { omitKeys } from '../util/omit-keys';
import { fromOpenApiValidationErrors } from '../error/bad-data-error';

export interface ISchemaValidationErrors<S = SchemaId> {
    schema: S;
    errors: ErrorObject[];
}

const ajv = new Ajv({
    schemas: Object.values(schemas).map((schema) =>
        omitKeys(schema, 'components'),
    ),
    // example was superseded by examples in openapi 3.1, but we're still on 3.0, so
    // let's add it back in!
    keywords: ['example', 'x-enforcer-exception-skip-codes'],
    formats: {
        'date-time': true,
        date: true,
        uri: true,
    },
});

export const addAjvSchema = (schemaObjects: any[]): any => {
    const newSchemas = schemaObjects.filter(
        (schema) => !ajv.getSchema(schema.$id),
    );
    return ajv.addSchema(newSchemas);
};

export const validateSchema = <S = SchemaId>(
    schema: S,
    data: unknown,
): ISchemaValidationErrors<S> | undefined => {
    // @ts-expect-error we validate that we have an $id field, AJV apparently does not think this is enough to be willing to validate.
    if (!ajv.validate(schema, data)) {
        return {
            schema,
            errors: ajv.errors ?? [],
        };
    }
};

export const throwOnInvalidSchema = <S = SchemaId>(
    schema: S,
    data: object,
): void => {
    const validationErrors = validateSchema(schema, data);
    if (validationErrors) {
        const [firstError, ...remainingErrors] = validationErrors.errors;
        throw fromOpenApiValidationErrors(data, [
            firstError,
            ...remainingErrors,
        ]);
    }
};