@sanity/schema 5.8.0 → 5.8.1-next.1

package/lib/_internal.d.ts

@@ -1,219 +1,219 @@
-import {Rule} from '@sanity/types'
-import {SanityDocument} from '@sanity/types'
-import {Schema} from '@sanity/types'
-import {SchemaType} from '@sanity/types'
-import {SchemaType as SchemaType_2} from 'groq-js'
-import {SchemaTypeDefinition} from '@sanity/types'
-import {SchemaValidationProblem} from '@sanity/types'
-import {SchemaValidationProblemGroup} from '@sanity/types'
-import {SetSynchronization} from '@sanity/descriptors'
-import {SynchronizationRequest} from '@sanity/descriptors'
-import {SynchronizationResult} from '@sanity/descriptors'
+import { Rule } from "@sanity/types";
+import { SanityDocument } from "@sanity/types";
+import { Schema } from "@sanity/types";
+import { SchemaType } from "@sanity/types";
+import { SchemaType as SchemaType_2 } from "groq-js";
+import { SchemaTypeDefinition } from "@sanity/types";
+import { SchemaValidationProblem } from "@sanity/types";
+import { SchemaValidationProblemGroup } from "@sanity/types";
+import { SetSynchronization } from "@sanity/descriptors";
+import { SynchronizationRequest } from "@sanity/descriptors";
+import { SynchronizationResult } from "@sanity/descriptors";
 
-export declare const ALL_FIELDS_GROUP_NAME = 'all-fields'
+export declare const ALL_FIELDS_GROUP_NAME = "all-fields";
 
 export declare const builtinTypes: (
   | {
-      title: string
-      name: string
-      type: string
+      title: string;
+      name: string;
+      type: string;
       fields: {
-        name: string
-        type: string
-        title: string
-      }[]
+        name: string;
+        type: string;
+        title: string;
+      }[];
     }
   | {
-      name: string
-      title: string
-      type: string
+      name: string;
+      title: string;
+      type: string;
       fieldsets: {
-        name: string
-        title: string
-        description: string
-      }[]
+        name: string;
+        title: string;
+        description: string;
+      }[];
       fields: (
         | {
-            name: string
-            type: string
-            title: string
-            readOnly: boolean
-            fieldset?: undefined
-            hidden?: undefined
+            name: string;
+            type: string;
+            title: string;
+            readOnly: boolean;
+            fieldset?: undefined;
+            hidden?: undefined;
           }
         | {
-            name: string
-            type: string
-            title: string
-            readOnly?: undefined
-            fieldset?: undefined
-            hidden?: undefined
+            name: string;
+            type: string;
+            title: string;
+            readOnly?: undefined;
+            fieldset?: undefined;
+            hidden?: undefined;
           }
         | {
-            name: string
-            type: string
-            title: string
-            readOnly: boolean
-            fieldset: string
-            hidden?: undefined
+            name: string;
+            type: string;
+            title: string;
+            readOnly: boolean;
+            fieldset: string;
+            hidden?: undefined;
           }
         | {
-            name: string
-            type: string
-            readOnly: boolean
-            hidden: boolean
-            fieldset: string
-            title?: undefined
+            name: string;
+            type: string;
+            readOnly: boolean;
+            hidden: boolean;
+            fieldset: string;
+            title?: undefined;
           }
-      )[]
+      )[];
       preview: {
         select: {
-          id: string
-          title: string
-          mimeType: string
-          size: string
-          media: string
-        }
+          id: string;
+          title: string;
+          mimeType: string;
+          size: string;
+          media: string;
+        };
         prepare(doc: Partial<SanityDocument>): {
-          title: {}
+          title: {};
           media: {
-            media?: {} | undefined
+            media?: {} | undefined;
             asset: {
-              _ref: unknown
-            }
-          }
-          subtitle: string
-        }
-      }
+              _ref: unknown;
+            };
+          };
+          subtitle: string;
+        };
+      };
       orderings: {
-        title: string
-        name: string
+        title: string;
+        name: string;
         by: {
-          field: string
-          direction: string
-        }[]
-      }[]
+          field: string;
+          direction: string;
+        }[];
+      }[];
     }
   | {
-      name: string
-      title: string
-      type: string
+      name: string;
+      title: string;
+      type: string;
       fieldsets: {
-        name: string
-        title: string
-        description: string
-      }[]
+        name: string;
+        title: string;
+        description: string;
+      }[];
       fields: (
         | {
-            name: string
-            type: string
-            title: string
-            readOnly: boolean
-            fieldset?: undefined
-            hidden?: undefined
+            name: string;
+            type: string;
+            title: string;
+            readOnly: boolean;
+            fieldset?: undefined;
+            hidden?: undefined;
           }
         | {
-            name: string
-            type: string
-            title: string
-            readOnly?: undefined
-            fieldset?: undefined
-            hidden?: undefined
+            name: string;
+            type: string;
+            title: string;
+            readOnly?: undefined;
+            fieldset?: undefined;
+            hidden?: undefined;
           }
         | {
-            name: string
-            type: string
-            title: string
-            readOnly: boolean
-            fieldset: string
-            hidden?: undefined
+            name: string;
+            type: string;
+            title: string;
+            readOnly: boolean;
+            fieldset: string;
+            hidden?: undefined;
           }
         | {
-            name: string
-            type: string
-            readOnly: boolean
-            hidden: boolean
-            fieldset: string
-            title?: undefined
+            name: string;
+            type: string;
+            readOnly: boolean;
+            hidden: boolean;
+            fieldset: string;
+            title?: undefined;
           }
-      )[]
+      )[];
       preview: {
         select: {
-          title: string
-          path: string
-          mimeType: string
-          size: string
-        }
+          title: string;
+          path: string;
+          mimeType: string;
+          size: string;
+        };
         prepare(doc: Record<string, any>): {
-          title: any
-          subtitle: string
-        }
-      }
+          title: any;
+          subtitle: string;
+        };
+      };
       orderings: {
-        title: string
-        name: string
+        title: string;
+        name: string;
         by: {
-          field: string
-          direction: string
-        }[]
-      }[]
+          field: string;
+          direction: string;
+        }[];
+      }[];
     }
   | {
-      name: string
-      title: string
-      type: string
+      name: string;
+      title: string;
+      type: string;
       fields: {
-        name: string
-        type: string
-        validation: (Rule: Rule) => Rule
-      }[]
+        name: string;
+        type: string;
+        validation: (Rule: Rule) => Rule;
+      }[];
     }
   | {
-      name: string
-      title: string
-      type: string
+      name: string;
+      title: string;
+      type: string;
       fieldsets: {
-        name: string
-        title: string
+        name: string;
+        title: string;
         options: {
-          collapsable: boolean
-        }
-      }[]
+          collapsable: boolean;
+        };
+      }[];
       fields: (
         | {
-            name: string
-            type: string
-            title?: undefined
-            fieldset?: undefined
-            readOnly?: undefined
+            name: string;
+            type: string;
+            title?: undefined;
+            fieldset?: undefined;
+            readOnly?: undefined;
           }
         | {
-            name: string
-            title: string
-            type: string
-            fieldset: string
-            readOnly?: undefined
+            name: string;
+            title: string;
+            type: string;
+            fieldset: string;
+            readOnly?: undefined;
           }
         | {
-            name: string
-            title: string
-            type: string
-            readOnly: boolean
-            fieldset?: undefined
+            name: string;
+            title: string;
+            type: string;
+            readOnly: boolean;
+            fieldset?: undefined;
           }
-      )[]
+      )[];
     }
