@sanity/cli 3.52.4 → 3.53.0

package/lib/_chunks-cjs/generateAction.js

@@ -44,6 +44,7 @@ async function typegenGenerateAction(args, context) {
       workDir,
       schemaPath: codegenConfig.schema,
       searchPath: codegenConfig.path,
+      overloadClientMethods: codegenConfig.overloadClientMethods,
       prettierConfig
     },
     // eslint-disable-next-line no-process-env
@@ -85,19 +86,22 @@ async function typegenGenerateAction(args, context) {
         stats.schemaTypesCount += msg.length, fileTypeString += msg.schema, typeFile.write(fileTypeString);
         return;
       }
-      stats.queryFilesCount++;
-      for (const {
-        queryName,
-        query,
-        type,
-        typeNodesGenerated,
-        unknownTypeNodesGenerated,
-        emptyUnionTypeNodesGenerated
-      } of msg.types)
-        fileTypeString += `// Variable: ${queryName}
+      if (msg.type === "types") {
+        stats.queryFilesCount++;
+        for (const {
+          queryName,
+          query,
+          type,
+          typeNodesGenerated,
+          unknownTypeNodesGenerated,
+          emptyUnionTypeNodesGenerated
+        } of msg.types)
+          fileTypeString += `// Variable: ${queryName}
 `, fileTypeString += `// Query: ${query.replace(/(\r\n|\n|\r)/gm, "")}
 `, fileTypeString += type, stats.queriesCount++, stats.typeNodesGenerated += typeNodesGenerated, stats.unknownTypeNodesGenerated += unknownTypeNodesGenerated, stats.emptyUnionTypeNodesGenerated += emptyUnionTypeNodesGenerated;
-      typeFile.write(fileTypeString), stats.size += Buffer.byteLength(fileTypeString);
+        typeFile.write(fileTypeString), stats.size += Buffer.byteLength(fileTypeString);
+      }
+      msg.type === "typemap" && (typeFile.write(msg.typeMap), stats.size += Buffer.byteLength(msg.typeMap));
     }), worker.addListener("error", reject);
   }), typeFile.close(), trace.log({
     outputSize: stats.size,
@@ -108,7 +112,8 @@ async function typegenGenerateAction(args, context) {
     typeNodesGenerated: stats.typeNodesGenerated,
     unknownTypeNodesGenerated: stats.unknownTypeNodesGenerated,
     unknownTypeNodesRatio: stats.typeNodesGenerated > 0 ? stats.unknownTypeNodesGenerated / stats.typeNodesGenerated : 0,
-    emptyUnionTypeNodesGenerated: stats.emptyUnionTypeNodesGenerated
+    emptyUnionTypeNodesGenerated: stats.emptyUnionTypeNodesGenerated,
+    configOverloadClientMethods: codegenConfig.overloadClientMethods
   }), trace.complete(), stats.errors > 0 && spinner.warn(`Encountered errors in ${stats.errors} files while generating types`), spinner.succeed(
     `Generated TypeScript types for ${stats.schemaTypesCount} schema types and ${stats.queriesCount} GROQ queries in ${stats.queryFilesCount} files into: ${codegenConfig.generates}`
   );

package/lib/_chunks-cjs/generateAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateAction.js","sources":["../../src/actions/typegen/generate.telemetry.ts","../../src/actions/typegen/generateAction.ts"],"sourcesContent":["import {defineTrace} from '@sanity/telemetry'\n\ninterface TypesGeneratedTraceAttrubutes {\n  outputSize: number\n  queriesCount: number\n  schemaTypesCount: number\n  queryFilesCount: number\n  filesWithErrors: number\n  typeNodesGenerated: number\n  unknownTypeNodesGenerated: number\n  unknownTypeNodesRatio: number\n  emptyUnionTypeNodesGenerated: number\n}\n\nexport const TypesGeneratedTrace = defineTrace<TypesGeneratedTraceAttrubutes>({\n  name: 'Types Generated',\n  version: 0,\n  description: 'Trace emitted when generating TypeScript types for queries',\n})\n","import {constants, mkdir, open, stat} from 'node:fs/promises'\nimport {dirname, join} from 'node:path'\nimport {Worker} from 'node:worker_threads'\n\nimport {readConfig} from '@sanity/codegen'\nimport prettier from 'prettier'\n\nimport {type CliCommandArguments, type CliCommandContext} from '../../types'\nimport {getCliWorkerPath} from '../../util/cliWorker'\nimport {\n  type TypegenGenerateTypesWorkerData,\n  type TypegenGenerateTypesWorkerMessage,\n} from '../../workers/typegenGenerate'\nimport {TypesGeneratedTrace} from './generate.telemetry'\n\nexport interface TypegenGenerateTypesCommandFlags {\n  'config-path'?: string\n}\n\nconst generatedFileWarning = `/**\n * ---------------------------------------------------------------------------------\n * This file has been generated by Sanity TypeGen.\n * Command: \\`sanity typegen generate\\`\n *\n * Any modifications made directly to this file will be overwritten the next time\n * the TypeScript definitions are generated. Please make changes to the Sanity\n * schema definitions and/or GROQ queries if you need to update these types.\n *\n * For more information on how to use Sanity TypeGen, visit the official documentation:\n * https://www.sanity.io/docs/sanity-typegen\n * ---------------------------------------------------------------------------------\n */\\n\\n`\n\nexport default async function typegenGenerateAction(\n  args: CliCommandArguments<TypegenGenerateTypesCommandFlags>,\n  context: CliCommandContext,\n): Promise<void> {\n  const flags = args.extOptions\n  const {output, workDir, telemetry} = context\n\n  const trace = telemetry.trace(TypesGeneratedTrace)\n  trace.start()\n\n  const codegenConfig = await readConfig(flags['config-path'] || 'sanity-typegen.json')\n\n  try {\n    const schemaStats = await stat(codegenConfig.schema)\n    if (!schemaStats.isFile()) {\n      throw new Error(`Schema path is not a file: ${codegenConfig.schema}`)\n    }\n  } catch (err) {\n    if (err.code === 'ENOENT') {\n      // If the user has not provided a specific schema path (eg we're using the default), give some help\n      const hint =\n        codegenConfig.schema === './schema.json' ? ` - did you run \"sanity schema extract\"?` : ''\n      throw new Error(`Schema file not found: ${codegenConfig.schema}${hint}`)\n    }\n    throw err\n  }\n\n  const outputPath = join(process.cwd(), codegenConfig.generates)\n  const outputDir = dirname(outputPath)\n  await mkdir(outputDir, {recursive: true})\n\n  const prettierConfig = codegenConfig.formatGeneratedCode\n    ? await prettier.resolveConfig(outputPath).catch((err) => {\n        output.warn(`Failed to load prettier config: ${err.message}`)\n        return null\n      })\n    : null\n  const workerPath = await getCliWorkerPath('typegenGenerate')\n\n  const spinner = output.spinner({}).start('Generating types')\n\n  const worker = new Worker(workerPath, {\n    workerData: {\n      workDir,\n      schemaPath: codegenConfig.schema,\n      searchPath: codegenConfig.path,\n      prettierConfig,\n    } satisfies TypegenGenerateTypesWorkerData,\n    // eslint-disable-next-line no-process-env\n    env: process.env,\n  })\n\n  const typeFile = await open(\n    outputPath,\n    // eslint-disable-next-line no-bitwise\n    constants.O_TRUNC | constants.O_CREAT | constants.O_WRONLY,\n  )\n\n  typeFile.write(generatedFileWarning)\n\n  const stats = {\n    queryFilesCount: 0,\n    errors: 0,\n    queriesCount: 0,\n    schemaTypesCount: 0,\n    unknownTypeNodesGenerated: 0,\n    typeNodesGenerated: 0,\n    emptyUnionTypeNodesGenerated: 0,\n    size: 0,\n  }\n\n  await new Promise<void>((resolve, reject) => {\n    worker.addListener('message', (msg: TypegenGenerateTypesWorkerMessage) => {\n      if (msg.type === 'error') {\n        if (msg.fatal) {\n          trace.error(msg.error)\n          reject(msg.error)\n          return\n        }\n        const errorMessage = msg.filename\n          ? `${msg.error.message} in \"${msg.filename}\"`\n          : msg.error.message\n        spinner.fail(errorMessage)\n        stats.errors++\n        return\n      }\n      if (msg.type === 'complete') {\n        resolve()\n        return\n      }\n\n      let fileTypeString = `// Source: ${msg.filename}\\n`\n\n      if (msg.type === 'schema') {\n        stats.schemaTypesCount += msg.length\n        fileTypeString += msg.schema\n        typeFile.write(fileTypeString)\n        return\n      }\n\n      stats.queryFilesCount++\n      for (const {\n        queryName,\n        query,\n        type,\n        typeNodesGenerated,\n        unknownTypeNodesGenerated,\n        emptyUnionTypeNodesGenerated,\n      } of msg.types) {\n        fileTypeString += `// Variable: ${queryName}\\n`\n        fileTypeString += `// Query: ${query.replace(/(\\r\\n|\\n|\\r)/gm, '')}\\n`\n        fileTypeString += type\n        stats.queriesCount++\n        stats.typeNodesGenerated += typeNodesGenerated\n        stats.unknownTypeNodesGenerated += unknownTypeNodesGenerated\n        stats.emptyUnionTypeNodesGenerated += emptyUnionTypeNodesGenerated\n      }\n      typeFile.write(fileTypeString)\n      stats.size += Buffer.byteLength(fileTypeString)\n    })\n    worker.addListener('error', reject)\n  })\n\n  typeFile.close()\n\n  trace.log({\n    outputSize: stats.size,\n    queriesCount: stats.queriesCount,\n    schemaTypesCount: stats.schemaTypesCount,\n    queryFilesCount: stats.queryFilesCount,\n    filesWithErrors: stats.errors,\n    typeNodesGenerated: stats.typeNodesGenerated,\n    unknownTypeNodesGenerated: stats.unknownTypeNodesGenerated,\n    unknownTypeNodesRatio:\n      stats.typeNodesGenerated > 0 ? stats.unknownTypeNodesGenerated / stats.typeNodesGenerated : 0,\n    emptyUnionTypeNodesGenerated: stats.emptyUnionTypeNodesGenerated,\n  })\n\n  trace.complete()\n  if (stats.errors > 0) {\n    spinner.warn(`Encountered errors in ${stats.errors} files while generating types`)\n  }\n\n  spinner.succeed(\n    `Generated TypeScript types for ${stats.schemaTypesCount} schema types and ${stats.queriesCount} GROQ queries in ${stats.queryFilesCount} files into: ${codegenConfig.generates}`,\n  )\n}\n"],"names":["defineTrace","telemetry","readConfig","stat","join","dirname","mkdir","prettier","getCliWorkerPath","Worker","open","constants"],"mappings":";;;;;;AAcO,MAAM,sBAAsBA,UAAAA,YAA2C;AAAA,EAC5E,MAAM;AAAA,EACN,SAAS;AAAA,EACT,aAAa;AACf,CAAC,GCCK,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAcC,eAAA,sBAC5B,MACA,SACe;AACf,QAAM,QAAQ,KAAK,YACb,EAAC,QAAQ,SAAS,WAAAC,WAAS,IAAI,SAE/B,QAAQA,WAAU,MAAM,mBAAmB;AACjD,QAAM,MAAM;AAEZ,QAAM,gBAAgB,MAAMC,QAAA,WAAW,MAAM,aAAa,KAAK,qBAAqB;AAEhF,MAAA;AAEF,QAAI,EADgB,MAAMC,GAAA,KAAK,cAAc,MAAM,GAClC,OAAO;AACtB,YAAM,IAAI,MAAM,8BAA8B,cAAc,MAAM,EAAE;AAAA,WAE/D,KAAK;AACR,QAAA,IAAI,SAAS,UAAU;AAEzB,YAAM,OACJ,cAAc,WAAW,kBAAkB,4CAA4C;AACzF,YAAM,IAAI,MAAM,0BAA0B,cAAc,MAAM,GAAG,IAAI,EAAE;AAAA,IACzE;AACM,UAAA;AAAA,EACR;AAEM,QAAA,aAAaC,KAAAA,KAAK,QAAQ,IAAI,GAAG,cAAc,SAAS,GACxD,YAAYC,KAAA,QAAQ,UAAU;AACpC,QAAMC,GAAAA,MAAM,WAAW,EAAC,WAAW,GAAK,CAAA;AAExC,QAAM,iBAAiB,cAAc,sBACjC,MAAMC,kBAAAA,QAAS,cAAc,UAAU,EAAE,MAAM,CAAC,SAC9C,OAAO,KAAK,mCAAmC,IAAI,OAAO,EAAE,GACrD,KACR,IACD,MACE,aAAa,MAAMC,UAAA,iBAAiB,iBAAiB,GAErD,UAAU,OAAO,QAAQ,CAAE,CAAA,EAAE,MAAM,kBAAkB,GAErD,SAAS,IAAIC,2BAAO,YAAY;AAAA,IACpC,YAAY;AAAA,MACV;AAAA,MACA,YAAY,cAAc;AAAA,MAC1B,YAAY,cAAc;AAAA,MAC1B;AAAA,IACF;AAAA;AAAA,IAEA,KAAK,QAAQ;AAAA,EAAA,CACd,GAEK,WAAW,MAAMC,GAAA;AAAA,IACrB;AAAA;AAAA,IAEAC,GAAAA,UAAU,UAAUA,GAAAA,UAAU,UAAUA,GAAU,UAAA;AAAA,EAAA;AAGpD,WAAS,MAAM,oBAAoB;AAEnC,QAAM,QAAQ;AAAA,IACZ,iBAAiB;AAAA,IACjB,QAAQ;AAAA,IACR,cAAc;AAAA,IACd,kBAAkB;AAAA,IAClB,2BAA2B;AAAA,IAC3B,oBAAoB;AAAA,IACpB,8BAA8B;AAAA,IAC9B,MAAM;AAAA,EAAA;AAGR,QAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AACpC,WAAA,YAAY,WAAW,CAAC,QAA2C;AACpE,UAAA,IAAI,SAAS,SAAS;AACxB,YAAI,IAAI,OAAO;AACb,gBAAM,MAAM,IAAI,KAAK,GACrB,OAAO,IAAI,KAAK;AAChB;AAAA,QACF;AACA,cAAM,eAAe,IAAI,WACrB,GAAG,IAAI,MAAM,OAAO,QAAQ,IAAI,QAAQ,MACxC,IAAI,MAAM;AACN,gBAAA,KAAK,YAAY,GACzB,MAAM;AACN;AAAA,MACF;AACI,UAAA,IAAI,SAAS,YAAY;AACnB;AACR;AAAA,MACF;AAEI,UAAA,iBAAiB,cAAc,IAAI,QAAQ;AAAA;AAE3C,UAAA,IAAI,SAAS,UAAU;AACnB,cAAA,oBAAoB,IAAI,QAC9B,kBAAkB,IAAI,QACtB,SAAS,MAAM,cAAc;AAC7B;AAAA,MACF;AAEM,YAAA;AACK,iBAAA;AAAA,QACT;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,WACG,IAAI;AACP,0BAAkB,gBAAgB,SAAS;AAAA,GAC3C,kBAAkB,aAAa,MAAM,QAAQ,kBAAkB,EAAE,CAAC;AAAA,GAClE,kBAAkB,MAClB,MAAM,gBACN,MAAM,sBAAsB,oBAC5B,MAAM,6BAA6B,2BACnC,MAAM,gCAAgC;AAExC,eAAS,MAAM,cAAc,GAC7B,MAAM,QAAQ,OAAO,WAAW,cAAc;AAAA,IAC/C,CAAA,GACD,OAAO,YAAY,SAAS,MAAM;AAAA,EACnC,CAAA,GAED,SAAS,SAET,MAAM,IAAI;AAAA,IACR,YAAY,MAAM;AAAA,IAClB,cAAc,MAAM;AAAA,IACpB,kBAAkB,MAAM;AAAA,IACxB,iBAAiB,MAAM;AAAA,IACvB,iBAAiB,MAAM;AAAA,IACvB,oBAAoB,MAAM;AAAA,IAC1B,2BAA2B,MAAM;AAAA,IACjC,uBACE,MAAM,qBAAqB,IAAI,MAAM,4BAA4B,MAAM,qBAAqB;AAAA,IAC9F,8BAA8B,MAAM;AAAA,EAAA,CACrC,GAED,MAAM,SAAA,GACF,MAAM,SAAS,KACjB,QAAQ,KAAK,yBAAyB,MAAM,MAAM,+BAA+B,GAGnF,QAAQ;AAAA,IACN,kCAAkC,MAAM,gBAAgB,qBAAqB,MAAM,YAAY,oBAAoB,MAAM,eAAe,gBAAgB,cAAc,SAAS;AAAA,EAAA;AAEnL;;"}
+{"version":3,"file":"generateAction.js","sources":["../../src/actions/typegen/generate.telemetry.ts","../../src/actions/typegen/generateAction.ts"],"sourcesContent":["import {defineTrace} from '@sanity/telemetry'\n\ninterface TypesGeneratedTraceAttrubutes {\n  outputSize: number\n  queriesCount: number\n  schemaTypesCount: number\n  queryFilesCount: number\n  filesWithErrors: number\n  typeNodesGenerated: number\n  unknownTypeNodesGenerated: number\n  unknownTypeNodesRatio: number\n  emptyUnionTypeNodesGenerated: number\n  configOverloadClientMethods: boolean\n}\n\nexport const TypesGeneratedTrace = defineTrace<TypesGeneratedTraceAttrubutes>({\n  name: 'Types Generated',\n  version: 0,\n  description: 'Trace emitted when generating TypeScript types for queries',\n})\n","import {constants, mkdir, open, stat} from 'node:fs/promises'\nimport {dirname, join} from 'node:path'\nimport {Worker} from 'node:worker_threads'\n\nimport {readConfig} from '@sanity/codegen'\nimport prettier from 'prettier'\n\nimport {type CliCommandArguments, type CliCommandContext} from '../../types'\nimport {getCliWorkerPath} from '../../util/cliWorker'\nimport {\n  type TypegenGenerateTypesWorkerData,\n  type TypegenGenerateTypesWorkerMessage,\n} from '../../workers/typegenGenerate'\nimport {TypesGeneratedTrace} from './generate.telemetry'\n\nexport interface TypegenGenerateTypesCommandFlags {\n  'config-path'?: string\n}\n\nconst generatedFileWarning = `/**\n * ---------------------------------------------------------------------------------\n * This file has been generated by Sanity TypeGen.\n * Command: \\`sanity typegen generate\\`\n *\n * Any modifications made directly to this file will be overwritten the next time\n * the TypeScript definitions are generated. Please make changes to the Sanity\n * schema definitions and/or GROQ queries if you need to update these types.\n *\n * For more information on how to use Sanity TypeGen, visit the official documentation:\n * https://www.sanity.io/docs/sanity-typegen\n * ---------------------------------------------------------------------------------\n */\\n\\n`\n\nexport default async function typegenGenerateAction(\n  args: CliCommandArguments<TypegenGenerateTypesCommandFlags>,\n  context: CliCommandContext,\n): Promise<void> {\n  const flags = args.extOptions\n  const {output, workDir, telemetry} = context\n\n  const trace = telemetry.trace(TypesGeneratedTrace)\n  trace.start()\n\n  const codegenConfig = await readConfig(flags['config-path'] || 'sanity-typegen.json')\n\n  try {\n    const schemaStats = await stat(codegenConfig.schema)\n    if (!schemaStats.isFile()) {\n      throw new Error(`Schema path is not a file: ${codegenConfig.schema}`)\n    }\n  } catch (err) {\n    if (err.code === 'ENOENT') {\n      // If the user has not provided a specific schema path (eg we're using the default), give some help\n      const hint =\n        codegenConfig.schema === './schema.json' ? ` - did you run \"sanity schema extract\"?` : ''\n      throw new Error(`Schema file not found: ${codegenConfig.schema}${hint}`)\n    }\n    throw err\n  }\n\n  const outputPath = join(process.cwd(), codegenConfig.generates)\n  const outputDir = dirname(outputPath)\n  await mkdir(outputDir, {recursive: true})\n\n  const prettierConfig = codegenConfig.formatGeneratedCode\n    ? await prettier.resolveConfig(outputPath).catch((err) => {\n        output.warn(`Failed to load prettier config: ${err.message}`)\n        return null\n      })\n    : null\n  const workerPath = await getCliWorkerPath('typegenGenerate')\n\n  const spinner = output.spinner({}).start('Generating types')\n\n  const worker = new Worker(workerPath, {\n    workerData: {\n      workDir,\n      schemaPath: codegenConfig.schema,\n      searchPath: codegenConfig.path,\n      overloadClientMethods: codegenConfig.overloadClientMethods,\n      prettierConfig,\n    } satisfies TypegenGenerateTypesWorkerData,\n    // eslint-disable-next-line no-process-env\n    env: process.env,\n  })\n\n  const typeFile = await open(\n    outputPath,\n    // eslint-disable-next-line no-bitwise\n    constants.O_TRUNC | constants.O_CREAT | constants.O_WRONLY,\n  )\n\n  typeFile.write(generatedFileWarning)\n\n  const stats = {\n    queryFilesCount: 0,\n    errors: 0,\n    queriesCount: 0,\n    schemaTypesCount: 0,\n    unknownTypeNodesGenerated: 0,\n    typeNodesGenerated: 0,\n    emptyUnionTypeNodesGenerated: 0,\n    size: 0,\n  }\n\n  await new Promise<void>((resolve, reject) => {\n    worker.addListener('message', (msg: TypegenGenerateTypesWorkerMessage) => {\n      if (msg.type === 'error') {\n        if (msg.fatal) {\n          trace.error(msg.error)\n          reject(msg.error)\n          return\n        }\n        const errorMessage = msg.filename\n          ? `${msg.error.message} in \"${msg.filename}\"`\n          : msg.error.message\n        spinner.fail(errorMessage)\n        stats.errors++\n        return\n      }\n      if (msg.type === 'complete') {\n        resolve()\n        return\n      }\n\n      let fileTypeString = `// Source: ${msg.filename}\\n`\n\n      if (msg.type === 'schema') {\n        stats.schemaTypesCount += msg.length\n        fileTypeString += msg.schema\n        typeFile.write(fileTypeString)\n        return\n      }\n\n      if (msg.type === 'types') {\n        stats.queryFilesCount++\n        for (const {\n          queryName,\n          query,\n          type,\n          typeNodesGenerated,\n          unknownTypeNodesGenerated,\n          emptyUnionTypeNodesGenerated,\n        } of msg.types) {\n          fileTypeString += `// Variable: ${queryName}\\n`\n          fileTypeString += `// Query: ${query.replace(/(\\r\\n|\\n|\\r)/gm, '')}\\n`\n          fileTypeString += type\n          stats.queriesCount++\n          stats.typeNodesGenerated += typeNodesGenerated\n          stats.unknownTypeNodesGenerated += unknownTypeNodesGenerated\n          stats.emptyUnionTypeNodesGenerated += emptyUnionTypeNodesGenerated\n        }\n        typeFile.write(fileTypeString)\n        stats.size += Buffer.byteLength(fileTypeString)\n      }\n\n      if (msg.type === 'typemap') {\n        typeFile.write(msg.typeMap)\n        stats.size += Buffer.byteLength(msg.typeMap)\n      }\n    })\n    worker.addListener('error', reject)\n  })\n\n  typeFile.close()\n\n  trace.log({\n    outputSize: stats.size,\n    queriesCount: stats.queriesCount,\n    schemaTypesCount: stats.schemaTypesCount,\n    queryFilesCount: stats.queryFilesCount,\n    filesWithErrors: stats.errors,\n    typeNodesGenerated: stats.typeNodesGenerated,\n    unknownTypeNodesGenerated: stats.unknownTypeNodesGenerated,\n    unknownTypeNodesRatio:\n      stats.typeNodesGenerated > 0 ? stats.unknownTypeNodesGenerated / stats.typeNodesGenerated : 0,\n    emptyUnionTypeNodesGenerated: stats.emptyUnionTypeNodesGenerated,\n    configOverloadClientMethods: codegenConfig.overloadClientMethods,\n  })\n\n  trace.complete()\n  if (stats.errors > 0) {\n    spinner.warn(`Encountered errors in ${stats.errors} files while generating types`)\n  }\n\n  spinner.succeed(\n    `Generated TypeScript types for ${stats.schemaTypesCount} schema types and ${stats.queriesCount} GROQ queries in ${stats.queryFilesCount} files into: ${codegenConfig.generates}`,\n  )\n}\n"],"names":["defineTrace","telemetry","readConfig","stat","join","dirname","mkdir","prettier","getCliWorkerPath","Worker","open","constants"],"mappings":";;;;;;AAeO,MAAM,sBAAsBA,UAAAA,YAA2C;AAAA,EAC5E,MAAM;AAAA,EACN,SAAS;AAAA,EACT,aAAa;AACf,CAAC,GCAK,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAcC,eAAA,sBAC5B,MACA,SACe;AACf,QAAM,QAAQ,KAAK,YACb,EAAC,QAAQ,SAAS,WAAAC,WAAS,IAAI,SAE/B,QAAQA,WAAU,MAAM,mBAAmB;AACjD,QAAM,MAAM;AAEZ,QAAM,gBAAgB,MAAMC,QAAA,WAAW,MAAM,aAAa,KAAK,qBAAqB;AAEhF,MAAA;AAEF,QAAI,EADgB,MAAMC,GAAA,KAAK,cAAc,MAAM,GAClC,OAAO;AACtB,YAAM,IAAI,MAAM,8BAA8B,cAAc,MAAM,EAAE;AAAA,WAE/D,KAAK;AACR,QAAA,IAAI,SAAS,UAAU;AAEzB,YAAM,OACJ,cAAc,WAAW,kBAAkB,4CAA4C;AACzF,YAAM,IAAI,MAAM,0BAA0B,cAAc,MAAM,GAAG,IAAI,EAAE;AAAA,IACzE;AACM,UAAA;AAAA,EACR;AAEM,QAAA,aAAaC,KAAAA,KAAK,QAAQ,IAAI,GAAG,cAAc,SAAS,GACxD,YAAYC,KAAA,QAAQ,UAAU;AACpC,QAAMC,GAAAA,MAAM,WAAW,EAAC,WAAW,GAAK,CAAA;AAExC,QAAM,iBAAiB,cAAc,sBACjC,MAAMC,kBAAAA,QAAS,cAAc,UAAU,EAAE,MAAM,CAAC,SAC9C,OAAO,KAAK,mCAAmC,IAAI,OAAO,EAAE,GACrD,KACR,IACD,MACE,aAAa,MAAMC,UAAA,iBAAiB,iBAAiB,GAErD,UAAU,OAAO,QAAQ,CAAE,CAAA,EAAE,MAAM,kBAAkB,GAErD,SAAS,IAAIC,2BAAO,YAAY;AAAA,IACpC,YAAY;AAAA,MACV;AAAA,MACA,YAAY,cAAc;AAAA,MAC1B,YAAY,cAAc;AAAA,MAC1B,uBAAuB,cAAc;AAAA,MACrC;AAAA,IACF;AAAA;AAAA,IAEA,KAAK,QAAQ;AAAA,EAAA,CACd,GAEK,WAAW,MAAMC,GAAA;AAAA,IACrB;AAAA;AAAA,IAEAC,GAAAA,UAAU,UAAUA,GAAAA,UAAU,UAAUA,GAAU,UAAA;AAAA,EAAA;AAGpD,WAAS,MAAM,oBAAoB;AAEnC,QAAM,QAAQ;AAAA,IACZ,iBAAiB;AAAA,IACjB,QAAQ;AAAA,IACR,cAAc;AAAA,IACd,kBAAkB;AAAA,IAClB,2BAA2B;AAAA,IAC3B,oBAAoB;AAAA,IACpB,8BAA8B;AAAA,IAC9B,MAAM;AAAA,EAAA;AAGR,QAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AACpC,WAAA,YAAY,WAAW,CAAC,QAA2C;AACpE,UAAA,IAAI,SAAS,SAAS;AACxB,YAAI,IAAI,OAAO;AACb,gBAAM,MAAM,IAAI,KAAK,GACrB,OAAO,IAAI,KAAK;AAChB;AAAA,QACF;AACA,cAAM,eAAe,IAAI,WACrB,GAAG,IAAI,MAAM,OAAO,QAAQ,IAAI,QAAQ,MACxC,IAAI,MAAM;AACN,gBAAA,KAAK,YAAY,GACzB,MAAM;AACN;AAAA,MACF;AACI,UAAA,IAAI,SAAS,YAAY;AACnB;AACR;AAAA,MACF;AAEI,UAAA,iBAAiB,cAAc,IAAI,QAAQ;AAAA;AAE3C,UAAA,IAAI,SAAS,UAAU;AACnB,cAAA,oBAAoB,IAAI,QAC9B,kBAAkB,IAAI,QACtB,SAAS,MAAM,cAAc;AAC7B;AAAA,MACF;AAEI,UAAA,IAAI,SAAS,SAAS;AAClB,cAAA;AACK,mBAAA;AAAA,UACT;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,aACG,IAAI;AACP,4BAAkB,gBAAgB,SAAS;AAAA,GAC3C,kBAAkB,aAAa,MAAM,QAAQ,kBAAkB,EAAE,CAAC;AAAA,GAClE,kBAAkB,MAClB,MAAM,gBACN,MAAM,sBAAsB,oBAC5B,MAAM,6BAA6B,2BACnC,MAAM,gCAAgC;AAExC,iBAAS,MAAM,cAAc,GAC7B,MAAM,QAAQ,OAAO,WAAW,cAAc;AAAA,MAChD;AAEI,UAAI,SAAS,cACf,SAAS,MAAM,IAAI,OAAO,GAC1B,MAAM,QAAQ,OAAO,WAAW,IAAI,OAAO;AAAA,IAE9C,CAAA,GACD,OAAO,YAAY,SAAS,MAAM;AAAA,EACnC,CAAA,GAED,SAAS,SAET,MAAM,IAAI;AAAA,IACR,YAAY,MAAM;AAAA,IAClB,cAAc,MAAM;AAAA,IACpB,kBAAkB,MAAM;AAAA,IACxB,iBAAiB,MAAM;AAAA,IACvB,iBAAiB,MAAM;AAAA,IACvB,oBAAoB,MAAM;AAAA,IAC1B,2BAA2B,MAAM;AAAA,IACjC,uBACE,MAAM,qBAAqB,IAAI,MAAM,4BAA4B,MAAM,qBAAqB;AAAA,IAC9F,8BAA8B,MAAM;AAAA,IACpC,6BAA6B,cAAc;AAAA,EAAA,CAC5C,GAED,MAAM,SAAA,GACF,MAAM,SAAS,KACjB,QAAQ,KAAK,yBAAyB,MAAM,MAAM,+BAA+B,GAGnF,QAAQ;AAAA,IACN,kCAAkC,MAAM,gBAAgB,qBAAqB,MAAM,YAAY,oBAAoB,MAAM,eAAe,gBAAgB,cAAc,SAAS;AAAA,EAAA;AAEnL;;"}

