@strapi/utils/dist/validate/visitors/throw-disallowed-fields.js

Shared utilities for the Strapi packages

'use strict';

var fp = require('lodash/fp');
var utils = require('../utils.js');

var throwDisallowedFields = ((allowedFields = null)=>({ key, path: { attribute: path } })=>{
        // All fields are allowed
        if (allowedFields === null) {
            return;
        }
        // Throw on invalid formats
        if (!(fp.isArray(allowedFields) && allowedFields.every(fp.isString))) {
            throw new TypeError(`Expected array of strings for allowedFields but got "${typeof allowedFields}"`);
        }
        if (fp.isNil(path)) {
            return;
        }
        const containedPaths = getContainedPaths(path);
        /**
     * Tells if the current path should be kept or not based
     * on the success of the check functions for any of the allowed paths.
     *
     * The check functions are defined as follow:
     *
     * `containedPaths.includes(p)`
     * @example
     * ```js
     * const path = 'foo.bar.field';
     * const p = 'foo.bar';
     * // it should match
     *
     * const path = 'foo.bar.field';
     * const p = 'bar.foo';
     * // it shouldn't match
     *
     * const path = 'foo.bar';
     * const p = 'foo.bar.field';
     * // it should match but isn't handled by this check
     * ```
     *
     * `p.startsWith(`${path}.`)`
     * @example
     * ```js
     * const path = 'foo.bar';
     * const p = 'foo.bar.field';
     * // it should match
     *
     * const path = 'foo.bar.field';
     * const p = 'bar.foo';
     * // it shouldn't match
     *
     * const path = 'foo.bar.field';
     * const p = 'foo.bar';
     * // it should match but isn't handled by this check
     * ```
     */ const isPathAllowed = allowedFields.some((p)=>containedPaths.includes(p) || p.startsWith(`${path}.`));
        if (isPathAllowed) {
            return;
        }
        // throw otherwise
        utils.throwInvalidKey({
            key,
            path
        });
    });
/**
 * Retrieve the list of allowed paths based on the given path
 *
 * @example
 * ```js
 * const containedPaths = getContainedPaths('foo');
 * // ['foo']
 *
 *  * const containedPaths = getContainedPaths('foo.bar');
 * // ['foo', 'foo.bar']
 *
 *  * const containedPaths = getContainedPaths('foo.bar.field');
 * // ['foo', 'foo.bar', 'foo.bar.field']
 * ```
 */ const getContainedPaths = (path)=>{
    const parts = fp.toPath(path);
    return parts.reduce((acc, value, index, list)=>{
        return [
            ...acc,
            list.slice(0, index + 1).join('.')
        ];
    }, []);
};

module.exports = throwDisallowedFields;
//# sourceMappingURL=throw-disallowed-fields.js.map