@sanity/validation 2.21.5 → 2.21.8-reference-updates.27

package/dist/dts/validateDocument.d.ts

@@ -3,7 +3,7 @@ import { SanityDocument, Schema, SchemaType, ValidationContext, ValidationMarker
  * @internal
  */
 export declare function resolveTypeForArrayItem(item: unknown, candidates: SchemaType[]): SchemaType | undefined;
-export default function validateDocument(doc: SanityDocument, schema: Schema): Promise<ValidationMarker[]>;
+export default function validateDocument(doc: SanityDocument, schema: Schema, context?: Pick<ValidationContext, 'getDocumentExists'>): Promise<ValidationMarker[]>;
 /**
  * this is used make optional properties required by replacing optionals with
  * `T[P] | undefined`. this is used to prevent errors in `validateItem` where

package/dist/dts/validateDocument.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateDocument.d.ts","sourceRoot":"","sources":["../../src/validateDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,eAAe,CAAA;AAYtB;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,UAAU,EAAE,GACvB,UAAU,GAAG,SAAS,CAiBxB;AAED,wBAA8B,gBAAgB,CAC5C,GAAG,EAAE,cAAc,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA0B7B;AAED;;;;;;GAMG;AACH,aAAK,iBAAiB,CAAC,CAAC,IAAI;KACzB,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;CAC5F,CAAA;AAED,aAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,OAAO,CAAA;CACf,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;AAExC,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,IAAI,EACJ,IAAS,EACT,MAAM,EACN,GAAG,aAAa,EACjB,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA8FnD"}
+{"version":3,"file":"validateDocument.d.ts","sourceRoot":"","sources":["../../src/validateDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,eAAe,CAAA;AAYtB;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,UAAU,EAAE,GACvB,UAAU,GAAG,SAAS,CAiBxB;AAED,wBAA8B,gBAAgB,CAC5C,GAAG,EAAE,cAAc,EACnB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,GACrD,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA2B7B;AAED;;;;;;GAMG;AACH,aAAK,iBAAiB,CAAC,CAAC,IAAI;KACzB,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;CAC5F,CAAA;AAED,aAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,OAAO,CAAA;CACf,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;AAExC,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,IAAI,EACJ,IAAS,EACT,MAAM,EACN,GAAG,aAAa,EACjB,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA8FnD"}

package/dist/dts/validators/blockValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blockValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/blockValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,cAAc,EAAC,MAAM,eAAe,CAAA;AAG9D,eAAO,MAAM,cAAc,EAAE,cAkD5B,CAAA"}
+{"version":3,"file":"blockValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/blockValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,cAAc,EAAC,MAAM,eAAe,CAAA;AAG9D,eAAO,MAAM,cAAc,EAAE,cAmD5B,CAAA"}

package/dist/dts/validators/objectValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"objectValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/objectValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAA;AAKxC,QAAA,MAAM,gBAAgB,EAAE,UA8CvB,CAAA;AAED,eAAe,gBAAgB,CAAA"}
+{"version":3,"file":"objectValidator.d.ts","sourceRoot":"","sources":["../../../src/validators/objectValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAc,MAAM,eAAe,CAAA;AAKrD,QAAA,MAAM,gBAAgB,EAAE,UAkEvB,CAAA;AAED,eAAe,gBAAgB,CAAA"}

package/lib/validateDocument.js

@@ -74,7 +74,7 @@ function resolveTypeForArrayItem(item, candidates) {
   }) || candidates.find(candidate => candidate.name === itemType) || candidates.find(candidate => candidate.name === 'object' && primitive === 'object');
 }
 
-function validateDocument(_x, _x2) {
+function validateDocument(_x, _x2, _x3) {
   return _validateDocument.apply(this, arguments);
 }
 /**
@@ -87,7 +87,7 @@ function validateDocument(_x, _x2) {
 
 
 function _validateDocument() {
-  _validateDocument = _asyncToGenerator(function* (doc, schema) {
+  _validateDocument = _asyncToGenerator(function* (doc, schema, context) {
     var documentType = schema.get(doc._type);
 
     if (!documentType) {
@@ -101,7 +101,8 @@ function _validateDocument() {
         value: doc,
         path: [],
         document: doc,
-        type: documentType
+        type: documentType,
+        getDocumentExists: context === null || context === void 0 ? void 0 : context.getDocumentExists
       });
     } catch (err) {
       console.error(err);
@@ -116,7 +117,7 @@ function _validateDocument() {
   return _validateDocument.apply(this, arguments);
 }
 
-function validateItem(_x3) {
+function validateItem(_x4) {
   return _validateItem.apply(this, arguments);
 }
 

package/lib/validators/blockValidator.js

@@ -44,7 +44,8 @@ var blockValidator = /*#__PURE__*/function () {
         path: (context.path || []).concat(['markDefs', {
           _key: markDef._key
         }]),
-        parent: value
+        parent: value,
+        getDocumentExists: context.getDocumentExists
       });
       annotationValidations.push(validations);
     });

