feat(typegen): set overload client methods to default to true (#7390)

sanity-io · Aug 20, 2024 · c11e51f · c11e51f
1 parent b86e3d0
commit c11e51f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/packages/@sanity/cli/test/__fixtures__/v3/working-typegen-overloadClientMethods.json b/packages/@sanity/cli/test/__fixtures__/v3/working-typegen-overloadClientMethods.json
@@ -1,5 +1,5 @@
 {
   "schema": "./working-schema.json",
   "generates": "./out/types.ts",
-  "overloadClientMethods": true
+  "overloadClientMethods": false
 }
diff --git a/packages/@sanity/cli/test/__snapshots__/typegen.test.ts.snap b/packages/@sanity/cli/test/__snapshots__/typegen.test.ts.snap
@@ -38,10 +38,18 @@ export declare const internalGroqTypeReferenceTo: unique symbol;
 // Variable: PAGE_QUERY
 // Query: *[_type == \\"page\\" && slug.current == $slug][0]
 export type PAGE_QUERYResult = null;
+
+// Query TypeMap
+import '@sanity/client';
+declare module '@sanity/client' {
+  interface SanityQueries {
+    '*[_type == \\"page\\" && slug.current == $slug][0]': PAGE_QUERYResult;
+  }
+}
 "
 `;
 
-exports[`CLI: \`sanity typegen\` sanity typegen generate: with overloadClientMethods 1`] = `
+exports[`CLI: \`sanity typegen\` sanity typegen generate: with overloadClientMethods false 1`] = `
 "/**
  * ---------------------------------------------------------------------------------
  * This file has been generated by Sanity TypeGen.
@@ -79,13 +87,5 @@ export declare const internalGroqTypeReferenceTo: unique symbol;
 // Variable: PAGE_QUERY
 // Query: *[_type == \\"page\\" && slug.current == $slug][0]
 export type PAGE_QUERYResult = null;
-
-// Query TypeMap
-import '@sanity/client';
-declare module '@sanity/client' {
-  interface SanityQueries {
-    '*[_type == \\"page\\" && slug.current == $slug][0]': PAGE_QUERYResult;
-  }
-}
 "
 `;
diff --git a/packages/@sanity/cli/test/typegen.test.ts b/packages/@sanity/cli/test/typegen.test.ts
@@ -70,7 +70,7 @@ describeCliTest('CLI: `sanity typegen`', () => {
     expect(types.toString()).toMatchSnapshot()
   })
 
-  test('sanity typegen generate: with overloadClientMethods', async () => {
+  test('sanity typegen generate: with overloadClientMethods false', async () => {
     // Write a prettier config to the output folder, with single quotes. The defeault is double quotes.
     await writeFile(`${studiosPath}/v3/out/.prettierrc`, '{\n  "singleQuote": true\n}\n')
     const result = await runSanityCmdCommand('v3', [
@@ -86,7 +86,7 @@ describeCliTest('CLI: `sanity typegen`', () => {
     )
 
     const types = await readFile(`${studiosPath}/v3/out/types.ts`)
-    expect(types.toString()).toContain(`'person'`)
+    expect(types.toString()).not.toContain(`Query TypeMap`)
     expect(types.toString()).toMatchSnapshot()
   })
 })
diff --git a/packages/@sanity/codegen/src/readConfig.ts b/packages/@sanity/codegen/src/readConfig.ts
@@ -15,7 +15,7 @@ export const configDefintion = z.object({
   schema: z.string().default('./schema.json'),
   generates: z.string().default('./sanity.types.ts'),
   formatGeneratedCode: z.boolean().default(true),
-  overloadClientMethods: z.boolean().default(false),
+  overloadClientMethods: z.boolean().default(true),
 })
 
 export type CodegenConfig = z.infer<typeof configDefintion>