package/lib/workers/typegenGenerate.d.ts

@@ -6,6 +6,7 @@ export declare interface TypegenGenerateTypesWorkerData {
   schemaPath: string
   searchPath: string | string[]
   prettierConfig: Options | null
+  overloadClientMethods?: boolean
 }
 
 export declare type TypegenGenerateTypesWorkerMessage =
@@ -34,6 +35,11 @@ export declare type TypegenGenerateTypesWorkerMessage =
       schema: string
       length: number
     }
+  | {
+      type: 'typemap'
+      filename: string
+      typeMap: string
+    }
   | {
       type: 'complete'
     }

package/lib/workers/typegenGenerate.js

@@ -53,14 +53,13 @@ async function main() {
     const fileQueryTypes = [];
     for (const { name: queryName, result: query } of result.queries)
       try {
-        const ast = codegen.safeParseQuery(query), queryTypes = groqJs.typeEvaluate(ast, schema), type = await maybeFormatCode(
-          typeGenerator.generateTypeNodeTypes(`${queryName}Result`, queryTypes).trim(),
-          opts.prettierConfig
-        ), queryTypeStats = walkAndCountQueryTypeNodeStats(queryTypes);
+        const ast = codegen.safeParseQuery(query), queryTypes = groqJs.typeEvaluate(ast, schema), typeName = `${queryName}Result`, type = typeGenerator.generateTypeNodeTypes(typeName, queryTypes), code = await maybeFormatCode(type.trim(), opts.prettierConfig), queryTypeStats = walkAndCountQueryTypeNodeStats(queryTypes);
         fileQueryTypes.push({
           queryName,
           query,
-          type,
+          typeName,
+          typeNode: queryTypes,
+          type: code,
           unknownTypeNodesGenerated: queryTypeStats.unknownTypes,
           typeNodesGenerated: queryTypeStats.allTypes,
           emptyUnionTypeNodesGenerated: queryTypeStats.emptyUnions
@@ -76,12 +75,19 @@ async function main() {
           query
         });
       }
-    fileQueryTypes.length > 0 && ($info(`Generated types for ${fileQueryTypes.length} queries in "${result.filename}"
+    if (fileQueryTypes.length > 0 && ($info(`Generated types for ${fileQueryTypes.length} queries in "${result.filename}"
 `), node_worker_threads.parentPort?.postMessage({
       type: "types",
       types: fileQueryTypes,
       filename: result.filename
-    }));
+    })), fileQueryTypes.length > 0 && opts.overloadClientMethods) {
+      const typeMap = typeGenerator.generateQueryMap(fileQueryTypes);
+      node_worker_threads.parentPort?.postMessage({
+        type: "typemap",
+        filename: result.filename,
+        typeMap
+      });
+    }
   }
   node_worker_threads.parentPort?.postMessage({
     type: "complete"

package/lib/workers/typegenGenerate.js.map

@@ -1 +1 @@
-{"version":3,"file":"typegenGenerate.js","sources":["../../src/workers/typegenGenerate.ts"],"sourcesContent":["import {isMainThread, parentPort, workerData as _workerData} from 'node:worker_threads'\n\nimport {\n  findQueriesInPath,\n  getResolver,\n  readSchema,\n  registerBabel,\n  safeParseQuery,\n  TypeGenerator,\n} from '@sanity/codegen'\nimport createDebug from 'debug'\nimport {typeEvaluate, type TypeNode} from 'groq-js'\nimport {format as prettierFormat, type Options as PrettierOptions} from 'prettier'\n\nconst $info = createDebug('sanity:codegen:generate:info')\nconst $warn = createDebug('sanity:codegen:generate:warn')\n\nexport interface TypegenGenerateTypesWorkerData {\n  workDir: string\n  workspaceName?: string\n  schemaPath: string\n  searchPath: string | string[]\n  prettierConfig: PrettierOptions | null\n}\n\nexport type TypegenGenerateTypesWorkerMessage =\n  | {\n      type: 'error'\n      error: Error\n      fatal: boolean\n      query?: string\n      filename?: string\n    }\n  | {\n      type: 'types'\n      filename: string\n      types: {\n        queryName: string\n        query: string\n        type: string\n        unknownTypeNodesGenerated: number\n        typeNodesGenerated: number\n        emptyUnionTypeNodesGenerated: number\n      }[]\n    }\n  | {\n      type: 'schema'\n      filename: string\n      schema: string\n      length: number\n    }\n  | {\n      type: 'complete'\n    }\n\nif (isMainThread || !parentPort) {\n  throw new Error('This module must be run as a worker thread')\n}\n\nconst opts = _workerData as TypegenGenerateTypesWorkerData\n\nregisterBabel()\n\nfunction maybeFormatCode(code: string, prettierConfig: PrettierOptions | null): Promise<string> {\n  if (!prettierConfig) {\n    return Promise.resolve(`${code}\\n`) // add an extra new newline, poor mans formatting\n  }\n\n  try {\n    return prettierFormat(code, {\n      ...prettierConfig,\n      parser: 'typescript' as const,\n    })\n  } catch (err) {\n    $warn(`Error formatting: ${err.message}`)\n  }\n  return Promise.resolve(code)\n}\n\nasync function main() {\n  const schema = await readSchema(opts.schemaPath)\n\n  const typeGenerator = new TypeGenerator(schema)\n  const schemaTypes = await maybeFormatCode(\n    [typeGenerator.generateSchemaTypes(), TypeGenerator.generateKnownTypes()].join('\\n').trim(),\n    opts.prettierConfig,\n  )\n  const resolver = getResolver()\n\n  parentPort?.postMessage({\n    type: 'schema',\n    schema: schemaTypes,\n    filename: 'schema.json',\n    length: schema.length,\n  } satisfies TypegenGenerateTypesWorkerMessage)\n\n  const queries = findQueriesInPath({\n    path: opts.searchPath,\n    resolver,\n  })\n\n  for await (const result of queries) {\n    if (result.type === 'error') {\n      parentPort?.postMessage({\n        type: 'error',\n        error: result.error,\n        fatal: false,\n        filename: result.filename,\n      } satisfies TypegenGenerateTypesWorkerMessage)\n      continue\n    }\n    $info(`Processing ${result.queries.length} queries in \"${result.filename}\"...`)\n\n    const fileQueryTypes: {\n      queryName: string\n      query: string\n      type: string\n      unknownTypeNodesGenerated: number\n      typeNodesGenerated: number\n      emptyUnionTypeNodesGenerated: number\n    }[] = []\n    for (const {name: queryName, result: query} of result.queries) {\n      try {\n        const ast = safeParseQuery(query)\n        const queryTypes = typeEvaluate(ast, schema)\n\n        const type = await maybeFormatCode(\n          typeGenerator.generateTypeNodeTypes(`${queryName}Result`, queryTypes).trim(),\n          opts.prettierConfig,\n        )\n\n        const queryTypeStats = walkAndCountQueryTypeNodeStats(queryTypes)\n        fileQueryTypes.push({\n          queryName,\n          query,\n          type,\n          unknownTypeNodesGenerated: queryTypeStats.unknownTypes,\n          typeNodesGenerated: queryTypeStats.allTypes,\n          emptyUnionTypeNodesGenerated: queryTypeStats.emptyUnions,\n        })\n      } catch (err) {\n        parentPort?.postMessage({\n          type: 'error',\n          error: new Error(\n            `Error generating types for query \"${queryName}\" in \"${result.filename}\": ${err.message}`,\n            {cause: err},\n          ),\n          fatal: false,\n          query,\n        } satisfies TypegenGenerateTypesWorkerMessage)\n      }\n    }\n\n    if (fileQueryTypes.length > 0) {\n      $info(`Generated types for ${fileQueryTypes.length} queries in \"${result.filename}\"\\n`)\n      parentPort?.postMessage({\n        type: 'types',\n        types: fileQueryTypes,\n        filename: result.filename,\n      } satisfies TypegenGenerateTypesWorkerMessage)\n    }\n  }\n\n  parentPort?.postMessage({\n    type: 'complete',\n  } satisfies TypegenGenerateTypesWorkerMessage)\n}\n\nfunction walkAndCountQueryTypeNodeStats(typeNode: TypeNode): {\n  allTypes: number\n  unknownTypes: number\n  emptyUnions: number\n} {\n  switch (typeNode.type) {\n    case 'unknown': {\n      return {allTypes: 1, unknownTypes: 1, emptyUnions: 0}\n    }\n    case 'array': {\n      const acc = walkAndCountQueryTypeNodeStats(typeNode.of)\n      acc.allTypes += 1 // count the array type itself\n      return acc\n    }\n    case 'object': {\n      // if the rest is unknown, we count it as one unknown type\n      if (typeNode.rest && typeNode.rest.type === 'unknown') {\n        return {allTypes: 2, unknownTypes: 1, emptyUnions: 0} // count the object type itself as well\n      }\n\n      const restStats = typeNode.rest\n        ? walkAndCountQueryTypeNodeStats(typeNode.rest)\n        : {allTypes: 1, unknownTypes: 0, emptyUnions: 0} // count the object type itself\n\n      return Object.values(typeNode.attributes).reduce((acc, attribute) => {\n        const {allTypes, unknownTypes, emptyUnions} = walkAndCountQueryTypeNodeStats(\n          attribute.value,\n        )\n        return {\n          allTypes: acc.allTypes + allTypes,\n          unknownTypes: acc.unknownTypes + unknownTypes,\n          emptyUnions: acc.emptyUnions + emptyUnions,\n        }\n      }, restStats)\n    }\n    case 'union': {\n      if (typeNode.of.length === 0) {\n        return {allTypes: 1, unknownTypes: 0, emptyUnions: 1}\n      }\n\n      return typeNode.of.reduce(\n        (acc, type) => {\n          const {allTypes, unknownTypes, emptyUnions} = walkAndCountQueryTypeNodeStats(type)\n          return {\n            allTypes: acc.allTypes + allTypes,\n            unknownTypes: acc.unknownTypes + unknownTypes,\n            emptyUnions: acc.emptyUnions + emptyUnions,\n          }\n        },\n        {allTypes: 1, unknownTypes: 0, emptyUnions: 0}, // count the union type itself\n      )\n    }\n    default: {\n      return {allTypes: 1, unknownTypes: 0, emptyUnions: 0}\n    }\n  }\n}\n\nmain()\n"],"names":["createDebug","isMainThread","parentPort","_workerData","registerBabel","prettierFormat","readSchema","TypeGenerator","getResolver","findQueriesInPath","safeParseQuery","typeEvaluate"],"mappings":";;;;;;AAcA,MAAM,QAAQA,qBAAY,QAAA,8BAA8B,GAClD,QAAQA,qBAAAA,QAAY,8BAA8B;AAwCxD,IAAIC,oBAAAA,gBAAgB,CAACC,oBAAA;AACb,QAAA,IAAI,MAAM,4CAA4C;AAG9D,MAAM,OAAOC,oBAAAA;AAEbC,QAAAA;AAEA,SAAS,gBAAgB,MAAc,gBAAyD;AAC9F,MAAI,CAAC;AACI,WAAA,QAAQ,QAAQ,GAAG,IAAI;AAAA,CAAI;AAGhC,MAAA;AACF,WAAOC,SAAAA,OAAe,MAAM;AAAA,MAC1B,GAAG;AAAA,MACH,QAAQ;AAAA,IAAA,CACT;AAAA,WACM,KAAK;AACN,UAAA,qBAAqB,IAAI,OAAO,EAAE;AAAA,EAC1C;AACO,SAAA,QAAQ,QAAQ,IAAI;AAC7B;AAEA,eAAe,OAAO;AACpB,QAAM,SAAS,MAAMC,mBAAW,KAAK,UAAU,GAEzC,gBAAgB,IAAIC,sBAAc,MAAM,GACxC,cAAc,MAAM;AAAA,IACxB,CAAC,cAAc,uBAAuBA,QAAAA,cAAc,mBAAoB,CAAA,EAAE,KAAK;AAAA,CAAI,EAAE,KAAK;AAAA,IAC1F,KAAK;AAAA,EAAA,GAED,WAAWC,QAAAA;AAEjBN,sBAAAA,YAAY,YAAY;AAAA,IACtB,MAAM;AAAA,IACN,QAAQ;AAAA,IACR,UAAU;AAAA,IACV,QAAQ,OAAO;AAAA,EAAA,CAC4B;AAE7C,QAAM,UAAUO,QAAAA,kBAAkB;AAAA,IAChC,MAAM,KAAK;AAAA,IACX;AAAA,EAAA,CACD;AAED,mBAAiB,UAAU,SAAS;AAC9B,QAAA,OAAO,SAAS,SAAS;AAC3BP,0BAAAA,YAAY,YAAY;AAAA,QACtB,MAAM;AAAA,QACN,OAAO,OAAO;AAAA,QACd,OAAO;AAAA,QACP,UAAU,OAAO;AAAA,MAAA,CAC0B;AAC7C;AAAA,IACF;AACA,UAAM,cAAc,OAAO,QAAQ,MAAM,gBAAgB,OAAO,QAAQ,MAAM;AAE9E,UAAM,iBAOA,CAAA;AACN,eAAW,EAAC,MAAM,WAAW,QAAQ,MAAA,KAAU,OAAO;AAChD,UAAA;AACI,cAAA,MAAMQ,QAAAA,eAAe,KAAK,GAC1B,aAAaC,oBAAa,KAAK,MAAM,GAErC,OAAO,MAAM;AAAA,UACjB,cAAc,sBAAsB,GAAG,SAAS,UAAU,UAAU,EAAE,KAAK;AAAA,UAC3E,KAAK;AAAA,QAAA,GAGD,iBAAiB,+BAA+B,UAAU;AAChE,uBAAe,KAAK;AAAA,UAClB;AAAA,UACA;AAAA,UACA;AAAA,UACA,2BAA2B,eAAe;AAAA,UAC1C,oBAAoB,eAAe;AAAA,UACnC,8BAA8B,eAAe;AAAA,QAAA,CAC9C;AAAA,eACM,KAAK;AACZT,4BAAAA,YAAY,YAAY;AAAA,UACtB,MAAM;AAAA,UACN,OAAO,IAAI;AAAA,YACT,qCAAqC,SAAS,SAAS,OAAO,QAAQ,MAAM,IAAI,OAAO;AAAA,YACvF,EAAC,OAAO,IAAG;AAAA,UACb;AAAA,UACA,OAAO;AAAA,UACP;AAAA,QAAA,CAC2C;AAAA,MAC/C;AAGE,mBAAe,SAAS,MAC1B,MAAM,uBAAuB,eAAe,MAAM,gBAAgB,OAAO,QAAQ;AAAA,CAAK,GACtFA,gCAAY,YAAY;AAAA,MACtB,MAAM;AAAA,MACN,OAAO;AAAA,MACP,UAAU,OAAO;AAAA,IAC0B,CAAA;AAAA,EAEjD;AAEAA,sBAAAA,YAAY,YAAY;AAAA,IACtB,MAAM;AAAA,EAAA,CACqC;AAC/C;AAEA,SAAS,+BAA+B,UAItC;AACA,UAAQ,SAAS,MAAM;AAAA,IACrB,KAAK;AACH,aAAO,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa;IAErD,KAAK,SAAS;AACN,YAAA,MAAM,+BAA+B,SAAS,EAAE;AACtD,aAAA,IAAI,YAAY,GACT;AAAA,IACT;AAAA,IACA,KAAK,UAAU;AAEb,UAAI,SAAS,QAAQ,SAAS,KAAK,SAAS;AAC1C,eAAO,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa;AAGrD,YAAM,YAAY,SAAS,OACvB,+BAA+B,SAAS,IAAI,IAC5C,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa,EAAC;AAE1C,aAAA,OAAO,OAAO,SAAS,UAAU,EAAE,OAAO,CAAC,KAAK,cAAc;AACnE,cAAM,EAAC,UAAU,cAAc,YAAe,IAAA;AAAA,UAC5C,UAAU;AAAA,QAAA;AAEL,eAAA;AAAA,UACL,UAAU,IAAI,WAAW;AAAA,UACzB,cAAc,IAAI,eAAe;AAAA,UACjC,aAAa,IAAI,cAAc;AAAA,QAAA;AAAA,SAEhC,SAAS;AAAA,IACd;AAAA,IACA,KAAK;AACH,aAAI,SAAS,GAAG,WAAW,IAClB,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa,EAAC,IAG/C,SAAS,GAAG;AAAA,QACjB,CAAC,KAAK,SAAS;AACb,gBAAM,EAAC,UAAU,cAAc,YAAW,IAAI,+BAA+B,IAAI;AAC1E,iBAAA;AAAA,YACL,UAAU,IAAI,WAAW;AAAA,YACzB,cAAc,IAAI,eAAe;AAAA,YACjC,aAAa,IAAI,cAAc;AAAA,UAAA;AAAA,QAEnC;AAAA,QACA,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa,EAAC;AAAA;AAAA,MAAA;AAAA,IAGjD;AACE,aAAO,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa;EAEvD;AACF;AAEA,KAAK;"}
+{"version":3,"file":"typegenGenerate.js","sources":["../../src/workers/typegenGenerate.ts"],"sourcesContent":["import {isMainThread, parentPort, workerData as _workerData} from 'node:worker_threads'\n\nimport {\n  findQueriesInPath,\n  getResolver,\n  readSchema,\n  registerBabel,\n  safeParseQuery,\n  TypeGenerator,\n} from '@sanity/codegen'\nimport createDebug from 'debug'\nimport {typeEvaluate, type TypeNode} from 'groq-js'\nimport {format as prettierFormat, type Options as PrettierOptions} from 'prettier'\n\nconst $info = createDebug('sanity:codegen:generate:info')\nconst $warn = createDebug('sanity:codegen:generate:warn')\n\nexport interface TypegenGenerateTypesWorkerData {\n  workDir: string\n  workspaceName?: string\n  schemaPath: string\n  searchPath: string | string[]\n  prettierConfig: PrettierOptions | null\n  overloadClientMethods?: boolean\n}\n\nexport type TypegenGenerateTypesWorkerMessage =\n  | {\n      type: 'error'\n      error: Error\n      fatal: boolean\n      query?: string\n      filename?: string\n    }\n  | {\n      type: 'types'\n      filename: string\n      types: {\n        queryName: string\n        query: string\n        type: string\n        unknownTypeNodesGenerated: number\n        typeNodesGenerated: number\n        emptyUnionTypeNodesGenerated: number\n      }[]\n    }\n  | {\n      type: 'schema'\n      filename: string\n      schema: string\n      length: number\n    }\n  | {\n      type: 'typemap'\n      filename: string\n      typeMap: string\n    }\n  | {\n      type: 'complete'\n    }\n\nif (isMainThread || !parentPort) {\n  throw new Error('This module must be run as a worker thread')\n}\n\nconst opts = _workerData as TypegenGenerateTypesWorkerData\n\nregisterBabel()\n\nfunction maybeFormatCode(code: string, prettierConfig: PrettierOptions | null): Promise<string> {\n  if (!prettierConfig) {\n    return Promise.resolve(`${code}\\n`) // add an extra new newline, poor mans formatting\n  }\n\n  try {\n    return prettierFormat(code, {\n      ...prettierConfig,\n      parser: 'typescript' as const,\n    })\n  } catch (err) {\n    $warn(`Error formatting: ${err.message}`)\n  }\n  return Promise.resolve(code)\n}\n\nasync function main() {\n  const schema = await readSchema(opts.schemaPath)\n\n  const typeGenerator = new TypeGenerator(schema)\n  const schemaTypes = await maybeFormatCode(\n    [typeGenerator.generateSchemaTypes(), TypeGenerator.generateKnownTypes()].join('\\n').trim(),\n    opts.prettierConfig,\n  )\n  const resolver = getResolver()\n\n  parentPort?.postMessage({\n    type: 'schema',\n    schema: schemaTypes,\n    filename: 'schema.json',\n    length: schema.length,\n  } satisfies TypegenGenerateTypesWorkerMessage)\n\n  const queries = findQueriesInPath({\n    path: opts.searchPath,\n    resolver,\n  })\n\n  for await (const result of queries) {\n    if (result.type === 'error') {\n      parentPort?.postMessage({\n        type: 'error',\n        error: result.error,\n        fatal: false,\n        filename: result.filename,\n      } satisfies TypegenGenerateTypesWorkerMessage)\n      continue\n    }\n    $info(`Processing ${result.queries.length} queries in \"${result.filename}\"...`)\n\n    const fileQueryTypes: {\n      queryName: string\n      query: string\n      type: string\n      typeName: string\n      typeNode: TypeNode\n      unknownTypeNodesGenerated: number\n      typeNodesGenerated: number\n      emptyUnionTypeNodesGenerated: number\n    }[] = []\n    for (const {name: queryName, result: query} of result.queries) {\n      try {\n        const ast = safeParseQuery(query)\n        const queryTypes = typeEvaluate(ast, schema)\n\n        const typeName = `${queryName}Result`\n        const type = typeGenerator.generateTypeNodeTypes(typeName, queryTypes)\n        const code = await maybeFormatCode(type.trim(), opts.prettierConfig)\n\n        const queryTypeStats = walkAndCountQueryTypeNodeStats(queryTypes)\n        fileQueryTypes.push({\n          queryName,\n          query,\n          typeName,\n          typeNode: queryTypes,\n          type: code,\n          unknownTypeNodesGenerated: queryTypeStats.unknownTypes,\n          typeNodesGenerated: queryTypeStats.allTypes,\n          emptyUnionTypeNodesGenerated: queryTypeStats.emptyUnions,\n        })\n      } catch (err) {\n        parentPort?.postMessage({\n          type: 'error',\n          error: new Error(\n            `Error generating types for query \"${queryName}\" in \"${result.filename}\": ${err.message}`,\n            {cause: err},\n          ),\n          fatal: false,\n          query,\n        } satisfies TypegenGenerateTypesWorkerMessage)\n      }\n    }\n\n    if (fileQueryTypes.length > 0) {\n      $info(`Generated types for ${fileQueryTypes.length} queries in \"${result.filename}\"\\n`)\n      parentPort?.postMessage({\n        type: 'types',\n        types: fileQueryTypes,\n        filename: result.filename,\n      } satisfies TypegenGenerateTypesWorkerMessage)\n    }\n\n    if (fileQueryTypes.length > 0 && opts.overloadClientMethods) {\n      const typeMap = typeGenerator.generateQueryMap(fileQueryTypes)\n      parentPort?.postMessage({\n        type: 'typemap',\n        filename: result.filename,\n        typeMap,\n      } satisfies TypegenGenerateTypesWorkerMessage)\n    }\n  }\n\n  parentPort?.postMessage({\n    type: 'complete',\n  } satisfies TypegenGenerateTypesWorkerMessage)\n}\n\nfunction walkAndCountQueryTypeNodeStats(typeNode: TypeNode): {\n  allTypes: number\n  unknownTypes: number\n  emptyUnions: number\n} {\n  switch (typeNode.type) {\n    case 'unknown': {\n      return {allTypes: 1, unknownTypes: 1, emptyUnions: 0}\n    }\n    case 'array': {\n      const acc = walkAndCountQueryTypeNodeStats(typeNode.of)\n      acc.allTypes += 1 // count the array type itself\n      return acc\n    }\n    case 'object': {\n      // if the rest is unknown, we count it as one unknown type\n      if (typeNode.rest && typeNode.rest.type === 'unknown') {\n        return {allTypes: 2, unknownTypes: 1, emptyUnions: 0} // count the object type itself as well\n      }\n\n      const restStats = typeNode.rest\n        ? walkAndCountQueryTypeNodeStats(typeNode.rest)\n        : {allTypes: 1, unknownTypes: 0, emptyUnions: 0} // count the object type itself\n\n      return Object.values(typeNode.attributes).reduce((acc, attribute) => {\n        const {allTypes, unknownTypes, emptyUnions} = walkAndCountQueryTypeNodeStats(\n          attribute.value,\n        )\n        return {\n          allTypes: acc.allTypes + allTypes,\n          unknownTypes: acc.unknownTypes + unknownTypes,\n          emptyUnions: acc.emptyUnions + emptyUnions,\n        }\n      }, restStats)\n    }\n    case 'union': {\n      if (typeNode.of.length === 0) {\n        return {allTypes: 1, unknownTypes: 0, emptyUnions: 1}\n      }\n\n      return typeNode.of.reduce(\n        (acc, type) => {\n          const {allTypes, unknownTypes, emptyUnions} = walkAndCountQueryTypeNodeStats(type)\n          return {\n            allTypes: acc.allTypes + allTypes,\n            unknownTypes: acc.unknownTypes + unknownTypes,\n            emptyUnions: acc.emptyUnions + emptyUnions,\n          }\n        },\n        {allTypes: 1, unknownTypes: 0, emptyUnions: 0}, // count the union type itself\n      )\n    }\n    default: {\n      return {allTypes: 1, unknownTypes: 0, emptyUnions: 0}\n    }\n  }\n}\n\nmain()\n"],"names":["createDebug","isMainThread","parentPort","_workerData","registerBabel","prettierFormat","readSchema","TypeGenerator","getResolver","findQueriesInPath","safeParseQuery","typeEvaluate"],"mappings":";;;;;;AAcA,MAAM,QAAQA,qBAAY,QAAA,8BAA8B,GAClD,QAAQA,qBAAAA,QAAY,8BAA8B;AA8CxD,IAAIC,oBAAAA,gBAAgB,CAACC,oBAAA;AACb,QAAA,IAAI,MAAM,4CAA4C;AAG9D,MAAM,OAAOC,oBAAAA;AAEbC,QAAAA;AAEA,SAAS,gBAAgB,MAAc,gBAAyD;AAC9F,MAAI,CAAC;AACI,WAAA,QAAQ,QAAQ,GAAG,IAAI;AAAA,CAAI;AAGhC,MAAA;AACF,WAAOC,SAAAA,OAAe,MAAM;AAAA,MAC1B,GAAG;AAAA,MACH,QAAQ;AAAA,IAAA,CACT;AAAA,WACM,KAAK;AACN,UAAA,qBAAqB,IAAI,OAAO,EAAE;AAAA,EAC1C;AACO,SAAA,QAAQ,QAAQ,IAAI;AAC7B;AAEA,eAAe,OAAO;AACpB,QAAM,SAAS,MAAMC,mBAAW,KAAK,UAAU,GAEzC,gBAAgB,IAAIC,sBAAc,MAAM,GACxC,cAAc,MAAM;AAAA,IACxB,CAAC,cAAc,uBAAuBA,QAAAA,cAAc,mBAAoB,CAAA,EAAE,KAAK;AAAA,CAAI,EAAE,KAAK;AAAA,IAC1F,KAAK;AAAA,EAAA,GAED,WAAWC,QAAAA;AAEjBN,sBAAAA,YAAY,YAAY;AAAA,IACtB,MAAM;AAAA,IACN,QAAQ;AAAA,IACR,UAAU;AAAA,IACV,QAAQ,OAAO;AAAA,EAAA,CAC4B;AAE7C,QAAM,UAAUO,QAAAA,kBAAkB;AAAA,IAChC,MAAM,KAAK;AAAA,IACX;AAAA,EAAA,CACD;AAED,mBAAiB,UAAU,SAAS;AAC9B,QAAA,OAAO,SAAS,SAAS;AAC3BP,0BAAAA,YAAY,YAAY;AAAA,QACtB,MAAM;AAAA,QACN,OAAO,OAAO;AAAA,QACd,OAAO;AAAA,QACP,UAAU,OAAO;AAAA,MAAA,CAC0B;AAC7C;AAAA,IACF;AACA,UAAM,cAAc,OAAO,QAAQ,MAAM,gBAAgB,OAAO,QAAQ,MAAM;AAE9E,UAAM,iBASA,CAAA;AACN,eAAW,EAAC,MAAM,WAAW,QAAQ,MAAA,KAAU,OAAO;AAChD,UAAA;AACF,cAAM,MAAMQ,QAAA,eAAe,KAAK,GAC1B,aAAaC,OAAAA,aAAa,KAAK,MAAM,GAErC,WAAW,GAAG,SAAS,UACvB,OAAO,cAAc,sBAAsB,UAAU,UAAU,GAC/D,OAAO,MAAM,gBAAgB,KAAK,KAAK,GAAG,KAAK,cAAc,GAE7D,iBAAiB,+BAA+B,UAAU;AAChE,uBAAe,KAAK;AAAA,UAClB;AAAA,UACA;AAAA,UACA;AAAA,UACA,UAAU;AAAA,UACV,MAAM;AAAA,UACN,2BAA2B,eAAe;AAAA,UAC1C,oBAAoB,eAAe;AAAA,UACnC,8BAA8B,eAAe;AAAA,QAAA,CAC9C;AAAA,eACM,KAAK;AACZT,4BAAAA,YAAY,YAAY;AAAA,UACtB,MAAM;AAAA,UACN,OAAO,IAAI;AAAA,YACT,qCAAqC,SAAS,SAAS,OAAO,QAAQ,MAAM,IAAI,OAAO;AAAA,YACvF,EAAC,OAAO,IAAG;AAAA,UACb;AAAA,UACA,OAAO;AAAA,UACP;AAAA,QAAA,CAC2C;AAAA,MAC/C;AAGE,QAAA,eAAe,SAAS,MAC1B,MAAM,uBAAuB,eAAe,MAAM,gBAAgB,OAAO,QAAQ;AAAA,CAAK,GACtFA,gCAAY,YAAY;AAAA,MACtB,MAAM;AAAA,MACN,OAAO;AAAA,MACP,UAAU,OAAO;AAAA,IAAA,CAC0B,IAG3C,eAAe,SAAS,KAAK,KAAK,uBAAuB;AACrD,YAAA,UAAU,cAAc,iBAAiB,cAAc;AAC7DA,0BAAAA,YAAY,YAAY;AAAA,QACtB,MAAM;AAAA,QACN,UAAU,OAAO;AAAA,QACjB;AAAA,MAAA,CAC2C;AAAA,IAC/C;AAAA,EACF;AAEAA,sBAAAA,YAAY,YAAY;AAAA,IACtB,MAAM;AAAA,EAAA,CACqC;AAC/C;AAEA,SAAS,+BAA+B,UAItC;AACA,UAAQ,SAAS,MAAM;AAAA,IACrB,KAAK;AACH,aAAO,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa;IAErD,KAAK,SAAS;AACN,YAAA,MAAM,+BAA+B,SAAS,EAAE;AACtD,aAAA,IAAI,YAAY,GACT;AAAA,IACT;AAAA,IACA,KAAK,UAAU;AAEb,UAAI,SAAS,QAAQ,SAAS,KAAK,SAAS;AAC1C,eAAO,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa;AAGrD,YAAM,YAAY,SAAS,OACvB,+BAA+B,SAAS,IAAI,IAC5C,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa,EAAC;AAE1C,aAAA,OAAO,OAAO,SAAS,UAAU,EAAE,OAAO,CAAC,KAAK,cAAc;AACnE,cAAM,EAAC,UAAU,cAAc,YAAe,IAAA;AAAA,UAC5C,UAAU;AAAA,QAAA;AAEL,eAAA;AAAA,UACL,UAAU,IAAI,WAAW;AAAA,UACzB,cAAc,IAAI,eAAe;AAAA,UACjC,aAAa,IAAI,cAAc;AAAA,QAAA;AAAA,SAEhC,SAAS;AAAA,IACd;AAAA,IACA,KAAK;AACH,aAAI,SAAS,GAAG,WAAW,IAClB,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa,EAAC,IAG/C,SAAS,GAAG;AAAA,QACjB,CAAC,KAAK,SAAS;AACb,gBAAM,EAAC,UAAU,cAAc,YAAW,IAAI,+BAA+B,IAAI;AAC1E,iBAAA;AAAA,YACL,UAAU,IAAI,WAAW;AAAA,YACzB,cAAc,IAAI,eAAe;AAAA,YACjC,aAAa,IAAI,cAAc;AAAA,UAAA;AAAA,QAEnC;AAAA,QACA,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa,EAAC;AAAA;AAAA,MAAA;AAAA,IAGjD;AACE,aAAO,EAAC,UAAU,GAAG,cAAc,GAAG,aAAa;EAEvD;AACF;AAEA,KAAK;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.52.4",
+  "version": "3.53.0",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -58,9 +58,9 @@
   "dependencies": {
     "@babel/traverse": "^7.23.5",
     "@sanity/client": "^6.21.1",
-    "@sanity/codegen": "3.52.4",
+    "@sanity/codegen": "3.53.0",
     "@sanity/telemetry": "^0.7.7",
-    "@sanity/util": "3.52.4",
+    "@sanity/util": "3.53.0",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -77,12 +77,12 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@repo/package.config": "3.52.4",
+    "@repo/package.config": "3.53.0",
     "@rexxars/gitconfiglocal": "^3.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/eslint-config-studio": "^4.0.0",
     "@sanity/generate-help-url": "^3.0.0",
-    "@sanity/types": "3.52.4",
+    "@sanity/types": "3.53.0",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -117,7 +117,7 @@
     "lodash": "^4.17.21",
     "minimist": "^1.2.5",
     "open": "^8.4.0",
-    "ora": "^5.4.1",
+    "ora": "^8.0.1",
     "p-filter": "^2.1.0",
     "p-timeout": "^4.0.0",
     "preferred-pm": "^3.0.3",
@@ -135,5 +135,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "ace321ed7991a67eeb282254195b92e8fd11b5c6"
+  "gitHead": "d60dc6d2ae67d56ae680ebfffee2c66599924b4d"
 }

package/src/actions/init-project/initProject.ts

@@ -439,10 +439,14 @@ export default async function initSanity(
     }
     const {chosen} = await getPackageManagerChoice(workDir, {interactive: false})
     trace.log({step: 'selectPackageManager', selectedOption: chosen})
+    const packages = ['@sanity/vision@3', 'sanity@3', '@sanity/image-url@1', 'styled-components@6']
+    if (templateToUse === 'blog') {
+      packages.push('@sanity/icons')
+    }
     await installNewPackages(
       {
         packageManager: chosen,
-        packages: ['@sanity/vision@3', 'sanity@3', '@sanity/image-url@1', 'styled-components@6'],
+        packages,
       },
       {
         output: context.output,
@@ -1277,8 +1281,7 @@ export default async function initSanity(
       '# Warning: Do not add secrets (API keys and similar) to this file, as it source controlled!',
       '# Use `.env.local` for any secrets, and ensure it is not added to source control',
     ].join('\n')
-    const shouldPrependWarning = !existingEnv.includes(warningComment)
-    // prepend warning comment to the env vars if one does not exist
+    const shouldPrependWarning = filename !== '.env.local' && !existingEnv.includes(warningComment)
     if (shouldPrependWarning) {
       await fs.writeFile(fileOutputPath, `${warningComment}\n\n${updatedEnv}`, {
         encoding: 'utf8',

package/src/actions/init-project/prompts/nextjs.ts

@@ -37,16 +37,16 @@ export function promptForNextTemplate(prompt: CliPrompter): Promise<'clean' | 'b
     message: 'Select project template to use',
     type: 'list',
     choices: [
-      {
-        value: 'clean',
-        name: 'Clean project with no predefined schema types',
-      },
       {
         value: 'blog',
         name: 'Blog (schema)',
       },
+      {
+        value: 'clean',
+        name: 'Clean project with no predefined schema types',
+      },
     ],
-    default: 'clean',
+    default: 'blog',
   })
 }
 

package/src/actions/init-project/templates/nextjs/index.ts

@@ -12,17 +12,18 @@ import {structureTool} from 'sanity/structure'
 
 // Go to https://www.sanity.io/docs/api-versioning to learn how API versioning works
 import {apiVersion, dataset, projectId} from ${hasSrcFolder ? "'./src/sanity/env'" : "'./sanity/env'"}
-import {schema} from ${hasSrcFolder ? "'./src/sanity/schema'" : "'./sanity/schema'"}
+import {schema} from ${hasSrcFolder ? "'./src/sanity/schemaTypes'" : "'./sanity/schemaTypes'"}
+import {structure} from ${hasSrcFolder ? "'./src/sanity/structure'" : "'./sanity/structure'"}
 
 export default defineConfig({
   basePath: ':basePath:',
   projectId,
   dataset,
-  // Add and edit the content schema in the './sanity/schema' folder
+  // Add and edit the content schema in the './sanity/schemaTypes' folder
   schema,
   plugins: [
-    structureTool(),
-    // Vision is a tool that lets you query your content with GROQ in the studio
+    structureTool({structure}),
+    // Vision is for querying with GROQ from inside the Studio
     // https://www.sanity.io/docs/the-vision-plugin
     visionTool({defaultApiVersion: apiVersion}),
   ],
@@ -59,7 +60,8 @@ export { metadata, viewport } from 'next-sanity/studio'
 
 export default function StudioPage() {
   return <NextStudio config={config} />
-}`
+}
+`
 
 // Format today's date like YYYY-MM-DD
 const envTS = `export const apiVersion =
@@ -103,6 +105,54 @@ const schemaJS = `export const schema = {
 }
 `
 
+const blogStructureTS = `import type {StructureResolver} from 'sanity/structure'
+
+// https://www.sanity.io/docs/structure-builder-cheat-sheet
+export const structure: StructureResolver = (S) =>
+  S.list()
+    .title('Blog')
+    .items([
+      S.documentTypeListItem('post').title('Posts'),
+      S.documentTypeListItem('category').title('Categories'),
+      S.documentTypeListItem('author').title('Authors'),
+      S.divider(),
+      ...S.documentTypeListItems().filter(
+        (item) => item.getId() && !['post', 'category', 'author'].includes(item.getId()!),
+      ),
+    ])
+`
+
+const blogStructureJS = `// https://www.sanity.io/docs/structure-builder-cheat-sheet
+export const structure = (S) =>
+  S.list()
+    .title('Blog')
+    .items([
+      S.documentTypeListItem('post').title('Posts'),
+      S.documentTypeListItem('category').title('Categories'),
+      S.documentTypeListItem('author').title('Authors'),
+      S.divider(),
+      ...S.documentTypeListItems().filter(
+        (item) => item.getId() && !['post', 'category', 'author'].includes(item.getId()),
+      ),
+    ])
+`
+
+const structureTS = `import type {StructureResolver} from 'sanity/structure'
+
+// https://www.sanity.io/docs/structure-builder-cheat-sheet
+export const structure: StructureResolver = (S) =>
+  S.list()
+    .title('Content')
+    .items(S.documentTypeListItems())
+`
+
+const structureJS = `// https://www.sanity.io/docs/structure-builder-cheat-sheet
+export const structure = (S) =>
+  S.list()
+    .title('Content')
+    .items(S.documentTypeListItems())
+`
+
 const client = `import { createClient } from 'next-sanity'
 
 import { apiVersion, dataset, projectId } from '../env'
@@ -146,17 +196,8 @@ export const sanityFolder = (
   useTypeScript: boolean,
   template?: 'clean' | 'blog',
 ): FolderStructure => {
-  const isBlogTemplate = template === 'blog'
-
+  // Files used in both templates
   const structure: FolderStructure = {
-    // eslint-disable-next-line no-nested-ternary
-    'schema.': useTypeScript
-      ? isBlogTemplate
-        ? blogSchemaTS
-        : schemaTS
-      : isBlogTemplate
-        ? blogSchemaJS
-        : schemaJS,
     'env.': useTypeScript ? envTS : envJS,
     'lib': {
       'client.': client,
@@ -164,8 +205,17 @@ export const sanityFolder = (
     },
   }
 
-  if (isBlogTemplate) {
-    structure.schemaTypes = blogSchemaFolder(useTypeScript)
+  if (template === 'blog') {
+    structure.schemaTypes = {
+      ...blogSchemaFolder,
+      'index.': useTypeScript ? blogSchemaTS : blogSchemaJS,
+    }
+    structure['structure.'] = useTypeScript ? blogStructureTS : blogStructureJS
+  } else {
+    structure.schemaTypes = {
+      'index.': useTypeScript ? schemaTS : schemaJS,
+    }
+    structure['structure.'] = useTypeScript ? structureTS : structureJS
   }
 
   return structure