sanity-advanced-validators 0.2.1 → 0.3.1

package/README.md

@@ -1,8 +1,10 @@
+*🚓 Never trust a user! 👮*
+
 # Sanity Advanced Validators
 
-This package includes a set of Sanity validators for aggressive and weird edge cases. Please let me know if you find these helpful!
+This package includes a set of Sanity validators for aggressive and weird edge cases. *Maintain sanity with micro-managed validation.*
 
-Note that every validator can accept an optional custom error message as its last parameter. `minDimensions` lists one example; all the others work the same way.
+Note: Every validator can accept an optional custom error message as its last parameter. See [minDimensions](#minDimensions) for an example.
 
 ## Tools
 
@@ -18,7 +20,10 @@ Note that every validator can accept an optional custom error message as its las
 
 ## Mega-example
 
-Imagine that you’ve got a document that has an optional video file — but it's required on the `/about` page. If the video exists, it must be either MP4 or MOV, and have a poster image that's between 1250x800 and 2500x1600 pixels in size.
+Imagine that you’ve got a document that has an optional video file, but…
+- it’s required on the `/about` page
+- if the video exists, it must be either **MP4** or **MOV**
+- and there must be a poster image that's between **1250x800** and **2500x1600** pixels in size
 
 ```typescript
 const Page = defineType({
@@ -51,7 +56,7 @@ const Page = defineType({
 
 ## Examples
 
-### fileType
+### fileExtension
 
 Enforces that an uploaded file asset is of a certain format.
 
@@ -65,7 +70,7 @@ const Page = defineType({
     defineField({
       name: "catalog",
       type: "file",
-      validation: (rule) => rule.custom(fileType("pdf")),
+      validation: (rule) => rule.custom(fileExtension("pdf")),
     }),
     defineField({
       name: "video",
@@ -76,6 +81,14 @@ const Page = defineType({
 })
 ```
 
+#### parameters
+```typescript
+fileType: string | Array<string>, 
+message?: string // optional custom error message; replaces {validFileExtension} with fileType (flattened)
+```
+
+---
+
 ### minDimensions
 
 Enforces that an uploaded image asset is at minimum certain dimensions.
@@ -113,6 +126,15 @@ defineField({
 })
 ```
 
+#### parameters
+```typescript
+dimensions: {x?: number, y?: number}, 
+message?: string // optional custom error message; replaces {x} and {y} with your dimension requirements, and {width} and {height} with submitted image dimensions
+```
+
+---
+
+
 ### maxDimensions
 
 Enforces that an uploaded image asset is at most certain dimensions.
@@ -140,11 +162,20 @@ defineField({
 })
 ```
 
+#### parameters
+```typescript
+dimensions: {x?: number, y?: number}, 
+message?: string // optional custom error message; replaces {x} and {y} with your dimension requirements, and {width} and {height} with submitted image dimensions
+```
+
+---
+
+
 ### requiredIfSiblingEq
 
-For a given object that has multiple fields, mark a field as `required` if a sibling has a particular value.
+Mark a field as `required` if a sibling field has a particular value. This is the validator we use most. *It’s super effective!*
 
-This is really handy if you have a field that is hidden circumstances, but need to make it `required()` when it’s visible! This is probably the validator I use most.
+This is handy if you have a field that is hidden under some circumstances, but is `required()` when it’s visible. 
 
 _note:_ This does not work for slugs, because they have to match a nested `.current` value. Use the [requiredIfSlugEq validator](#requiredIfSlugEq) instead.
 
@@ -181,7 +212,7 @@ defineType({
 })
 ```
 
-This also works for null. It’s very effective!
+“If not that, then this.” This also works for null.
 
 ```typescript
 defineType({
@@ -242,6 +273,16 @@ defineType({
 })
 ```
 
+#### parameters
+```typescript
+key: string, // name of sibling
+operand: string | number | null | Array<string, number, null> // value that you’re testing for (i.e. if 'name' === operand)
+message?: string // optional custom error message; replaces {key} and {operand} with your input, and {siblingValue} with the value of the sibling you’re testing against.
+```
+
+---
+
+
 ### requiredIfSiblingNeq
 
 For a given object that has multiple fields, mark a field as `required` if a sibling does _not_ have a particular value.
@@ -276,6 +317,16 @@ defineType({
 })
 ```
 
+#### parameters
+```typescript
+key: string, // name of sibling
+operand: string | number | null | Array<string, number, null> // value that you’re testing for (i.e. if 'name' === operand)
+message?: string // optional custom error message; replaces {key} and {operand} with your input, and {siblingValue} with the value of the sibling you’re testing against.
+```
+
+---
+
+
 ### requiredIfSlugEq
 
 Require for matching slugs.
@@ -313,6 +364,16 @@ defineField({
 }),
 ```
 
+#### parameters
+```typescript
+operand: string | number | null | Array<string, number, null> // possible slug or slugs you’re testing
+key?: string, // name of sibling if not "slug"
+message?: string // optional custom error message; replaces {slugKey} and {operand} with your input, and {siblingSlugValue} with the value of the sibling you’re testing against.
+```
+
+---
+
+
 ### requiredIfSlugNeq
 
 Require fields on pages that don't match one or more slugs.
@@ -342,13 +403,23 @@ defineType({
 })
 ```
 
+#### parameters
+```typescript
+operand: string | number | null | Array<string, number, null> // possible slug or slugs you’re testing
+key?: string, // name of sibling if not "slug"
+message?: string // optional custom error message; replaces {slugKey} and {operand} with your input, and {siblingSlugValue} with the value of the sibling you’re testing against.
+```
+
+---
+
+
 ### referencedDocumentRequires
 
 You might want to enforce some validation on a referenced document. This validator enforces that a given value is not null in the referenced document.
 
 ```typescript
 defineField({
-  name: 'refferedArticle',
+  name: 'referredArticle',
   description: 'An article (must include a valid poster image)',
   type: 'reference',
   to: [{type: 'article'}],
@@ -356,6 +427,16 @@ defineField({
 }),
 ```
 
+#### parameters
+```typescript
+documentType: string // type of document you’re referring to
+field: string, // name of document field that is required
+message?: string // optional custom error message; replaces {documentType} and {field} with your input
+```
+
+---
+
+
 ### maxDepth
 
 It can be useful to have a nested type. This often comes up when making some kind of navigation tree, like…
@@ -428,7 +509,20 @@ const navLink = defineType({
 
 This will enforce that a subnav list can embed in a subnav, which can also be embedded in a subnav — but no further.
 
-_Note to any Sanity dev who looks at this_: I’d love to include similar logic on my `hidden:` attribute, but I don’t think that’t possible without a `path` array in `hidden`’s `ConditionalPropertyCallbackContext` that’s similar to the one fed to the `ValidationContext` (todo: type this correctly). Wouldn’t this be cool?
+
+#### parameters
+```typescript
+maxDepth: number // maximum "depth" of embedding (including parent)
+key: string, // name of the field that includes the cursive value (i.e. the field’s own name)
+message?: string // optional custom error message; replaces {maxDepth} and {key} with your input
+```
+
+---
+
+
+#### Note to any Sanity dev who looks at this
+
+I’d love to include similar logic on my `hidden:` attribute, but I don’t think that’t possible without a `path` array in `hidden`’s `ConditionalPropertyCallbackContext` that’s similar to the one fed to the `ValidationContext` (todo: type this correctly). Wouldn’t this be cool?
 
 ```typescript
 defineField({
@@ -443,6 +537,8 @@ defineField({
 })
 ```
 
+---
+
 ## Extending these and writing your own
 
 Most of these validators rely on a function called `getSibling()`. If you’re thinking about picking this apart and writing your own custom validator, take a close look at how these validators use it.

package/package.json

@@ -1,6 +1,6 @@
 {
   "package-name": "sanity-advanced-validators",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Advanced input validation tools for Sanity CMS.",
   "author": "Eric_WVGG",
   "license": "MIT",