sanity-advanced-validators 0.4.0 → 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!_
@@ -160,7 +235,7 @@ _note:_ This does not work for slugs, because they have to match a nested `.curr
 
 ```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)
+operand: string | number | boolean | null | Array<string, number> // 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.
 ```
 
@@ -187,73 +262,77 @@ defineType({
       type: 'string',
       options: {
         list: [
-          'javascript', 'rust', 'python', 'swift'
+          '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',
     }),
   ],
 })
 ```
 
-“If not that, then this.” This also works for null.
+And it also works for arrays.
 
 ```typescript
 defineType({
-  name: 'person',
-  type: 'object',
+  name: "person",
+  type: "object",
   fields: [
+    // ...
     defineField({
-      name: 'name',
-      type: 'string'
+      name: "occupation",
+      type: "string",
+      options: {
+        list: ["doctor", "lawyer", "software engineer", "linguist"],
+      },
     }),
     defineField({
-      name: 'email',
-      type: 'string',
-    })
-    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."
-      ))
-    })
+      name: "favoriteLanguage",
+      type: "string",
+      options: {
+        list: ["typescript", "rust", "python", "swift", "latin", "urdu", "klingon"],
+      },
+      validation: (rule) => 
+        rule.custom(
+          requiredIfSiblingEq("occupation", ["software engineer", "linguist"])
+        ),
+      hidden: ({ parent }) => !["software engineer", "linguist"].includes(parent.occupation),
+    }),
   ],
 })
 ```
 
-And it even works for arrays.
+It even works for null.
 
 ```typescript
 defineType({
-  name: "person",
-  type: "object",
+  name: 'person',
+  type: 'object',
   fields: [
     defineField({
-      name: "name",
-      type: "string",
-    }),
-    defineField({
-      name: "name",
-      type: "string",
+      name: 'name',
+      type: 'string'
     }),
     defineField({
-      name: "occupation",
-      type: "string",
-      options: {
-        list: ["doctor", "lawyer", "software engineer"],
-      },
-    }),
+      name: 'email',
+      type: 'string',
+    })
     defineField({
-      name: "explanation",
-      description: "Why are you wasting your life this way?",
-      type: "text",
-      validation: (rule) => rule.custom(requiredIfSiblingEq("occupation", ["doctor", "lawyer"])),
-      hidden: ({ parent }) => parent.occuption === "software engineer",
-    }),
+      name: 'phone',
+      type: 'string',
+      validation: rule => 
+        rule.custom(
+          requiredIfSiblingEq(
+            'email',
+            null,
+            "If you don’t have an email address, a phone number is required."
+          )
+        )
+    })
   ],
 })
 ```
@@ -262,13 +341,13 @@ defineType({
 
 ### requiredIfSiblingNeq
 
-For a given object that has multiple fields, mark a field as `required` if a sibling does _not_ have a particular value.
+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).
 
 _note:_ This does not work for slugs, because they have to match a nested `.current` value. Use the [requiredIfSlugNeq validator](#requiredIfSlugNeq) instead.
 
 ```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)
+operand: string | number | boolean | null | Array<string, number> // 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.
 ```
 
@@ -291,12 +370,15 @@ defineType({
       }
     })
     defineField({
-      name: 'why',
-      description: 'How many years will you spend paying off your degree?',
-      type: 'number',
-      validation: rule => rule.custom(requiredIfSiblingNeq('occupation', 'software engineer'))
-    }),
-  ],
+      name: "explanation",
+      description: "Why are you wasting your life this way?",
+      type: "text",
+      validation: (rule) => 
+        rule.custom(
+          requiredIfSiblingNeq("occupation", "software engineer")
+        ),
+      hidden: ({ parent }) => parent.occuption === "software engineer",
+    }),  ],
 })
 ```
 
@@ -307,7 +389,7 @@ defineType({
 Mark a field as `required` for documents with matching slugs.
 
 ```typescript
-operand: string | number | null | Array<string, number, null> // possible slug or slugs you’re testing
+operand: string | number | null | Array<string, number> // 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.
 ```
@@ -327,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",
     }),
   ],
@@ -339,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"])
+    ),
 }),
 ```
 
@@ -350,7 +438,7 @@ defineField({
 Require fields on pages that don't match one or more slugs.
 
 ```typescript
-operand: string | number | null | Array<string, number, null> // possible slug or slugs you’re testing
+operand: string | number | null | Array<string, number> // 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.
 ```
@@ -371,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",
     }),
   ],
@@ -395,16 +486,18 @@ 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."
+      )
+    ),
 }),
 ```
 
 **Custom error messages are highly recommended here.** Without the custom message above, the default response would be:
+
 ```
 “me@googlecom” does not match the pattern /^([a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,6})*$/.
 ```
@@ -427,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')
+    ),
 }),
 ```
 
@@ -503,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")
+        ),
     }),
   ],
 })
