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

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@sanity/validation",
-  "version": "3.0.0-v3-pkg-utils.59+a412550301",
+  "version": "3.0.0-v3-pkg-utils.79+73676e30fc",
   "description": "Validation and warning infrastructure for Sanity projects",
-  "source": "./src/index.ts",
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.js",
   "types": "./lib/dts/src/index.d.ts",
+  "source": "./src/index.ts",
+  "module": "./lib/index.mjs",
+  "main": "./lib/index.js",
   "files": [
     "lib",
     "src"
@@ -43,17 +43,18 @@
     "directory": "packages/@sanity/validation"
   },
   "dependencies": {
-    "@sanity/types": "3.0.0-v3-pkg-utils.59+a412550301",
+    "@sanity/types": "3.0.0-v3-pkg-utils.79+73676e30fc",
     "date-fns": "^2.26.1",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "rxjs": "^6.5.3"
   },
   "devDependencies": {
-    "@sanity/client": "^3.3.3",
-    "@sanity/schema": "3.0.0-v3-pkg-utils.59+a412550301"
+    "@sanity/client": "^3.4.1",
+    "@sanity/schema": "3.0.0-v3-pkg-utils.79+73676e30fc"
   },
   "peerDependencies": {
-    "@sanity/client": "^3.3.3",
+    "@sanity/client": "^3.4.1",
     "@sanity/schema": "dev-preview"
   },
-  "gitHead": "a412550301a93eba1dea643753e5b54f12b6fdae"
+  "gitHead": "73676e30fcc7d17f60ca574f45b632eb6823b60f"
 }

package/src/index.ts

@@ -5,3 +5,5 @@ import inferFromSchemaType from './inferFromSchemaType'
 
 // export default {Rule: RuleClass, validateDocument, inferFromSchema, inferFromSchemaType}
 export {RuleClass as Rule, validateDocument, inferFromSchema, inferFromSchemaType}
+
+export {validateDocumentObservable} from './validateDocument'

package/src/util/requestIdleCallback.ts

@@ -0,0 +1,31 @@
+/**
+ * Simple requestIdleCallback polyfill
+ * Can be removed when all browsers support requestIdleCallback: https://caniuse.com/requestidlecallback
+ * @param callback
+ * @param options
+ */
+const requestIdleCallbackShim: typeof window.requestIdleCallback = function requestIdleCallbackShim(
+  callback,
+  options?
+): number {
+  const start = Date.now()
+  return window.setTimeout(() => {
+    callback({
+      didTimeout: false,
+      timeRemaining() {
+        return Math.max(0, Date.now() - start)
+      },
+    })
+  }, 0)
+}
+
+const cancelIdleCallbackShim: typeof window.cancelIdleCallback = function cancelIdleCallbackShim(
+  handle: number
+): void {
+  return window.clearTimeout(handle)
+}
+
+const win = typeof window === 'undefined' ? undefined : window
+
+export const requestIdleCallback = win?.requestIdleCallback || requestIdleCallbackShim
+export const cancelIdleCallback = win?.cancelIdleCallback || cancelIdleCallbackShim

package/src/validateDocument.test.ts

@@ -1,3 +1,4 @@
+import type {SanityClient} from '@sanity/client'
 import {Rule, SchemaType, SanityDocument, Schema, ArraySchemaType, Block} from '@sanity/types'
 import {createSchema} from '../test/createSchema'
 import {createMockSanityClient} from '../test/mocks/mockSanityClient'
@@ -17,7 +18,8 @@ beforeEach(() => {
 })
 
 // mock client
