Files
directus/packages/utils/shared/validate-payload.ts
Rijk van Zanten 2983e61870 The Great TypeScript Modernization Program Season 3 Episode 6: The Big One (#18014)
* Step 1

* Step 2

* False sense of confidence

* Couple more before dinner

* Update schema package

* Update format-title

* Upgrade specs file

* Close

* Replace ts-node-dev with tsx, and various others

* Replace lodash with lodash-es

* Add lodash-es types

* Update knex import

* More fun is had

* FSE

* Consolidate repos

* Various tweaks and fixes

* Fix specs

* Remove dependency on knex-schema-inspector

* Fix wrong imports of inspector

* Move shared exceptions to new package

* Move constants to separate module

* Move types to new types package

* Use directus/types

* I believe this is no longer needed

* [WIP] Start moving utils to esm

* ESMify Shared

* Move shared utils to  @directus/utils

* Use @directus/utils instead of @directus/shared/utils

* It runs!

* Use correct schemaoverview type

* Fix imports

* Fix the thing

* Start on new update-checker lib

* Use new update-check package

* Swap out directus/shared in app

* Pushing through the last bits now

* Dangerously make extensions SDK ESM

* Use @directus/types in tests

* Copy util function to test

* Fix linter config

* Add missing import

* Hot takes

* Fix build

* Curse these default exports

* No tests in constants

* Add tests

* Remove tests from types

* Add tests for exceptions

* Fix test

* Fix app tests

* Fix import in test

* Fix various tests

* Fix specs export

* Some more tests

* Remove broken integration tests

These were broken beyond repair.. They were also written before we really knew what we we're doing with tests, so I think it's better to say goodbye and start over with these

* Regenerate lockfile

* Fix imports from merge

* I create my own problems

* Make sharp play nice

* Add vitest config

* Install missing blackbox dep

* Consts shouldn't be in types

tsk tsk tsk tsk

* Fix type/const usage in extensions-sdk

* cursed.default

* Reduce circular deps

* Fix circular dep in items service

* vvv

* Trigger testing for all vendors

* Add workaround for rollup

* Prepend the file protocol for the ESM loader to be compatible with Windows
"WARN: Only URLs with a scheme in: file and data are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'"

* Fix postgres

* Schema package updates

Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>

* Resolve cjs/mjs extensions

* Clean-up eslint config

* fixed extension concatination

* using string interpolation for consistency

* Revert MySQL optimisation

* Revert testing for all vendors

* Replace tsx with esbuild-kit/esm-loader

Is a bit faster and we can rely on the built-in `watch` and `inspect`
functionalities of Node.js

Note: The possibility to watch other files (.env in our case) might be
added in the future, see https://github.com/nodejs/node/issues/45467

* Use exact version for esbuild-kit/esm-loader

* Fix import

---------

Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: Brainslug <tim@brainslug.nl>
Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-04-04 17:41:56 -04:00

66 lines
1.9 KiB
TypeScript

import type { FieldFilter, Filter } from '@directus/types';
import { flatten } from 'lodash-es';
import { generateJoi, JoiOptions } from './generate-joi.js';
import { injectFunctionResults } from './inject-function-results.js';
import type Joi from 'joi';
/**
* Validate the payload against the given filter rules
*
* @param {Filter} filter - The filter rules to check against
* @param {Record<string, any>} payload - The payload to validate
* @param {JoiOptions} [options] - Optional options to pass to Joi
* @returns Array of errors
*/
export function validatePayload(
filter: Filter,
payload: Record<string, any>,
options?: JoiOptions
): Joi.ValidationError[] {
const errors: Joi.ValidationError[] = [];
/**
* Note there can only be a single _and / _or per level
*/
if (Object.keys(filter)[0] === '_and') {
const subValidation = Object.values(filter)[0] as FieldFilter[];
const nestedErrors = flatten<Joi.ValidationError>(
subValidation.map((subObj: Record<string, any>) => {
return validatePayload(subObj, payload, options);
})
).filter((err?: Joi.ValidationError) => err);
errors.push(...nestedErrors);
} else if (Object.keys(filter)[0] === '_or') {
const subValidation = Object.values(filter)[0] as FieldFilter[];
const swallowErrors: Joi.ValidationError[] = [];
const pass = subValidation.some((subObj: Record<string, any>) => {
const nestedErrors = validatePayload(subObj, payload, options);
if (nestedErrors.length > 0) {
swallowErrors.push(...nestedErrors);
return false;
}
return true;
});
if (!pass) {
errors.push(...swallowErrors);
}
} else {
const payloadWithFunctions = injectFunctionResults(payload, filter);
const schema = generateJoi(filter as FieldFilter, options);
const { error } = schema.validate(payloadWithFunctions, { abortEarly: false });
if (error) {
errors.push(error);
}
}
return errors;
}