@@ -536,7 +635,7 @@ defineField({
 
 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.
 
-## Upcoming
+## Roadmap
 
 ### Nested pathfinders
 

package/dist/index.cjs

@@ -25,6 +25,7 @@ __export(index_exports, {
   maxDepth: () => maxDepth,
   minDimensions: () => minDimensions,
   referencedDocumentRequires: () => referencedDocumentRequires,
+  regex: () => regex,
   requiredIfSiblingEq: () => requiredIfSiblingEq,
   requiredIfSlugEq: () => requiredIfSlugEq
 });
@@ -69,20 +70,20 @@ var minDimensions = ({ x, y }, message) => (value) => {
   }
   const { width, height } = (0, import_asset_utils2.getImageDimensions)(value.asset._ref);
   if (!!x && width < x) {
-    return message ? message.replace("{x}", x.toString()).replace("{y}", !y ? "(any)" : y.toString()) : `Image must be at least ${x} pixels wide.`;
+    return message ? message.replace("{width}", width.toString()).replace("{height}", height.toString()).replace("{x}", x.toString()).replace("{y}", !y ? "(any)" : y.toString()) : `Image must be at least ${x} pixels wide.`;
   }
   if (!!y && height < y) {
-    return message ? message.replace("{x}", !x ? "(any)" : x.toString()).replace("{y}", y.toString()) : `Image must be at least ${y} pixels tall.`;
+    return message ? message.replace("{width}", width.toString()).replace("{height}", height.toString()).replace("{x}", !x ? "(any)" : x.toString()).replace("{y}", y.toString()) : `Image must be at least ${y} pixels tall.`;
   }
   return true;
 };
 
 // src/maxDepth.ts
-var maxDepth = (maxDepth2, nestedValueName, message = `Error: You can only nest {nestedValueName} {maxDepth} levels deep.`) => (_, context) => {
-  let regex = new RegExp(String.raw`topLevelItems|${nestedValueName}`);
-  const paths = context.path.filter((e) => typeof e === "string" && e.match(regex));
+var maxDepth = (maxDepth2, key, message = `Error: You can only nest {key} {maxDepth} levels deep.`) => (_, context) => {
+  let regex2 = new RegExp(String.raw`topLevelItems|${key}`);
+  const paths = context.path.filter((e) => typeof e === "string" && e.match(regex2));
   if (paths.length > maxDepth2) {
-    return message.replace("{nestedValueName}", nestedValueName).replace("{maxDepth}", maxDepth2.toString());
+    return message.replace("{key}", key).replace("{nestedValueName}", key).replace("{maxDepth}", maxDepth2.toString());
   }
   return true;
 };
@@ -91,20 +92,20 @@ var maxDepth = (maxDepth2, nestedValueName, message = `Error: You can only nest
 var requiredIfSlugEq = (slug, slugKey = "slug", message = `This is a required field.`) => (value, context) => {
   var _a, _b;
   const slugs = typeof slug === "string" ? [slug] : slug;
-  const currentSlugValue = (_b = (_a = context.parent) == null ? void 0 : _a[slugKey]) == null ? void 0 : _b.current;
-  if (!value && !!currentSlugValue && slugs.includes(currentSlugValue)) {
-    return message.replace("{slugKey}", slugKey).replace("{slug}", slugs.join(", or "));
+  const slugValue = (_b = (_a = context.parent) == null ? void 0 : _a[slugKey]) == null ? void 0 : _b.current;
+  if (!value && !!slugValue && slugs.includes(slugValue)) {
+    return message.replace("{slugKey}", slugKey).replace("{operand}", slugs.join(", or ")).replace("{siblingSlugValue}", slugValue);
   }
   return true;
 };
 
 // src/requiredIfSiblingEq.ts
-var requiredIfSiblingEq = (key, comparison, message = "Required if {key} equals {value}.") => (value, context) => {
-  var _a;
-  const sibling = getSibling(key, context);
-  const comparisons = Array.isArray(comparison) ? comparison : [comparison];
-  if (!value && comparisons.includes(sibling)) {
-    return message.replace("{key}", key).replace("{value}", (_a = comparisons.join(", or ")) != null ? _a : "null");
+var requiredIfSiblingEq = (key, operand, message = "Required if {key} equals {operand}.") => (value, context) => {
+  var _a, _b;
+  const siblingValue = getSibling(key, context);
+  const operands = Array.isArray(operand) ? operand : [operand];
+  if (!value && operands.includes(siblingValue)) {
+    return message.replace("{key}", key).replace("{operand}", (_a = operands.join(", or ")) != null ? _a : "null").replace("{value}", (_b = operands.join(", or ")) != null ? _b : "null").replace("{siblingValue}", siblingValue);
   }
   return true;
 };
@@ -116,6 +117,15 @@ var getSibling = (key, context) => {
   const sibling = (0, import_lodash_es.get)(context.document, [...pathToParentObject, key]);
   return sibling;
 };
+
+// src/regex.ts
+var regex = (pattern, message = `\u201C{value}\u201D does not match the pattern {pattern}.`) => (value) => {
+  if (!value) {
+    return true;
+  }
+  const valueAsString = typeof value !== "string" ? value.toString() : value;
+  return pattern.test(valueAsString) ? true : message.replace("{value}", valueAsString).replace("{pattern}", pattern.toString());
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   fileExtension,
@@ -123,6 +133,7 @@ var getSibling = (key, context) => {
   maxDepth,
   minDimensions,
   referencedDocumentRequires,
+  regex,
   requiredIfSiblingEq,
   requiredIfSlugEq
 });

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/referencedDocumentRequires.ts","../src/fileExtension.ts","../src/minDimensions.ts","../src/maxDepth.ts","../src/requiredIfSlugEq.ts","../src/requiredIfSiblingEq.ts","../src/lib/getSibling.ts"],"sourcesContent":["export * from \"./referencedDocumentRequires\"\nexport * from \"./fileExtension\"\nexport * from \"./minDimensions\"\nexport * from \"./maxDepth\"\nexport * from \"./requiredIfSlugEq\"\nexport * from \"./requiredIfSiblingEq\"\nexport * from \"./lib\"\n","import { ValidationContext } from \"sanity\"\n\nexport const referencedDocumentRequires = (\n  documentType: string, \n  field: string, \n  message: string = `{documentType}’s {field} must be filled.`\n) => async (value: any | undefined, context: ValidationContext) => {\n  if (!value?._ref) {\n    return true\n  }\n  const client = context.getClient({ apiVersion: \"2022-08-12\" })\n  // todo: use current API version, or test with no version at all\n\n  // todo: if there's a value._type or value.referenced._type or something, we get rid of document.type from inputs\n  const data = await client.fetch(`\n    *[_type == \"${documentType}\" && _id == \"${value._ref}\"]{\n      ${field}\n    }[0]\n  `) // TODO: why is typescript screaming about this? Fetch takes two parameters.\n  if (!data[field]) {\n    return message.replace(\"{documentType}\", documentType).replace(\"{field}\", field)\n  }\n  return true\n}\n","import { getExtension } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const fileExtension = (\n  validFileExtension: string | Array<string>, \n  message: string = `Image must be of type {validFileExtension}`\n) => (value: FileValue | undefined) => {\n  if (!value || !value.asset) {\n    return true\n  }\n  const validExtensions = typeof validFileExtension === \"string\" ? [validFileExtension] : validFileExtension\n  const filetype = getExtension(value.asset._ref)\n  if (!validExtensions.includes(filetype)) {\n    return message.replace(\"{validFileExtension}\", validExtensions.join(\", or \"))\n  }\n  return true\n}\n","import { getImageDimensions } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const minDimensions =\n  ({ x, y }: { x: number; y: number }, message?: string) =>\n  (value: FileValue | undefined) => {\n    if (!value || !value.asset) {\n      return true\n    }\n    const { width, height } = getImageDimensions(value.asset._ref)\n    if (!!x && width < x) {\n      return message ? message.replace(\"{x}\", x.toString()).replace(\"{y}\", !y ? \"(any)\" : y.toString()) : `Image must be at least ${x} pixels wide.`\n    }\n    if (!!y && height < y) {\n      return message ? message.replace(\"{x}\", !x ? \"(any)\" : x.toString()).replace(\"{y}\", y.toString()) : `Image must be at least ${y} pixels tall.`\n    }\n    return true\n  }\n","import { ValidationContext } from \"sanity\"\n\nexport const maxDepth = (\n  maxDepth: number, \n  nestedValueName: string,\n  message: string = `Error: You can only nest {nestedValueName} {maxDepth} levels deep.`\n) => (_: any, context: ValidationContext) => {\n  let regex = new RegExp(String.raw`topLevelItems|${nestedValueName}`)\n  const paths = (context.path as Array<any>).filter((e) => typeof e === \"string\" && e.match(regex))\n  if (paths.length > maxDepth) {\n    return message.replace(\"{nestedValueName}\", nestedValueName).replace(\"{maxDepth}\", maxDepth.toString())\n  }\n  return true\n}\n","import { ValidationContext } from \"sanity\"\n\n/*\nSanity has a funny idea of conditional fields. Every field is _always_ present, but it might be hidden.\nex. hidden: (node) => node.parent.slug === 'hideMe'\nThis works really well — unless a field marked as required gets hidden. \n\nThis validator conditionally marks a field as required only for specific slugs. It accepts a string or array of strings.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha'))\nvalidation: (rule) => rule.custom(requiredIfSlugEq(['alpha', 'beta']))\nvalidation: (rule) => rule.custom(requiredIfSlugNotEq(['beta']))\n```\n\nIf the key of your slug is not simply \"slug\", fill that in the optional second parameter.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha', 'id'))\n```\n\n\"Could this method be simpler if it just checked for the self.hidden state?\"\nNot possible, since the hidden state is not exposed to the context.\n\nBut even if it were, you wouldn't want to. There are valid reasons to make a component required but hidden.\nex. an admin- or developer-level identifier that you don't want civilians to see or edit.\n*/\n\nexport const requiredIfSlugEq = (\n  slug: Array<string> | string, \n  slugKey: string = \"slug\", \n  message: string = `This is a required field.`\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const slugs = typeof slug === \"string\" ? [slug] : slug\n    const currentSlugValue = (context.parent as any)?.[slugKey]?.current\n    \n    // todo: does slugKey exist? If not, fail.\n    // todo: deal with nested slugKey (ex. metadata.slug)\n    \n    if (!value && !!currentSlugValue && slugs.includes(currentSlugValue)) {\n      return message.replace(\"{slugKey}\", slugKey).replace(\"{slug}\", slugs.join(', or '))\n    }\n    return true\n  }","import {getSibling} from './'\nimport {ValidationContext} from 'sanity'\n\n/*\nFor a given object that has multiple fields, mark a field as `required` if a sibling has a particular value.\n\n```\ndefineType({\n  name: 'ifAlphaAlsoBeta',\n  type: 'object',\n  fields: [\n    defineField({\n      name: 'alpha',\n      type: 'string',\n      options: {\n        list: ['left', 'right'],\n        layout: 'radio',\n        direction: 'horizontal',\n      },\n    }),\n    defineField({\n      name: 'beta',\n      type: 'string',\n      placeholder: 'If alpha is “left”, I’m also required',\n      validation: (rule) => rule.custom(requiredIfSiblingEq('alpha', 'left')),\n    })\n  ],\n})\n```\n\nIncidentally, context.path is technically Array<sanity.PathSegment>.\n\nThat shouldn't matter, but dealing with that and remapping siblingKey as a PathSegment could be a possible future enhancement.\n*/\n\nexport const requiredIfSiblingEq = (\n  key: string, \n  comparison: string | number | null | Array<string | number | null>, \n  message: string = 'Required if {key} equals {value}.'\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const sibling = getSibling(key, context)\n    const comparisons = Array.isArray(comparison) ? comparison : [comparison]\n    if (!value && comparisons.includes(sibling)) {\n      return message.replace('{key}', key).replace('{value}', comparisons.join(', or ') ?? 'null')\n    }\n    return true\n  }\n","import { get } from \"lodash-es\"\nimport { ValidationContext } from \"sanity\"\n\nexport const getSibling = (key: string | number, context: ValidationContext) => {\n  const pathToParentObject = context.path!.slice(0, -1) as Array<string | number>\n  const sibling = get(context.document, [...pathToParentObject, key])\n  return sibling\n}\n\n/*\nTODO:\n  There is an issue with finding a sibling when in an array element.\n  If the context document looks something like this…\n    {\n      someArray: [\n        {\n          _key: 'abc123',\n          targetSibling: 'herpderp'\n        }\n      ]\n    }\n  … we wind up with a path of…\n    [ 'someArray', { _key: 'ab123' }, 'targetSibling' ]\n  lodash.get() is trying to do an exact match, it doesn't know how to get object by _key.\n  \n  Will probably have to replace get() with a gnarly recursive lookup function.\n*/\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEO,IAAM,6BAA6B,CACxC,cACA,OACA,UAAkB,oDACf,OAAO,OAAwB,YAA+B;AACjE,MAAI,EAAC,+BAAO,OAAM;AAChB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,QAAQ,UAAU,EAAE,YAAY,aAAa,CAAC;AAI7D,QAAM,OAAO,MAAM,OAAO,MAAM;AAAA,kBAChB,YAAY,gBAAgB,MAAM,IAAI;AAAA,QAChD,KAAK;AAAA;AAAA,GAEV;AACD,MAAI,CAAC,KAAK,KAAK,GAAG;AAChB,WAAO,QAAQ,QAAQ,kBAAkB,YAAY,EAAE,QAAQ,WAAW,KAAK;AAAA,EACjF;AACA,SAAO;AACT;;;ACvBA,yBAA6B;AAGtB,IAAM,gBAAgB,CAC3B,oBACA,UAAkB,iDACf,CAAC,UAAiC;AACrC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,kBAAkB,OAAO,uBAAuB,WAAW,CAAC,kBAAkB,IAAI;AACxF,QAAM,eAAW,iCAAa,MAAM,MAAM,IAAI;AAC9C,MAAI,CAAC,gBAAgB,SAAS,QAAQ,GAAG;AACvC,WAAO,QAAQ,QAAQ,wBAAwB,gBAAgB,KAAK,OAAO,CAAC;AAAA,EAC9E;AACA,SAAO;AACT;;;AChBA,IAAAA,sBAAmC;AAG5B,IAAM,gBACX,CAAC,EAAE,GAAG,EAAE,GAA6B,YACrC,CAAC,UAAiC;AAChC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,EAAE,OAAO,OAAO,QAAI,wCAAmB,MAAM,MAAM,IAAI;AAC7D,MAAI,CAAC,CAAC,KAAK,QAAQ,GAAG;AACpB,WAAO,UAAU,QAAQ,QAAQ,OAAO,EAAE,SAAS,CAAC,EAAE,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,IAAI,0BAA0B,CAAC;AAAA,EACjI;AACA,MAAI,CAAC,CAAC,KAAK,SAAS,GAAG;AACrB,WAAO,UAAU,QAAQ,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,EAAE,QAAQ,OAAO,EAAE,SAAS,CAAC,IAAI,0BAA0B,CAAC;AAAA,EACjI;AACA,SAAO;AACT;;;ACfK,IAAM,WAAW,CACtBC,WACA,iBACA,UAAkB,yEACf,CAAC,GAAQ,YAA+B;AAC3C,MAAI,QAAQ,IAAI,OAAO,OAAO,oBAAoB,eAAe,EAAE;AACnE,QAAM,QAAS,QAAQ,KAAoB,OAAO,CAAC,MAAM,OAAO,MAAM,YAAY,EAAE,MAAM,KAAK,CAAC;AAChG,MAAI,MAAM,SAASA,WAAU;AAC3B,WAAO,QAAQ,QAAQ,qBAAqB,eAAe,EAAE,QAAQ,cAAcA,UAAS,SAAS,CAAC;AAAA,EACxG;AACA,SAAO;AACT;;;ACaO,IAAM,mBAAmB,CAC9B,MACA,UAAkB,QAClB,UAAkB,gCAElB,CAAC,OAA4B,YAA+B;AA/B9D;AAgCI,QAAM,QAAQ,OAAO,SAAS,WAAW,CAAC,IAAI,IAAI;AAClD,QAAM,oBAAoB,mBAAQ,WAAR,mBAAyB,aAAzB,mBAAmC;AAK7D,MAAI,CAAC,SAAS,CAAC,CAAC,oBAAoB,MAAM,SAAS,gBAAgB,GAAG;AACpE,WAAO,QAAQ,QAAQ,aAAa,OAAO,EAAE,QAAQ,UAAU,MAAM,KAAK,OAAO,CAAC;AAAA,EACpF;AACA,SAAO;AACT;;;ACPK,IAAM,sBAAsB,CACjC,KACA,YACA,UAAkB,wCAElB,CAAC,OAA4B,YAA+B;AAxC9D;AAyCI,QAAM,UAAU,WAAW,KAAK,OAAO;AACvC,QAAM,cAAc,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;AACxE,MAAI,CAAC,SAAS,YAAY,SAAS,OAAO,GAAG;AAC3C,WAAO,QAAQ,QAAQ,SAAS,GAAG,EAAE,QAAQ,YAAW,iBAAY,KAAK,OAAO,MAAxB,YAA6B,MAAM;AAAA,EAC7F;AACA,SAAO;AACT;;;AC/CF,uBAAoB;AAGb,IAAM,aAAa,CAAC,KAAsB,YAA+B;AAC9E,QAAM,qBAAqB,QAAQ,KAAM,MAAM,GAAG,EAAE;AACpD,QAAM,cAAU,sBAAI,QAAQ,UAAU,CAAC,GAAG,oBAAoB,GAAG,CAAC;AAClE,SAAO;AACT;","names":["import_asset_utils","maxDepth"]}
+{"version":3,"sources":["../src/index.ts","../src/referencedDocumentRequires.ts","../src/fileExtension.ts","../src/minDimensions.ts","../src/maxDepth.ts","../src/requiredIfSlugEq.ts","../src/requiredIfSiblingEq.ts","../src/lib/getSibling.ts","../src/regex.ts"],"sourcesContent":["export * from \"./referencedDocumentRequires\"\nexport * from \"./fileExtension\"\nexport * from \"./minDimensions\"\nexport * from \"./maxDepth\"\nexport * from \"./requiredIfSlugEq\"\nexport * from \"./requiredIfSiblingEq\"\nexport * from \"./lib\"\nexport * from \"./regex\"\n","import { ValidationContext } from \"sanity\"\n\nexport const referencedDocumentRequires = (\n  documentType: string, \n  field: string, \n  message: string = `{documentType}’s {field} must be filled.`\n) => async (value: any | undefined, context: ValidationContext) => {\n  if (!value?._ref) {\n    return true\n  }\n  const client = context.getClient({ apiVersion: \"2022-08-12\" })\n  // todo: use current API version, or test with no version at all\n\n  // todo: if there's a value._type or value.referenced._type or something, we get rid of document.type from inputs\n  const data = await client.fetch(`\n    *[_type == \"${documentType}\" && _id == \"${value._ref}\"]{\n      ${field}\n    }[0]\n  `) // TODO: why is typescript screaming about this? Fetch takes two parameters.\n  if (!data[field]) {\n    return message.replace(\"{documentType}\", documentType).replace(\"{field}\", field)\n  }\n  return true\n}\n","import { getExtension } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const fileExtension = (\n  validFileExtension: string | Array<string>, \n  message: string = `Image must be of type {validFileExtension}`\n) => (value: FileValue | undefined) => {\n  if (!value || !value.asset) {\n    return true\n  }\n  const validExtensions = typeof validFileExtension === \"string\" ? [validFileExtension] : validFileExtension\n  const filetype = getExtension(value.asset._ref)\n  if (!validExtensions.includes(filetype)) {\n    return message.replace(\"{validFileExtension}\", validExtensions.join(\", or \"))\n  }\n  return true\n}\n\n// todo: this should fail if its attached to a field that is not of type \"file\"","import { getImageDimensions } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const minDimensions =\n  ({ x, y }: { x: number; y: number }, message?: string) =>\n  (value: FileValue | undefined) => {\n    if (!value || !value.asset) {\n      return true\n    }\n    const { width, height } = getImageDimensions(value.asset._ref)\n    if (!!x && width < x) {\n      return message \n        ? message.replace(\"{width}\", width.toString())\n          .replace(\"{height}\", height.toString())\n          .replace(\"{x}\", x.toString())\n          .replace(\"{y}\", !y ? \"(any)\" : y.toString()) \n        : `Image must be at least ${x} pixels wide.`\n    }\n    if (!!y && height < y) {\n      return message \n        ? message.replace(\"{width}\", width.toString())\n          .replace(\"{height}\", height.toString())\n          .replace(\"{x}\", !x ? \"(any)\" : x.toString())\n          .replace(\"{y}\", y.toString())\n        : `Image must be at least ${y} pixels tall.`\n    }\n    return true\n  }\n\n// todo: this should fail if its attached to a field that is not of type \"image\"","import { ValidationContext } from \"sanity\"\n\nexport const maxDepth = (\n  maxDepth: number, \n  key: string,\n  message: string = `Error: You can only nest {key} {maxDepth} levels deep.`\n) => (_: any, context: ValidationContext) => {\n  let regex = new RegExp(String.raw`topLevelItems|${key}`)\n  const paths = (context.path as Array<any>).filter((e) => typeof e === \"string\" && e.match(regex))\n  if (paths.length > maxDepth) {\n    return message\n      .replace(\"{key}\", key)\n      .replace(\"{nestedValueName}\", key)  // backward compatibility\n      .replace(\"{maxDepth}\", maxDepth.toString())\n  }\n  return true\n}\n","import { ValidationContext } from \"sanity\"\n\n/*\nSanity has a funny idea of conditional fields. Every field is _always_ present, but it might be hidden.\nex. hidden: (node) => node.parent.slug === 'hideMe'\nThis works really well — unless a field marked as required gets hidden. \n\nThis validator conditionally marks a field as required only for specific slugs. It accepts a string or array of strings.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha'))\nvalidation: (rule) => rule.custom(requiredIfSlugEq(['alpha', 'beta']))\nvalidation: (rule) => rule.custom(requiredIfSlugNotEq(['beta']))\n```\n\nIf the key of your slug is not simply \"slug\", fill that in the optional second parameter.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha', 'id'))\n```\n\n\"Could this method be simpler if it just checked for the self.hidden state?\"\nNot possible, since the hidden state is not exposed to the context.\n\nBut even if it were, you wouldn't want to. There are valid reasons to make a component required but hidden.\nex. an admin- or developer-level identifier that you don't want civilians to see or edit.\n*/\n\nexport const requiredIfSlugEq = (\n  slug: Array<string> | string, \n  slugKey: string = \"slug\", \n  message: string = `This is a required field.`\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const slugs = typeof slug === \"string\" ? [slug] : slug\n    const slugValue = (context.parent as any)?.[slugKey]?.current\n    \n    // todo: does slugKey exist? If not, fail.\n    // todo: deal with nested slugKey (ex. metadata.slug)\n    \n    if (!value && !!slugValue && slugs.includes(slugValue)) {\n      return message\n        .replace(\"{slugKey}\", slugKey)\n        .replace(\"{operand}\", slugs.join(', or '))\n        .replace(\"{siblingSlugValue}\", slugValue)\n    }\n    return true\n  }","import {getSibling} from './'\nimport {ValidationContext} from 'sanity'\n\n/*\nFor a given object that has multiple fields, mark a field as `required` if a sibling has a particular value.\n\n```\ndefineType({\n  name: 'ifAlphaAlsoBeta',\n  type: 'object',\n  fields: [\n    defineField({\n      name: 'alpha',\n      type: 'string',\n      options: {\n        list: ['left', 'right'],\n        layout: 'radio',\n        direction: 'horizontal',\n      },\n    }),\n    defineField({\n      name: 'beta',\n      type: 'string',\n      placeholder: 'If alpha is “left”, I’m also required',\n      validation: (rule) => rule.custom(requiredIfSiblingEq('alpha', 'left')),\n    })\n  ],\n})\n```\n\nIncidentally, context.path is technically Array<sanity.PathSegment>.\n\nThat shouldn't matter, but dealing with that and remapping siblingKey as a PathSegment could be a possible future enhancement.\n*/\n\nexport const requiredIfSiblingEq = (\n  key: string, \n  operand: string | number | null | Array<string | number | null>, \n  message: string = 'Required if {key} equals {operand}.'\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const siblingValue = getSibling(key, context)\n    const operands = Array.isArray(operand) ? operand : [operand]\n    if (!value && operands.includes(siblingValue)) {\n      return message\n        .replace('{key}', key)\n        .replace('{operand}', operands.join(', or ') ?? 'null')\n        .replace('{value}', operands.join(', or ') ?? 'null') // backward compatibility\n        .replace('{siblingValue}', siblingValue)\n    }\n    return true\n  }\n","import { get } from \"lodash-es\"\nimport { ValidationContext } from \"sanity\"\n\nexport const getSibling = (key: string | number, context: ValidationContext) => {\n  const pathToParentObject = context.path!.slice(0, -1) as Array<string | number>\n  const sibling = get(context.document, [...pathToParentObject, key])\n  return sibling\n}\n\n/*\nTODO:\n  There is an issue with finding a sibling when in an array element.\n  If the context document looks something like this…\n    {\n      someArray: [\n        {\n          _key: 'abc123',\n          targetSibling: 'herpderp'\n        }\n      ]\n    }\n  … we wind up with a path of…\n    [ 'someArray', { _key: 'ab123' }, 'targetSibling' ]\n  lodash.get() is trying to do an exact match, it doesn't know how to get object by _key.\n  \n  Will probably have to replace get() with a gnarly recursive lookup function.\n*/\n","export const regex =\n  (pattern: RegExp, message: string = `“{value}” does not match the pattern {pattern}.`) =>\n  (value: unknown) => {\n    if (!value) {\n      return true\n    }\n    const valueAsString = typeof value !== \"string\" ? value.toString() : value\n    return pattern.test(valueAsString) ? true : message.replace(\"{value}\", valueAsString).replace(\"{pattern}\", pattern.toString())\n  }\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEO,IAAM,6BAA6B,CACxC,cACA,OACA,UAAkB,oDACf,OAAO,OAAwB,YAA+B;AACjE,MAAI,EAAC,+BAAO,OAAM;AAChB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,QAAQ,UAAU,EAAE,YAAY,aAAa,CAAC;AAI7D,QAAM,OAAO,MAAM,OAAO,MAAM;AAAA,kBAChB,YAAY,gBAAgB,MAAM,IAAI;AAAA,QAChD,KAAK;AAAA;AAAA,GAEV;AACD,MAAI,CAAC,KAAK,KAAK,GAAG;AAChB,WAAO,QAAQ,QAAQ,kBAAkB,YAAY,EAAE,QAAQ,WAAW,KAAK;AAAA,EACjF;AACA,SAAO;AACT;;;ACvBA,yBAA6B;AAGtB,IAAM,gBAAgB,CAC3B,oBACA,UAAkB,iDACf,CAAC,UAAiC;AACrC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,kBAAkB,OAAO,uBAAuB,WAAW,CAAC,kBAAkB,IAAI;AACxF,QAAM,eAAW,iCAAa,MAAM,MAAM,IAAI;AAC9C,MAAI,CAAC,gBAAgB,SAAS,QAAQ,GAAG;AACvC,WAAO,QAAQ,QAAQ,wBAAwB,gBAAgB,KAAK,OAAO,CAAC;AAAA,EAC9E;AACA,SAAO;AACT;;;AChBA,IAAAA,sBAAmC;AAG5B,IAAM,gBACX,CAAC,EAAE,GAAG,EAAE,GAA6B,YACrC,CAAC,UAAiC;AAChC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,EAAE,OAAO,OAAO,QAAI,wCAAmB,MAAM,MAAM,IAAI;AAC7D,MAAI,CAAC,CAAC,KAAK,QAAQ,GAAG;AACpB,WAAO,UACH,QAAQ,QAAQ,WAAW,MAAM,SAAS,CAAC,EAC1C,QAAQ,YAAY,OAAO,SAAS,CAAC,EACrC,QAAQ,OAAO,EAAE,SAAS,CAAC,EAC3B,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,IAC3C,0BAA0B,CAAC;AAAA,EACjC;AACA,MAAI,CAAC,CAAC,KAAK,SAAS,GAAG;AACrB,WAAO,UACH,QAAQ,QAAQ,WAAW,MAAM,SAAS,CAAC,EAC1C,QAAQ,YAAY,OAAO,SAAS,CAAC,EACrC,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,EAC1C,QAAQ,OAAO,EAAE,SAAS,CAAC,IAC5B,0BAA0B,CAAC;AAAA,EACjC;AACA,SAAO;AACT;;;ACzBK,IAAM,WAAW,CACtBC,WACA,KACA,UAAkB,6DACf,CAAC,GAAQ,YAA+B;AAC3C,MAAIC,SAAQ,IAAI,OAAO,OAAO,oBAAoB,GAAG,EAAE;AACvD,QAAM,QAAS,QAAQ,KAAoB,OAAO,CAAC,MAAM,OAAO,MAAM,YAAY,EAAE,MAAMA,MAAK,CAAC;AAChG,MAAI,MAAM,SAASD,WAAU;AAC3B,WAAO,QACJ,QAAQ,SAAS,GAAG,EACpB,QAAQ,qBAAqB,GAAG,EAChC,QAAQ,cAAcA,UAAS,SAAS,CAAC;AAAA,EAC9C;AACA,SAAO;AACT;;;ACUO,IAAM,mBAAmB,CAC9B,MACA,UAAkB,QAClB,UAAkB,gCAElB,CAAC,OAA4B,YAA+B;AA/B9D;AAgCI,QAAM,QAAQ,OAAO,SAAS,WAAW,CAAC,IAAI,IAAI;AAClD,QAAM,aAAa,mBAAQ,WAAR,mBAAyB,aAAzB,mBAAmC;AAKtD,MAAI,CAAC,SAAS,CAAC,CAAC,aAAa,MAAM,SAAS,SAAS,GAAG;AACtD,WAAO,QACJ,QAAQ,aAAa,OAAO,EAC5B,QAAQ,aAAa,MAAM,KAAK,OAAO,CAAC,EACxC,QAAQ,sBAAsB,SAAS;AAAA,EAC5C;AACA,SAAO;AACT;;;ACVK,IAAM,sBAAsB,CACjC,KACA,SACA,UAAkB,0CAElB,CAAC,OAA4B,YAA+B;AAxC9D;AAyCI,QAAM,eAAe,WAAW,KAAK,OAAO;AAC5C,QAAM,WAAW,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;AAC5D,MAAI,CAAC,SAAS,SAAS,SAAS,YAAY,GAAG;AAC7C,WAAO,QACJ,QAAQ,SAAS,GAAG,EACpB,QAAQ,cAAa,cAAS,KAAK,OAAO,MAArB,YAA0B,MAAM,EACrD,QAAQ,YAAW,cAAS,KAAK,OAAO,MAArB,YAA0B,MAAM,EACnD,QAAQ,kBAAkB,YAAY;AAAA,EAC3C;AACA,SAAO;AACT;;;ACnDF,uBAAoB;AAGb,IAAM,aAAa,CAAC,KAAsB,YAA+B;AAC9E,QAAM,qBAAqB,QAAQ,KAAM,MAAM,GAAG,EAAE;AACpD,QAAM,cAAU,sBAAI,QAAQ,UAAU,CAAC,GAAG,oBAAoB,GAAG,CAAC;AAClE,SAAO;AACT;;;ACPO,IAAM,QACX,CAAC,SAAiB,UAAkB,gEACpC,CAAC,UAAmB;AAClB,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AACA,QAAM,gBAAgB,OAAO,UAAU,WAAW,MAAM,SAAS,IAAI;AACrE,SAAO,QAAQ,KAAK,aAAa,IAAI,OAAO,QAAQ,QAAQ,WAAW,aAAa,EAAE,QAAQ,aAAa,QAAQ,SAAS,CAAC;AAC/H;","names":["import_asset_utils","maxDepth","regex"]}

package/dist/index.d.cts

@@ -9,12 +9,14 @@ declare const minDimensions: ({ x, y }: {
     y: number;
 }, message?: string) => (value: FileValue | undefined) => string | true;
 
-declare const maxDepth: (maxDepth: number, nestedValueName: string, message?: string) => (_: any, context: ValidationContext) => string | true;
+declare const maxDepth: (maxDepth: number, key: string, message?: string) => (_: any, context: ValidationContext) => string | true;
 
 declare const requiredIfSlugEq: (slug: Array<string> | string, slugKey?: string, message?: string) => (value: unknown | undefined, context: ValidationContext) => string | true;
 
-declare const requiredIfSiblingEq: (key: string, comparison: string | number | null | Array<string | number | null>, message?: string) => (value: unknown | undefined, context: ValidationContext) => string | true;
+declare const requiredIfSiblingEq: (key: string, operand: string | number | null | Array<string | number | null>, message?: string) => (value: unknown | undefined, context: ValidationContext) => string | true;
 
 declare const getSibling: (key: string | number, context: ValidationContext) => any;
 
-export { fileExtension, getSibling, maxDepth, minDimensions, referencedDocumentRequires, requiredIfSiblingEq, requiredIfSlugEq };
+declare const regex: (pattern: RegExp, message?: string) => (value: unknown) => string | true;
+
+export { fileExtension, getSibling, maxDepth, minDimensions, referencedDocumentRequires, regex, requiredIfSiblingEq, requiredIfSlugEq };

package/dist/index.d.ts

@@ -9,12 +9,14 @@ declare const minDimensions: ({ x, y }: {
     y: number;
 }, message?: string) => (value: FileValue | undefined) => string | true;
 
-declare const maxDepth: (maxDepth: number, nestedValueName: string, message?: string) => (_: any, context: ValidationContext) => string | true;
+declare const maxDepth: (maxDepth: number, key: string, message?: string) => (_: any, context: ValidationContext) => string | true;
 
 declare const requiredIfSlugEq: (slug: Array<string> | string, slugKey?: string, message?: string) => (value: unknown | undefined, context: ValidationContext) => string | true;
 
-declare const requiredIfSiblingEq: (key: string, comparison: string | number | null | Array<string | number | null>, message?: string) => (value: unknown | undefined, context: ValidationContext) => string | true;
+declare const requiredIfSiblingEq: (key: string, operand: string | number | null | Array<string | number | null>, message?: string) => (value: unknown | undefined, context: ValidationContext) => string | true;
 
 declare const getSibling: (key: string | number, context: ValidationContext) => any;
 
-export { fileExtension, getSibling, maxDepth, minDimensions, referencedDocumentRequires, requiredIfSiblingEq, requiredIfSlugEq };
+declare const regex: (pattern: RegExp, message?: string) => (value: unknown) => string | true;
+
+export { fileExtension, getSibling, maxDepth, minDimensions, referencedDocumentRequires, regex, requiredIfSiblingEq, requiredIfSlugEq };

package/dist/index.js

@@ -37,20 +37,20 @@ var minDimensions = ({ x, y }, message) => (value) => {
   }
   const { width, height } = getImageDimensions(value.asset._ref);
   if (!!x && width < x) {
-    return message ? message.replace("{x}", x.toString()).replace("{y}", !y ? "(any)" : y.toString()) : `Image must be at least ${x} pixels wide.`;
+    return message ? message.replace("{width}", width.toString()).replace("{height}", height.toString()).replace("{x}", x.toString()).replace("{y}", !y ? "(any)" : y.toString()) : `Image must be at least ${x} pixels wide.`;
   }
   if (!!y && height < y) {
-    return message ? message.replace("{x}", !x ? "(any)" : x.toString()).replace("{y}", y.toString()) : `Image must be at least ${y} pixels tall.`;
+    return message ? message.replace("{width}", width.toString()).replace("{height}", height.toString()).replace("{x}", !x ? "(any)" : x.toString()).replace("{y}", y.toString()) : `Image must be at least ${y} pixels tall.`;
   }
   return true;
 };
 
 // src/maxDepth.ts
-var maxDepth = (maxDepth2, nestedValueName, message = `Error: You can only nest {nestedValueName} {maxDepth} levels deep.`) => (_, context) => {
-  let regex = new RegExp(String.raw`topLevelItems|${nestedValueName}`);
-  const paths = context.path.filter((e) => typeof e === "string" && e.match(regex));
+var maxDepth = (maxDepth2, key, message = `Error: You can only nest {key} {maxDepth} levels deep.`) => (_, context) => {
+  let regex2 = new RegExp(String.raw`topLevelItems|${key}`);
+  const paths = context.path.filter((e) => typeof e === "string" && e.match(regex2));
   if (paths.length > maxDepth2) {
-    return message.replace("{nestedValueName}", nestedValueName).replace("{maxDepth}", maxDepth2.toString());
+    return message.replace("{key}", key).replace("{nestedValueName}", key).replace("{maxDepth}", maxDepth2.toString());
   }
   return true;
 };
@@ -59,20 +59,20 @@ var maxDepth = (maxDepth2, nestedValueName, message = `Error: You can only nest
 var requiredIfSlugEq = (slug, slugKey = "slug", message = `This is a required field.`) => (value, context) => {
   var _a, _b;
   const slugs = typeof slug === "string" ? [slug] : slug;
-  const currentSlugValue = (_b = (_a = context.parent) == null ? void 0 : _a[slugKey]) == null ? void 0 : _b.current;
-  if (!value && !!currentSlugValue && slugs.includes(currentSlugValue)) {
-    return message.replace("{slugKey}", slugKey).replace("{slug}", slugs.join(", or "));
+  const slugValue = (_b = (_a = context.parent) == null ? void 0 : _a[slugKey]) == null ? void 0 : _b.current;
+  if (!value && !!slugValue && slugs.includes(slugValue)) {
+    return message.replace("{slugKey}", slugKey).replace("{operand}", slugs.join(", or ")).replace("{siblingSlugValue}", slugValue);
   }
   return true;
 };
 
 // src/requiredIfSiblingEq.ts
-var requiredIfSiblingEq = (key, comparison, message = "Required if {key} equals {value}.") => (value, context) => {
-  var _a;
-  const sibling = getSibling(key, context);
-  const comparisons = Array.isArray(comparison) ? comparison : [comparison];
-  if (!value && comparisons.includes(sibling)) {
-    return message.replace("{key}", key).replace("{value}", (_a = comparisons.join(", or ")) != null ? _a : "null");
+var requiredIfSiblingEq = (key, operand, message = "Required if {key} equals {operand}.") => (value, context) => {
+  var _a, _b;
+  const siblingValue = getSibling(key, context);
+  const operands = Array.isArray(operand) ? operand : [operand];
+  if (!value && operands.includes(siblingValue)) {
+    return message.replace("{key}", key).replace("{operand}", (_a = operands.join(", or ")) != null ? _a : "null").replace("{value}", (_b = operands.join(", or ")) != null ? _b : "null").replace("{siblingValue}", siblingValue);
   }
   return true;
 };
@@ -84,12 +84,22 @@ var getSibling = (key, context) => {
   const sibling = get(context.document, [...pathToParentObject, key]);
   return sibling;
 };
+
+// src/regex.ts
+var regex = (pattern, message = `\u201C{value}\u201D does not match the pattern {pattern}.`) => (value) => {
+  if (!value) {
+    return true;
+  }
+  const valueAsString = typeof value !== "string" ? value.toString() : value;
+  return pattern.test(valueAsString) ? true : message.replace("{value}", valueAsString).replace("{pattern}", pattern.toString());
+};
 export {
   fileExtension,
   getSibling,
   maxDepth,
   minDimensions,
   referencedDocumentRequires,
+  regex,
   requiredIfSiblingEq,
   requiredIfSlugEq
 };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/referencedDocumentRequires.ts","../src/fileExtension.ts","../src/minDimensions.ts","../src/maxDepth.ts","../src/requiredIfSlugEq.ts","../src/requiredIfSiblingEq.ts","../src/lib/getSibling.ts"],"sourcesContent":["import { ValidationContext } from \"sanity\"\n\nexport const referencedDocumentRequires = (\n  documentType: string, \n  field: string, \n  message: string = `{documentType}’s {field} must be filled.`\n) => async (value: any | undefined, context: ValidationContext) => {\n  if (!value?._ref) {\n    return true\n  }\n  const client = context.getClient({ apiVersion: \"2022-08-12\" })\n  // todo: use current API version, or test with no version at all\n\n  // todo: if there's a value._type or value.referenced._type or something, we get rid of document.type from inputs\n  const data = await client.fetch(`\n    *[_type == \"${documentType}\" && _id == \"${value._ref}\"]{\n      ${field}\n    }[0]\n  `) // TODO: why is typescript screaming about this? Fetch takes two parameters.\n  if (!data[field]) {\n    return message.replace(\"{documentType}\", documentType).replace(\"{field}\", field)\n  }\n  return true\n}\n","import { getExtension } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const fileExtension = (\n  validFileExtension: string | Array<string>, \n  message: string = `Image must be of type {validFileExtension}`\n) => (value: FileValue | undefined) => {\n  if (!value || !value.asset) {\n    return true\n  }\n  const validExtensions = typeof validFileExtension === \"string\" ? [validFileExtension] : validFileExtension\n  const filetype = getExtension(value.asset._ref)\n  if (!validExtensions.includes(filetype)) {\n    return message.replace(\"{validFileExtension}\", validExtensions.join(\", or \"))\n  }\n  return true\n}\n","import { getImageDimensions } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const minDimensions =\n  ({ x, y }: { x: number; y: number }, message?: string) =>\n  (value: FileValue | undefined) => {\n    if (!value || !value.asset) {\n      return true\n    }\n    const { width, height } = getImageDimensions(value.asset._ref)\n    if (!!x && width < x) {\n      return message ? message.replace(\"{x}\", x.toString()).replace(\"{y}\", !y ? \"(any)\" : y.toString()) : `Image must be at least ${x} pixels wide.`\n    }\n    if (!!y && height < y) {\n      return message ? message.replace(\"{x}\", !x ? \"(any)\" : x.toString()).replace(\"{y}\", y.toString()) : `Image must be at least ${y} pixels tall.`\n    }\n    return true\n  }\n","import { ValidationContext } from \"sanity\"\n\nexport const maxDepth = (\n  maxDepth: number, \n  nestedValueName: string,\n  message: string = `Error: You can only nest {nestedValueName} {maxDepth} levels deep.`\n) => (_: any, context: ValidationContext) => {\n  let regex = new RegExp(String.raw`topLevelItems|${nestedValueName}`)\n  const paths = (context.path as Array<any>).filter((e) => typeof e === \"string\" && e.match(regex))\n  if (paths.length > maxDepth) {\n    return message.replace(\"{nestedValueName}\", nestedValueName).replace(\"{maxDepth}\", maxDepth.toString())\n  }\n  return true\n}\n","import { ValidationContext } from \"sanity\"\n\n/*\nSanity has a funny idea of conditional fields. Every field is _always_ present, but it might be hidden.\nex. hidden: (node) => node.parent.slug === 'hideMe'\nThis works really well — unless a field marked as required gets hidden. \n\nThis validator conditionally marks a field as required only for specific slugs. It accepts a string or array of strings.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha'))\nvalidation: (rule) => rule.custom(requiredIfSlugEq(['alpha', 'beta']))\nvalidation: (rule) => rule.custom(requiredIfSlugNotEq(['beta']))\n```\n\nIf the key of your slug is not simply \"slug\", fill that in the optional second parameter.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha', 'id'))\n```\n\n\"Could this method be simpler if it just checked for the self.hidden state?\"\nNot possible, since the hidden state is not exposed to the context.\n\nBut even if it were, you wouldn't want to. There are valid reasons to make a component required but hidden.\nex. an admin- or developer-level identifier that you don't want civilians to see or edit.\n*/\n\nexport const requiredIfSlugEq = (\n  slug: Array<string> | string, \n  slugKey: string = \"slug\", \n  message: string = `This is a required field.`\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const slugs = typeof slug === \"string\" ? [slug] : slug\n    const currentSlugValue = (context.parent as any)?.[slugKey]?.current\n    \n    // todo: does slugKey exist? If not, fail.\n    // todo: deal with nested slugKey (ex. metadata.slug)\n    \n    if (!value && !!currentSlugValue && slugs.includes(currentSlugValue)) {\n      return message.replace(\"{slugKey}\", slugKey).replace(\"{slug}\", slugs.join(', or '))\n    }\n    return true\n  }","import {getSibling} from './'\nimport {ValidationContext} from 'sanity'\n\n/*\nFor a given object that has multiple fields, mark a field as `required` if a sibling has a particular value.\n\n```\ndefineType({\n  name: 'ifAlphaAlsoBeta',\n  type: 'object',\n  fields: [\n    defineField({\n      name: 'alpha',\n      type: 'string',\n      options: {\n        list: ['left', 'right'],\n        layout: 'radio',\n        direction: 'horizontal',\n      },\n    }),\n    defineField({\n      name: 'beta',\n      type: 'string',\n      placeholder: 'If alpha is “left”, I’m also required',\n      validation: (rule) => rule.custom(requiredIfSiblingEq('alpha', 'left')),\n    })\n  ],\n})\n```\n\nIncidentally, context.path is technically Array<sanity.PathSegment>.\n\nThat shouldn't matter, but dealing with that and remapping siblingKey as a PathSegment could be a possible future enhancement.\n*/\n\nexport const requiredIfSiblingEq = (\n  key: string, \n  comparison: string | number | null | Array<string | number | null>, \n  message: string = 'Required if {key} equals {value}.'\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const sibling = getSibling(key, context)\n    const comparisons = Array.isArray(comparison) ? comparison : [comparison]\n    if (!value && comparisons.includes(sibling)) {\n      return message.replace('{key}', key).replace('{value}', comparisons.join(', or ') ?? 'null')\n    }\n    return true\n  }\n","import { get } from \"lodash-es\"\nimport { ValidationContext } from \"sanity\"\n\nexport const getSibling = (key: string | number, context: ValidationContext) => {\n  const pathToParentObject = context.path!.slice(0, -1) as Array<string | number>\n  const sibling = get(context.document, [...pathToParentObject, key])\n  return sibling\n}\n\n/*\nTODO:\n  There is an issue with finding a sibling when in an array element.\n  If the context document looks something like this…\n    {\n      someArray: [\n        {\n          _key: 'abc123',\n          targetSibling: 'herpderp'\n        }\n      ]\n    }\n  … we wind up with a path of…\n    [ 'someArray', { _key: 'ab123' }, 'targetSibling' ]\n  lodash.get() is trying to do an exact match, it doesn't know how to get object by _key.\n  \n  Will probably have to replace get() with a gnarly recursive lookup function.\n*/\n"],"mappings":";AAEO,IAAM,6BAA6B,CACxC,cACA,OACA,UAAkB,oDACf,OAAO,OAAwB,YAA+B;AACjE,MAAI,EAAC,+BAAO,OAAM;AAChB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,QAAQ,UAAU,EAAE,YAAY,aAAa,CAAC;AAI7D,QAAM,OAAO,MAAM,OAAO,MAAM;AAAA,kBAChB,YAAY,gBAAgB,MAAM,IAAI;AAAA,QAChD,KAAK;AAAA;AAAA,GAEV;AACD,MAAI,CAAC,KAAK,KAAK,GAAG;AAChB,WAAO,QAAQ,QAAQ,kBAAkB,YAAY,EAAE,QAAQ,WAAW,KAAK;AAAA,EACjF;AACA,SAAO;AACT;;;ACvBA,SAAS,oBAAoB;AAGtB,IAAM,gBAAgB,CAC3B,oBACA,UAAkB,iDACf,CAAC,UAAiC;AACrC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,kBAAkB,OAAO,uBAAuB,WAAW,CAAC,kBAAkB,IAAI;AACxF,QAAM,WAAW,aAAa,MAAM,MAAM,IAAI;AAC9C,MAAI,CAAC,gBAAgB,SAAS,QAAQ,GAAG;AACvC,WAAO,QAAQ,QAAQ,wBAAwB,gBAAgB,KAAK,OAAO,CAAC;AAAA,EAC9E;AACA,SAAO;AACT;;;AChBA,SAAS,0BAA0B;AAG5B,IAAM,gBACX,CAAC,EAAE,GAAG,EAAE,GAA6B,YACrC,CAAC,UAAiC;AAChC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,EAAE,OAAO,OAAO,IAAI,mBAAmB,MAAM,MAAM,IAAI;AAC7D,MAAI,CAAC,CAAC,KAAK,QAAQ,GAAG;AACpB,WAAO,UAAU,QAAQ,QAAQ,OAAO,EAAE,SAAS,CAAC,EAAE,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,IAAI,0BAA0B,CAAC;AAAA,EACjI;AACA,MAAI,CAAC,CAAC,KAAK,SAAS,GAAG;AACrB,WAAO,UAAU,QAAQ,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,EAAE,QAAQ,OAAO,EAAE,SAAS,CAAC,IAAI,0BAA0B,CAAC;AAAA,EACjI;AACA,SAAO;AACT;;;ACfK,IAAM,WAAW,CACtBA,WACA,iBACA,UAAkB,yEACf,CAAC,GAAQ,YAA+B;AAC3C,MAAI,QAAQ,IAAI,OAAO,OAAO,oBAAoB,eAAe,EAAE;AACnE,QAAM,QAAS,QAAQ,KAAoB,OAAO,CAAC,MAAM,OAAO,MAAM,YAAY,EAAE,MAAM,KAAK,CAAC;AAChG,MAAI,MAAM,SAASA,WAAU;AAC3B,WAAO,QAAQ,QAAQ,qBAAqB,eAAe,EAAE,QAAQ,cAAcA,UAAS,SAAS,CAAC;AAAA,EACxG;AACA,SAAO;AACT;;;ACaO,IAAM,mBAAmB,CAC9B,MACA,UAAkB,QAClB,UAAkB,gCAElB,CAAC,OAA4B,YAA+B;AA/B9D;AAgCI,QAAM,QAAQ,OAAO,SAAS,WAAW,CAAC,IAAI,IAAI;AAClD,QAAM,oBAAoB,mBAAQ,WAAR,mBAAyB,aAAzB,mBAAmC;AAK7D,MAAI,CAAC,SAAS,CAAC,CAAC,oBAAoB,MAAM,SAAS,gBAAgB,GAAG;AACpE,WAAO,QAAQ,QAAQ,aAAa,OAAO,EAAE,QAAQ,UAAU,MAAM,KAAK,OAAO,CAAC;AAAA,EACpF;AACA,SAAO;AACT;;;ACPK,IAAM,sBAAsB,CACjC,KACA,YACA,UAAkB,wCAElB,CAAC,OAA4B,YAA+B;AAxC9D;AAyCI,QAAM,UAAU,WAAW,KAAK,OAAO;AACvC,QAAM,cAAc,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;AACxE,MAAI,CAAC,SAAS,YAAY,SAAS,OAAO,GAAG;AAC3C,WAAO,QAAQ,QAAQ,SAAS,GAAG,EAAE,QAAQ,YAAW,iBAAY,KAAK,OAAO,MAAxB,YAA6B,MAAM;AAAA,EAC7F;AACA,SAAO;AACT;;;AC/CF,SAAS,WAAW;AAGb,IAAM,aAAa,CAAC,KAAsB,YAA+B;AAC9E,QAAM,qBAAqB,QAAQ,KAAM,MAAM,GAAG,EAAE;AACpD,QAAM,UAAU,IAAI,QAAQ,UAAU,CAAC,GAAG,oBAAoB,GAAG,CAAC;AAClE,SAAO;AACT;","names":["maxDepth"]}
+{"version":3,"sources":["../src/referencedDocumentRequires.ts","../src/fileExtension.ts","../src/minDimensions.ts","../src/maxDepth.ts","../src/requiredIfSlugEq.ts","../src/requiredIfSiblingEq.ts","../src/lib/getSibling.ts","../src/regex.ts"],"sourcesContent":["import { ValidationContext } from \"sanity\"\n\nexport const referencedDocumentRequires = (\n  documentType: string, \n  field: string, \n  message: string = `{documentType}’s {field} must be filled.`\n) => async (value: any | undefined, context: ValidationContext) => {\n  if (!value?._ref) {\n    return true\n  }\n  const client = context.getClient({ apiVersion: \"2022-08-12\" })\n  // todo: use current API version, or test with no version at all\n\n  // todo: if there's a value._type or value.referenced._type or something, we get rid of document.type from inputs\n  const data = await client.fetch(`\n    *[_type == \"${documentType}\" && _id == \"${value._ref}\"]{\n      ${field}\n    }[0]\n  `) // TODO: why is typescript screaming about this? Fetch takes two parameters.\n  if (!data[field]) {\n    return message.replace(\"{documentType}\", documentType).replace(\"{field}\", field)\n  }\n  return true\n}\n","import { getExtension } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const fileExtension = (\n  validFileExtension: string | Array<string>, \n  message: string = `Image must be of type {validFileExtension}`\n) => (value: FileValue | undefined) => {\n  if (!value || !value.asset) {\n    return true\n  }\n  const validExtensions = typeof validFileExtension === \"string\" ? [validFileExtension] : validFileExtension\n  const filetype = getExtension(value.asset._ref)\n  if (!validExtensions.includes(filetype)) {\n    return message.replace(\"{validFileExtension}\", validExtensions.join(\", or \"))\n  }\n  return true\n}\n\n// todo: this should fail if its attached to a field that is not of type \"file\"","import { getImageDimensions } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const minDimensions =\n  ({ x, y }: { x: number; y: number }, message?: string) =>\n  (value: FileValue | undefined) => {\n    if (!value || !value.asset) {\n      return true\n    }\n    const { width, height } = getImageDimensions(value.asset._ref)\n    if (!!x && width < x) {\n      return message \n        ? message.replace(\"{width}\", width.toString())\n          .replace(\"{height}\", height.toString())\n          .replace(\"{x}\", x.toString())\n          .replace(\"{y}\", !y ? \"(any)\" : y.toString()) \n        : `Image must be at least ${x} pixels wide.`\n    }\n    if (!!y && height < y) {\n      return message \n        ? message.replace(\"{width}\", width.toString())\n          .replace(\"{height}\", height.toString())\n          .replace(\"{x}\", !x ? \"(any)\" : x.toString())\n          .replace(\"{y}\", y.toString())\n        : `Image must be at least ${y} pixels tall.`\n    }\n    return true\n  }\n\n// todo: this should fail if its attached to a field that is not of type \"image\"","import { ValidationContext } from \"sanity\"\n\nexport const maxDepth = (\n  maxDepth: number, \n  key: string,\n  message: string = `Error: You can only nest {key} {maxDepth} levels deep.`\n) => (_: any, context: ValidationContext) => {\n  let regex = new RegExp(String.raw`topLevelItems|${key}`)\n  const paths = (context.path as Array<any>).filter((e) => typeof e === \"string\" && e.match(regex))\n  if (paths.length > maxDepth) {\n    return message\n      .replace(\"{key}\", key)\n      .replace(\"{nestedValueName}\", key)  // backward compatibility\n      .replace(\"{maxDepth}\", maxDepth.toString())\n  }\n  return true\n}\n","import { ValidationContext } from \"sanity\"\n\n/*\nSanity has a funny idea of conditional fields. Every field is _always_ present, but it might be hidden.\nex. hidden: (node) => node.parent.slug === 'hideMe'\nThis works really well — unless a field marked as required gets hidden. \n\nThis validator conditionally marks a field as required only for specific slugs. It accepts a string or array of strings.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha'))\nvalidation: (rule) => rule.custom(requiredIfSlugEq(['alpha', 'beta']))\nvalidation: (rule) => rule.custom(requiredIfSlugNotEq(['beta']))\n```\n\nIf the key of your slug is not simply \"slug\", fill that in the optional second parameter.\n```\nvalidation: (rule) => rule.custom(requiredIfSlugEq('alpha', 'id'))\n```\n\n\"Could this method be simpler if it just checked for the self.hidden state?\"\nNot possible, since the hidden state is not exposed to the context.\n\nBut even if it were, you wouldn't want to. There are valid reasons to make a component required but hidden.\nex. an admin- or developer-level identifier that you don't want civilians to see or edit.\n*/\n\nexport const requiredIfSlugEq = (\n  slug: Array<string> | string, \n  slugKey: string = \"slug\", \n  message: string = `This is a required field.`\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const slugs = typeof slug === \"string\" ? [slug] : slug\n    const slugValue = (context.parent as any)?.[slugKey]?.current\n    \n    // todo: does slugKey exist? If not, fail.\n    // todo: deal with nested slugKey (ex. metadata.slug)\n    \n    if (!value && !!slugValue && slugs.includes(slugValue)) {\n      return message\n        .replace(\"{slugKey}\", slugKey)\n        .replace(\"{operand}\", slugs.join(', or '))\n        .replace(\"{siblingSlugValue}\", slugValue)\n    }\n    return true\n  }","import {getSibling} from './'\nimport {ValidationContext} from 'sanity'\n\n/*\nFor a given object that has multiple fields, mark a field as `required` if a sibling has a particular value.\n\n```\ndefineType({\n  name: 'ifAlphaAlsoBeta',\n  type: 'object',\n  fields: [\n    defineField({\n      name: 'alpha',\n      type: 'string',\n      options: {\n        list: ['left', 'right'],\n        layout: 'radio',\n        direction: 'horizontal',\n      },\n    }),\n    defineField({\n      name: 'beta',\n      type: 'string',\n      placeholder: 'If alpha is “left”, I’m also required',\n      validation: (rule) => rule.custom(requiredIfSiblingEq('alpha', 'left')),\n    })\n  ],\n})\n```\n\nIncidentally, context.path is technically Array<sanity.PathSegment>.\n\nThat shouldn't matter, but dealing with that and remapping siblingKey as a PathSegment could be a possible future enhancement.\n*/\n\nexport const requiredIfSiblingEq = (\n  key: string, \n  operand: string | number | null | Array<string | number | null>, \n  message: string = 'Required if {key} equals {operand}.'\n) =>\n  (value: unknown | undefined, context: ValidationContext) => {\n    const siblingValue = getSibling(key, context)\n    const operands = Array.isArray(operand) ? operand : [operand]\n    if (!value && operands.includes(siblingValue)) {\n      return message\n        .replace('{key}', key)\n        .replace('{operand}', operands.join(', or ') ?? 'null')\n        .replace('{value}', operands.join(', or ') ?? 'null') // backward compatibility\n        .replace('{siblingValue}', siblingValue)\n    }\n    return true\n  }\n","import { get } from \"lodash-es\"\nimport { ValidationContext } from \"sanity\"\n\nexport const getSibling = (key: string | number, context: ValidationContext) => {\n  const pathToParentObject = context.path!.slice(0, -1) as Array<string | number>\n  const sibling = get(context.document, [...pathToParentObject, key])\n  return sibling\n}\n\n/*\nTODO:\n  There is an issue with finding a sibling when in an array element.\n  If the context document looks something like this…\n    {\n      someArray: [\n        {\n          _key: 'abc123',\n          targetSibling: 'herpderp'\n        }\n      ]\n    }\n  … we wind up with a path of…\n    [ 'someArray', { _key: 'ab123' }, 'targetSibling' ]\n  lodash.get() is trying to do an exact match, it doesn't know how to get object by _key.\n  \n  Will probably have to replace get() with a gnarly recursive lookup function.\n*/\n","export const regex =\n  (pattern: RegExp, message: string = `“{value}” does not match the pattern {pattern}.`) =>\n  (value: unknown) => {\n    if (!value) {\n      return true\n    }\n    const valueAsString = typeof value !== \"string\" ? value.toString() : value\n    return pattern.test(valueAsString) ? true : message.replace(\"{value}\", valueAsString).replace(\"{pattern}\", pattern.toString())\n  }\n"],"mappings":";AAEO,IAAM,6BAA6B,CACxC,cACA,OACA,UAAkB,oDACf,OAAO,OAAwB,YAA+B;AACjE,MAAI,EAAC,+BAAO,OAAM;AAChB,WAAO;AAAA,EACT;AACA,QAAM,SAAS,QAAQ,UAAU,EAAE,YAAY,aAAa,CAAC;AAI7D,QAAM,OAAO,MAAM,OAAO,MAAM;AAAA,kBAChB,YAAY,gBAAgB,MAAM,IAAI;AAAA,QAChD,KAAK;AAAA;AAAA,GAEV;AACD,MAAI,CAAC,KAAK,KAAK,GAAG;AAChB,WAAO,QAAQ,QAAQ,kBAAkB,YAAY,EAAE,QAAQ,WAAW,KAAK;AAAA,EACjF;AACA,SAAO;AACT;;;ACvBA,SAAS,oBAAoB;AAGtB,IAAM,gBAAgB,CAC3B,oBACA,UAAkB,iDACf,CAAC,UAAiC;AACrC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,kBAAkB,OAAO,uBAAuB,WAAW,CAAC,kBAAkB,IAAI;AACxF,QAAM,WAAW,aAAa,MAAM,MAAM,IAAI;AAC9C,MAAI,CAAC,gBAAgB,SAAS,QAAQ,GAAG;AACvC,WAAO,QAAQ,QAAQ,wBAAwB,gBAAgB,KAAK,OAAO,CAAC;AAAA,EAC9E;AACA,SAAO;AACT;;;AChBA,SAAS,0BAA0B;AAG5B,IAAM,gBACX,CAAC,EAAE,GAAG,EAAE,GAA6B,YACrC,CAAC,UAAiC;AAChC,MAAI,CAAC,SAAS,CAAC,MAAM,OAAO;AAC1B,WAAO;AAAA,EACT;AACA,QAAM,EAAE,OAAO,OAAO,IAAI,mBAAmB,MAAM,MAAM,IAAI;AAC7D,MAAI,CAAC,CAAC,KAAK,QAAQ,GAAG;AACpB,WAAO,UACH,QAAQ,QAAQ,WAAW,MAAM,SAAS,CAAC,EAC1C,QAAQ,YAAY,OAAO,SAAS,CAAC,EACrC,QAAQ,OAAO,EAAE,SAAS,CAAC,EAC3B,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,IAC3C,0BAA0B,CAAC;AAAA,EACjC;AACA,MAAI,CAAC,CAAC,KAAK,SAAS,GAAG;AACrB,WAAO,UACH,QAAQ,QAAQ,WAAW,MAAM,SAAS,CAAC,EAC1C,QAAQ,YAAY,OAAO,SAAS,CAAC,EACrC,QAAQ,OAAO,CAAC,IAAI,UAAU,EAAE,SAAS,CAAC,EAC1C,QAAQ,OAAO,EAAE,SAAS,CAAC,IAC5B,0BAA0B,CAAC;AAAA,EACjC;AACA,SAAO;AACT;;;ACzBK,IAAM,WAAW,CACtBA,WACA,KACA,UAAkB,6DACf,CAAC,GAAQ,YAA+B;AAC3C,MAAIC,SAAQ,IAAI,OAAO,OAAO,oBAAoB,GAAG,EAAE;AACvD,QAAM,QAAS,QAAQ,KAAoB,OAAO,CAAC,MAAM,OAAO,MAAM,YAAY,EAAE,MAAMA,MAAK,CAAC;AAChG,MAAI,MAAM,SAASD,WAAU;AAC3B,WAAO,QACJ,QAAQ,SAAS,GAAG,EACpB,QAAQ,qBAAqB,GAAG,EAChC,QAAQ,cAAcA,UAAS,SAAS,CAAC;AAAA,EAC9C;AACA,SAAO;AACT;;;ACUO,IAAM,mBAAmB,CAC9B,MACA,UAAkB,QAClB,UAAkB,gCAElB,CAAC,OAA4B,YAA+B;AA/B9D;AAgCI,QAAM,QAAQ,OAAO,SAAS,WAAW,CAAC,IAAI,IAAI;AAClD,QAAM,aAAa,mBAAQ,WAAR,mBAAyB,aAAzB,mBAAmC;AAKtD,MAAI,CAAC,SAAS,CAAC,CAAC,aAAa,MAAM,SAAS,SAAS,GAAG;AACtD,WAAO,QACJ,QAAQ,aAAa,OAAO,EAC5B,QAAQ,aAAa,MAAM,KAAK,OAAO,CAAC,EACxC,QAAQ,sBAAsB,SAAS;AAAA,EAC5C;AACA,SAAO;AACT;;;ACVK,IAAM,sBAAsB,CACjC,KACA,SACA,UAAkB,0CAElB,CAAC,OAA4B,YAA+B;AAxC9D;AAyCI,QAAM,eAAe,WAAW,KAAK,OAAO;AAC5C,QAAM,WAAW,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;AAC5D,MAAI,CAAC,SAAS,SAAS,SAAS,YAAY,GAAG;AAC7C,WAAO,QACJ,QAAQ,SAAS,GAAG,EACpB,QAAQ,cAAa,cAAS,KAAK,OAAO,MAArB,YAA0B,MAAM,EACrD,QAAQ,YAAW,cAAS,KAAK,OAAO,MAArB,YAA0B,MAAM,EACnD,QAAQ,kBAAkB,YAAY;AAAA,EAC3C;AACA,SAAO;AACT;;;ACnDF,SAAS,WAAW;AAGb,IAAM,aAAa,CAAC,KAAsB,YAA+B;AAC9E,QAAM,qBAAqB,QAAQ,KAAM,MAAM,GAAG,EAAE;AACpD,QAAM,UAAU,IAAI,QAAQ,UAAU,CAAC,GAAG,oBAAoB,GAAG,CAAC;AAClE,SAAO;AACT;;;ACPO,IAAM,QACX,CAAC,SAAiB,UAAkB,gEACpC,CAAC,UAAmB;AAClB,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AACA,QAAM,gBAAgB,OAAO,UAAU,WAAW,MAAM,SAAS,IAAI;AACrE,SAAO,QAAQ,KAAK,aAAa,IAAI,OAAO,QAAQ,QAAQ,WAAW,aAAa,EAAE,QAAQ,aAAa,QAAQ,SAAS,CAAC;AAC/H;","names":["maxDepth","regex"]}

package/package.json

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