-)[]
+)[];
 
 export declare function createSchemaFromManifestTypes(schemaDef: {
-  name: string
-  types: unknown[]
-}): Schema_2
+  name: string;
+  types: unknown[];
+}): Schema_2;
 
-export declare const DEFAULT_MAX_FIELD_DEPTH = 5
+export declare const DEFAULT_MAX_FIELD_DEPTH = 5;
 
 export declare class DescriptorConverter {
-  cache: WeakMap<Schema, SetSynchronization<RegistryType>>
+  cache: WeakMap<Schema, SetSynchronization<RegistryType>>;
   /**
    * Returns a synchronization object for a schema.
    *
@@ -226,11 +226,11 @@ export declare class DescriptorConverter {
        * If present, this will use an idle scheduler which records duration into this array.
        * This option will be ignored if the `scheduler` option is passed in.
        **/
-      pauseDurations?: number[]
+      pauseDurations?: number[];
       /** An explicit scheduler to do the work. */
-      scheduler?: Scheduler
+      scheduler?: Scheduler;
     },
-  ): Promise<SetSynchronization<RegistryType>>
+  ): Promise<SetSynchronization<RegistryType>>;
 }
 
 /**
@@ -249,54 +249,63 @@ export declare class DescriptorConverter {
 export declare function extractSchema(
   schemaDef: Schema,
   extractOptions?: ExtractSchemaOptions,
-): SchemaType_2
+): SchemaType_2;
 
 declare interface ExtractSchemaOptions {
-  enforceRequiredFields?: boolean
+  enforceRequiredFields?: boolean;
 }
 
 /**
  * @internal
  */
