@sanity/validation 3.2.6-client-v5.17 → 3.2.6

package/src/validateDocument.test.ts

@@ -1,11 +1,11 @@
+import type {SanityClient} from '@sanity/client'
 import {
-  ArraySchemaType,
-  PortableTextTextBlock,
   Rule,
+  SchemaType,
   SanityDocument,
   Schema,
-  SchemaType,
-  ValidationContext,
+  ArraySchemaType,
+  PortableTextTextBlock,
 } from '@sanity/types'
 import {createSchema} from '../test/createSchema'
 import {createMockSanityClient} from '../test/mocks/mockSanityClient'
@@ -25,7 +25,7 @@ beforeEach(() => {
 })
 
 // mock client
-const client = createMockSanityClient() as any as ReturnType<ValidationContext['getClient']>
+const client = createMockSanityClient() as any as SanityClient
 const getClient = (options: {apiVersion: string}) => client
 
 describe('resolveTypeForArrayItem', () => {
@@ -176,6 +176,7 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
+        client,
         getClient,
         schema,
         value: {},
@@ -246,6 +247,7 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
+        client,
         getClient,
         schema,
         document: undefined,
@@ -413,6 +415,7 @@ describe('validateItem', () => {
     }
 
     const result = await validateItem({
+      client,
       getClient,
       schema,
       document: document,
@@ -516,6 +519,7 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
+        client,
         getClient,
         schema,
         document: undefined,
@@ -615,6 +619,7 @@ describe('validateItem', () => {
 
     await expect(
       validateItem({
+        client,
         getClient,
         schema,
         value,

package/src/validateDocument.ts

@@ -10,9 +10,10 @@ import {
   isSpanSchemaType,
   isPortableTextTextBlock,
 } from '@sanity/types'
-import {concat, defer, lastValueFrom, merge, Observable, of} from 'rxjs'
+import {concat, defer, firstValueFrom, lastValueFrom, 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'
@@ -51,7 +52,7 @@ export function resolveTypeForArrayItem(
 const EMPTY_MARKERS: ValidationMarker[] = []
 
 export default async function validateDocument(
-  getClient: ValidateItemOptions['getClient'],
+  getClient: (options: {apiVersion: string}) => SanityClient,
   doc: SanityDocument,
   schema: Schema,
   context?: Pick<ValidationContext, 'getDocumentExists'>
@@ -60,7 +61,7 @@ export default async function validateDocument(
 }
 
 export function validateDocumentObservable(
-  getClient: ValidateItemOptions['getClient'],
+  getClient: (options: {apiVersion: string}) => SanityClient,
   doc: SanityDocument,
   schema: Schema,
   context?: Pick<ValidationContext, 'getDocumentExists'>
@@ -71,7 +72,9 @@ export function validateDocumentObservable(
     return of(EMPTY_MARKERS)
   }
 
+  const client = getClient({apiVersion: '2021-06-07'})
   const validationOptions: ValidateItemOptions = {
+    client,
     getClient,
     schema,
     parent: undefined,
@@ -82,6 +85,29 @@ export function validateDocumentObservable(
     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)