feat: add TypeNode fingerprinting to dedupe more effectively

[kbrabrand]

TL;DR

Added type deduplication for GROQ query type generation to reduce output file size and improve readability.

What changed?

• Use hashTypeNode from groq-js for identifying identical type nodes
• Added a deduplication registry that extracts common types into reusable Inline* type aliases
• Modified the type generation process to work in phases:
  1. Collect all type nodes from queries
  2. Build a deduplication registry
  3. Generate TypeScript types with references to extracted common types

💡 With this change we accept the fact that we don't have full control of the name of the types, since the order of appearance impacts which name is used. This leads to a cases where types, while correct, may get unintuitive names. This is a trade off..

We could work around this by special casing things, adding additional logic to use top level names as the reusable etc. but it would lead to more code and other edge cases. Open to thoughts/ideas here..

Examples:

// The whole author by slug query result use the InlineAuthor type
export type AuthorBySlugQueryResult = InlineAuthor | null

// Image palette swatches all use the InlineDominant (if that comes first)
palette: {
  dominant: InlineDominant | null
  darkMuted: InlineDominant | null
  vibrant: InlineDominant | null
}

To reduce the chance of these types being referenced in the code by consuming projects I've opted not to export these new types directly – they're made available through references from the exported types.

🚫 This PR depends on changes that hasn't yet landed in groq-js, so it's blocked by the release of a new version with the hashTypeNode function exported. Until the PR has been merged this PR is using a tagged version of groq-js where this is available. So this is ready for review, not merge.

Why make this change?

Generated type files can be pretty large and difficult to read due to repeated type structures across different queries. For example, author and image types that appear in multiple queries were being duplicated in full. This change significantly reduces duplication by extracting common structures into named types, making the generated files easier to read and improving IDE performance when working with these types.

• CLDX-4784
• CLDX-2251

How to test?

1. Run the typegen command on a project with multiple GROQ queries
2. Verify that the generated types include Inline* type aliases at the top
3. Check that query result types reference these inline types instead of duplicating the same structure
4. Confirm that the output file is smaller and more readable than before

Automated tests has been added, and outdated snapshots updated.

[kbrabrand]

• feat: add TypeNode fingerprinting to dedupe more effectively #46 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[sgulseth]

Tests! There's no unit tests that asserts the behavior, it's a bit hard to review without knowing what's expected.

Also this is only deduping types that are exactly the same? 🤔

[sgulseth]

This one seems like a potential foot gun, why do we need to rewrite the names?

[kbrabrand]

A very common case is for the field to be named plural, but since we evaluate and hoist the type inside the array the following field:

authors: Array<{ /* author type */ }>

..if used in multiple places would end up as

type InlineAuthors = { /* author type */ }
authors: Array<InlineAuthors>

I find having a plural names for singluar things confusing.

[kbrabrand]

Tests! There's no unit tests that asserts the behavior, it's a bit hard to review without knowing what's expected.

Also this is only deduping types that are exactly the same? 🤔

🫡 More tests added now. Will have a look at exporting hashField from groq-js and refactor to using it instead of the custom fingerprinting.

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/​@​types/​react@​19.2.8 ⏵ 19.2.13	+1		+1
	npm/​@​sanity/​sdk@​2.6.0
	npm/​@​sanity/​sdk-react@​2.6.0
	npm/​groq-js@​1.25.0 ⏵ 1.27.0-type-node-hasher.0	-5			+2
	npm/​styled-components@​6.3.5 ⏵ 6.3.9	+1		+1
	npm/​vite-tsconfig-paths@​5.1.4 ⏵ 6.0.5			+1	+1
	npm/​@​sanity/​vision@​5.8.1
	npm/​sanity@​5.6.0 ⏵ 5.8.1	+1
	npm/​@​sanity/​code-input@​7.0.8

View full report