sanity-advanced-validators 0.5.3 → 0.6.1

package/README.md

@@ -9,10 +9,10 @@ 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)
+- [minCount](#minCount)
+- [maxCount](#maxCount)
+- [requiredIfSiblingEq](#requiredIfSiblingEq) 🆕
+- [requiredIfSiblingNeq](#requiredIfSiblingNeq) 🆕
 - [requiredIfSlugEq](#requiredIfSlugEq)
 - [requiredIfSlugNeq](#requiredIfSlugNeq)
 - [regex](#regex)
@@ -23,11 +23,19 @@ This package includes a set of Sanity validators for aggressive and weird edge c
 
 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
+- and it’s _always_ required on the `/home` page
 
 ```typescript
+import { defineType, defineField } from 'sanity'
+import {
+  requiredIfSlugEq,
+  requiredIfSiblingNeq,
+  minDimensions,
+  maxDimensions
+} from 'sanity-advanced-validators'
+
 const Page = defineType({
   name: "page",
   type: "document",
@@ -41,14 +49,11 @@ const Page = defineType({
       type: "file",
       validation: (rule) =>
         rule.custom(
-          requiredIfSlugEq(
-            'about',
-            'A video is required if {slugKey} is {operand}.'
-          )
+          requiredIfSlugEq('home', 'A video is required on the home page.')
         ).custom(
           fileExtension(['mp4', 'mov'])
         )
-    })
+    }),
     defineField({
       name: "posterImage",
       type: "image",
@@ -78,7 +83,7 @@ message?: string // optional custom error message; replaces {validFileExtension}
 ```
 
 ```typescript
-import { fileExtension } from "sanity-advanced-validation"
+import { fileExtension } from "sanity-advanced-validators"
 
 const Page = defineType({
   name: "page",
@@ -116,7 +121,7 @@ message?: string // optional custom error message; replaces {x} and {y} with you
 ```
 
 ```typescript
-import { minDimensions } from "sanity-advanced-validation"
+import { minDimensions } from "sanity-advanced-validators"
 
 const ImageWithCaption = defineType({
   name: "article",
@@ -223,6 +228,24 @@ defineField({
 }),
 ```
 
+And of course it can be chained.
+
+```typescript
+defineField({
+  name: "thumbnails",
+  type: "array",
+  of: [ {type: 'image'} ],
+  validation: (rule) => 
+    rule.required()
+      .custom(
+        minCount(1, "At least one thumbnail is required.")
+      ),
+      .custom(
+        maxCount(3, "1-3 thumbnails are required.")
+      ),
+}),
+```
+
 ---
 
 ### requiredIfSiblingEq
@@ -231,6 +254,8 @@ Mark a field as `required` if a sibling field has a particular value. This is th
 
 This is handy if you have a field that is hidden under some circumstances, but is `required()` when it’s visible.
 
+🆕 Previously, this would not work for objects that were members of an array. That is fixed now.
+
 _note:_ This does not work for slugs, because they have to match a nested `.current` value. Use the [requiredIfSlugEq validator](#requiredIfSlugEq) instead.
 
 ```typescript
@@ -240,7 +265,7 @@ message?: string // optional custom error message; replaces {key} and {operand}
 ```
 
 ```typescript
-import {requiredIfSiblingEq} from 'sanity-advanced-validation'
+import {requiredIfSiblingEq} from 'sanity-advanced-validators'
 
 defineType({
   name: 'person',
@@ -343,6 +368,8 @@ defineType({
 
 For a given object that has multiple fields, mark a field as `required` if a sibling does _not_ have a particular value (or member of an array of values).
 
+🆕 Previously, this would not work for objects that were members of an array. That is fixed now.
+
 _note:_ This does not work for slugs, because they have to match a nested `.current` value. Use the [requiredIfSlugNeq validator](#requiredIfSlugNeq) instead.
 
 ```typescript
@@ -352,7 +379,7 @@ message?: string // optional custom error message; replaces {key} and {operand}
 ```
 
 ```typescript
-import {requiredIfSiblingNeq} from 'sanity-advanced-validation'
+import {requiredIfSiblingNeq} from 'sanity-advanced-validators'
 
 defineType({
   name: 'person',
@@ -389,13 +416,13 @@ defineType({
 Mark a field as `required` for documents with matching slugs.
 
 ```typescript
-operand: string | number | null | Array<string, number> // possible slug or slugs you’re testing
-key?: string, // name of sibling if not "slug"
+operand: string | number | null | Array<string, number> // value or values that you’re testing for
+key?: string, // name of slug field 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.
 ```
 
 ```typescript
-import { requiredIfSlugEq } from "sanity-advanced-validation"
+import { requiredIfSlugEq } from "sanity-advanced-validators"
 
 defineType({
   name: "page",
@@ -438,13 +465,13 @@ defineField({
 Require fields on pages that don't match one or more slugs.
 
 ```typescript
-operand: string | number | null | Array<string, number> // possible slug or slugs you’re testing
-key?: string, // name of sibling if not "slug"
+operand: string | number | null | Array<string, number> // value or values that you’re testing
+key?: string, // name of slug field 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.
 ```
 
 ```typescript
-import { requiredIfSlugNeq } from "sanity-advanced-validation"
+import { requiredIfSlugNeq } from "sanity-advanced-validators"
 
 defineType({
   name: "page",
@@ -496,7 +523,7 @@ defineField({
 }),
 ```
 
-**Custom error messages are highly recommended here.** Without the custom message above, the default response would be:
+_Custom error messages are highly recommended here._ Without a custom message above, the default error message would be:
 
 ```
 “me@googlecom” does not match the pattern /^([a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,6})*$/.
@@ -584,12 +611,12 @@ const navLink = defineType({
 
 ```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)
+key: string, // name of the field that includes the recursive value (i.e. the field’s own name)
 message?: string // optional custom error message; replaces {maxDepth} and {key} with your input
 ```
 
 ```typescript
-import { maxDepth } from "sanity-advanced-validation"
+import { maxDepth } from "sanity-advanced-validators"
 
 const navLink = defineType({
   // …
@@ -631,26 +658,26 @@ 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.
-
 ## Roadmap
 
 ### Nested pathfinders
 
 Since building these validator, I took to putting my slugs in a metadata object. I need to update `requiredIfSlugEq` to accept a path, like `requiredIfSlugEq('metadata.slug', 'some-values')`.
 
-This pathfinding should be added to any validator that takes a sibling, like `requiredIfSiblingEq`. It can probably be snapped into `getSibling`.
+This pathfinding should be added to any validator that takes a sibling, like `requiredIfSiblingEq('metadata.slug.current', 'home')`. It can probably be snapped into `getSibling`.
 
 While I’m at it, there’s a possibility that `getSibling` could detect the target type. If that type is `slug`, then it could add `current` to the path, and then I can deprecate `requiredIfSlugEq` altogether.
 
+On a related note, `requiredIfSlugEq` does not work in an object nested inside an array. If we can deprecate `requiredIfSlugEq`, then this would be automatically resolved.
+
 ### Image and File checks
 
 `minDimensions`, `maxDimensions`, and `fileExtension` should check to see if the field is of type `image` or `file`.
 
 Some of the other checks should probably make sure the field is _not_ `image` or `file`.
 
+An `aspectRatio(n)` might be nice (ex. `aspectRatio(1.6)` or `aspectRatio(1.6/1)`).
+
 ### new referencedDocumentFieldEq validator
 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "package-name": "sanity-advanced-validators",
-  "version": "0.5.3",
+  "version": "0.6.1",
   "description": "Advanced input validation tools for Sanity CMS.",
   "author": "Eric_WVGG",
   "license": "MIT",
@@ -22,11 +22,9 @@
   ],
   "dependencies": {
     "@sanity/asset-utils": "^2.2.1",
-    "lodash-es": "^4.17.0",
     "sanity": "^4.9.0"
   },
   "devDependencies": {
-    "@types/lodash-es": "^4.17.0",
     "tsup": "^8.5.0",
     "typescript": "^5.8.0",
     "vitest": "^3.2.4"