feat(codegen): expose referenced type as hidden symbol

[sgulseth]

Description

Adds a symbol so that we can lookup which type a reference is referencing to.

Types generating ends up like:

{
      _ref: string;
      _type: "reference";
      _weak?: boolean;
      [internalGroqTypeReferenceTo]?: "sanity.imageAsset";
}

...

export declare const internalGroqTypeReferenceTo: unique symbol;

What to review

Testing

No specific tests added for this as the feature is marked as "internal". We should build out general integration testing for codegen, but that can be done separately.

Notes for release

N/A - no notes needed.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
performance-studio	🛑 Canceled (Inspect)			Mar 19, 2024 3:21pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 19, 2024 3:21pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Mar 19, 2024 3:21pm

[sgulseth]

• chore(codegen): bind groq-js to ^1.5.0 #6055
• chore: refactor codegen cli group to use typegen cli group #6051
• feat(codegen): expose referenced type as hidden symbol #6008 👈
• feat(codegen): add CLI to generate types given a codegen config #5982
• feat(codegen): add typegen methods to codegen package #5981
• feat(codegen): add groq finder methods. #5980
• feat(codegen): add codegen skeleton package #5979
• next

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

Join @sgulseth and the rest of your teammates on Graphite

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Mar 19, 2024 3:34 PM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	31s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	6s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	11s	3	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	12s	4	2	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	12s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	31s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	1m 0s	15	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 1s	18	0	0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	12s	6	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	13s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	19s	9	0	0

[ricokahler]

I like this pattern. It's very akin to the use of Symbol.iterator etc

I wonder if we should declare some kind of object to act as a symbol namespace. e.g.

declare const CodegenSymbol = {
  referenceTo: unique symbol
}

Then usage could be like:

interface SomeType {
  _type: 'ref';
  [CodegenSymbol.referenceTo]?: 'sanity.imageAsset';
  // ...
}

But not a blocker. Just an idea. It may not even work because the object implies a runtime value.

[ricokahler]

Alternative idea: you could export a type helper from the @sanity/codegen package that would abstract away this as well.

Instead of:

type myQueryResult = {
    asset?: {
      _ref: string;
      _type: "reference";
      _weak?: boolean;
      [internalGroqTypeReferenceTo]?: "sanity.imageAsset";
    };
    // ...
}

it could be:

import {type SanityReference} from '@sanity/codegen'

type myQueryResult = {
    asset?: SanityReference<'sanity.imageAsset'>;
    // ...
}

type SanityReference<TReferenceType extends string> = {
      _ref: string;
      _type: "reference";
      _weak?: boolean;
      [__internalGroqTypeReferenceTo]?: TReferenceType;
}