sanity-advanced-validators 0.4.1 → 0.5.0

package/README.md

@@ -9,11 +9,13 @@ This package includes a set of Sanity validators for aggressive and weird edge c
 - [fileExtension](#fileExtension)
 - [minDimensions](#minDimensions)
 - [maxDimensions](#maxDimensions)
+- [minCount](#minCount) 🆕
+- [maxCount](#maxCount) 🆕
 - [requiredIfSiblingEq](#requiredIfSiblingEq)
 - [requiredIfSiblingNeq](#requiredIfSiblingNeq)
 - [requiredIfSlugEq](#requiredIfSlugEq)
 - [requiredIfSlugNeq](#requiredIfSlugNeq)
-- [regex](#regex) 🆕
+- [regex](#regex)
 - [referencedDocumentRequires](#referencedDocumentRequires)
 - [maxDepth](#maxDepth)
 
@@ -38,17 +40,27 @@ const Page = defineType({
       name: "someVideoFile",
       type: "file",
       validation: (rule) =>
-        rule.custom(requiredIfSlugEq('about', 'A video is required if {slugKey} is {operand}.'))
-          .custom(fileExtension(['mp4', 'mov']))
+        rule.custom(
+          requiredIfSlugEq(
+            'about',
+            'A video is required if {slugKey} is {operand}.'
+          )
+        ).custom(
+          fileExtension(['mp4', 'mov'])
+        )
     })
     defineField({
       name: "posterImage",
       type: "image",
       hidden: ({ parent }) => parent.someVideoFile === null,
       validation: (rule) =>
-        rule.custom(requiredIfSiblingNeq('someVideoFile', null))
-          .custom(minDimensions({ x: 1250, y: 800 }))
-          .custom(maxDimensions({ x: 2500, y: 1600 })),
+        rule.custom(
+          requiredIfSiblingNeq('someVideoFile', null)
+        ).custom(
+          minDimensions({ x: 1250, y: 800 })
+        ).custom(
+          maxDimensions({ x: 2500, y: 1600 })
+        ),
     })
   ]
 })
@@ -75,12 +87,18 @@ const Page = defineType({
     defineField({
       name: "catalog",
       type: "file",
-      validation: (rule) => rule.custom(fileExtension("pdf")),
+      validation: (rule) => 
+        rule.custom(
+          fileExtension("pdf")
+        ),
     }),
     defineField({
       name: "video",
       type: "file",
-      validation: (rule) => rule.custom(fileExtension(["mp4", "mov", "webm"])),
+      validation: (rule) => 
+        rule.custom(
+          fileExtension(["mp4", "mov", "webm"])
+        ),
     }),
   ],
 })
@@ -108,7 +126,10 @@ const ImageWithCaption = defineType({
     defineField({
       name: "heroImage",
       type: "image",
-      validation: (rule) => rule.custom(minDimensions({ x: 1200, y: 800 })),
+      validation: (rule) => 
+        rule.custom(
+          minDimensions({ x: 1200, y: 800 })
+        ),
     }),
   ],
 })
@@ -129,7 +150,10 @@ message?: string // optional custom error message; replaces {x} and {y} with you
 defineField({
   name: "heroImage",
   type: "image",
-  validation: (rule) => rule.custom(maxDimensions({ x: 2400, y: 1600 })),
+  validation: (rule) => 
+    rule.custom(
+      maxDimensions({ x: 2400, y: 1600 })
+    ),
 }),
 ```
 
@@ -141,15 +165,66 @@ defineField({
   type: "image",
   description: "Min: 1200x800, max: 2400x1600.",
   validation: (rule) =>
-    rule
-      .required()
-      .custom(minDimensions({ x: 1200, y: 800 }))
-      .custom(maxDimensions({ x: 2400, y: 1600 })),
+    rule.required()
+      .custom(
+        minDimensions({ x: 1200, y: 800 })
+      ).custom(
+        maxDimensions({ x: 2400, y: 1600 })
+      ),
 })
 ```
 
 ---
 
+### minCount
+
+Enforces that an array contains at least _n_ items. 
+
+Note that null values are fine; use `rule.required()` to enforce non-nulls.
+
+```typescript
+n: number,
+message?: string // optional custom error message; replaces {n} with your minimum count
+```
+
+```typescript
+defineField({
+  name: "thumbnails",
+  type: "array",
+  of: [ {type: 'image'} ],
+  validation: (rule) => 
+    rule.required()
+      .custom(
+        minCount(3, "At least {n} thumbnails are required.")
+      ),
+}),
+```
+
+---
+
+### maxCount
+
+Enforces that an array contains at most _n_ items. 
+
+```typescript
+n: number,
+message?: string // optional custom error message; replaces {n} with your maximum count
+```
+
+```typescript
+defineField({
+  name: "thumbnails",
+  type: "array",
+  of: [ {type: 'image'} ],
+  validation: (rule) => 
+    rule.custom(
+      maxCount(3, "No more than {n} thumbnails.")
+    ),
+}),
+```
+
+---
+
 ### requiredIfSiblingEq
 
 Mark a field as `required` if a sibling field has a particular value. This is the validator we use most. _It’s super effective!_
@@ -190,7 +265,10 @@ defineType({
           'typescript', 'rust', 'python', 'swift'
         ]
       },
-      validation: rule => rule.custom(requiredIfSiblingEq('occupation', 'software engineer')),
+      validation: rule => 
+        rule.custom(
+          requiredIfSiblingEq('occupation', 'software engineer')
+        ),
       hidden: ({parent}) => parent.occuption !== 'software engineer',
     }),
   ],
@@ -218,14 +296,17 @@ defineType({
       options: {
         list: ["typescript", "rust", "python", "swift", "latin", "urdu", "klingon"],
       },
-      validation: (rule) => rule.custom(requiredIfSiblingEq("occupation", ["software engineer", "linguist"])),
+      validation: (rule) => 
+        rule.custom(
+          requiredIfSiblingEq("occupation", ["software engineer", "linguist"])
+        ),
       hidden: ({ parent }) => !["software engineer", "linguist"].includes(parent.occupation),
     }),
   ],
 })
 ```
 
-“If not that, then this.” It even works for null.
+It even works for null.
 
 ```typescript
 defineType({
@@ -243,11 +324,14 @@ defineType({
     defineField({
       name: 'phone',
       type: 'string',
-      validation: rule => rule.custom(requiredIfSiblingEq(
-        'email',
-        null,
-        "If you don’t have an email address, a phone number is required."
-      ))
+      validation: rule => 
+        rule.custom(
+          requiredIfSiblingEq(
+            'email',
+            null,
+            "If you don’t have an email address, a phone number is required."
+          )
+        )
     })
   ],
 })
@@ -289,7 +373,10 @@ defineType({
       name: "explanation",
       description: "Why are you wasting your life this way?",
       type: "text",
-      validation: (rule) => rule.custom(requiredIfSiblingNeq("occupation", "software engineer")),
+      validation: (rule) => 
+        rule.custom(
+          requiredIfSiblingNeq("occupation", "software engineer")
+        ),
       hidden: ({ parent }) => parent.occuption === "software engineer",
     }),  ],
 })
