@sanity/schema 5.14.0-next.8 → 5.14.0

package/lib/_internal.d.ts

@@ -1,7 +1,8 @@
 import { a as SchemaValidationResult, i as ProblemPathTypeSegment, l as Schema$1, n as ProblemPathPropertySegment, o as TypeWithProblems, r as ProblemPathSegment, s as _FIXME_, t as ProblemPath } from "./_chunks-dts/typedefs.js";
 import { SetSynchronization, SynchronizationRequest, SynchronizationResult } from "@sanity/descriptors";
 import * as _sanity_types0 from "@sanity/types";
-import { Schema, SchemaType, SchemaTypeDefinition, SchemaValidationProblem, SchemaValidationProblemGroup } from "@sanity/types";
+import { SanityDocumentLike, Schema, SchemaType, SchemaTypeDefinition, SchemaValidationProblem, SchemaValidationProblemGroup } from "@sanity/types";
+import { ComponentType, ReactNode } from "react";
 import { SchemaType as SchemaType$1 } from "groq-js";
 /** The scheduler is capable of executing work in different ways. */
 type Scheduler = {
@@ -44,6 +45,180 @@ declare function resolveSearchConfigForBaseFieldPaths(type: any, maxDepth?: numb
  */
 declare function resolveSearchConfig(type: any, maxDepth?: number): any;
 declare const ALL_FIELDS_GROUP_NAME = "all-fields";
+declare function createSchemaFromManifestTypes(schemaDef: {
+  name: string;
+  types: unknown[];
+}): Schema$1;
+interface MediaLibraryConfig {
+  enabled?: boolean;
+  libraryId?: string;
+  __internal?: {
+    frontendHost?: string;
+  };
+}
+declare const SANITY_WORKSPACE_SCHEMA_ID_PREFIX = "_.schemas";
+declare const SANITY_WORKSPACE_SCHEMA_TYPE = "system.schema";
+declare const CURRENT_WORKSPACE_SCHEMA_VERSION = "2025-05-01";
+type ManifestSerializable = string | number | boolean | {
+  [k: string]: ManifestSerializable;
+} | ManifestSerializable[];
+interface CreateManifest {
+  version: number;
+  createdAt: string;
+  workspaces: ManifestWorkspaceFile[];
+  studioVersion: string | null;
+}
+interface ManifestWorkspaceFile extends Omit<CreateWorkspaceManifest, 'schema' | 'tools'> {
+  schema: string;
+  tools: string;
+}
+interface CreateWorkspaceManifest {
+  name: string;
+  title?: string;
+  subtitle?: string;
+  basePath: string;
+  dataset: string;
+  projectId: string;
+  mediaLibrary?: MediaLibraryConfig;
+  schema: ManifestSchemaType[];
+  tools: ManifestTool[];
+  /**
+   * returns undefined in the case of the icon not being able to be stringified
+   */
+  icon: string | undefined;
+}
+interface ManifestSchemaType {
+  type: string;
+  name: string;
+  title?: string;
+  deprecated?: {
+    reason: string;
+  };
+  readOnly?: boolean | 'conditional';
+  hidden?: boolean | 'conditional';
+  validation?: ManifestValidationGroup[];
+  fields?: ManifestField[];
+  to?: ManifestReferenceMember[];
+  of?: ManifestArrayMember[];
+  preview?: {
+    select: Record<string, string>;
+  };
+  fieldsets?: ManifestFieldset[];
+  options?: Record<string, ManifestSerializable>;
+  marks?: {
+    annotations?: ManifestArrayMember[];
+    decorators?: ManifestTitledValue[];
+  };
+  lists?: ManifestTitledValue[];
+  styles?: ManifestTitledValue[];
+}
+interface ManifestFieldset {
+  name: string;
+  title?: string;
+  [index: string]: ManifestSerializable | undefined;
+}
+interface ManifestTitledValue {
+  value: string;
+  title?: string;
+}
+type ManifestField = ManifestSchemaType & {
+  fieldset?: string;
+};
+type ManifestArrayMember = Omit<ManifestSchemaType, 'name'> & {
+  name?: string;
+};
+type ManifestReferenceMember = Omit<ManifestSchemaType, 'name'> & {
+  name?: string;
+};
+interface ManifestValidationGroup {
+  rules: ManifestValidationRule[];
+  message?: string;
+  level?: 'error' | 'warning' | 'info';
+}
+type ManifestValidationRule = {
+  flag: string;
+  constraint?: ManifestSerializable;
+  [index: string]: ManifestSerializable | undefined;
+};
+interface ManifestTool {
+  name: string;
+  title: string;
+  /**
+   * returns undefined in the case of the icon not being able to be stringified
+   */
+  icon: string | undefined;
+  type: string | null;
+}
+type DefaultWorkspaceSchemaId = `${typeof SANITY_WORKSPACE_SCHEMA_ID_PREFIX}.${string}`;
+type PrefixedWorkspaceSchemaId = `${DefaultWorkspaceSchemaId}.${string}`;
+type WorkspaceSchemaId = DefaultWorkspaceSchemaId | PrefixedWorkspaceSchemaId;
+interface StoredWorkspaceSchema extends SanityDocumentLike {
+  _type: typeof SANITY_WORKSPACE_SCHEMA_TYPE;
+  _id: WorkspaceSchemaId;
+  version: typeof CURRENT_WORKSPACE_SCHEMA_VERSION | undefined;
+  tag?: string;
+  workspace: {
+    name: string;
+    title?: string;
+  };
+  /**
+   * The API expects JSON coming in, but will store a string to save on attribute paths.
+   * Consumers must use JSON.parse on the value, put we deploy to the API using ManifestSchemaType[]
+   */
+  schema: string | ManifestSchemaType[];
+}
+interface ManifestWorkspaceInput {
+  name: string;
+  title?: string;
+  subtitle?: string;
+  basePath: string;
+  projectId: string;
+  dataset: string;
+  icon?: ComponentType | ReactNode;
+  mediaLibrary?: MediaLibraryConfig;
+  schema: Schema;
+  tools: ManifestToolInput[];
+}
+interface ManifestToolInput {
+  title: string;
+  name: string;
+  icon?: ComponentType | ReactNode;
+  __internalApplicationType?: string;
+}
+type IconResolver = (props: {
+  icon?: ComponentType | ReactNode;
+  title: string;
+  subtitle?: string;
+}) => string | undefined | Promise<string | undefined>;
+declare function extractCreateWorkspaceManifest(workspace: ManifestWorkspaceInput, iconResolver?: IconResolver): Promise<CreateWorkspaceManifest>;
+/**
+ * Extracts all serializable properties from userland schema types,
+ * so they best-effort can be used as definitions for Schema.compile
+ . */
+declare function extractManifestSchemaTypes(schema: Schema): ManifestSchemaType[];
+declare const validForNamesChars = "a-zA-Z0-9_-";
+declare const validForNamesPattern: RegExp;
+declare function getWorkspaceSchemaId(args: {
+  workspaceName: string;
+  tag?: string;
+}): {
+  safeBaseId: DefaultWorkspaceSchemaId;
+  safeTaggedId: WorkspaceSchemaId;
+  idWarning: string | undefined;
+};
+interface ParsedWorkspaceSchemaId {
+  schemaId: string;
+  workspace: string;
+}
+declare function parseWorkspaceSchemaId(id: string, errors: string[]): ParsedWorkspaceSchemaId | undefined;
+declare function createStoredWorkspaceSchemaPayload(args: {
+  workspace: {
+    name: string;
+    title?: string;
+  };
+  schema: ManifestSchemaType[];
+  tag?: string;
+}): Omit<StoredWorkspaceSchema, '_id' | '_type'>;
 declare const builtinTypes: ({
   name: string;
   title: string;
@@ -58,17 +233,17 @@ declare const builtinTypes: ({
     type: string;
     title: string;
     readOnly: boolean;
+    fieldset?: undefined;
     validation?: undefined;
     hidden?: undefined;
-    fieldset?: undefined;
   } | {
     name: string;
     type: string;
     title: string;
+    fieldset?: undefined;
+    readOnly?: undefined;
     validation?: undefined;
     hidden?: undefined;
-    readOnly?: undefined;
-    fieldset?: undefined;
   } | {
     name: string;
     type: string;
@@ -83,8 +258,8 @@ declare const builtinTypes: ({
     readOnly: boolean;
     hidden: boolean;
     fieldset: string;
-    validation?: undefined;
     title?: undefined;
+    validation?: undefined;
   } | {
     name: string;
     type: string;
@@ -137,17 +312,17 @@ declare const builtinTypes: ({
     type: string;
     title: string;
     readOnly: boolean;
+    fieldset?: undefined;
     validation?: undefined;
     hidden?: undefined;
-    fieldset?: undefined;
   } | {
     name: string;
     type: string;
     title: string;
+    fieldset?: undefined;
+    readOnly?: undefined;
     validation?: undefined;
     hidden?: undefined;
-    readOnly?: undefined;
-    fieldset?: undefined;
   } | {
     name: string;
     type: string;
@@ -157,21 +332,21 @@ declare const builtinTypes: ({
     validation: (Rule: _sanity_types0.Rule) => _sanity_types0.Rule;
     hidden?: undefined;
   } | {
-    validation?: undefined;
     name: string;
     type: string;
     readOnly: boolean;
     hidden: boolean;
     fieldset: string;
     title?: undefined;
-  } | {
     validation?: undefined;
-    hidden?: undefined;
+  } | {
     name: string;
     type: string;
     title: string;
     readOnly: boolean;
     fieldset: string;
+    validation?: undefined;
+    hidden?: undefined;
   })[];
   preview: {
     select: {
@@ -221,17 +396,17 @@ declare const builtinTypes: ({
     };
   }[];
   fields: ({
-    title?: undefined;
-    readOnly?: undefined;
-    fieldset?: undefined;
     name: string;
     type: string;
-  } | {
+    fieldset?: undefined;
+    title?: undefined;
     readOnly?: undefined;
+  } | {
     name: string;
     title: string;
     type: string;
     fieldset: string;
+    readOnly?: undefined;
   } | {
     fieldset?: undefined;
     name: string;
@@ -240,10 +415,6 @@ declare const builtinTypes: ({
     readOnly: boolean;
   })[];
 })[];
-declare function createSchemaFromManifestTypes(schemaDef: {
-  name: string;
-  types: unknown[];
-}): Schema$1;
 interface ExtractSchemaOptions {
   enforceRequiredFields?: boolean;
 }
@@ -311,4 +482,4 @@ declare class ValidationError extends Error {
   problems: SchemaValidationProblemGroup[];
   constructor(problems: SchemaValidationProblemGroup[]);
 }
-export { ALL_FIELDS_GROUP_NAME, DEFAULT_MAX_FIELD_DEPTH, DescriptorConverter, type _FIXME_ as FIXME, type SchemaValidationResult as Problem, type SchemaValidationResult as ValidationResult, type ProblemPath, type ProblemPathPropertySegment, type ProblemPathSegment, type ProblemPathTypeSegment, SchemaSynchronizationRequest, SchemaSynchronizationResult, type TypeWithProblems, ValidationError, builtinTypes, createSchemaFromManifestTypes, extractSchema, groupProblems, isActionEnabled, processSchemaSynchronization, resolveSearchConfig, resolveSearchConfigForBaseFieldPaths, validateMediaLibraryAssetAspect, validateSchema };
+export { ALL_FIELDS_GROUP_NAME, type CreateManifest, type CreateWorkspaceManifest, DEFAULT_MAX_FIELD_DEPTH, type DefaultWorkspaceSchemaId, DescriptorConverter, type _FIXME_ as FIXME, type IconResolver, type ManifestSchemaType, type ManifestWorkspaceFile, type ParsedWorkspaceSchemaId, type SchemaValidationResult as Problem, type SchemaValidationResult as ValidationResult, type ProblemPath, type ProblemPathPropertySegment, type ProblemPathSegment, type ProblemPathTypeSegment, SchemaSynchronizationRequest, SchemaSynchronizationResult, type StoredWorkspaceSchema, type TypeWithProblems, ValidationError, type WorkspaceSchemaId, builtinTypes, createSchemaFromManifestTypes, createStoredWorkspaceSchemaPayload, extractCreateWorkspaceManifest, extractManifestSchemaTypes, extractSchema, getWorkspaceSchemaId, groupProblems, isActionEnabled, parseWorkspaceSchemaId, processSchemaSynchronization, resolveSearchConfig, resolveSearchConfigForBaseFieldPaths, validForNamesChars, validForNamesPattern, validateMediaLibraryAssetAspect, validateSchema };