@sanity/types 5.9.0-next.8 → 5.10.0-next.28

package/lib/index.d.ts

@@ -368,6 +368,7 @@ interface Rule {
   either(children: Rule[]): Rule;
   optional(): Rule;
   required(): Rule;
+  skip(): Rule;
   custom<T = unknown>(fn: CustomValidator<T>, options?: {
     bypassConcurrencyLimit?: boolean;
   }): Rule;
@@ -525,6 +526,10 @@ interface ValidationContext {
     id: string;
   }) => Promise<boolean>;
   environment: 'cli' | 'studio';
+  /**
+   * Whether this field is hidden for any reason (either itself or any of its ancestors).
+   */
+  hidden?: boolean;
 }
 /**
  * The base type for all validators in the validation library. Takes in a
@@ -711,6 +716,7 @@ declare interface InsertMenuOptions {
 /** @public */
 interface RuleDef<T, FieldValue = unknown> {
   required: () => T;
+  skip: () => T;
   custom: <LenientFieldValue extends FieldValue>(fn: CustomValidator<LenientFieldValue | undefined>) => T;
   info: (message?: string | LocalizedValidationMessages) => T;
   error: (message?: string | LocalizedValidationMessages) => T;
@@ -720,7 +726,7 @@ interface RuleDef<T, FieldValue = unknown> {
 /** @public */
 type RuleBuilder<T extends RuleDef<T, FieldValue>, FieldValue = unknown> = T | T[];
 /** @public */
-type ValidationBuilder<T extends RuleDef<T, FieldValue>, FieldValue = unknown> = (rule: T) => RuleBuilder<T, FieldValue>;
+type ValidationBuilder<T extends RuleDef<T, FieldValue>, FieldValue = unknown> = (rule: T, context?: ValidationContext) => RuleBuilder<T, FieldValue>;
 /** @public */
 interface ObjectOptions extends BaseSchemaTypeOptions {
   collapsible?: boolean;
@@ -2047,7 +2053,7 @@ type InitialValueProperty<Params, Value> = Value | InitialValueResolver<Params,
  *
  * @public
  */
-type SchemaValidationValue = false | undefined | Rule | SchemaValidationValue[] | ((rule: Rule) => SchemaValidationValue);
+type SchemaValidationValue = false | undefined | Rule | SchemaValidationValue[] | ((rule: Rule, context?: ValidationContext) => SchemaValidationValue);
 /** @public */
 type DeprecatedSchemaType<TSchemaType extends BaseSchemaType = BaseSchemaType> = TSchemaType & DeprecationConfiguration;
 /** @public */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/types",
-  "version": "5.9.0-next.8+c3a4cb19e1",
+  "version": "5.10.0-next.28+bbadd3b534",
   "description": "Type definitions for common Sanity data structures",
   "keywords": [
     "cms",
@@ -47,10 +47,10 @@
     "react": "^19.2.4",
     "rimraf": "^5.0.10",
     "vitest": "^4.0.18",
-    "@repo/eslint-config": "5.9.0-next.8+c3a4cb19e1",
-    "@repo/package.config": "5.9.0-next.8+c3a4cb19e1",
-    "@repo/test-config": "5.9.0-next.8+c3a4cb19e1",
-    "@repo/tsconfig": "5.9.0-next.8+c3a4cb19e1"
+    "@repo/eslint-config": "5.10.0-next.28+bbadd3b534",
+    "@repo/package.config": "5.10.0-next.28+bbadd3b534",
+    "@repo/tsconfig": "5.10.0-next.28+bbadd3b534",
+    "@repo/test-config": "5.10.0-next.28+bbadd3b534"
   },
   "peerDependencies": {
     "@types/react": "^19.2"