@sanity/validation 2.30.0 → 2.30.1-dev-preview.1013

package/lib/dts/src/validateDocument.js

@@ -0,0 +1,142 @@
+import { isKeyedObject, isTypedObject, isBlock, isBlockSchemaType, isSpanSchemaType, } from '@sanity/types';
+import { uniqBy } from 'lodash';
+import typeString from './util/typeString';
+import ValidationErrorClass from './ValidationError';
+import normalizeValidationRules from './util/normalizeValidationRules';
+const isRecord = (maybeRecord) => typeof maybeRecord === 'object' && maybeRecord !== null && !Array.isArray(maybeRecord);
+const isNonNullable = (value) => value !== null && value !== undefined;
+/**
+ * @internal
+ */
+export function resolveTypeForArrayItem(item, candidates) {
+    // if there is only one type available, assume that it's the correct one
+    if (candidates.length === 1)
+        return candidates[0];
+    const itemType = isTypedObject(item) && item._type;
+    const primitive = item === undefined || item === null || (!itemType && typeString(item).toLowerCase());
+    if (primitive && primitive !== 'object') {
+        return candidates.find((candidate) => candidate.jsonType === primitive);
+    }
+    return (candidates.find((candidate) => candidate.type?.name === itemType) ||
+        candidates.find((candidate) => candidate.name === itemType) ||
+        candidates.find((candidate) => candidate.name === 'object' && primitive === 'object'));
+}
+export default async function validateDocument(client, doc, schema, context) {
+    const documentType = schema.get(doc._type);
+    if (!documentType) {
+        console.warn('Schema type for object type "%s" not found, skipping validation', doc._type);
+        return [];
+    }
+    try {
+        return await validateItem({
+            client,
+            parent: undefined,
+            value: doc,
+            path: [],
+            document: doc,
+            type: documentType,
+            getDocumentExists: context?.getDocumentExists,
+        });
+    }
+    catch (err) {
+        console.error(err);
+        return [
+            {
+                level: 'error',
+                path: [],
+                item: new ValidationErrorClass(err?.message),
+            },
+        ];
+    }
+}
+export async function validateItem({ value, type, path = [], parent, ...restOfContext }) {
+    const rules = normalizeValidationRules(type);
+    // run validation for the current value
+    const selfChecks = rules.map((rule) => rule.validate(value, {
+        ...restOfContext,
+        parent,
+        path,
+        type,
+    }));
+    // run validation for nested values (conditionally)
+    let nestedChecks = [];
+    const selfIsRequired = rules.some((rule) => rule.isRequired());
+    const shouldRunNestedObjectValidation = 
+    // run nested validation for objects
+    type?.jsonType === 'object' &&
+        // if the value is truthy
+        (!!value || // or
+            // (the value is null or undefined) and the top-level value is required
+            ((value === null || value === undefined) && selfIsRequired));
+    if (shouldRunNestedObjectValidation) {
+        const fieldTypes = type.fields.reduce((acc, field) => {
+            acc[field.name] = field.type;
+            return acc;
+        }, {});
+        // Validation for rules set at the object level with `Rule.fields({/* ... */})`
+        nestedChecks = nestedChecks.concat(rules
+            .map((rule) => rule._fieldRules)
+            .filter(isNonNullable)
+            .flatMap((fieldResults) => Object.entries(fieldResults))
+            .flatMap(([name, validation]) => {
+            const fieldType = fieldTypes[name];
+            return normalizeValidationRules({ ...fieldType, validation }).map((subRule) => {
+                const nestedValue = isRecord(value) ? value[name] : undefined;
+                return subRule.validate(nestedValue, {
+                    ...restOfContext,
+                    parent: value,
+                    path: path.concat(name),
+                    type: fieldType,
+                });
+            });
+        }));
+        // Validation from each field's schema `validation: Rule => {/* ... */}` function
+        nestedChecks = nestedChecks.concat(type.fields.map((field) => validateItem({
+            ...restOfContext,
+            parent: value,
+            value: isRecord(value) ? value[field.name] : undefined,
+            path: path.concat(field.name),
+            type: field.type,
+        })));
+    }
+    // note: unlike objects, arrays should not run nested validation for undefined
+    // values because we won't have a valid path to put a marker (i.e. missing the
+    // key or index in the path) and the downstream form builder won't have a
+    // valid target component
+    const shouldRunNestedValidationForArrays = type?.jsonType === 'array' && Array.isArray(value);
+    if (shouldRunNestedValidationForArrays) {
+        nestedChecks = nestedChecks.concat(value.map((item) => validateItem({
+            ...restOfContext,
+            parent: value,
+            value: item,
+            path: path.concat(isKeyedObject(item) ? { _key: item._key } : value.indexOf(item)),
+            type: resolveTypeForArrayItem(item, type.of),
+        })));
+    }
+    // markDefs also do no run nested validation if the parent object is undefined
+    // for a similar reason to arrays
+    const shouldRunNestedValidationForMarkDefs = isBlock(value) && value.markDefs.length && isBlockSchemaType(type);
+    if (shouldRunNestedValidationForMarkDefs) {
+        const [spanChildrenField] = type.fields;
+        const spanType = spanChildrenField.type.of.find(isSpanSchemaType);
+        const annotations = (spanType?.annotations || []).reduce((map, annotationType) => {
+            map.set(annotationType.name, annotationType);
+            return map;
+        }, new Map());
+        nestedChecks = nestedChecks.concat(value.markDefs.map((markDef) => validateItem({
+            ...restOfContext,
+            parent: value,
+            value: markDef,
+            path: path.concat(['markDefs', { _key: markDef._key }]),
+            type: annotations.get(markDef._type),
+        })));
+    }
+    const results = (await Promise.all([...selfChecks, ...nestedChecks])).flat();
+    // run `uniqBy` if `_fieldRules` are present because they can
+    // cause repeat markers
+    if (rules.some((rule) => rule._fieldRules)) {
+        return uniqBy(results, (rule) => JSON.stringify(rule));
+    }
+    return results;
+}
+//# sourceMappingURL=validateDocument.js.map

