Skip to content

The open alternative to Salesforce, designed for AI.

Fix additionalEmails typing in generated client SDK (#24869)

martmullc9153c492204
diff --git a/packages/twenty-client-sdk/src/generate/__tests__/__snapshots__/genql-engine-output.test.ts.snap b/packages/twenty-client-sdk/src/generate/__tests__/__snapshots__/genql-engine-output.test.ts.snap
new file mode 100644
index 00000000000..1c0407ddd0a
--- /dev/null
+++ b/packages/twenty-client-sdk/src/generate/__tests__/__snapshots__/genql-engine-output.test.ts.snap
@@ -0,0 +1,347 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Vendored genql engine output > renders schema types byte-identically 1`] = `
+"// @ts-nocheck
+export type Scalars = {
+ JSON: Record<string, unknown>,
+ DateTime: string,
+ UUID: string,
+ String: string,
+ Boolean: boolean,
+}
+
+export type CompanyStage = 'LEAD' | 'CUSTOMER'
+
+export type Node = (Person | Company) & { __isUnion?: true }
+
+export type SearchResult = (Person | Company) & { __isUnion?: true }
+
+export interface Person {
+ id: Scalars['UUID']
+ name?: Scalars['String']
+ stage?: CompanyStage
+ settings?: Scalars['JSON']
+ createdAt: Scalars['DateTime']
+ employer?: Company
+ __typename: 'Person'
+}
+
+export interface Company {
+ id: Scalars['UUID']
+ domainName?: Scalars['String']
+ people?: (Person | undefined)[]
+ __typename: 'Company'
+}
+
+export interface Query {
+ node?: Node
+ person?: Person
+ search?: SearchResult
+ __typename: 'Query'
+}
+
+export interface Mutation {
+ createPerson?: Person
+ __typename: 'Mutation'
+}
+
+export interface NodeGenqlSelection{
+ id?: boolean | number
+ on_Person?: PersonGenqlSelection
+ on_Company?: CompanyGenqlSelection
+ __typename?: boolean | number
+ __scalar?: boolean | number
+}
+
+export interface SearchResultGenqlSelection{
+ on_Person?:PersonGenqlSelection,
+ on_Company?:CompanyGenqlSelection,
+ on_Node?: NodeGenqlSelection,
+ __typename?: boolean | number
+}
+
+export interface PersonGenqlSelection{
+ id?: boolean | number
+ name?: boolean | number
+ stage?: boolean | number
+ settings?: boolean | number
+ createdAt?: boolean | number
+ employer?: CompanyGenqlSelection
+ __typename?: boolean | number
+ __scalar?: boolean | number
+}
+
+export interface CompanyGenqlSelection{
+ id?: boolean | number
+ domainName?: boolean | number
+ people?: PersonGenqlSelection
+ __typename?: boolean | number
+ __scalar?: boolean | number
+}
+
+export interface PersonCreateInput {name: Scalars['String'],stage?: (CompanyStage | null),settings?: (Scalars['JSON'] | null)}
+
+export interface QueryGenqlSelection{
+ node?: (NodeGenqlSelection & { __args: {id: Scalars['UUID']} })
+ person?: (PersonGenqlSelection & { __args: {id: Scalars['UUID']} })
+ search?: (SearchResultGenqlSelection & { __args: {term: Scalars['String']} })
+ __typename?: boolean | number
+ __scalar?: boolean | number
+}
+
+export interface MutationGenqlSelection{
+ createPerson?: (PersonGenqlSelection & { __args: {input: PersonCreateInput} })
+ __typename?: boolean | number
+ __scalar?: boolean | number
+}
+
+
+ const Node_possibleTypes: string[] = ['Person','Company']
+ export const isNode = (obj?: { __typename?: any } | null): obj is Node => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isNode"')
+ return Node_possibleTypes.includes(obj.__typename)
+ }
+
+
+
+ const SearchResult_possibleTypes: string[] = ['Person','Company']
+ export const isSearchResult = (obj?: { __typename?: any } | null): obj is SearchResult => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isSearchResult"')
+ return SearchResult_possibleTypes.includes(obj.__typename)
+ }
+
+
+
+ const Person_possibleTypes: string[] = ['Person']
+ export const isPerson = (obj?: { __typename?: any } | null): obj is Person => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isPerson"')
+ return Person_possibleTypes.includes(obj.__typename)
+ }
+
+
+
+ const Company_possibleTypes: string[] = ['Company']
+ export const isCompany = (obj?: { __typename?: any } | null): obj is Company => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isCompany"')
+ return Company_possibleTypes.includes(obj.__typename)
+ }
+
+
+
+ const Query_possibleTypes: string[] = ['Query']
+ export const isQuery = (obj?: { __typename?: any } | null): obj is Query => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isQuery"')
+ return Query_possibleTypes.includes(obj.__typename)
+ }
+
+
+
+ const Mutation_possibleTypes: string[] = ['Mutation']
+ export const isMutation = (obj?: { __typename?: any } | null): obj is Mutation => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isMutation"')
+ return Mutation_possibleTypes.includes(obj.__typename)
+ }
+
+
+export const enumCompanyStage = {
+ LEAD: 'LEAD' as const,
+ CUSTOMER: 'CUSTOMER' as const
+}
+"
+`;
+
+exports[`Vendored genql engine output > renders the SDL byte-identically 1`] = `
+"scalar JSON
+
+scalar DateTime
+
+scalar UUID
+
+enum CompanyStage {
+ LEAD
+ CUSTOMER
+}
+
+interface Node {
+ id: UUID!
+}
+
+union SearchResult = Person | Company
+
+type Person implements Node {
+ id: UUID!
+ name: String
+ stage: CompanyStage
+ settings: JSON
+ createdAt: DateTime!
+ employer: Company
+}
+
+type Company implements Node {
+ id: UUID!
+ domainName: String
+ people: [Person]
+}
+
+input PersonCreateInput {
+ name: String!
+ stage: CompanyStage
+ settings: JSON
+}
+
+type Query {
+ node(id: UUID!): Node
+ person(id: UUID!): Person
+ search(term: String!): SearchResult
+}
+
+type Mutation {
+ createPerson(input: PersonCreateInput!): Person
+}"
+`;
+
+exports[`Vendored genql engine output > renders the runtime type map byte-identically 1`] = `
+"export default {
+ "scalars": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 7,
+ 12
+ ],
+ "types": {
+ "JSON": {},
+ "DateTime": {},
+ "UUID": {},
+ "CompanyStage": {},
+ "Node": {
+ "id": [
+ 2
+ ],
+ "on_Person": [
+ 6
+ ],
+ "on_Company": [
+ 8
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "SearchResult": {
+ "on_Person": [
+ 6
+ ],
+ "on_Company": [
+ 8
+ ],
+ "on_Node": [
+ 4
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "Person": {
+ "id": [
+ 2
+ ],
+ "name": [
+ 7
+ ],
+ "stage": [
+ 3
+ ],
+ "settings": [
+ 0
+ ],
+ "createdAt": [
+ 1
+ ],
+ "employer": [
+ 8
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "String": {},
+ "Company": {
+ "id": [
+ 2
+ ],
+ "domainName": [
+ 7
+ ],
+ "people": [
+ 6
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "PersonCreateInput": {
+ "name": [
+ 7
+ ],
+ "stage": [
+ 3
+ ],
+ "settings": [
+ 0
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "Query": {
+ "node": [
+ 4,
+ {
+ "id": [
+ 2,
+ "UUID!"
+ ]
+ }
+ ],
+ "person": [
+ 6,
+ {
+ "id": [
+ 2,
+ "UUID!"
+ ]
+ }
+ ],
+ "search": [
+ 5,
+ {
+ "term": [
+ 7,
+ "String!"
+ ]
+ }
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "Mutation": {
+ "createPerson": [
+ 6,
+ {
+ "input": [
+ 9,
+ "PersonCreateInput!"
+ ]
+ }
+ ],
+ "__typename": [
+ 7
+ ]
+ },
+ "Boolean": {}
+ }
+}"
+`;
diff --git a/packages/twenty-client-sdk/src/generate/__tests__/composite-field-type-overrides.test.ts b/packages/twenty-client-sdk/src/generate/__tests__/composite-field-type-overrides.test.ts
new file mode 100644
index 00000000000..bb859ee10ea
--- /dev/null
+++ b/packages/twenty-client-sdk/src/generate/__tests__/composite-field-type-overrides.test.ts
@@ -0,0 +1,85 @@
+import { mkdtemp, readFile, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+
+import { generateCoreClientFromSchema } from '../generate-core-client';
+
+const SCHEMA = `
+scalar JSON
+
+type Query {
+ person: Person
+}
+
+type Mutation {
+ createPerson(emails: EmailsCreateInput): Person
+}
+
+type Person {
+ id: ID!
+ emails: Emails
+ phones: Phones
+ settings: JSON
+}
+
+type Emails {
+ primaryEmail: String
+ additionalEmails: JSON
+}
+
+type Phones {
+ primaryPhoneNumber: String
+ additionalPhones: JSON
+}
+
+input EmailsCreateInput {
+ primaryEmail: String
+ additionalEmails: JSON
+}
+
+schema {
+ query: Query
+ mutation: Mutation
+}
+`;
+
+describe('Composite RAW_JSON field type overrides in the generated client', () => {
+ let temporaryDir: string;
+ let generatedTypes: string;
+
+ beforeAll(async () => {
+ temporaryDir = await mkdtemp(join(tmpdir(), 'twenty-genql-overrides-'));
+ const outputPath = join(temporaryDir, 'client');
+
+ await generateCoreClientFromSchema({ schema: SCHEMA, outputPath });
+
+ generatedTypes = await readFile(join(outputPath, 'schema.ts'), 'utf-8');
+ }, 60000);
+
+ afterAll(async () => {
+ if (temporaryDir) {
+ await rm(temporaryDir, { recursive: true, force: true });
+ }
+ });
+
+ it('types Emails.additionalEmails as a string array in response types', () => {
+ expect(generatedTypes).toContain('additionalEmails?: string[]');
+ expect(generatedTypes).not.toMatch(/additionalEmails\?: Scalars/);
+ });
+
+ it('types EmailsCreateInput.additionalEmails as a nullable string array', () => {
+ expect(generatedTypes).toContain('additionalEmails?: (string[] | null)');
+ });
+
+ it('types Phones.additionalPhones with the additional phone shape', () => {
+ expect(generatedTypes).toContain(
+ 'additionalPhones?: Array<{ number: string; callingCode: string; countryCode: string }>',
+ );
+ });
+
+ it('keeps non-composite JSON fields on the scalar mapping', () => {
+ expect(generatedTypes).toContain("settings?: Scalars['JSON']");
+ });
+});
diff --git a/packages/twenty-client-sdk/src/generate/__tests__/genql-engine-output.test.ts b/packages/twenty-client-sdk/src/generate/__tests__/genql-engine-output.test.ts
new file mode 100644
index 00000000000..babaace318a
--- /dev/null
+++ b/packages/twenty-client-sdk/src/generate/__tests__/genql-engine-output.test.ts
@@ -0,0 +1,109 @@
+import { mkdtemp, readFile, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+
+import { generate } from '../genql';
+
+const FIXTURE_SCHEMA = `
+scalar JSON
+scalar DateTime
+scalar UUID
+
+enum CompanyStage {
+ LEAD
+ CUSTOMER
+}
+
+interface Node {
+ id: UUID!
+}
+
+union SearchResult = Person | Company
+
+type Person implements Node {
+ id: UUID!
+ name: String
+ stage: CompanyStage
+ settings: JSON
+ createdAt: DateTime!
+ employer: Company
+}
+
+type Company implements Node {
+ id: UUID!
+ domainName: String
+ people: [Person]
+}
+
+input PersonCreateInput {
+ name: String!
+ stage: CompanyStage
+ settings: JSON
+}
+
+type Query {
+ node(id: UUID!): Node
+ person(id: UUID!): Person
+ search(term: String!): SearchResult
+}
+
+type Mutation {
+ createPerson(input: PersonCreateInput!): Person
+}
+
+schema {
+ query: Query
+ mutation: Mutation
+}
+`;
+
+const SCALAR_TYPES = {
+ DateTime: 'string',
+ JSON: 'Record<string, unknown>',
+ UUID: 'string',
+};
+
+describe('Vendored genql engine output', () => {
+ let temporaryDir: string;
+ let outputPath: string;
+
+ beforeAll(async () => {
+ temporaryDir = await mkdtemp(join(tmpdir(), 'twenty-genql-engine-'));
+ outputPath = join(temporaryDir, 'client');
+
+ await generate({
+ schema: FIXTURE_SCHEMA,
+ output: outputPath,
+ scalarTypes: SCALAR_TYPES,
+ });
+ }, 60000);
+
+ afterAll(async () => {
+ if (temporaryDir) {
+ await rm(temporaryDir, { recursive: true, force: true });
+ }
+ });
+
+ it('renders schema types byte-identically', async () => {
+ const schemaTypes = await readFile(join(outputPath, 'schema.ts'), 'utf-8');
+
+ expect(schemaTypes).toMatchSnapshot();
+ });
+
+ it('renders the runtime type map byte-identically', async () => {
+ const typeMap = await readFile(join(outputPath, 'types.ts'), 'utf-8');
+
+ expect(typeMap).toMatchSnapshot();
+ });
+
+ it('renders the SDL byte-identically', async () => {
+ const schemaGql = await readFile(
+ join(outputPath, 'schema.graphql'),
+ 'utf-8',
+ );
+
+ expect(schemaGql).toMatchSnapshot();
+ });
+});
diff --git a/packages/twenty-client-sdk/src/generate/composite-field-type-overrides.ts b/packages/twenty-client-sdk/src/generate/composite-field-type-overrides.ts
new file mode 100644
index 00000000000..16c5e1330be
--- /dev/null
+++ b/packages/twenty-client-sdk/src/generate/composite-field-type-overrides.ts
@@ -0,0 +1,112 @@
+import type { Equal, Expect } from 'twenty-shared/testing';
+import type {
+ ActorMetadata,
+ AdditionalPhoneMetadata,
+ EmailsMetadata,
+ LinkMetadata,
+} from 'twenty-shared/types';
+
+const ADDITIONAL_EMAILS_TYPE_TEXT = 'string[]';
+const ADDITIONAL_PHONES_TYPE_TEXT =
+ 'Array<{ number: string; callingCode: string; countryCode: string }>';
+const SECONDARY_LINKS_TYPE_TEXT = 'Array<{ label: string; url: string }>';
+const ACTOR_CONTEXT_TYPE_TEXT = '{ provider?: string }';
+
+type WidenStringValues<TObject> = {
+ [TKey in keyof TObject]: TObject[TKey] extends string | undefined
+ ? string
+ : TObject[TKey];
+};
+
+export type CompositeFieldTypeOverrideDriftGuards = [
+ Expect<Equal<string[], NonNullable<EmailsMetadata['additionalEmails']>>>,
+ Expect<
+ Equal<
+ { number: string; callingCode: string; countryCode: string },
+ WidenStringValues<AdditionalPhoneMetadata>
+ >
+ >,
+ Expect<Equal<{ label: string; url: string }, LinkMetadata>>,
+ Expect<
+ Equal<{ provider?: string }, WidenStringValues<ActorMetadata['context']>>
+ >,
+];
+
+export const COMPOSITE_FIELD_TYPE_OVERRIDES: {
+ [typeName: string]: { [fieldName: string]: string };
+} = {
+ Emails: { additionalEmails: ADDITIONAL_EMAILS_TYPE_TEXT },
+ EmailsCreateInput: { additionalEmails: ADDITIONAL_EMAILS_TYPE_TEXT },
+ EmailsUpdateInput: { additionalEmails: ADDITIONAL_EMAILS_TYPE_TEXT },
+ Phones: { additionalPhones: ADDITIONAL_PHONES_TYPE_TEXT },
+ PhonesCreateInput: { additionalPhones: ADDITIONAL_PHONES_TYPE_TEXT },
+ PhonesUpdateInput: { additionalPhones: ADDITIONAL_PHONES_TYPE_TEXT },
+ Links: { secondaryLinks: SECONDARY_LINKS_TYPE_TEXT },
+ LinksCreateInput: { secondaryLinks: SECONDARY_LINKS_TYPE_TEXT },
+ LinksUpdateInput: { secondaryLinks: SECONDARY_LINKS_TYPE_TEXT },
+ Actor: { context: ACTOR_CONTEXT_TYPE_TEXT },
+ ActorCreateInput: { context: ACTOR_CONTEXT_TYPE_TEXT },
+ ActorUpdateInput: { context: ACTOR_CONTEXT_TYPE_TEXT },
+};
+
+const findMatchingBrace = (source: string, openBraceIndex: number): number => {
+ let depth = 0;
+
+ for (let index = openBraceIndex; index < source.length; index++) {
+ if (source[index] === '{') {
+ depth++;
+ }
+
+ if (source[index] === '}') {
+ depth--;
+
+ if (depth === 0) {
+ return index;
+ }
+ }
+ }
+
+ throw new Error('Unbalanced braces in generated schema types');
+};
+
+export const applyCompositeFieldTypeOverrides = (
+ schemaTypesSource: string,
+): string => {
+ let source = schemaTypesSource;
+
+ for (const [typeName, fieldOverrides] of Object.entries(
+ COMPOSITE_FIELD_TYPE_OVERRIDES,
+ )) {
+ const interfaceHeader = `export interface ${typeName} {`;
+ const headerIndex = source.indexOf(interfaceHeader);
+
+ if (headerIndex === -1) {
+ continue;
+ }
+
+ const blockStart = headerIndex + interfaceHeader.length - 1;
+ const blockEnd = findMatchingBrace(source, blockStart);
+ let block = source.slice(blockStart, blockEnd + 1);
+
+ for (const [fieldName, overriddenType] of Object.entries(fieldOverrides)) {
+ const fieldPattern = new RegExp(
+ `(${fieldName}\\?: \\(?)Scalars\\['JSON'\\]`,
+ );
+
+ if (!fieldPattern.test(block)) {
+ throw new Error(
+ `Expected ${typeName}.${fieldName} to render as the JSON scalar in the generated client; the genql engine output changed shape`,
+ );
+ }
+
+ block = block.replace(
+ fieldPattern,
+ (_match, fieldPrefix) => `${fieldPrefix}${overriddenType}`,
+ );
+ }
+
+ source = source.slice(0, blockStart) + block + source.slice(blockEnd + 1);
+ }
+
+ return source;
+};
diff --git a/packages/twenty-client-sdk/src/generate/generate-core-client.ts b/packages/twenty-client-sdk/src/generate/generate-core-client.ts
index b293701f4cb..a23fa1d6011 100644
--- a/packages/twenty-client-sdk/src/generate/generate-core-client.ts
+++ b/packages/twenty-client-sdk/src/generate/generate-core-client.ts
@@ -1,10 +1,11 @@
-import { appendFile, copyFile, writeFile } from 'node:fs/promises';
+import { appendFile, copyFile, readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';
import { build } from 'esbuild';
import { DEFAULT_API_URL_NAME } from 'twenty-shared/application';
import { buildClientWrapperSource } from './client-wrapper';
+import { applyCompositeFieldTypeOverrides } from './composite-field-type-overrides';
import { emptyDir, ensureDir, move, remove } from './fs-utils';
import { generate } from './genql';
import twentyClientTemplateSource from './twenty-client-template.ts?raw';
@@ -42,6 +43,14 @@ export const generateCoreClientFromSchema = async ({
scalarTypes: COMMON_SCALAR_TYPES,
});
+ const schemaTypesPath = join(tempPath, 'schema.ts');
+ const schemaTypesSource = await readFile(schemaTypesPath, 'utf-8');
+
+ await writeFile(
+ schemaTypesPath,
+ applyCompositeFieldTypeOverrides(schemaTypesSource),
+ );
+
const clientContent = buildClientWrapperSource(templateSource, {
apiClientName: 'CoreApiClient',
defaultUrl: `\`\${process.env.${DEFAULT_API_URL_NAME}}/graphql\``,
diff --git a/packages/twenty-client-sdk/src/generate/genql/README.md b/packages/twenty-client-sdk/src/generate/genql/README.md
index 22a6912a611..55283dfb9dd 100644
--- a/packages/twenty-client-sdk/src/generate/genql/README.md
+++ b/packages/twenty-client-sdk/src/generate/genql/README.md
@@ -35,6 +35,13 @@ in abandoned and vulnerable transitive packages (`undici`, `native-fetch`,
generated client still defaults its url/fetch to `undefined` (Twenty's wrapper
supplies them) and the output is unchanged.
+Twenty-specific typing tweaks live OUTSIDE this tree so the vendored engine
+stays verbatim: composite RAW_JSON sub-fields (e.g. `Emails.additionalEmails`)
+get their real TypeScript shape via a post-processing pass over the generated
+`schema.ts` (`../composite-field-type-overrides.ts`), never via renderer edits.
+The engine's own output is pinned byte-for-byte by the snapshot test in
+`../__tests__/genql-engine-output.test.ts`.
+
The renderers are vendored verbatim from `@genql/[email protected]`. Formatting now runs
on `prettier@^3` (the version the monorepo resolves): it needs the explicit
`prettier/plugins/estree` printer and an awaited, async `format()`. The runtime