-export declare type FIXME = any
+export declare type FIXME = any;
 
 /**
  * @internal
  */
-export declare function groupProblems(types: SchemaTypeDefinition[]): SchemaValidationProblemGroup[]
+export declare function groupProblems(
+  types: SchemaTypeDefinition[],
+): SchemaValidationProblemGroup[];
 
-export declare const isActionEnabled: (schemaType: SchemaType, action: string) => boolean
+export declare const isActionEnabled: (
+  schemaType: SchemaType,
+  action: string,
+) => boolean;
 
 declare interface Options {
-  transformTypeVisitors?: (visitors: typeof typeVisitors) => Partial<typeof typeVisitors>
-  transformCommonVisitors?: (visitors: any[]) => any[]
+  transformTypeVisitors?: (
+    visitors: typeof typeVisitors,
+  ) => Partial<typeof typeVisitors>;
+  transformCommonVisitors?: (visitors: any[]) => any[];
 }
 
 /**
  * @internal
  */
-export declare type ProblemPath = ProblemPathSegment[]
+export declare type ProblemPath = ProblemPathSegment[];
 
 /**
  * @internal
  */
 export declare interface ProblemPathPropertySegment {
-  kind: 'property'
-  name: string
+  kind: "property";
+  name: string;
 }
 
 /**
  * @internal
  */
-export declare type ProblemPathSegment = ProblemPathTypeSegment | ProblemPathPropertySegment
+export declare type ProblemPathSegment =
+  | ProblemPathTypeSegment
+  | ProblemPathPropertySegment;
 
 /**
  * @internal
  */
 export declare interface ProblemPathTypeSegment {
-  kind: 'type'
-  type: string
-  name: string
+  kind: "type";
+  type: string;
+  name: string;
 }
 
 /**
@@ -309,96 +318,99 @@ export declare interface ProblemPathTypeSegment {
 export declare function processSchemaSynchronization(
   sync: SetSynchronization<RegistryType>,
   response: SchemaSynchronizationResult | null,
-): SchemaSynchronizationRequest | null
+): SchemaSynchronizationRequest | null;
 
-declare type RegistryType = 'sanity.schema.registry'
+declare type RegistryType = "sanity.schema.registry";
 
 /**
  * @internal
  */
-export declare function resolveSearchConfig(type: any, maxDepth?: number): any
+export declare function resolveSearchConfig(type: any, maxDepth?: number): any;
 
-export declare function resolveSearchConfigForBaseFieldPaths(type: any, maxDepth?: number): any
+export declare function resolveSearchConfigForBaseFieldPaths(
+  type: any,
+  maxDepth?: number,
+): any;
 
 /** The scheduler is capable of executing work in different ways. */
 declare type Scheduler = {
-  map<T, U>(arr: T[], fn: (val: T) => U): Promise<U[]>
-  forEach<T>(arr: T[], fn: (val: T) => void): Promise<void>
-  forEachIter<T>(iter: Iterable<T>, fn: (val: T) => void): Promise<void>
-}
+  map<T, U>(arr: T[], fn: (val: T) => U): Promise<U[]>;
+  forEach<T>(arr: T[], fn: (val: T) => void): Promise<void>;
+  forEachIter<T>(iter: Iterable<T>, fn: (val: T) => void): Promise<void>;
+};
 
 /**
  * @beta
  */
 declare class Schema_2 {
-  #private
+  #private;
   _original: {
-    name: string
-    types: any[]
-    parent?: Schema_2
-  }
+    name: string;
+    types: any[];
+    parent?: Schema_2;
+  };
   _registry: {
-    [typeName: string]: any
-  }
-  static compile(schemaDef: any): Schema_2
-  constructor(schemaDef: any)
-  get name(): string
+    [typeName: string]: any;
+  };
+  static compile(schemaDef: any): Schema_2;
+  constructor(schemaDef: any);
+  get name(): string;
   /**
    * Returns the parent schema.
    */
-  get parent(): Schema_2 | undefined
-  get(name: string): any
-  has(name: string): boolean
-  getTypeNames(): string[]
-  getLocalTypeNames(): string[]
+  get parent(): Schema_2 | undefined;
+  get(name: string): any;
+  has(name: string): boolean;
+  getTypeNames(): string[];
+  getLocalTypeNames(): string[];
 }
 
-export declare type SchemaSynchronizationRequest = SynchronizationRequest
+export declare type SchemaSynchronizationRequest = SynchronizationRequest;
 
