optolith-database-schema 0.11.3 → 0.11.4

package/lib/validation/builders/integrity.js

@@ -1,44 +0,0 @@
-import { printPathDescriptor } from "../../helpers/objectPath.js";
-import { Result } from "../../helpers/result.js";
-import { config } from "../../types/Locale.js";
-const integrityError = (instancePath, message) => ({
-    keyword: "integrity",
-    instancePath: printPathDescriptor(instancePath),
-    message
-});
-/**
- * Returns an error if the condition evaluates to `false`.
- */
-const conditionalError = (condition, instancePath, message) => condition ? Result.ok(undefined) : Result.error([integrityError(instancePath, message)]);
-export const getReferencialIntegrityErrors = (ids, typeName, existsId, pathToData) => {
-    const errors = ids
-        .filter(id => !existsId(id))
-        .map(id => integrityError(pathToData, `The identifier "${id}" for type ${typeName} does not exist.`));
-    if (errors.length > 0) {
-        return Result.error(errors);
-    }
-    else {
-        return Result.ok(undefined);
-    }
-};
-export const getReferencialIntegrityErrorsForTranslatable = (validators, data, pathToData = []) => getReferencialIntegrityErrors(Object.keys(data.translations), config.name, validators.identity.locales.exists, [...pathToData, { k: "translations" }]);
-/**
- * Validates that a given identifier is unique. If the identifier is present in
- * both the file name and the file contents, their equality is validated as
- * well. The `pathToId` parameter is used to identify the location of the
- * identifier in the file contents.
- */
-export const validateEntityIntegrity = (isUnique, filenameId, dataId, pathToId = [{ k: "id" }]) => reduceIntegrityValidationResults(conditionalError(isUnique(filenameId), [], `The identifier "${filenameId}" is not unique.`), conditionalError(dataId === undefined || filenameId === dataId, pathToId, `The identifier in the filename (${JSON.stringify(filenameId)}) and the identifier (${JSON.stringify(dataId)}) in the file itself are not equal.`));
-/**
- * Warns about missing integrity validation, but returns no errors.
- * @param typeName The name of the type that is not being validated.
- * @returns An empty list of errors.
- */
-export const todo = (typeName) => {
-    console.warn(`The type ${typeName} has no integrity validation yet.`);
-    return () => Result.ok(undefined);
-};
-/**
- * Combines multiple integrity validation results into one.
- */
-export const reduceIntegrityValidationResults = (...results) => results.reduce((acc, result) => Result.combine(acc, result, () => undefined, (a, b) => [...a, ...b]), Result.ok(undefined));

package/lib/validation/builders/naming.d.ts

@@ -1,13 +0,0 @@
-import { Result } from "../../helpers/result.js";
-/**
- * An error in the shape of an `Ajv` error, with `keyword` being the
- * discriminating property.
- */
-export type FileNameError = {
-    keyword: "filename";
-    instancePath: string;
-    message: string;
-};
-export type FileNameValidationResult = Result<void, FileNameError[]>;
-export type FileNameValidator = (filePath: string) => FileNameValidationResult;
-export declare const validateFileName: FileNameValidator;

package/lib/validation/builders/naming.js

@@ -1,14 +0,0 @@
-import { basename } from "node:path";
-import { error, ok } from "../../helpers/result.js";
-const BASE_NAME_PATTERN = /^(?:0|[1-9][0-9]*)_(?:[A-Z][a-zA-Z]*|[1-9][0-9]*)(?:-(?:[a-zA-Z]+|[1-9][0-9]*))*\.yml$/;
-const fileNameError = (fileName) => ({
-    keyword: "filename",
-    instancePath: "",
-    message: `the file name "${fileName}" does not match the pattern ${BASE_NAME_PATTERN.source}`
-});
-export const validateFileName = (filePath) => {
-    const fileName = basename(filePath);
-    return BASE_NAME_PATTERN.test(fileName)
-        ? ok(undefined)
-        : error([fileNameError(fileName)]);
-};

package/lib/validation/builders/schema.d.ts

@@ -1,31 +0,0 @@
-import type { default as AjvModule, DefinedError } from "ajv";
-import { Result } from "../../helpers/result.js";
-type Ajv = AjvModule.default;
-export type SchemaError = DefinedError;
-/**
- * The result of validating a single file. Either the valid data or validation
- * errors.
- */
-export type SchemaValidationResult<T> = Result<T, SchemaError[]>;
-/**
- * A function that validates `data` at a specific `filePath` to be of type `T`
- * using a specified `validator`.
- */
-export type SchemaValidator<T> = (validator: Ajv, data: unknown, filePath: string) => SchemaValidationResult<T>;
-/**
- * Options for creating a `TypeValidator`.
- */
-export type SchemaValidatorOptions = {
-    ignoreFileNamePattern?: boolean;
-};
-/**
- * Creates a type validator based on the URL of the type definition source file
- * and options. The source file URL is used to derive it’s corresponding schema
- * location.
- * @param importMetaUrl The `import.meta.url` value of the type definition
- * source file.
- * @param options
- * @returns
- */
-export declare const createSchemaValidator: <T>(importMetaUrl: string, options?: SchemaValidatorOptions) => SchemaValidator<T>;
-export {};

