sanity-advanced-validators 0.5.2 → 0.6.0

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)
@@ -28,6 +28,8 @@ Imagine that you’ve got a document that has an optional video file, but…
 - and there must be a poster image that's between **1250x800** and **2500x1600** pixels in size
 
 ```typescript
+import { requiredIfSlugEq, requiredIfSiblingNeq, minDimensions, maxDimensions } from 'sanity-advanced-validators'
+
 const Page = defineType({
   name: "page",
   type: "document",
@@ -78,7 +80,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 +118,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 +225,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 +251,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 +262,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 +365,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 +376,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',
@@ -395,7 +419,7 @@ message?: string // optional custom error message; replaces {slugKey} and {opera
 ```
 
 ```typescript
-import { requiredIfSlugEq } from "sanity-advanced-validation"
+import { requiredIfSlugEq } from "sanity-advanced-validators"
 
 defineType({
   name: "page",
@@ -444,7 +468,7 @@ message?: string // optional custom error message; replaces {slugKey} and {opera
 ```
 
 ```typescript
-import { requiredIfSlugNeq } from "sanity-advanced-validation"
+import { requiredIfSlugNeq } from "sanity-advanced-validators"
 
 defineType({
   name: "page",
@@ -584,12 +608,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({
   // …

package/package.json

@@ -1,6 +1,6 @@
 {
   "package-name": "sanity-advanced-validators",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "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": "^3.9.0"
+    "sanity": "^4.9.0"
   },
   "devDependencies": {
-    "@types/lodash-es": "^4.17.0",
     "tsup": "^8.5.0",
     "typescript": "^5.8.0",
     "vitest": "^3.2.4"