-const client = createMockSanityClient()
+const client = createMockSanityClient() as any as SanityClient
+const getClient = (options: {apiVersion: string}) => client
 
 describe('resolveTypeForArrayItem', () => {
   const schema: Schema = createSchema({
@@ -93,7 +95,7 @@ describe('validateDocument', () => {
       title: null,
     }
 
-    const result = await validateDocument(client as any, document, schema)
+    const result = await validateDocument(getClient, document, schema)
     expect(result).toMatchObject([
       {
         level: 'error',
@@ -167,7 +169,8 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
-        client: client as any,
+        client,
+        getClient,
         schema,
         value: {},
         document: undefined,
@@ -237,7 +240,8 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
-        client: client as any,
+        client,
+        getClient,
         schema,
         document: undefined,
         parent: undefined,
@@ -404,7 +408,8 @@ describe('validateItem', () => {
     }
 
     const result = await validateItem({
-      client: client as any,
+      client,
+      getClient,
       schema,
       document: document,
       parent: undefined,
@@ -507,7 +512,8 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
-        client: client as any,
+        client,
+        getClient,
         schema,
         document: undefined,
         parent: undefined,
@@ -606,7 +612,8 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
-        client: client as any,
+        client,
+        getClient,
         schema,
         value,
         type: rootType,
@@ -691,83 +698,4 @@ describe('validateItem', () => {
       },
     ])
   })
-
-  it('runs all nested validation checks concurrently', async () => {
-    type Resolver = (value: true) => void
-    const resolvers = new Set<Resolver>()
-    const customValidationFn = () => new Promise<true>((resolve) => resolvers.add(resolve))
-
-    const schema: Schema = createSchema({
-      types: [
-        {
-          name: 'root',
-          type: 'object',
-          fields: [
-            {
-              name: 'level1Object',
-              type: 'object',
-              validation: (rule: Rule) => [
-                rule.custom(customValidationFn),
-                rule.fields({
-                  level2String: (r) => r.custom(customValidationFn),
-                }),
-              ],
-              fields: [
-                {
-                  name: 'level2String',
-                  type: 'string',
-                  validation: (rule: Rule) => rule.custom(customValidationFn),
-                },
-              ],
-            },
-            {
-              name: 'level1Array',
-              type: 'array',
-              validation: (rule: Rule) => rule.custom(customValidationFn),
-              of: [
-                {
-                  type: 'object',
-                  fields: [
-                    {
-                      name: 'level2Number',
-                      type: 'number',
-                      validation: (rule: Rule) => rule.custom(customValidationFn),
-                    },
-                  ],
-                },
-              ],
-            },
-          ],
-          validation: (rule: Rule) => rule.custom(customValidationFn),
-        },
-      ],
-    })
-
-    const value = {
-      level1Object: {level3String: 'a string'},
-      level1Array: [{level2Number: 5}],
-    }
-
-    const resultPromise = validateItem({
-      client: client as any,
-      schema,
-      value,
-      document: undefined,
-      parent: undefined,
-      path: undefined,
-      type: schema.get('root'),
-      getDocumentExists: undefined,
-    })
-
-    // after `validateItem(...)` has been initiated, all of the custom
-    // validation calls should have fired so the resolver size should equal the
-    // amount of total fields
-    expect(resolvers.size).toBe(6)
-
-    for (const resolver of resolvers) {
-      resolver(true)
-    }
-
-    await resultPromise
-  })
 })

package/src/validateDocument.ts

@@ -10,9 +10,12 @@ import {
   isBlockSchemaType,
   isSpanSchemaType,
 } from '@sanity/types'
-import {uniqBy} from 'lodash'
+import {concat, defer, merge, Observable, of} from 'rxjs'
+import {catchError, map, mergeAll, mergeMap, toArray} from 'rxjs/operators'
+import {flatten, uniqBy} from 'lodash'
 import type {SanityClient} from '@sanity/client'
 import typeString from './util/typeString'
+import {cancelIdleCallback, requestIdleCallback} from './util/requestIdleCallback'
 import ValidationErrorClass from './ValidationError'
 import normalizeValidationRules from './util/normalizeValidationRules'
 
@@ -46,40 +49,78 @@ export function resolveTypeForArrayItem(
     candidates.find((candidate) => candidate.name === 'object' && primitive === 'object')
   )
 }
+const EMPTY_MARKERS: ValidationMarker[] = []
 
 export default async function validateDocument(
-  client: SanityClient,
+  getClient: (options: {apiVersion: string}) => SanityClient,
   doc: SanityDocument,
   schema: Schema,
   context?: Pick<ValidationContext, 'getDocumentExists'>
 ): Promise<ValidationMarker[]> {
+  return validateDocumentObservable(getClient, doc, schema, context).toPromise()
+}
+
+export function validateDocumentObservable(
+  getClient: (options: {apiVersion: string}) => SanityClient,
+  doc: SanityDocument,
+  schema: Schema,
+  context?: Pick<ValidationContext, 'getDocumentExists'>
+): Observable<ValidationMarker[]> {
   const documentType = schema.get(doc._type)
   if (!documentType) {
     console.warn('Schema type for object type "%s" not found, skipping validation', doc._type)
-    return []
+    return of(EMPTY_MARKERS)
   }
 
-  try {
-    return await validateItem({
-      client,
-      schema,
-      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),
-      },
-    ]
+  const client = getClient({apiVersion: '2021-06-07'})
+  const validationOptions: ValidateItemOptions = {
+    client,
+    getClient,
+    schema,
+    parent: undefined,
+    value: doc,
+    path: [],
+    document: doc,
+    type: documentType,
+    getDocumentExists: context?.getDocumentExists,
   }
+
+  // <TEMPORARY UGLY HACK TO PRINT DEPRECATION WARNINGS ON USE>
+  /* eslint-disable no-proto */
+  const wrappedClient = client as any
+  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
+      },
+    })
+  }, {}) as any as SanityClient
+  /* eslint-enable no-proto */
+  // </TEMPORARY UGLY HACK TO PRINT DEPRECATION WARNINGS ON USE>
+
+  return validateItemObservable(validationOptions).pipe(
+    catchError((err) => {
+      console.error(err)
+      return of([
+        {
+          type: 'validation' as const,
+          level: 'error' as const,
+          path: [],
+          item: new ValidationErrorClass(err?.message),
+        },
+      ])
+    })
+  )
 }
 
 /**
@@ -97,27 +138,32 @@ type ValidateItemOptions = {
   value: unknown
 } & ExplicitUndefined<ValidationContext>
 
-export async function validateItem({
+export function validateItem(opts: ValidateItemOptions): Promise<ValidationMarker[]> {
+  return validateItemObservable(opts).toPromise()
+}
+
+function validateItemObservable({
   value,
   type,
   path = [],
   parent,
   ...restOfContext
-}: ValidateItemOptions): Promise<ValidationMarker[]> {
+}: ValidateItemOptions): Observable<ValidationMarker[]> {
   const rules = normalizeValidationRules(type)
-
   // run validation for the current value
   const selfChecks = rules.map((rule) =>
-    rule.validate(value, {
-      ...restOfContext,
-      parent,
-      path,
-      type,
-    })
+    defer(() =>
+      rule.validate(value, {
+        ...restOfContext,
+        parent,
+        path,
+        type,
+      })
+    )
   )
 
   // run validation for nested values (conditionally)
-  let nestedChecks: Array<Promise<ValidationMarker[]>> = []
+  let nestedChecks: Array<Observable<ValidationMarker[]>> = []
 
   const selfIsRequired = rules.some((rule) => rule.isRequired())
   const shouldRunNestedObjectValidation =
@@ -144,12 +190,14 @@ export async function validateItem({
           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,
-            })
+            return defer(() =>
+              subRule.validate(nestedValue, {
+                ...restOfContext,
+                parent: value,
+                path: path.concat(name),
+                type: fieldType,
+              })
+            )
           })
         })
     )
@@ -157,7 +205,7 @@ export async function validateItem({
     // Validation from each field's schema `validation: Rule => {/* ... */}` function
     nestedChecks = nestedChecks.concat(
       type.fields.map((field) =>
-        validateItem({
+        validateItemObservable({
           ...restOfContext,
           parent: value,
           value: isRecord(value) ? value[field.name] : undefined,
@@ -177,7 +225,7 @@ export async function validateItem({
   if (shouldRunNestedValidationForArrays) {
     nestedChecks = nestedChecks.concat(
       value.map((item) =>
-        validateItem({
+        validateItemObservable({
           ...restOfContext,
           parent: value,
           value: item,
@@ -198,16 +246,16 @@ export async function validateItem({
     const spanType = spanChildrenField.type.of.find(isSpanSchemaType)
 
     const annotations = (spanType?.annotations || []).reduce<Map<string, SchemaType>>(
-      (map, annotationType) => {
-        map.set(annotationType.name, annotationType)
-        return map
+      (acc, annotationType) => {
+        acc.set(annotationType.name, annotationType)
+        return acc
       },
       new Map()
     )
 
     nestedChecks = nestedChecks.concat(
       value.markDefs.map((markDef) =>
-        validateItem({
+        validateItemObservable({
           ...restOfContext,
           parent: value,
           value: markDef,
@@ -218,13 +266,31 @@ export async function validateItem({
     )
   }
 
-  const results = (await Promise.all([...selfChecks, ...nestedChecks])).flat()
+  return defer(() => merge([...selfChecks, ...nestedChecks])).pipe(
+    mergeMap((validateNode) => concat(idle(), validateNode), 40),
+    mergeAll(),
+    toArray(),
+    map(flatten),
+    map((results) => {
+      // 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
+    })
+  )
+}
 
-  // 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))
-  }
+function idle(timeout?: number): Observable<never> {
+  return new Observable<never>((observer) => {
+    const handle = requestIdleCallback(
+      () => {
+        observer.complete()
+      },
+      timeout ? {timeout} : undefined
+    )
 
-  return results
+    return () => cancelIdleCallback(handle)
+  })
 }

package/src/validators/slugValidator.ts

@@ -23,7 +23,7 @@ function serializePath(path: Path): string {
 }
 
 const defaultIsUnique: SlugIsUniqueValidator = (slug, context) => {
-  const {client, document, path, type} = context
+  const {getClient, document, path, type} = context
   const schemaOptions = type?.options as {disableArrayWarning?: boolean} | undefined
 
   if (!document) {
@@ -48,7 +48,7 @@ const defaultIsUnique: SlugIsUniqueValidator = (slug, context) => {
     `${atPath} == $slug`,
   ].join(' && ')
 
-  return client.fetch<boolean>(
+  return getClient({apiVersion: '2022-09-09'}).fetch<boolean>(
     `!defined(*[${constraints}][0]._id)`,
     {
       docType,