@sanity/codegen 5.5.1-next.3 → 5.6.0-next.12

package/lib/index.d.ts

@@ -82,6 +82,53 @@ export declare interface ExtractedQuery {
   filename: string
 }
 
+/**
+ * Filter a union of object types by the _type property. This is handy when working with page builder
+ * setups where the returned type is an array containing multiple types.
+ *
+ * @example
+ * ```ts
+ *
+ * export type Callout = {
+ *   _type: 'callout'
+ *   title?: string
+ *   content?: string
+ * }
+ *
+ * export type Video = {
+ *   _type: 'video'
+ *   url?: string
+ *   caption?: string
+ * }
+ * type FORM_QUERY_RESULT = {
+ *   _id: string
+ *   title?: string
+ *   content?: Array<
+ *     | ({ _key: string } & Callout)
+ *     | ({ _key: string } & Video)
+ *   >
+ * } | null
+ *
+ * // Get the type of the content with the Get helper
+ * type Content = Get<FORM_QUERY_RESULT, 'content', number>
+ *
+ * // Get the type for a callout module from the page builder type
+ * type CalloutModule = FilterByType<Content, 'callout'>
+ * // → { _key: string } & Callout
+ * ```
+ */
+export declare type FilterByType<
+  U extends {
+    _type: string
+  },
+  T extends U['_type'],
+> = Extract<
+  U,
+  {
+    _type: T
+  }
+>
+
 /**
  * findQueriesInPath takes a path or array of paths and returns all GROQ queries in the files.
  * @param path - The path or array of paths to search for queries
@@ -132,6 +179,102 @@ export declare interface GenerateTypesOptions {
   reporter?: WorkerChannelReporter<TypegenWorkerChannel>
 }
 
+/**
+ * Get a deeply nested property type from a complex type structure. Safely navigates
+ * through nullable types (`T | null | undefined`) at each level, preserving the
+ * nullability of the final accessed property.
+ *
+ * Supports up to 20 levels of nesting.
+ *
+ * @example
+ * ```ts
+ * type POST_QUERY_RESULT = {
+ *   _id: string
+ *   author: {
+ *     profile: {
+ *       name: string;
+ *     } | null;
+ *   } | null;
+ *   links: Array<{
+ *     _key: string
+ *     type: 'link'
+ *     label: string
+ *     url: string
+ *   }> | null
+ * } | null
+ *
+ * // Basic property access:
+ * type Id = Get<POST_QUERY_RESULT, '_id'>;
+ * // → string
+ *
+ * // Nested property access:
+ * type Profile = Get<POST_QUERY_RESULT, 'author', 'profile';
+ * // → { name: string } | null
+ *
+ * // Array element access using `number`:
+ * type Link = Get<POST_QUERY_RESULT, 'links', number, 'label'>;
+ * // → string
+ * ```
+ */
+export declare type Get<
+  T,
+  K1 extends keyof NonNullish<T>,
+  K2 extends keyof NavigatePath<T, [K1]> = never,
+  K3 extends keyof NavigatePath<T, [K1, K2]> = never,
+  K4 extends keyof NavigatePath<T, [K1, K2, K3]> = never,
+  K5 extends keyof NavigatePath<T, [K1, K2, K3, K4]> = never,
+  K6 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5]> = never,
+  K7 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6]> = never,
+  K8 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7]> = never,
+  K9 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8]> = never,
+  K10 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8, K9]> = never,
+  K11 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10]> = never,
+  K12 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11]> = never,
+  K13 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12]> = never,
+  K14 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13]> =
+    never,
+  K15 extends keyof NavigatePath<T, [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14]> =
+    never,
+  K16 extends keyof NavigatePath<
+    T,
+    [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14, K15]
+  > = never,
+  K17 extends keyof NavigatePath<
+    T,
+    [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14, K15, K16]
+  > = never,
+  K18 extends keyof NavigatePath<
+    T,
+    [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14, K15, K16, K17]
+  > = never,
+  K19 extends keyof NavigatePath<
+    T,
+    [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14, K15, K16, K17, K18]
+  > = never,
+  K20 extends keyof NavigatePath<
+    T,
+    [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19]
+  > = never,
+> = GetAtPath<
+  T,
+  TakeUntilNever<
+    [K1, K2, K3, K4, K5, K6, K7, K8, K9, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K20]
+  >
+>
+
+/** Recursively gets value at path, preserving nullability at final access. */
+declare type GetAtPath<T, Path extends unknown[]> = Path extends []
+  ? T
+  : Path extends [infer K]
+    ? K extends keyof NonNullish<T>
+      ? NonNullish<T>[K]
+      : never
+    : Path extends [infer K, ...infer Rest]
+      ? K extends keyof NonNullish<T>
+        ? GetAtPath<NonNullish<T>[K], Rest>
+        : never
+      : never
+
 /**
  * This is a custom implementation of require.resolve that takes into account the paths
  * configuration in tsconfig.json. This is necessary if we want to resolve paths that are
@@ -141,6 +284,18 @@ export declare interface GenerateTypesOptions {
  */
 export declare function getResolver(cwd?: string): NodeJS.RequireResolve
 
+/** Recursively navigates through a path, stripping nullability for key lookup. */
+declare type NavigatePath<T, Path extends unknown[]> = Path extends []
+  ? NonNullish<T>
+  : Path extends [infer K, ...infer Rest]
+    ? K extends keyof NonNullish<T>
+      ? NavigatePath<NonNullish<T>[K], Rest>
+      : never
+    : never
+
+/** Excludes `null` and `undefined` from a type. */
+declare type NonNullish<T> = T extends null | undefined ? never : T
+
 /**
  * An error that occurred during query evaluation.
  * @public
@@ -209,6 +364,13 @@ export declare function registerBabel(babelOptions?: TransformOptions): void
  */
 export declare function safeParseQuery(query: string): ExprNode
 
+/** Builds a tuple from elements, stopping at the first `never`. */
+declare type TakeUntilNever<T extends unknown[]> = T extends [infer H, ...infer Rest]
+  ? [H] extends [never]
+    ? []
+    : [H, ...TakeUntilNever<Rest>]
+  : []
+
 /**
  * Statistics from the query type evaluation process.
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/codegen",
-  "version": "5.5.1-next.3+c86d4fb254",
+  "version": "5.6.0-next.12+682b253b5b",
   "description": "Codegen toolkit for Sanity.io",
   "keywords": [
     "sanity",
@@ -50,7 +50,7 @@
     "reselect": "^5.1.1",
     "tsconfig-paths": "^4.2.0",
     "zod": "^3.25.76",
-    "groq": "5.5.1-next.3+c86d4fb254"
+    "groq": "5.6.0-next.12+682b253b5b"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.3.2",
@@ -64,10 +64,10 @@
     "eslint": "^9.39.2",
     "rimraf": "^5.0.10",
     "vitest": "^4.0.16",
-    "@repo/test-config": "5.5.1-next.3+c86d4fb254",
-    "@repo/package.config": "5.5.1-next.3+c86d4fb254",
-    "@repo/tsconfig": "5.5.1-next.3+c86d4fb254",
-    "@repo/eslint-config": "5.5.1-next.3+c86d4fb254"
+    "@repo/eslint-config": "5.6.0-next.12+682b253b5b",
+    "@repo/test-config": "5.6.0-next.12+682b253b5b",
+    "@repo/package.config": "5.6.0-next.12+682b253b5b",
+    "@repo/tsconfig": "5.6.0-next.12+682b253b5b"
   },
   "engines": {
     "node": ">=20.19 <22 || >=22.12"