-export declare type SchemaSynchronizationResult = SynchronizationResult
+export declare type SchemaSynchronizationResult = SynchronizationResult;
 
 /**
  * @internal
  */
 declare interface SchemaValidationResult {
-  severity: 'warning' | 'error'
-  message: string
-  helpId?: string
+  severity: "warning" | "error";
+  message: string;
+  helpId?: string;
 }
-export {SchemaValidationResult as Problem}
-export {SchemaValidationResult as ValidationResult}
+export { SchemaValidationResult as Problem };
+export { SchemaValidationResult as ValidationResult };
 
 declare const typeVisitors: {
-  array: (typeDef: any, visitorContext: any) => any
-  object: (typeDef: any, visitorContext: any) => any
-  slug: (typeDef: any, visitorContext: any) => any
-  file: (typeDef: any, visitorContext: any) => any
-  image: (typeDef: any, visitorContext: any) => any
-  block: typeof validateBlockType
-  document: (typeDefinition: any, visitorContext: any) => any
-  reference: (typeDef: any, visitorContext: any) => any
-  crossDatasetReference: (typeDef: any, visitorContext: any) => any
-  globalDocumentReference: (typeDef: any, visitorContext: any) => any
-}
+  array: (typeDef: any, visitorContext: any) => any;
+  object: (typeDef: any, visitorContext: any) => any;
+  slug: (typeDef: any, visitorContext: any) => any;
+  file: (typeDef: any, visitorContext: any) => any;
+  image: (typeDef: any, visitorContext: any) => any;
+  block: typeof validateBlockType;
+  document: (typeDefinition: any, visitorContext: any) => any;
+  reference: (typeDef: any, visitorContext: any) => any;
+  crossDatasetReference: (typeDef: any, visitorContext: any) => any;
+  globalDocumentReference: (typeDef: any, visitorContext: any) => any;
+};
 
 /**
  * @internal
  */
 export declare interface TypeWithProblems {
-  path: ProblemPath
-  problems: SchemaValidationResult[]
+  path: ProblemPath;
+  problems: SchemaValidationResult[];
 }
 
 declare function validateBlockType(
   typeDef: any,
   visitorContext: any,
 ): {
-  marks: any
-  styles: any
-  name: any
-  of: any
-  _problems: SchemaValidationResult[]
-}
+  marks: any;
+  styles: any;
+  name: any;
+  of: any;
+  _problems: SchemaValidationResult[];
+};
 
 /**
  * Ensure that the provided value is a valid Media Library asset aspect that can be safely deployed.
@@ -407,25 +419,28 @@ declare function validateBlockType(
  */
 export declare function validateMediaLibraryAssetAspect(
   maybeAspect: unknown,
-): [isValidMediaLibraryAspect: boolean, validationErrors: SchemaValidationProblem[][]]
+): [
+  isValidMediaLibraryAspect: boolean,
+  validationErrors: SchemaValidationProblem[][],
+];
 
 /**
  * @internal
  */
 export declare function validateSchema(
   schemaTypes: FIXME,
-  {transformTypeVisitors, transformCommonVisitors}?: Options,
+  { transformTypeVisitors, transformCommonVisitors }?: Options,
 ): {
-  get(typeName: string): any
-  has(typeName: string): boolean
-  getTypeNames(): string[]
-  getTypes(): any[]
-  toJSON(): any[]
-}
+  get(typeName: string): any;
+  has(typeName: string): boolean;
+  getTypeNames(): string[];
+  getTypes(): any[];
+  toJSON(): any[];
+};
 
 export declare class ValidationError extends Error {
-  problems: SchemaValidationProblemGroup[]
-  constructor(problems: SchemaValidationProblemGroup[])
+  problems: SchemaValidationProblemGroup[];
+  constructor(problems: SchemaValidationProblemGroup[]);
 }
 
-export {}
+export {};

package/lib/index.d.ts

@@ -1,38 +1,38 @@
-import {RuleClass} from '@sanity/types'
+import { RuleClass } from "@sanity/types";
 
 export declare const DEFAULT_ANNOTATIONS: {
-  type: string
-  name: string
-  title: string
-  i18nTitleKey: string
+  type: string;
+  name: string;
+  title: string;
+  i18nTitleKey: string;
   options: {
     modal: {
-      type: string
-    }
-  }
+      type: string;
+    };
+  };
   fields: {
-    name: string
-    type: string
-    title: string
-    description: string
-    validation: (Rule: any) => any
-  }[]
-}[]
+    name: string;
+    type: string;
+    title: string;
+    description: string;
+    validation: (Rule: any) => any;
+  }[];
+}[];
 
 export declare const DEFAULT_DECORATORS: {
-  title: string
-  value: string
-  i18nTitleKey: string
-}[]
+  title: string;
+  value: string;
+  i18nTitleKey: string;
+}[];
 
 /**
  * @deprecated Use `import {Schema} from "@sanity/schema"` instead
  */
 declare class DeprecatedDefaultSchema extends Schema_2 {
-  static compile(schemaDef: any): Schema_2
-  constructor(schemaDef: any)
+  static compile(schemaDef: any): Schema_2;
+  constructor(schemaDef: any);
 }