package/lib/validation/builders/schema.js

@@ -1,32 +0,0 @@
-import { basename, relative, sep } from "path";
-import { fileURLToPath } from "url";
-import { libDir } from "../../../build/config.js";
-import { changeFileExtension } from "../../helpers/io.js";
-import { error, ok } from "../../helpers/result.js";
-const schemaIdFromSourcePath = (sourcePath) => {
-    const relativePathOfType = relative(libDir, fileURLToPath(sourcePath));
-    const relativePathOfSchema = changeFileExtension(relativePathOfType, ".schema.json");
-    return "/" + relativePathOfSchema.split(sep).join("/");
-};
-/**
- * Creates a type validator based on the URL of the type definition source file
- * and options. The source file URL is used to derive it’s corresponding schema
- * location.
- * @param importMetaUrl The `import.meta.url` value of the type definition
- * source file.
- * @param options
- * @returns
- */
-export const createSchemaValidator = (importMetaUrl, options = {}) => {
-    const { ignoreFileNamePattern = false } = options;
-    const schemaId = schemaIdFromSourcePath(importMetaUrl);
-    return (validator, data, filePath) => {
-        const fileName = basename(filePath);
-        if (validator.validate(schemaId, data)) {
-            return ok(data);
-        }
-        else {
-            return error(validator.errors ?? []);
-        }
-    };
-};

package/lib/validation/filename.d.ts

@@ -1,9 +0,0 @@
-/**
- * Returns the numeric prefix of a filename, that is, the part before the first
- * underscore.
- */
-export declare const getFIlenamePrefixAsNumericId: (_data: {}, filepath: string) => number;
-/**
- * Returns the filename without the extension.
- */
-export declare const getFilenameAsStringId: (_data: {}, filepath: string) => string;

package/lib/validation/filename.js

@@ -1,10 +0,0 @@
-import { basename, extname } from "node:path";
-/**
- * Returns the numeric prefix of a filename, that is, the part before the first
- * underscore.
- */
-export const getFIlenamePrefixAsNumericId = (_data, filepath) => Number.parseInt(/^(\d+?)_/.exec(basename(filepath))?.[1] ?? "", 10);
-/**
- * Returns the filename without the extension.
- */
-export const getFilenameAsStringId = (_data, filepath) => basename(filepath, extname(filepath));

package/lib/validation/raw.d.ts

@@ -1,9 +0,0 @@
-import { TypeMap } from "../config.js";
-import "../helpers/array.js";
-import { Result } from "../helpers/result.js";
-import { EntityDirectoryPaths, TypeValidationError, ValidationOptions } from "../main.js";
-import { TypeId } from "../typeConfig.js";
-export type TypeIdPair<K extends keyof TypeMap> = [id: TypeId<K>, data: TypeMap[K]];
-export type TypeValidationResult<K extends keyof TypeMap> = Result<TypeIdPair<K>, TypeValidationError[]>;
-export type TypeValidationResultsByType = [keyof TypeMap, [filePath: string, result: TypeValidationResult<keyof TypeMap>][]][];
-export declare const getRawValidationResults: (entityDirectoryPaths: EntityDirectoryPaths, options?: ValidationOptions) => Promise<TypeValidationResultsByType>;

package/lib/validation/raw.js

