feat(typegen): add all schema types exported union (#6962)

packages/@sanity/cli/test/__snapshots__/typegen.test.ts.snap

@@ -31,6 +31,8 @@ export type Slug = {
   current?: string;
   source?: string;
 };
+
+export type AllSanitySchemaTypes = Person | Slug;
 export declare const internalGroqTypeReferenceTo: unique symbol;
 // Source: ./src/queries.ts
 // Variable: PAGE_QUERY

packages/@sanity/codegen/src/typescript/__tests__/__snapshots__/typeGenerator.test.ts.snap

@@ -208,7 +208,9 @@ export type SanityImagePaletteSwatch = {
   population?: number;
   title?: string;
   _type: \\"sanity.imagePaletteSwatch\\";
-};"
+};
+
+export type AllSanitySchemaTypes = Author | Post | Ghost | BlockContent | SanityAssetSourceData | Slug | Geopoint | SanityImageAsset | SanityFileAsset | SanityImageCrop | SanityImageHotspot | SanityImageMetadata | SanityImageDimensions | SanityImagePalette | SanityImagePaletteSwatch;"
 `;
 
 exports[`generateSchemaTypes should generate correct types for document schema with inline fields 1`] = `

packages/@sanity/codegen/src/typescript/__tests__/typeGenerator.test.ts

@@ -56,7 +56,9 @@ describe('generateSchemaTypes', () => {
 "export type Author = {
   _id: string;
   name?: string;
-};"
+};
+
+export type AllSanitySchemaTypes = Author;"
 `)
   })
 
@@ -80,7 +82,9 @@ describe('generateSchemaTypes', () => {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type Product = {
   price: number;
-};"
+};
+
+export type AllSanitySchemaTypes = Product;"
 `)
   })
 
@@ -103,7 +107,9 @@ describe('generateSchemaTypes', () => {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type Task = {
   completed: boolean;
-};"
+};
+
+export type AllSanitySchemaTypes = Task;"
 `)
   })
 
@@ -142,7 +148,9 @@ describe('generateSchemaTypes', () => {
     street: string;
     city: string;
   };
-};"
+};
+
+export type AllSanitySchemaTypes = User;"
 `)
   })
 
@@ -169,7 +177,9 @@ describe('generateSchemaTypes', () => {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type BlogPost = {
   tags: Array<string>;
-};"
+};
+
+export type AllSanitySchemaTypes = BlogPost;"
 `)
   })
 
@@ -193,7 +203,9 @@ describe('generateSchemaTypes', () => {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type DynamicData = {
   metadata: unknown;
-};"
+};
+
+export type AllSanitySchemaTypes = DynamicData;"
 `)
   })
 
@@ -217,7 +229,9 @@ describe('generateSchemaTypes', () => {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type Impossible = {
   willNotHappen: null;
-};"
+};
+
+export type AllSanitySchemaTypes = Impossible;"
 `)
   })
 
@@ -259,7 +273,9 @@ describe('generateSchemaTypes', () => {
 
 export type Author = {
   name: string;
-};"
+};
+
+export type AllSanitySchemaTypes = BlogPost | Author;"
 `)
   })
 
@@ -286,7 +302,9 @@ export type Author = {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type MixedContent = {
   content: string | number;
-};"
+};
+
+export type AllSanitySchemaTypes = MixedContent;"
 `)
   })
 
@@ -310,7 +328,9 @@ export type Author = {
     expect(actualOutput).toMatchInlineSnapshot(`
 "export type OptionalData = {
   obsoleteField: null;
-};"
+};
+
+export type AllSanitySchemaTypes = OptionalData;"
 `)
   })
 

packages/@sanity/codegen/src/typescript/typeGenerator.ts

@@ -12,6 +12,7 @@ import {
 } from 'groq-js'
 
 const REFERENCE_SYMBOL_NAME = 'internalGroqTypeReferenceTo'
+const ALL_SCHEMA_TYPES = 'AllSanitySchemaTypes'
 
 /**
  * A class used to generate TypeScript types from a given schema
@@ -49,6 +50,26 @@ export class TypeGenerator {
       typeDeclarations.push(t.exportNamedDeclaration(typeAlias))
     })
 
+    typeDeclarations.push(
+      t.exportNamedDeclaration(
+        t.tsTypeAliasDeclaration(
+          t.identifier(this.getTypeName(ALL_SCHEMA_TYPES)),
+          null,
+          t.tsUnionType(
+            this.schema.map(({name}) => {
+              const typeName = this.typeNameMap.get(name)
+              if (!typeName) {
+                // this is a type guard since maps return undefined if the key is not found, however this map should
+                // be set inside the loop above by `this.getTypeName(...)`
+                throw new Error(`Unexpected error: Could not find type name for schema ${name}`)
+              }
+              return t.tsTypeReference(t.identifier(typeName))
+            }),
+          ),
+        ),
+      ),
+    )
+
     // Generate TypeScript code from the AST nodes
     return typeDeclarations.map((decl) => new CodeGenerator(decl).generate().code).join('\n\n')
   }