@sanity/validation 6.12.0-next.63 → 6.12.0-next.75

package/README.md

@@ -3,13 +3,36 @@
 Validates complete Sanity documents against a compiled Sanity schema.
 
 ```ts
-import {validateDocument} from '@sanity/validation'
+import {validateDocument, validationMarkerCodes} from '@sanity/validation'
 
 const markers = await validateDocument({document, schema, client})
+
+for (const marker of markers) {
+  if (marker.code === validationMarkerCodes.stringMinimumLength) {
+    const {actualLength, minimumLength} = marker.details || {}
+    if (typeof actualLength === 'number' && typeof minimumLength === 'number') {
+      console.log(`Expected at least ${minimumLength} characters, got ${actualLength}`)
+    }
+  }
+}
+
+const summary = markers
+  .map((marker) => {
+    const path = marker.path
+      .map((segment) => (typeof segment === 'object' ? segment._key : segment))
+      .join('.')
+
+    return `[${marker.level}] ${path || '<document>'}: ${marker.message} (${marker.code})`
+  })
+  .join('\n')
 ```
 
-The package reports validation markers. It does not apply mutations or decide whether a document
-may be edited or published.
+Every returned marker includes a stable machine-readable `code` alongside its localized `message`,
+`level`, and `path`. Built-in failures may also include structured `details`. Custom validators can
+return their own `code` and `details`; custom codes should be namespaced, for example
+`custom.seo-title`.
+
+The package does not apply mutations or decide whether a document may be edited or published.
 
 ## Migrating from `sanity`
 

package/lib/_internal.d.ts