@@ -1,55 +0,0 @@
-import { readdir } from "fs/promises";
-import { join } from "path";
-import { jsonSchemaDir, jsonSchemaSpec } from "../../build/config.js";
-import { configMap } from "../config.js";
-import "../helpers/array.js";
-import { collator } from "../helpers/i18n.js";
-import { isHiddenFileName, readYamlFile } from "../helpers/io.js";
-import { mapSecond, mapSecondAsync, mapToSecondAsync } from "../helpers/pair.js";
-import { Result, isOk } from "../helpers/result.js";
-import { validateFileName } from "./builders/naming.js";
-import { getPreparedSchemaValidator } from "./schema.js";
-const getFiles = async (path) => (await readdir(path))
-    .sort(collator.compare)
-    .filter(isHiddenFileName)
-    .map(fileName => join(path, fileName))
-    .map(mapToSecondAsync(async (filePath) => {
-    try {
-        return await readYamlFile(filePath);
-    }
-    catch (error) {
-        if (error instanceof Error) {
-            error.message = `in "${filePath}":\n  ${error.message}`;
-        }
-        return null;
-    }
-}))
-    .promiseAll();
-const validateStructuralIntegrityOfFiles = (validator, typeConfig, validateFileName, files) => files.map(mapSecond((data, path) => {
-    const schemaValidationResult = typeConfig.schemaValidator(validator, data, path);
-    const fileNameValidationResult = validateFileName(path);
-    return Result.map(Result.combine(schemaValidationResult, fileNameValidationResult, (data, _) => data, (schemaErrors, fileNameErrors) => [...schemaErrors, ...fileNameErrors]), data => [typeConfig.id(data, path), data]);
-}));
-const validateSemanticAndReferencialIntegrityOfFiles = (validators, typeConfig, results) => results.map(mapSecond((res, path) => Result.reduce(res, ([id, data]) => Result.map(typeConfig.integrityValidator(validators, data, path), () => [id, data]), errors => Result.error(errors))));
-export const getRawValidationResults = async (entityDirectoryPaths, options = {}) => {
-    const { checkIntegrity = false } = options;
-    const validator = await getPreparedSchemaValidator(jsonSchemaSpec, {}, jsonSchemaDir);
-    const entityDirectoryPathEntries = Object.entries(entityDirectoryPaths);
-    const structuralIntegrityResults = await Promise.all(entityDirectoryPathEntries.map(mapSecondAsync(async (path, typeName) => {
-        const files = await getFiles(path);
-        return validateStructuralIntegrityOfFiles(validator, configMap[typeName], validateFileName, files);
-    })));
-    if (checkIntegrity) {
-        const identityIntegrityValidators = Object.fromEntries(structuralIntegrityResults.map(mapSecond(results => {
-            const idCount = results.reduce((mp, [_, result]) => isOk(result) ? mp.set(result.value[0], (mp.get(result.value[0]) ?? 0) + 1) : mp, new Map());
-            return {
-                isUnique: (id) => (idCount.get(id) ?? 0) === 1,
-                exists: (id) => idCount.has(id),
-            };
-        })));
-        return structuralIntegrityResults.map(mapSecond((results, typeName) => validateSemanticAndReferencialIntegrityOfFiles({ identity: identityIntegrityValidators }, configMap[typeName], results)));
-    }
-    else {
-        return structuralIntegrityResults;
-    }
-};

package/lib/validation/schema.d.ts

@@ -1,6 +0,0 @@
-import AjvModule from "ajv";
-import Ajv2019Module from "ajv/dist/2019.js";
-import Ajv2020Module from "ajv/dist/2020.js";
-import { JsonSchemaSpec } from "optolith-tsjsonschemamd/renderers";
-import "../helpers/array.js";
-export declare const getPreparedSchemaValidator: (jsonSchemaSpec: JsonSchemaSpec, validatorOptions: AjvModule.Options | undefined, jsonSchemaDir: string) => Promise<Ajv2019Module.default | Ajv2020Module.default>;

package/lib/validation/schema.js

@@ -1,33 +0,0 @@
-import addFormatsModule from "ajv-formats";
-import Ajv2019Module from "ajv/dist/2019.js";
-import Ajv2020Module from "ajv/dist/2020.js";
-import { JsonSchemaSpec } from "optolith-tsjsonschemamd/renderers";
-import "../helpers/array.js";
-import { isHiddenFileName, readDirectoryRec, readJsonFile } from "../helpers/io.js";
-import { assertExhaustive } from "../helpers/typeSafety.js";
-const Ajv2019 = Ajv2019Module.default;
-const Ajv2020 = Ajv2020Module.default;
-const addFormats = addFormatsModule.default;
-const createSchemaValidator = (jsonSchemaSpec, validatorOptions = {}) => {
-    switch (jsonSchemaSpec) {
-        case JsonSchemaSpec.Draft_07:
-        case JsonSchemaSpec.Draft_2019_09:
-            return new Ajv2019(validatorOptions);
-        case JsonSchemaSpec.Draft_2020_12:
-            return new Ajv2020(validatorOptions);
-        default:
-            assertExhaustive(jsonSchemaSpec);
-    }
-};
-const registerAllJsonSchemaDocuments = async (jsonSchemaDir, validator) => {
-    for await (const jsonSchemaPath of readDirectoryRec(jsonSchemaDir, isHiddenFileName)) {
-        const jsonSchema = await readJsonFile(jsonSchemaPath);
-        validator.addSchema(jsonSchema);
-    }
-};
-export const getPreparedSchemaValidator = async (jsonSchemaSpec, validatorOptions = {}, jsonSchemaDir) => {
-    const validator = createSchemaValidator(jsonSchemaSpec, validatorOptions);
-    await registerAllJsonSchemaDocuments(jsonSchemaDir, validator);
-    addFormats(validator);
-    return validator;
-};