@sanity/validation 3.0.0-v3-pkg-utils.59 → 3.0.0-v3-pkg-utils.79

package/lib/dts/src/index.d.ts

@@ -1,3 +1,4 @@
+import {Observable} from 'rxjs'
 import {RuleClass} from '@sanity/types'
 import type {SanityClient} from '@sanity/client'
 import {SanityDocument} from '@sanity/types'
@@ -19,10 +20,17 @@ export declare function inferFromSchemaType(typeDef: SchemaType): SchemaType
 export declare const Rule: RuleClass
 
 export declare function validateDocument(
-  client: SanityClient,
+  getClient: (options: {apiVersion: string}) => SanityClient,
   doc: SanityDocument,
   schema: Schema,
   context?: Pick<ValidationContext, 'getDocumentExists'>
 ): Promise<ValidationMarker[]>
 
+export declare function validateDocumentObservable(
+  getClient: (options: {apiVersion: string}) => SanityClient,
+  doc: SanityDocument,
+  schema: Schema,
+  context?: Pick<ValidationContext, 'getDocumentExists'>
+): Observable<ValidationMarker[]>
+
 export {}

package/lib/index.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const _excluded = ["value", "type", "path", "parent"];
 
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
@@ -10,9 +12,28 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import { cloneDeep, get, memoize, uniqBy } from 'lodash';
-import { isKeyedObject, isReference, isBlock, isBlockSchemaType, isSpanSchemaType, isTypedObject } from '@sanity/types';
-import formatDate from 'date-fns/format';
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+var lodash = require('lodash');
+
+var types = require('@sanity/types');
+
+var formatDate = require('date-fns/format');
+
+var rxjs = require('rxjs');
+
+var operators = require('rxjs/operators');
+
+function _interopDefaultLegacy(e) {
+  return e && typeof e === 'object' && 'default' in e ? e : {
+    'default': e
+  };
+}
+
+var formatDate__default = /*#__PURE__*/_interopDefaultLegacy(formatDate);
+
 const ValidationError = class ValidationError2 {
   constructor(message) {
     let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -50,7 +71,7 @@ function pathToString() {
       return "".concat(target).concat(separator).concat(segment);
     }
 
-    if (isKeyedObject(segment)) {
+    if (types.isKeyedObject(segment)) {
       return "".concat(target, "[_key==\"").concat(segment._key, "\"]");
     }
 
@@ -575,7 +596,7 @@ const objectValidators = _objectSpread(_objectSpread({}, genericValidators), {},
       return true;
     }
 
-    if (!isReference(value)) {
+    if (!types.isReference(value)) {
       return message || true;
     }
 
@@ -633,7 +654,7 @@ const getFormattedDate = function () {
   }
 
   if (type === "date") {
-    return formatDate(new Date(value), format);
+    return formatDate__default["default"](new Date(value), format);
   }
 
   if (options && options.timeFormat) {
@@ -642,7 +663,7 @@ const getFormattedDate = function () {
     format += " HH:mm";
   }
 
-  return formatDate(new Date(value), format);
+  return formatDate__default["default"](new Date(value), format);
 };
 
 function parseDate(date) {
@@ -792,7 +813,7 @@ const Rule = (_a = class {
     rule._type = this._type;
     rule._message = this._message;
     rule._required = this._required;
-    rule._rules = cloneDeep(this._rules);
+    rule._rules = lodash.cloneDeep(this._rules);
     rule._level = this._level;
     rule._fieldRules = this._fieldRules;
     rule._typeDef = this._typeDef;
@@ -1093,7 +1114,7 @@ const Rule = (_a = class {
       let specConstraint = "constraint" in curr ? curr.constraint : null;
 
       if (isFieldRef(specConstraint)) {
-        specConstraint = get(context.parent, specConstraint.path);
+        specConstraint = lodash.get(context.parent, specConstraint.path);
       }
 
       let result;
@@ -1114,7 +1135,29 @@ const Rule = (_a = class {
   type: FIELD_REF,
   path
 }), _a);
-const memoizedWarnOnArraySlug = memoize(warnOnArraySlug);
+
+const requestIdleCallbackShim = function requestIdleCallbackShim2(callback, options) {
+  const start = Date.now();
+  return window.setTimeout(() => {
+    callback({
+      didTimeout: false,
+
+      timeRemaining() {
+        return Math.max(0, Date.now() - start);
+      }
+
+    });
+  }, 0);
+};
+
+const cancelIdleCallbackShim = function cancelIdleCallbackShim2(handle) {
+  return window.clearTimeout(handle);
+};
+
+const win = typeof window === "undefined" ? void 0 : window;
+const requestIdleCallback = (win == null ? void 0 : win.requestIdleCallback) || requestIdleCallbackShim;
+const cancelIdleCallback = (win == null ? void 0 : win.cancelIdleCallback) || cancelIdleCallbackShim;
+const memoizedWarnOnArraySlug = lodash.memoize(warnOnArraySlug);
 
 function getDocumentIds(id) {
   const isDraft = id.indexOf("drafts.") === 0;
@@ -1127,7 +1170,7 @@ function getDocumentIds(id) {
 function serializePath(path) {
   return path.reduce((target, part, i) => {
     const isIndex = typeof part === "number";
-    const isKey = isKeyedObject(part);
+    const isKey = types.isKeyedObject(part);
     const separator = i === 0 ? "" : ".";
     const add = isIndex || isKey ? "[]" : "".concat(separator).concat(part);
     return "".concat(target).concat(add);
@@ -1136,7 +1179,7 @@ function serializePath(path) {
 
 const defaultIsUnique = (slug, context) => {
   const {
-    client,
+    getClient,
     document,
     path,
     type
@@ -1164,7 +1207,9 @@ const defaultIsUnique = (slug, context) => {
   }
 
   const constraints = ["_type == $docType", "!(_id in [$draft, $published])", "".concat(atPath, " == $slug")].join(" && ");
-  return client.fetch("!defined(*[".concat(constraints, "][0]._id)"), {
+  return getClient({
+    apiVersion: "2022-09-09"
+  }).fetch("!defined(*[".concat(constraints, "][0]._id)"), {
     docType,
     draft,
     published,
@@ -1300,7 +1345,7 @@ const isNonNullable = value => value !== null && value !== void 0;
 function resolveTypeForArrayItem(item, candidates) {
   if (candidates.length === 1) return candidates[0];
 
-  const itemType = isTypedObject(item) && item._type;
+  const itemType = types.isTypedObject(item) && item._type;
 
   const primitive = item === void 0 || item === null || !itemType && typeString(item).toLowerCase();
 
@@ -1315,36 +1360,57 @@ function resolveTypeForArrayItem(item, candidates) {
   }) || candidates.find(candidate => candidate.name === itemType) || candidates.find(candidate => candidate.name === "object" && primitive === "object");
 }
 
-async function validateDocument(client, doc, schema, context) {
+const EMPTY_MARKERS = [];
+
+async function validateDocument(getClient, doc, schema, context) {
+  return validateDocumentObservable(getClient, doc, schema, context).toPromise();
+}
+
+function validateDocumentObservable(getClient, 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 [];
+    return rxjs.of(EMPTY_MARKERS);
   }
 
-  try {
-    return await validateItem({
-      client,
-      schema,
-      parent: void 0,
-      value: doc,
-      path: [],
-      document: doc,
-      type: documentType,
-      getDocumentExists: context == null ? void 0 : context.getDocumentExists
+  const client = getClient({
+    apiVersion: "2021-06-07"
+  });
+  const validationOptions = {
+    client,
+    getClient,
+    schema,
+    parent: void 0,
+    value: doc,
+    path: [],
+    document: doc,
+    type: documentType,
+    getDocumentExists: context == null ? void 0 : context.getDocumentExists
+  };
+  const wrappedClient = client;
+  validationOptions.client = [...Object.keys(client), ...Object.keys(wrappedClient.__proto__)].reduce((acc, key) => {
+    const original = Object.hasOwnProperty.call(client, key) ? wrappedClient[key] : wrappedClient.__proto__[key];
+    return Object.defineProperty(acc, key, {
+      get() {
+        console.warn('`configContext.client` is deprecated and will be removed in the next release! Use `context.getClient({apiVersion: "2021-06-07"})` instead');
+        return original;
+      }
+
     });
-  } catch (err) {
+  }, {});
+  return validateItemObservable(validationOptions).pipe(operators.catchError(err => {
     console.error(err);
-    return [{
+    return rxjs.of([{
+      type: "validation",
       level: "error",
       path: [],
       item: new ValidationError(err == null ? void 0 : err.message)
-    }];
-  }
+    }]);
+  }));
 }
 
-async function validateItem(_ref) {
+function validateItemObservable(_ref) {
   let {
     value,
     type,
@@ -1354,11 +1420,11 @@ async function validateItem(_ref) {
       restOfContext = _objectWithoutProperties(_ref, _excluded);
 
   const rules = normalizeValidationRules(type);
-  const selfChecks = rules.map(rule => rule.validate(value, _objectSpread(_objectSpread({}, restOfContext), {}, {
+  const selfChecks = rules.map(rule => rxjs.defer(() => rule.validate(value, _objectSpread(_objectSpread({}, restOfContext), {}, {
     parent,
     path,
     type
-  })));
+  }))));
   let nestedChecks = [];
   const selfIsRequired = rules.some(rule => rule.isRequired());
   const shouldRunNestedObjectValidation = (type == null ? void 0 : type.jsonType) === "object" && (!!value || (value === null || value === void 0) && selfIsRequired);
@@ -1375,14 +1441,14 @@ async function validateItem(_ref) {
         validation
       })).map(subRule => {
         const nestedValue = isRecord(value) ? value[name] : void 0;
-        return subRule.validate(nestedValue, _objectSpread(_objectSpread({}, restOfContext), {}, {
+        return rxjs.defer(() => subRule.validate(nestedValue, _objectSpread(_objectSpread({}, restOfContext), {}, {
           parent: value,
           path: path.concat(name),
           type: fieldType
-        }));
+        })));
       });
     }));
-    nestedChecks = nestedChecks.concat(type.fields.map(field => validateItem(_objectSpread(_objectSpread({}, restOfContext), {}, {
+    nestedChecks = nestedChecks.concat(type.fields.map(field => validateItemObservable(_objectSpread(_objectSpread({}, restOfContext), {}, {
       parent: value,
       value: isRecord(value) ? value[field.name] : void 0,
       path: path.concat(field.name),
@@ -1393,26 +1459,26 @@ async function validateItem(_ref) {
   const shouldRunNestedValidationForArrays = (type == null ? void 0 : type.jsonType) === "array" && Array.isArray(value);
 
   if (shouldRunNestedValidationForArrays) {
-    nestedChecks = nestedChecks.concat(value.map(item => validateItem(_objectSpread(_objectSpread({}, restOfContext), {}, {
+    nestedChecks = nestedChecks.concat(value.map(item => validateItemObservable(_objectSpread(_objectSpread({}, restOfContext), {}, {
       parent: value,
       value: item,
-      path: path.concat(isKeyedObject(item) ? {
+      path: path.concat(types.isKeyedObject(item) ? {
         _key: item._key
       } : value.indexOf(item)),
       type: resolveTypeForArrayItem(item, type.of)
     }))));
   }
 
-  const shouldRunNestedValidationForMarkDefs = isBlock(value) && value.markDefs.length && isBlockSchemaType(type);
+  const shouldRunNestedValidationForMarkDefs = types.isBlock(value) && value.markDefs.length && types.isBlockSchemaType(type);
 
   if (shouldRunNestedValidationForMarkDefs) {
     const [spanChildrenField] = type.fields;
-    const spanType = spanChildrenField.type.of.find(isSpanSchemaType);
-    const annotations = ((spanType == null ? void 0 : spanType.annotations) || []).reduce((map, annotationType) => {
-      map.set(annotationType.name, annotationType);
-      return map;
+    const spanType = spanChildrenField.type.of.find(types.isSpanSchemaType);
+    const annotations = ((spanType == null ? void 0 : spanType.annotations) || []).reduce((acc, annotationType) => {
+      acc.set(annotationType.name, annotationType);
+      return acc;
     }, /* @__PURE__ */new Map());
-    nestedChecks = nestedChecks.concat(value.markDefs.map(markDef => validateItem(_objectSpread(_objectSpread({}, restOfContext), {}, {
+    nestedChecks = nestedChecks.concat(value.markDefs.map(markDef => validateItemObservable(_objectSpread(_objectSpread({}, restOfContext), {}, {
       parent: value,
       value: markDef,
       path: path.concat(["markDefs", {
@@ -1422,13 +1488,24 @@ async function validateItem(_ref) {
     }))));
   }
 
-  const results = (await Promise.all([...selfChecks, ...nestedChecks])).flat();
+  return rxjs.defer(() => rxjs.merge([...selfChecks, ...nestedChecks])).pipe(operators.mergeMap(validateNode => rxjs.concat(idle(), validateNode), 40), operators.mergeAll(), operators.toArray(), operators.map(lodash.flatten), operators.map(results => {
+    if (rules.some(rule => rule._fieldRules)) {
+      return lodash.uniqBy(results, rule => JSON.stringify(rule));
+    }
 
-  if (rules.some(rule => rule._fieldRules)) {
-    return uniqBy(results, rule => JSON.stringify(rule));
-  }
+    return results;
+  }));
+}
 
-  return results;
+function idle(timeout) {
+  return new rxjs.Observable(observer => {
+    const handle = requestIdleCallback(() => {
+      observer.complete();
+    }, timeout ? {
+      timeout
+    } : void 0);
+    return () => cancelIdleCallback(handle);
+  });
 }
 
 function traverse(typeDef, visited) {
@@ -1475,5 +1552,9 @@ function inferFromSchema(schema) {
   return schema;
 }
 
-export { Rule, inferFromSchema, inferFromSchemaType, validateDocument };
+exports.Rule = Rule;
+exports.inferFromSchema = inferFromSchema;
+exports.inferFromSchemaType = inferFromSchemaType;
+exports.validateDocument = validateDocument;
+exports.validateDocumentObservable = validateDocumentObservable;
 //# sourceMappingURL=index.js.map