package/lib/dts/src/validateDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateDocument.js","sourceRoot":"","sources":["../../../src/validateDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,aAAa,EACb,aAAa,EACb,OAAO,EACP,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAA;AAE7B,OAAO,UAAU,MAAM,mBAAmB,CAAA;AAC1C,OAAO,oBAAoB,MAAM,mBAAmB,CAAA;AACpD,OAAO,wBAAwB,MAAM,iCAAiC,CAAA;AAEtE,MAAM,QAAQ,GAAG,CAAC,WAAoB,EAA0C,EAAE,CAChF,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;AAExF,MAAM,aAAa,GAAG,CAAI,KAAQ,EAA2B,EAAE,CAC7D,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAA;AAEvC;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,IAAa,EACb,UAAwB;IAExB,wEAAwE;IACxE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAA;IAEjD,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAA;IAClD,MAAM,SAAS,GACb,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;IAEtF,IAAI,SAAS,IAAI,SAAS,KAAK,QAAQ,EAAE;QACvC,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;KACxE;IAED,OAAO,CACL,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC;QACjE,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC;QAC3D,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,QAAQ,IAAI,SAAS,KAAK,QAAQ,CAAC,CACtF,CAAA;AACH,CAAC;AAED,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,gBAAgB,CAC5C,MAAoB,EACpB,GAAmB,EACnB,MAAc,EACd,OAAsD;IAEtD,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAC1C,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,iEAAiE,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;QAC1F,OAAO,EAAE,CAAA;KACV;IAED,IAAI;QACF,OAAO,MAAM,YAAY,CAAC;YACxB,MAAM;YACN,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,EAAE;YACR,QAAQ,EAAE,GAAG;YACb,IAAI,EAAE,YAAY;YAClB,iBAAiB,EAAE,OAAO,EAAE,iBAAiB;SAC9C,CAAC,CAAA;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAClB,OAAO;YACL;gBACE,KAAK,EAAE,OAAO;gBACd,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,IAAI,oBAAoB,CAAC,GAAG,EAAE,OAAO,CAAC;aAC7C;SACF,CAAA;KACF;AACH,CAAC;AAiBD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,KAAK,EACL,IAAI,EACJ,IAAI,GAAG,EAAE,EACT,MAAM,EACN,GAAG,aAAa,EACI;IACpB,MAAM,KAAK,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAA;IAE5C,uCAAuC;IACvC,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;QACnB,GAAG,aAAa;QAChB,MAAM;QACN,IAAI;QACJ,IAAI;KACL,CAAC,CACH,CAAA;IAED,mDAAmD;IACnD,IAAI,YAAY,GAAuC,EAAE,CAAA;IAEzD,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;IAC9D,MAAM,+BAA+B;IACnC,oCAAoC;IACpC,IAAI,EAAE,QAAQ,KAAK,QAAQ;QAC3B,yBAAyB;QACzB,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK;YACf,uEAAuE;YACvE,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,IAAI,cAAc,CAAC,CAAC,CAAA;IAEhE,IAAI,+BAA+B,EAAE;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAA6B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC/E,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAA;YAC5B,OAAO,GAAG,CAAA;QACZ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEN,+EAA+E;QAC/E,YAAY,GAAG,YAAY,CAAC,MAAM,CAChC,KAAK;aACF,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;aAC/B,MAAM,CAAC,aAAa,CAAC;aACrB,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;aACvD,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;YAC9B,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;YAClC,OAAO,wBAAwB,CAAC,EAAC,GAAG,SAAS,EAAE,UAAU,EAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC1E,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;gBAC7D,OAAO,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACnC,GAAG,aAAa;oBAChB,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;oBACvB,IAAI,EAAE,SAAS;iBAChB,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CACL,CAAA;QAED,iFAAiF;QACjF,YAAY,GAAG,YAAY,CAAC,MAAM,CAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,YAAY,CAAC;YACX,GAAG,aAAa;YAChB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YACtD,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC,CACH,CACF,CAAA;KACF;IAED,8EAA8E;IAC9E,8EAA8E;IAC9E,yEAAyE;IACzE,yBAAyB;IACzB,MAAM,kCAAkC,GAAG,IAAI,EAAE,QAAQ,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE7F,IAAI,kCAAkC,EAAE;QACtC,YAAY,GAAG,YAAY,CAAC,MAAM,CAChC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACjB,YAAY,CAAC;YACX,GAAG,aAAa;YAChB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChF,IAAI,EAAE,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;SAC7C,CAAC,CACH,CACF,CAAA;KACF;IAED,8EAA8E;IAC9E,iCAAiC;IACjC,MAAM,oCAAoC,GACxC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAEpE,IAAI,oCAAoC,EAAE;QACxC,MAAM,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA;QACvC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAEjE,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,MAAM,CACtD,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE;YACtB,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;YAC5C,OAAO,GAAG,CAAA;QACZ,CAAC,EACD,IAAI,GAAG,EAAE,CACV,CAAA;QAED,YAAY,GAAG,YAAY,CAAC,MAAM,CAChC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAC7B,YAAY,CAAC;YACX,GAAG,aAAa;YAChB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAC,CAAC,CAAC;YACrD,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC;SACrC,CAAC,CACH,CACF,CAAA;KACF;IAED,MAAM,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAE5E,6DAA6D;IAC7D,uBAAuB;IACvB,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;QAC1C,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;KACvD;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/lib/dts/src/validateDocument.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateDocument.test.d.ts","sourceRoot":"","sources":["../../../src/validateDocument.test.ts"],"names":[],"mappings":""}