@@ -322,7 +409,10 @@ defineType({
       name: "questionsAndAnswers",
       type: "array",
       of: [{ type: "qaItem" }],
-      validation: (rule) => rule.custom(requiredIfSlugEq("faq")),
+      validation: (rule) => 
+        rule.custom(
+          requiredIfSlugEq("faq")
+        ),
       hidden: ({ parent }) => parent.slug.current !== "faq",
     }),
   ],
@@ -334,7 +424,10 @@ And this can apply to multiple slugs…
 ```typescript
 defineField({
   name: "questionsAndAnswers",
-  validation: (rule) => rule.custom(requiredIfSlugEq(["faq", "about"])),
+  validation: (rule) => 
+    rule.custom(
+      requiredIfSlugEq(["faq", "about"])
+    ),
 }),
 ```
 
@@ -366,7 +459,10 @@ defineType({
       description: `Subnav is required on documents that aren’t '/home'`,
       type: "array",
       of: [{ type: "navLink" }],
-      validation: (rule) => rule.custom(requiredIfSlugNeq("home")),
+      validation: (rule) => 
+        rule.custom(
+          requiredIfSlugNeq("home")
+        ),
       hidden: ({ parent }) => parent.slug.current !== "home",
     }),
   ],
@@ -390,12 +486,13 @@ message?: string // optional custom error message; replaces {pattern} with your
 defineField({
   name: 'email',
   type: 'string',
-  validation: (rule) => rule.custom(
-    regex(
-      /^([a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,6})*$/,
-      "“{value}” is not a valid email address."
-    )
-  ),
+  validation: (rule) => 
+    rule.custom(
+      regex(
+        /^([a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,6})*$/,
+        "“{value}” is not a valid email address."
+      )
+    ),
 }),
 ```
 
@@ -423,7 +520,10 @@ defineField({
   description: 'An article (must include a valid poster image)',
   type: 'reference',
   to: [{type: 'article'}],
-  validation: (rule) => rule.custom(referencedDocumentRequires('article', 'poster')),
+  validation: (rule) => 
+    rule.custom(
+      referencedDocumentRequires('article', 'poster')
+    ),
 }),
 ```
 
@@ -499,7 +599,10 @@ const navLink = defineType({
       name: "subnav",
       type: "array",
       of: [{ type: navigation }],
-      validation: (rule) => rule.custom(maxDepth(3, "subnav")),
+      validation: (rule) => 
+        rule.custom(
+          maxDepth(3, "subnav")
+        ),
     }),
   ],
 })

package/package.json

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