@@ -1,4 +1,4 @@
-import { c as validateDocumentInternal, d as validateItem, f as ValidationContext, l as validateDocumentObservable, n as ValidateDocumentObservableOptions, o as resolveTypeForArrayItem, p as LocaleSource, t as ValidateDocumentInternalOptions } from "./validateDocument-CBOsd748.js";
+import { c as resolveTypeForArrayItem, d as validateDocumentObservable, g as ValidationMarkerCode, n as ValidateDocumentObservableOptions, p as validateItem, t as ValidateDocumentInternalOptions, u as validateDocumentInternal, v as ValidationContext, y as LocaleSource } from "./validateDocument-6pLTIHIn.js";
 import { Path, Rule as Rule$1, RuleClass, Schema, SchemaType, SchemaValidationValue, ValidationContext as ValidationContext$1, ValidationError, ValidationMarker } from "@sanity/types";
 declare function getFallbackLocaleSource(): LocaleSource;
 declare const validationLocaleStrings: {
@@ -84,7 +84,10 @@ declare function hasValidationContext(validation: SchemaValidationValue | undefi
  * @internal
  */
 declare const Rule: RuleClass;
-declare function convertToValidationMarker(validatorResult: true | true[] | string | string[] | ValidationError | ValidationError[], level: 'error' | 'warning' | 'info' | undefined, context: ValidationContext): ValidationMarker[];
+declare function convertToValidationMarker(validatorResult: true | true[] | string | string[] | ValidationError | ValidationError[], level: 'error' | 'warning' | 'info' | undefined, context: ValidationContext, fallback?: {
+  code: ValidationMarkerCode;
+  details?: Record<string, unknown>;
+}): ValidationMarker[];
 declare function getTypeChain(type: SchemaType | undefined, visited?: Set<SchemaType>): SchemaType[];
 declare function normalizeValidationRules(typeDef: SchemaType | undefined, context?: ValidationContext$1): Rule$1[];
 declare function pathToString(path?: Path | undefined): string;

package/lib/_internal.js

@@ -1,4 +1,4 @@
-import { c as normalizeValidationRules, d as convertToValidationMarker, f as pathToString, i as validateDocumentObservable, l as Rule, m as validationLocaleStrings, o as validateItem, p as getFallbackLocaleSource, r as validateDocumentInternal, s as getTypeChain, t as resolveTypeForArrayItem, u as typeString } from "./validateDocument-C77_Oewa.js";
+import { c as normalizeValidationRules, d as convertToValidationMarker, f as pathToString, i as validateDocumentObservable, l as Rule, m as validationLocaleStrings, o as validateItem, p as getFallbackLocaleSource, r as validateDocumentInternal, s as getTypeChain, t as resolveTypeForArrayItem, u as typeString } from "./validateDocument-Cq33kUmN.js";
 function inferFromSchemaType(typeDef) {
 	return traverse(typeDef, /* @__PURE__ */ new Set()), typeDef;
 }

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-import { a as ValidationSource, i as ValidateDocumentWorkspaceOptions, r as ValidateDocumentOptions, s as validateDocument, u as validateDocumentWithWorkspace } from "./validateDocument-CBOsd748.js";
-export { type ValidateDocumentOptions, type ValidateDocumentWorkspaceOptions, type ValidationSource, validateDocument, validateDocumentWithWorkspace };
+import { _ as validationMarkerCodes, a as ValidationClient, f as validateDocumentWithWorkspace, g as ValidationMarkerCode, h as DocumentValidationMarker, i as ValidateDocumentWorkspaceOptions, l as validateDocument, m as BuiltInValidationMarkerCode, o as ValidationSchema, r as ValidateDocumentOptions, s as ValidationSource } from "./validateDocument-6pLTIHIn.js";
+export { type BuiltInValidationMarkerCode, type DocumentValidationMarker, type ValidateDocumentOptions, type ValidateDocumentWorkspaceOptions, type ValidationClient, type ValidationMarkerCode, type ValidationSchema, type ValidationSource, validateDocument, validateDocumentWithWorkspace, validationMarkerCodes };

package/lib/index.js

@@ -1,2 +1,2 @@
-import { a as validateDocumentWithWorkspace, n as validateDocument } from "./validateDocument-C77_Oewa.js";
-export { validateDocument, validateDocumentWithWorkspace };
+import { a as validateDocumentWithWorkspace, h as validationMarkerCodes, n as validateDocument } from "./validateDocument-Cq33kUmN.js";
+export { validateDocument, validateDocumentWithWorkspace, validationMarkerCodes };

package/lib/{validateDocument-CBOsd748.d.ts → validateDocument-6pLTIHIn.d.ts}

@@ -34,6 +34,66 @@ declare module '@sanity/types' {
     i18n: LocaleSource;
   }
 }
+/** Machine-readable codes emitted by built-in document validation. @beta */
+declare const validationMarkerCodes: {
+  readonly arrayDuplicateItem: 'array.duplicate-item';
+  readonly arrayExactLength: 'array.exact-length';
+  readonly arrayMaximumLength: 'array.maximum-length';
+  readonly arrayMinimumLength: 'array.minimum-length';
+  readonly assetRequired: 'asset.required';
+  readonly custom: 'custom';
+  readonly dateInvalidFormat: 'date.invalid-format';
+  readonly dateMaximum: 'date.maximum';
+  readonly dateMinimum: 'date.minimum';
+  readonly documentUnknownType: 'document.unknown-type';
+  readonly mediaCustom: 'media.custom';
+  readonly mediaInvalidReference: 'media.invalid-reference';
+  readonly mediaNotFound: 'media.not-found';
+  readonly numberGreaterThan: 'number.greater-than';
+  readonly numberInteger: 'number.integer';
+  readonly numberLessThan: 'number.less-than';
+  readonly numberMaximum: 'number.maximum';
+  readonly numberMinimum: 'number.minimum';
+  readonly numberPrecision: 'number.precision';
+  readonly objectUnknownField: 'object.unknown-field';
+  readonly referenceInvalid: 'reference.invalid';
+  readonly referenceNotPublished: 'reference.not-published';
+  readonly ruleAllFailed: 'rule.all-failed';
+  readonly ruleEitherFailed: 'rule.either-failed';
+  readonly slugInvalidType: 'slug.invalid-type';
+  readonly slugMissingCurrent: 'slug.missing-current';
+  readonly slugNotUnique: 'slug.not-unique';
+  readonly stringEmail: 'string.email';
+  readonly stringExactLength: 'string.exact-length';
+  readonly stringLowercase: 'string.lowercase';
+  readonly stringMaximumLength: 'string.maximum-length';
+  readonly stringMinimumLength: 'string.minimum-length';
+  readonly stringRegexMatch: 'string.regex-match';
+  readonly stringRegexMismatch: 'string.regex-mismatch';
+  readonly stringUppercase: 'string.uppercase';
+  readonly stringUrlCredentialsNotAllowed: 'string.url.credentials-not-allowed';
+  readonly stringUrlInvalid: 'string.url.invalid';
+  readonly stringUrlNotAbsolute: 'string.url.not-absolute';
+  readonly stringUrlNotRelative: 'string.url.not-relative';
+  readonly stringUrlSchemeNotAllowed: 'string.url.scheme-not-allowed';
+  readonly validationException: 'validation.exception';
+  readonly validationFailed: 'validation.failed';
+  readonly valueNotAllowed: 'value.not-allowed';
+  readonly valueRequired: 'value.required';
+  readonly valueTypeMismatch: 'value.type-mismatch';
+};
+/** A code emitted by a built-in validator. @beta */
+type BuiltInValidationMarkerCode = (typeof validationMarkerCodes)[keyof typeof validationMarkerCodes];
+/**
+ * A built-in validation code or an application-defined custom code.
+ * Custom validators should namespace their codes, for example `custom.seo-title`.
+ * @beta
+ */
+type ValidationMarkerCode = BuiltInValidationMarkerCode | (string & {});
+/** A validation marker emitted by `validateDocument`, which always has a code. @beta */
+type DocumentValidationMarker = Omit<ValidationMarker, 'code'> & {
+  code: ValidationMarkerCode;
+};
 /**
  * @internal
  */
@@ -47,9 +107,9 @@ interface ValidateDocumentOptions {
    */
   document: SanityDocument;
   /** The compiled schema to validate against. */
-  schema: Schema;
+  schema: ValidationSchema;
   /** A configured client used for reference checks and custom validators. */
-  client: SanityClient;
+  client: ValidationClient;
   /**
    * Function used to check if referenced documents exists (and is published).
    *
@@ -89,6 +149,24 @@ interface ValidateDocumentOptions {
    */
   currentUser?: Omit<CurrentUser, 'role'> | null;
 }
+/** A compiled schema accepted across compatible `@sanity/types` versions. @beta */
+interface ValidationSchema {
+  get(name: string): unknown;
+}
+/**
+ * A configured Sanity client accepted across compatible client versions.
+ *
+ * This structural type describes the capabilities used internally by validation.
+ * The configured client is exposed to custom validators as a `SanityClient`, so it must be compatible with the full client API.
+ *
+ * @beta
+ */
+interface ValidationClient {
+  fetch: SanityClient['fetch'];
+  getDataUrl: SanityClient['getDataUrl'];
+  observable: Pick<SanityClient['observable'], 'fetch' | 'request'>;
+  withConfig(config: Parameters<SanityClient['withConfig']>[0]): ValidationClient;
+}
 /**
  * The validation capabilities required from a resolved Studio source or workspace.
  *
@@ -127,7 +205,7 @@ interface ValidateDocumentWorkspaceOptions extends Omit<ValidateDocumentOptions,
  * @beta
  * @deprecated Prefer {@link validateDocument} with `{document, schema, client}` for new code.
  */
-declare function validateDocumentWithWorkspace({ document, workspace, getClient, getDocumentExists, environment, maxCustomValidationConcurrency, maxFetchConcurrency, currentUser }: ValidateDocumentWorkspaceOptions): Promise<ValidationMarker[]>;
+declare function validateDocumentWithWorkspace({ document, workspace, getClient, getDocumentExists, environment, maxCustomValidationConcurrency, maxFetchConcurrency, currentUser }: ValidateDocumentWorkspaceOptions): Promise<DocumentValidationMarker[]>;
 /**
  * Validates a document against the schema in a resolved Studio workspace or source.
  *
@@ -136,14 +214,14 @@ declare function validateDocumentWithWorkspace({ document, workspace, getClient,
  *
  * @beta
  */
-declare function validateDocument(options: ValidateDocumentWorkspaceOptions): Promise<ValidationMarker[]>;
+declare function validateDocument(options: ValidateDocumentWorkspaceOptions): Promise<DocumentValidationMarker[]>;
 /**
  * Validates a document against a compiled schema. Returns validation markers
  * without deciding whether the document may be edited or published.
  *
  * @beta
  */
-declare function validateDocument(options: ValidateDocumentOptions): Promise<ValidationMarker[]>;
+declare function validateDocument(options: ValidateDocumentOptions): Promise<DocumentValidationMarker[]>;
 /** @internal */
 interface ValidateDocumentInternalOptions {
   document: SanityDocument;
@@ -161,7 +239,7 @@ interface ValidateDocumentInternalOptions {
   currentUser?: Omit<CurrentUser, 'role'> | null;
 }
 /** @internal */
-declare function validateDocumentInternal({ document, schema, getClient, getDocumentExists, i18n, environment, maxCustomValidationConcurrency, maxFetchConcurrency, currentUser }: ValidateDocumentInternalOptions): Promise<ValidationMarker[]>;
+declare function validateDocumentInternal({ document, schema, getClient, getDocumentExists, i18n, environment, maxCustomValidationConcurrency, maxFetchConcurrency, currentUser }: ValidateDocumentInternalOptions): Promise<DocumentValidationMarker[]>;
 /**
  * @internal
  */
@@ -179,7 +257,7 @@ interface ValidateDocumentObservableOptions extends Pick<ValidationContext$1, 'g
  * Validates a document against the given schema, returning an Observable
  * @internal
  */
-declare function validateDocumentObservable({ document, getClient, i18n, schema, getDocumentExists, environment, maxCustomValidationConcurrency, currentUser }: ValidateDocumentObservableOptions): Observable<ValidationMarker[]>;
+declare function validateDocumentObservable({ document, getClient, i18n, schema, getDocumentExists, environment, maxCustomValidationConcurrency, currentUser }: ValidateDocumentObservableOptions): Observable<DocumentValidationMarker[]>;
 /**
  * this is used make optional properties required by replacing optionals with
  * `T[P] | undefined`. this is used to prevent errors in `validateItem` where
@@ -195,5 +273,5 @@ type ValidateItemOptions = {
   currentUser?: Omit<CurrentUser, 'role'> | null;
 } & ExplicitUndefined<Omit<ValidationContext$1, 'hidden'>>;
 declare function validateItem(opts: ValidateItemOptions): Promise<ValidationMarker[]>;
-export { ValidationSource as a, validateDocumentInternal as c, validateItem as d, ValidationContext$1 as f, ValidateDocumentWorkspaceOptions as i, validateDocumentObservable as l, ValidateDocumentObservableOptions as n, resolveTypeForArrayItem as o, LocaleSource as p, ValidateDocumentOptions as r, validateDocument as s, ValidateDocumentInternalOptions as t, validateDocumentWithWorkspace as u };
-//# sourceMappingURL=validateDocument-CBOsd748.d.ts.map
+export { validationMarkerCodes as _, ValidationClient as a, resolveTypeForArrayItem as c, validateDocumentObservable as d, validateDocumentWithWorkspace as f, ValidationMarkerCode as g, DocumentValidationMarker as h, ValidateDocumentWorkspaceOptions as i, validateDocument as l, BuiltInValidationMarkerCode as m, ValidateDocumentObservableOptions as n, ValidationSchema as o, validateItem as p, ValidateDocumentOptions as r, ValidationSource as s, ValidateDocumentInternalOptions as t, validateDocumentInternal as u, ValidationContext$1 as v, LocaleSource as y };
+//# sourceMappingURL=validateDocument-6pLTIHIn.d.ts.map