package/lib/validators/objectValidator.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _types = require("@sanity/types");
+
 var _genericValidator = _interopRequireDefault(require("./genericValidator"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -35,17 +37,48 @@ var objectValidators = _objectSpread(_objectSpread({}, _genericValidator.default
 
     return true;
   },
-  reference: (_unused, value, message) => {
-    if (!value) {
+  reference: function () {
+    var _reference = _asyncToGenerator(function* (_unused, value, message, context) {
+      if (!value) {
+        return true;
+      }
+
+      if (!(0, _types.isReference)(value)) {
+        return message || 'Must be a reference to a document';
+      }
+
+      var type = context.type,
+          getDocumentExists = context.getDocumentExists;
+
+      if (!type) {
+        throw new Error("`type` was not provided in validation context");
+      }
+
+      if ('weak' in type && type.weak) {
+        return true;
+      }
+
+      if (!getDocumentExists) {
+        throw new Error("`getDocumentExists` was not provided in validation context");
+      }
+
+      var exists = yield getDocumentExists({
+        id: value._ref
+      }); // TODO: this error message copy may need improvement
+
+      if (!exists) {
+        return 'The referenced document is not yet published. Fix this error by opening the referenced document and publishing it';
+      }
+
       return true;
-    }
+    });
 
-    if (typeof value._ref !== 'string') {
-      return message || 'Must be a reference to a document';
+    function reference(_x, _x2, _x3, _x4) {
+      return _reference.apply(this, arguments);
     }
 
-    return true;
-  },
+    return reference;
+  }(),
   block: function () {
     var _block = _asyncToGenerator(function* (validateBlock, value, message, context) {
       var result = yield validateBlock(value, context);
@@ -57,7 +90,7 @@ var objectValidators = _objectSpread(_objectSpread({}, _genericValidator.default
       return result;
     });
 
-    function block(_x, _x2, _x3, _x4) {
+    function block(_x5, _x6, _x7, _x8) {
       return _block.apply(this, arguments);
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/validation",
-  "version": "2.21.5",
+  "version": "2.21.8-reference-updates.27+3ea3a7ef74",
   "description": "Validation and warning infrastructure for Sanity projects",
   "main": "./lib/index.js",
   "types": "./dist/dts",
@@ -32,8 +32,8 @@
     "directory": "packages/@sanity/validation"
   },
   "devDependencies": {
-    "@sanity/client": "2.21.3",
-    "@sanity/schema": "2.21.5"
+    "@sanity/client": "2.21.8-reference-updates.27+3ea3a7ef74",
+    "@sanity/schema": "2.21.8-reference-updates.27+3ea3a7ef74"
   },
   "peerDependencies": {
     "@sanity/client": "^2.0.0"
@@ -44,9 +44,9 @@
     }
   },
   "dependencies": {
-    "@sanity/types": "2.21.4",
+    "@sanity/types": "2.21.8-reference-updates.27+3ea3a7ef74",
     "date-fns": "^2.16.1",
     "lodash": "^4.17.15"
   },
-  "gitHead": "ebe802083c98f60df03e02cedd298482f79b7105"
+  "gitHead": "3ea3a7ef7426d4eb4e4a7a81ec5c15eef4384f8a"
 }

package/src/validateDocument.test.ts

@@ -165,6 +165,7 @@ describe('validateItem', () => {
         path: [],
         parent: undefined,
         type: schema.get('testObj'),
+        getDocumentExists: undefined,
       })
     ).resolves.toMatchObject([
       {
@@ -235,6 +236,7 @@ describe('validateItem', () => {
         path: undefined,
         type: schema.get('testObj'),
         value: {foo: 5},
+        getDocumentExists: undefined,
       })
     ).resolves.toMatchObject([
       {
@@ -285,6 +287,7 @@ describe('validateItem', () => {
         path: [],
         type: schema.get('values'),
         value: values,
+        getDocumentExists: undefined,
       })
     ).resolves.toEqual([
       {
@@ -377,6 +380,7 @@ describe('validateItem', () => {
         document,
         parent: document,
         path: undefined,
+        getDocumentExists: undefined,
       })
     ).resolves.toMatchObject([
       {
@@ -517,6 +521,7 @@ describe('validateItem', () => {
       parent: undefined,
       path: undefined,
       type: schema.get('root'),
+      getDocumentExists: undefined,
     })
 
     // after `validateItem(...)` has been initiated, all of the custom

package/src/validateDocument.ts

@@ -45,7 +45,8 @@ export function resolveTypeForArrayItem(
 
 export default async function validateDocument(
   doc: SanityDocument,
-  schema: Schema
+  schema: Schema,
+  context?: Pick<ValidationContext, 'getDocumentExists'>
 ): Promise<ValidationMarker[]> {
   const documentType = schema.get(doc._type)
   if (!documentType) {
@@ -60,6 +61,7 @@ export default async function validateDocument(
       path: [],
       document: doc,
       type: documentType,
+      getDocumentExists: context?.getDocumentExists,
     })
   } catch (err) {
     console.error(err)

package/src/validators/blockValidator.ts

@@ -38,6 +38,7 @@ export const blockValidator: BlockValidator = async (value, context) => {
       type: annotationType,
       path: (context.path || []).concat(['markDefs', {_key: markDef._key}]),
       parent: value,
+      getDocumentExists: context.getDocumentExists,
     })
     annotationValidations.push(validations)
   })

package/src/validators/objectValidator.ts

@@ -1,4 +1,4 @@
-import {Validators} from '@sanity/types'
+import {Validators, isReference} from '@sanity/types'
 import genericValidator from './genericValidator'
 
 const metaKeys = ['_key', '_type', '_weak']
@@ -20,15 +20,35 @@ const objectValidators: Validators = {
     return true
   },
 
-  reference: (_unused, value, message) => {
+  reference: async (_unused, value: unknown, message, context) => {
     if (!value) {
       return true
     }
 
-    if (typeof value._ref !== 'string') {
+    if (!isReference(value)) {
       return message || 'Must be a reference to a document'
     }
 
+    const {type, getDocumentExists} = context
+
+    if (!type) {
+      throw new Error(`\`type\` was not provided in validation context`)
+    }
+
+    if ('weak' in type && type.weak) {
+      return true
+    }
+
+    if (!getDocumentExists) {
+      throw new Error(`\`getDocumentExists\` was not provided in validation context`)
+    }
+
+    const exists = await getDocumentExists({id: value._ref})
+    // TODO: this error message copy may need improvement
+    if (!exists) {
+      return 'The referenced document is not yet published. Fix this error by opening the referenced document and publishing it'
+    }
+
     return true
   },