-export default DeprecatedDefaultSchema
+export default DeprecatedDefaultSchema;
 
 /**
  * Core Rule implementation without validation logic.
@@ -40,43 +40,43 @@ export default DeprecatedDefaultSchema
  *
  * @internal
  */
-export declare const Rule: RuleClass
+export declare const Rule: RuleClass;
 
-export declare const Schema: typeof Schema_2
+export declare const Schema: typeof Schema_2;
 
 /**
  * @beta
  */
 declare class Schema_2 {
-  #private
+  #private;
   _original: {
-    name: string
-    types: any[]
-    parent?: Schema_2
-  }
+    name: string;
+    types: any[];
+    parent?: Schema_2;
+  };
   _registry: {
-    [typeName: string]: any
-  }
-  static compile(schemaDef: any): Schema_2
-  constructor(schemaDef: any)
-  get name(): string
+    [typeName: string]: any;
+  };
+  static compile(schemaDef: any): Schema_2;
+  constructor(schemaDef: any);
+  get name(): string;
   /**
    * Returns the parent schema.
    */
-  get parent(): Schema_2 | undefined
-  get(name: string): any
-  has(name: string): boolean
-  getTypeNames(): string[]
-  getLocalTypeNames(): string[]
+  get parent(): Schema_2 | undefined;
+  get(name: string): any;
+  has(name: string): boolean;
+  getTypeNames(): string[];
+  getLocalTypeNames(): string[];
 }
 
 /**
  * @internal
  */
 export declare interface SchemaValidationResult {
-  severity: 'warning' | 'error'
-  message: string
-  helpId?: string
+  severity: "warning" | "error";
+  message: string;
+  helpId?: string;
 }
 
-export {}
+export {};

package/package.json

@@ -1,33 +1,31 @@
 {
   "name": "@sanity/schema",
-  "version": "5.8.0",
+  "version": "5.8.1-next.1+a2c187ff7a",
   "description": "",
   "keywords": [
-    "sanity",
     "cms",
+    "content",
     "headless",
     "realtime",
-    "content",
+    "sanity",
     "schema"
   ],
   "homepage": "https://www.sanity.io/",
   "bugs": {
     "url": "https://github.com/sanity-io/sanity/issues"
   },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sanity-io/sanity.git",
     "directory": "packages/@sanity/schema"
   },
-  "license": "MIT",
-  "author": "Sanity.io <hello@sanity.io>",
-  "sideEffects": false,
+  "files": [
+    "lib"
+  ],
   "type": "module",
-  "exports": {
-    ".": "./lib/index.js",
-    "./_internal": "./lib/_internal.js",
-    "./package.json": "./package.json"
-  },
+  "sideEffects": false,
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "typesVersions": {
@@ -37,9 +35,11 @@
       ]
     }
   },
-  "files": [
-    "lib"
-  ],
+  "exports": {
+    ".": "./lib/index.js",
+    "./_internal": "./lib/_internal.js",
+    "./package.json": "./package.json"
+  },
   "dependencies": {
     "@sanity/descriptors": "^1.3.0",
     "@sanity/generate-help-url": "^4.0.0",
@@ -61,10 +61,10 @@
     "eslint": "^9.39.2",
     "rimraf": "^5.0.10",
     "vitest": "^4.0.18",
-    "@repo/package.config": "5.8.0",
-    "@repo/test-config": "5.8.0",
-    "@repo/eslint-config": "5.8.0",
-    "@repo/tsconfig": "5.8.0"
+    "@repo/package.config": "5.8.1-next.1+a2c187ff7a",
+    "@repo/eslint-config": "5.8.1-next.1+a2c187ff7a",
+    "@repo/test-config": "5.8.1-next.1+a2c187ff7a",
+    "@repo/tsconfig": "5.8.1-next.1+a2c187ff7a"
   },
   "scripts": {
     "build": "pnpm clean && pkg-utils build --strict --check --clean",