sanity-advanced-validators/dist/index.cjs.map

Advanced input validation tools for Sanity CMS.

{"version":3,"sources":["../src/index.ts","../src/referencedDocumentRequires.ts","../src/fileExtension.ts","../src/minCount.ts","../src/maxCount.ts","../src/minDimensions.ts","../src/maxDimensions.ts","../src/maxDepth.ts","../src/requiredIfSlugEq.ts","../src/requiredIfSlugNeq.ts","../src/requiredIfSiblingEq.ts","../src/requiredIfSiblingNeq.ts","../src/lib/getSibling.ts","../src/regex.ts"],"sourcesContent":["export * from \"./referencedDocumentRequires\"\nexport * from \"./fileExtension\"\nexport * from \"./minCount\"\nexport * from \"./maxCount\"\nexport * from \"./minDimensions\"\nexport * from \"./maxDimensions\"\nexport * from \"./maxDepth\"\nexport * from \"./requiredIfSlugEq\"\nexport * from \"./requiredIfSlugNeq\"\nexport * from \"./requiredIfSiblingEq\"\nexport * from \"./requiredIfSiblingNeq\"\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\"","export const minCount = (n: number, message?: string) => (value: Array<unknown> | undefined) => {\n  if (!value) {\n    return true\n  }\n  if (value.length < n) {\n    return message ? message.replace(\"{n}\", n.toString()) : `Array must contain at least ${n} items.`\n  }\n  return true\n}\n","export const maxCount = (n: number, message?: string) => (value: Array<unknown> | undefined) => {\n  if (!value) {\n    return true\n  }\n  if (value.length > n) {\n    return message ? message.replace(\"{n}\", n.toString()) : `Array must contain at most ${n} items.`\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 \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 { getImageDimensions } from \"@sanity/asset-utils\"\nimport { FileValue } from \"sanity\"\n\nexport const maxDimensions =\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 most ${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 most ${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 { ValidationContext } from \"sanity\"\n\nexport const requiredIfSlugNeq = (\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    if (!value && !slugs.includes(slugValue)) {\n      return message\n          .replace(\"{slugKey}\", slugKey)\n          .replace(\"{operand}\", slugs.join(', or '))\n          .replace(\"{siblingSlugValue}\", slugValue)\n      \n    }\n    return true\n  }\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 {getSibling} from './'\nimport {ValidationContext} from 'sanity'\n\nexport const requiredIfSiblingNeq = (\n  key: string, \n  operand: string | number | null | Array<string | number | null>, \n  message: string = 'Required if {key} does not equal {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\n\n\n\n\n\n\n\n\n","import { get } from \"lodash-es\"\nimport { ValidationContext } from \"sanity\"\n\nexport const getSibling = (key: string | number, context: ValidationContext) => {\n  if(!context.path) return undefined\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;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;;;AChBO,IAAM,WAAW,CAAC,GAAW,YAAqB,CAAC,UAAsC;AAC9F,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AACA,MAAI,MAAM,SAAS,GAAG;AACpB,WAAO,UAAU,QAAQ,QAAQ,OAAO,EAAE,SAAS,CAAC,IAAI,+BAA+B,CAAC;AAAA,EAC1F;AACA,SAAO;AACT;;;ACRO,IAAM,WAAW,CAAC,GAAW,YAAqB,CAAC,UAAsC;AAC9F,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AACA,MAAI,MAAM,SAAS,GAAG;AACpB,WAAO,UAAU,QAAQ,QAAQ,OAAO,EAAE,SAAS,CAAC,IAAI,8BAA8B,CAAC;AAAA,EACzF;AACA,SAAO;AACT;;;ACRA,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;;;AC3BF,IAAAC,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,yBAAyB,CAAC;AAAA,EAChC;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,yBAAyB,CAAC;AAAA,EAChC;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;;;AC3CK,IAAM,oBAAoB,CAC/B,MACA,UAAkB,QAClB,UAAkB,gCAElB,CAAC,OAA4B,YAA+B;AAP9D;AAQI,QAAM,QAAQ,OAAO,SAAS,WAAW,CAAC,IAAI,IAAI;AAClD,QAAM,aAAa,mBAAQ,WAAR,mBAAyB,aAAzB,mBAAmC;AACtD,MAAI,CAAC,SAAS,CAAC,MAAM,SAAS,SAAS,GAAG;AACxC,WAAO,QACF,QAAQ,aAAa,OAAO,EAC5B,QAAQ,aAAa,MAAM,KAAK,OAAO,CAAC,EACxC,QAAQ,sBAAsB,SAAS;AAAA,EAE9C;AACA,SAAO;AACT;;;ACiBK,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;;;AChDK,IAAM,uBAAuB,CAClC,KACA,SACA,UAAkB,kDAElB,CAAC,OAA4B,YAA+B;AAR9D;AASI,QAAM,eAAe,WAAW,KAAK,OAAO;AAC5C,QAAM,WAAW,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;AAC5D,MAAG,CAAC,SAAS,CAAC,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;;;ACnBF,uBAAoB;AAGb,IAAM,aAAa,CAAC,KAAsB,YAA+B;AAC9E,MAAG,CAAC,QAAQ,KAAM,QAAO;AACzB,QAAM,qBAAqB,QAAQ,KAAK,MAAM,GAAG,EAAE;AACnD,QAAM,cAAU,sBAAI,QAAQ,UAAU,CAAC,GAAG,oBAAoB,GAAG,CAAC;AAClE,SAAO;AACT;;;ACRO,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","import_asset_utils","maxDepth","regex"]}