@sanity/cli 3.52.4 → 3.53.0

package/src/actions/init-project/templates/nextjs/schemaTypes/blog.ts

@@ -1,11 +1,13 @@
 // Types
 
-const authorTS = `import {defineField, defineType} from 'sanity'
+const authorType = `import {UserIcon} from '@sanity/icons'
+import {defineArrayMember, defineField, defineType} from 'sanity'
 
 export const authorType = defineType({
   name: 'author',
   title: 'Author',
   type: 'document',
+  icon: UserIcon,
   fields: [
     defineField({
       name: 'name',
@@ -16,7 +18,6 @@ export const authorType = defineType({
       type: 'slug',
       options: {
         source: 'name',
-        maxLength: 96,
       },
     }),
     defineField({
@@ -25,23 +26,16 @@ export const authorType = defineType({
       options: {
         hotspot: true,
       },
-      fields: [
-        {
-          name: 'alt',
-          type: 'string',
-          title: 'Alternative Text',
-        }
-      ]
     }),
     defineField({
       name: 'bio',
       type: 'array',
       of: [
-        {
+        defineArrayMember({
           type: 'block',
           styles: [{title: 'Normal', value: 'normal'}],
           lists: [],
-        },
+        }),
       ],
     }),
   ],
@@ -54,59 +48,7 @@ export const authorType = defineType({
 })
 `
 
-const authorJS = `export const authorType = {
-  name: 'author',
-  title: 'Author',
-  type: 'document',
-  fields: [
-    {
-      name: 'name',
-      type: 'string',
-    },
-    {
-      name: 'slug',
-      type: 'slug',
-      options: {
-        source: 'name',
-        maxLength: 96,
-      },
-    },
-    {
-      name: 'image',
-      type: 'image',
-      options: {
-        hotspot: true,
-      },
-      fields: [
-        {
-          name: 'alt',
-          type: 'string',
-          title: 'Alternative Text',
-        }
-      ]
-    },
-    {
-      name: 'bio',
-      type: 'array',
-      of: [
-        {
-          type: 'block',
-          styles: [{title: 'Normal', value: 'normal'}],
-          lists: [],
-        },
-      ],
-    },
-  ],
-  preview: {
-    select: {
-      title: 'name',
-      media: 'image',
-    },
-  },
-}
-`
-
-const blockContentTS = `import {defineType, defineArrayMember} from 'sanity'
+const blockContentType = `import {defineType, defineArrayMember} from 'sanity'
 import {ImageIcon} from '@sanity/icons'
 
 /**
@@ -184,94 +126,26 @@ export const blockContentType = defineType({
 })
 `
 
-const blockContentJS = `import {ImageIcon} from '@sanity/icons'
-
-/**
- * This is the schema type for block content used in the post document type
- * Importing this type into the studio configuration's \`schema\` property
- * lets you reuse it in other document types with:
- *  {
- *    name: 'someName',
- *    title: 'Some title',
- *    type: 'blockContent'
- *  }
- */
-
-export const blockContentType = {
-  title: 'Block Content',
-  name: 'blockContent',
-  type: 'array',
-  of: [
-    {
-      title: 'Block',
-      type: 'block',
-      // Styles let you set what your user can mark up blocks with. These
-      // correspond with HTML tags, but you can set any title or value
-      // you want and decide how you want to deal with it where you want to
-      // use your content.
-      styles: [
-        {title: 'Normal', value: 'normal'},
-        {title: 'H1', value: 'h1'},
-        {title: 'H2', value: 'h2'},
-        {title: 'H3', value: 'h3'},
-        {title: 'H4', value: 'h4'},
-        {title: 'Quote', value: 'blockquote'},
-      ],
-      lists: [{title: 'Bullet', value: 'bullet'}],
-      // Marks let you mark up inline text in the block editor.
-      marks: {
-        // Decorators usually describe a single property – e.g. a typographic
-        // preference or highlighting by editors.
-        decorators: [
-          {title: 'Strong', value: 'strong'},
-          {title: 'Emphasis', value: 'em'},
-        ],
-        // Annotations can be any object structure – e.g. a link or a footnote.
-        annotations: [
-          {
-            title: 'URL',
-            name: 'link',
-            type: 'object',
-            fields: [
-              {
-                title: 'URL',
-                name: 'href',
-                type: 'url',
-              },
-            ],
-          },
-        ],
-      },
-    },
-    // You can add additional types here. Note that you can't use
-    // primitive types such as 'string' and 'number' in the same array
-    // as a block type.
-    {
-      type: 'image',
-      icon: ImageIcon,
-      options: {hotspot: true},
-      fields: [
-        {
-          name: 'alt',
-          type: 'string',
-          title: 'Alternative Text',
-        }
-      ]
-    },
-  ],
-}
-`
-
-const categoryTS = `import {defineField, defineType} from 'sanity'
+const categoryType = `import {TagIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
 
 export const categoryType = defineType({
   name: 'category',
+  title: 'Category',
   type: 'document',
+  icon: TagIcon,
   fields: [
     defineField({
       name: 'title',
       type: 'string',
     }),
+    defineField({
+      name: 'slug',
+      type: 'slug',
+      options: {
+        source: 'title',
+      },
+    }),
     defineField({
       name: 'description',
       type: 'text',
@@ -280,29 +154,14 @@ export const categoryType = defineType({
 })
 `
 
-const categoryJS = `export const categoryType = {
-  name: 'category',
-  title: 'Category',
-  type: 'document',
-  fields: [
-    {
-      name: 'title',
-      type: 'string',
-    },
-    {
-      name: 'description',
-      type: 'text',
-    },
-  ],
-}
-`
-
-const postTS = `import {defineField, defineType} from 'sanity'
+const postType = `import {DocumentTextIcon} from '@sanity/icons'
+import {defineArrayMember, defineField, defineType} from 'sanity'
 
 export const postType = defineType({
   name: 'post',
   title: 'Post',
   type: 'document',
+  icon: DocumentTextIcon,
   fields: [
     defineField({
       name: 'title',
@@ -313,7 +172,6 @@ export const postType = defineType({
       type: 'slug',
       options: {
         source: 'title',
-        maxLength: 96,
       },
     }),
     defineField({
@@ -338,7 +196,7 @@ export const postType = defineType({
     defineField({
       name: 'categories',
       type: 'array',
-      of: [{type: 'reference', to: {type: 'category'}}],
+      of: [defineArrayMember({type: 'reference', to: {type: 'category'}})],
     }),
     defineField({
       name: 'publishedAt',
@@ -363,99 +221,32 @@ export const postType = defineType({
 })
 `
 
-const postJS = `export const postType = {
-  name: 'post',
-  title: 'Post',
-  type: 'document',
-  fields: [
-    {
-      name: 'title',
-      type: 'string',
-    },
-    {
-      name: 'slug',
-      type: 'slug',
-      options: {
-        source: 'title',
-        maxLength: 96,
-      },
-    },
-    {
-      name: 'author',
-      type: 'reference',
-      to: {type: 'author'},
-    },
-    {
-      name: 'mainImage',
-      type: 'image',
-      options: {
-        hotspot: true,
-      },
-      fields: [
-        {
-          name: 'alt',
-          type: 'string',
-          title: 'Alternative text',
-        }
-      ]
-    },
-    {
-      name: 'categories',
-      type: 'array',
-      of: [{type: 'reference', to: {type: 'category'}}],
-    },
-    {
-      name: 'publishedAt',
-      type: 'datetime',
-    },
-    {
-      name: 'body',
-      type: 'blockContent',
-    },
-  ],
-  preview: {
-    select: {
-      title: 'title',
-      author: 'author.name',
-      media: 'mainImage',
-    },
-    prepare(selection) {
-      const {author} = selection
-      return {...selection, subtitle: author && \`by \${author}\`}
-    },
-  },
-}
-`
-
 // Schema definition
-
 export const blogSchemaTS = `import { type SchemaTypeDefinition } from 'sanity'
 
-import {blockContentType} from './schemaTypes/blockContentType'
-import {categoryType} from './schemaTypes/categoryType'
-import {postType} from './schemaTypes/postType'
-import {authorType} from './schemaTypes/authorType'
+import {blockContentType} from './blockContentType'
+import {categoryType} from './categoryType'
+import {postType} from './postType'
+import {authorType} from './authorType'
 
 export const schema: { types: SchemaTypeDefinition[] } = {
   types: [blockContentType, categoryType, postType, authorType],
 }
 `
 
-export const blogSchemaJS = `import {blockContentType} from './schemaTypes/blockContentType'
-import {categoryType} from './schemaTypes/categoryType'
-import {postType} from './schemaTypes/postType'
-import {authorType} from './schemaTypes/authorType'
+export const blogSchemaJS = `import {blockContentType} from './blockContentType'
+import {categoryType} from './categoryType'
+import {postType} from './postType'
+import {authorType} from './authorType'
 
 export const schema = {
   types: [blockContentType, categoryType, postType, authorType],
 }
 `
 
-export const blogSchemaFolder = (useTypeScript: boolean): Record<string, string> => {
-  return {
-    'authorType.': useTypeScript ? authorTS : authorJS,
-    'blockContentType.': useTypeScript ? blockContentTS : blockContentJS,
-    'categoryType.': useTypeScript ? categoryTS : categoryJS,
-    'postType.': useTypeScript ? postTS : postJS,
-  }
+export const blogSchemaFolder: Record<string, string> = {
+  'authorType.': authorType,
+  'blockContentType.': blockContentType,
+  'categoryType.': categoryType,
+  'postType.': postType,
 }

package/src/actions/typegen/generate.telemetry.ts

@@ -10,6 +10,7 @@ interface TypesGeneratedTraceAttrubutes {
   unknownTypeNodesGenerated: number
   unknownTypeNodesRatio: number
   emptyUnionTypeNodesGenerated: number
+  configOverloadClientMethods: boolean
 }
 
 export const TypesGeneratedTrace = defineTrace<TypesGeneratedTraceAttrubutes>({

package/src/actions/typegen/generateAction.ts

@@ -77,6 +77,7 @@ export default async function typegenGenerateAction(
       workDir,
       schemaPath: codegenConfig.schema,
       searchPath: codegenConfig.path,
+      overloadClientMethods: codegenConfig.overloadClientMethods,
       prettierConfig,
     } satisfies TypegenGenerateTypesWorkerData,
     // eslint-disable-next-line no-process-env
@@ -131,25 +132,32 @@ export default async function typegenGenerateAction(
         return
       }
 
-      stats.queryFilesCount++
-      for (const {
-        queryName,
-        query,
-        type,
-        typeNodesGenerated,
-        unknownTypeNodesGenerated,
-        emptyUnionTypeNodesGenerated,
-      } of msg.types) {
-        fileTypeString += `// Variable: ${queryName}\n`
-        fileTypeString += `// Query: ${query.replace(/(\r\n|\n|\r)/gm, '')}\n`
-        fileTypeString += type
-        stats.queriesCount++
-        stats.typeNodesGenerated += typeNodesGenerated
-        stats.unknownTypeNodesGenerated += unknownTypeNodesGenerated
-        stats.emptyUnionTypeNodesGenerated += emptyUnionTypeNodesGenerated
+      if (msg.type === 'types') {
+        stats.queryFilesCount++
+        for (const {
+          queryName,
+          query,
+          type,
+          typeNodesGenerated,
+          unknownTypeNodesGenerated,
+          emptyUnionTypeNodesGenerated,
+        } of msg.types) {
+          fileTypeString += `// Variable: ${queryName}\n`
+          fileTypeString += `// Query: ${query.replace(/(\r\n|\n|\r)/gm, '')}\n`
+          fileTypeString += type
+          stats.queriesCount++
+          stats.typeNodesGenerated += typeNodesGenerated
+          stats.unknownTypeNodesGenerated += unknownTypeNodesGenerated
+          stats.emptyUnionTypeNodesGenerated += emptyUnionTypeNodesGenerated
+        }
+        typeFile.write(fileTypeString)
+        stats.size += Buffer.byteLength(fileTypeString)
+      }
+
+      if (msg.type === 'typemap') {
+        typeFile.write(msg.typeMap)
+        stats.size += Buffer.byteLength(msg.typeMap)
       }
-      typeFile.write(fileTypeString)
-      stats.size += Buffer.byteLength(fileTypeString)
     })
     worker.addListener('error', reject)
   })
@@ -167,6 +175,7 @@ export default async function typegenGenerateAction(
     unknownTypeNodesRatio:
       stats.typeNodesGenerated > 0 ? stats.unknownTypeNodesGenerated / stats.typeNodesGenerated : 0,
     emptyUnionTypeNodesGenerated: stats.emptyUnionTypeNodesGenerated,
+    configOverloadClientMethods: codegenConfig.overloadClientMethods,
   })
 
   trace.complete()

package/src/outputters/cliOutputter.ts

@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 import chalk from 'chalk'
-import ora, {type Ora} from 'ora'
+import ora, {type Options, type Ora} from 'ora'
 
 let isFirstClear = true
 
@@ -28,7 +28,7 @@ export default {
     isFirstClear = false
   },
 
-  spinner(options: ora.Options | string): Ora {
+  spinner(options: Options | string): Ora {
     return ora(options)
   },
 }

package/src/workers/typegenGenerate.ts

@@ -21,6 +21,7 @@ export interface TypegenGenerateTypesWorkerData {
   schemaPath: string
   searchPath: string | string[]
   prettierConfig: PrettierOptions | null
+  overloadClientMethods?: boolean
 }
 
 export type TypegenGenerateTypesWorkerMessage =
@@ -49,6 +50,11 @@ export type TypegenGenerateTypesWorkerMessage =
       schema: string
       length: number
     }
+  | {
+      type: 'typemap'
+      filename: string
+      typeMap: string
+    }
   | {
       type: 'complete'
     }
@@ -115,6 +121,8 @@ async function main() {
       queryName: string
       query: string
       type: string
+      typeName: string
+      typeNode: TypeNode
       unknownTypeNodesGenerated: number
       typeNodesGenerated: number
       emptyUnionTypeNodesGenerated: number
@@ -124,16 +132,17 @@ async function main() {
         const ast = safeParseQuery(query)
         const queryTypes = typeEvaluate(ast, schema)
 
-        const type = await maybeFormatCode(
-          typeGenerator.generateTypeNodeTypes(`${queryName}Result`, queryTypes).trim(),
-          opts.prettierConfig,
-        )
+        const typeName = `${queryName}Result`
+        const type = typeGenerator.generateTypeNodeTypes(typeName, queryTypes)
+        const code = await maybeFormatCode(type.trim(), opts.prettierConfig)
 
         const queryTypeStats = walkAndCountQueryTypeNodeStats(queryTypes)
         fileQueryTypes.push({
           queryName,
           query,
-          type,
+          typeName,
+          typeNode: queryTypes,
+          type: code,
           unknownTypeNodesGenerated: queryTypeStats.unknownTypes,
           typeNodesGenerated: queryTypeStats.allTypes,
           emptyUnionTypeNodesGenerated: queryTypeStats.emptyUnions,
@@ -159,6 +168,15 @@ async function main() {
         filename: result.filename,
       } satisfies TypegenGenerateTypesWorkerMessage)
     }
+
+    if (fileQueryTypes.length > 0 && opts.overloadClientMethods) {
+      const typeMap = typeGenerator.generateQueryMap(fileQueryTypes)
+      parentPort?.postMessage({
+        type: 'typemap',
+        filename: result.filename,
+        typeMap,
+      } satisfies TypegenGenerateTypesWorkerMessage)
+    }
   }
 
   parentPort?.postMessage({