Skip to content

fix(api-codegen-preset): generate string instead of any for custom scalars #3099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
byrichardpowell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(api-codegen-preset): generate string instead of any for custom scalars #3099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .changeset/fix-codegen-scalar-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
'@shopify/api-codegen-preset': patch
---

Fix custom GraphQL scalars generating as `any` in codegen output

Shopify API custom scalars (e.g. `DateTime`, `Money`, `URL`, `HTML`) now
correctly generate as `string` in codegen output instead of `any`. The `JSON`
scalar generates as `unknown`. This applies automatically to all current and
future Shopify API scalars without requiring manual configuration.

Fixes https://github.com/Shopify/shopify-app-js/issues/1154
10 changes: 5 additions & 5 deletions packages/api-clients/api-codegen-preset/src/api-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ export const shopifyApiTypes = ({
[`${outputDir}/${typesFile}`]: {
schema: schemaFileExists ? schemaFile : schema,
plugins: ['typescript'],
...(enumsAsConst !== undefined && {
config: {
enumsAsConst,
},
}),
config: {
defaultScalarType: 'string',
scalars: {JSON: 'unknown'},
...(enumsAsConst !== undefined && {enumsAsConst}),
},
},
[`${outputDir}/${queryTypesFile}`]: {
schema: schemaFileExists ? schemaFile : schema,
Expand Down
19 changes: 13 additions & 6 deletions packages/api-clients/api-codegen-preset/src/tests/api-project.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ describe('shopifyApiProject', () => {
schema: expect.anything(),
plugins: ['typescript'],
config: {
defaultScalarType: 'string',
scalars: {JSON: 'unknown'},
enumsAsConst: true,
},
}),
Expand All @@ -165,13 +167,15 @@ describe('shopifyApiProject', () => {
schema: expect.anything(),
plugins: ['typescript'],
config: {
defaultScalarType: 'string',
scalars: {JSON: 'unknown'},
enumsAsConst: false,
},
}),
);
});

it('does not include config when enumsAsConst is not provided', () => {
it('uses default scalar config when enumsAsConst is not provided', () => {
// GIVEN
const config: ShopifyApiProjectOptions = {
apiType,
Expand All @@ -184,13 +188,16 @@ describe('shopifyApiProject', () => {
// THEN
expect(
projectConfig.extensions.codegen.generates[`./${type}.types.d.ts`],
).toEqual({
schema: expect.anything(),
plugins: ['typescript'],
});
).toEqual(
expect.objectContaining({
schema: expect.anything(),
plugins: ['typescript'],
config: {defaultScalarType: 'string', scalars: {JSON: 'unknown'}},
}),
);
expect(
projectConfig.extensions.codegen.generates[`./${type}.types.d.ts`],
).not.toHaveProperty('config');
).not.toHaveProperty('config.enumsAsConst');
});
},
);
Expand Down
14 changes: 11 additions & 3 deletions packages/api-clients/api-codegen-preset/src/tests/api-types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ describe('shopifyApiTypes', () => {
[`./testDir/${type}.types.d.ts`]: {
schema: expectedSchema,
plugins: ['typescript'],
config: {defaultScalarType: 'string', scalars: {JSON: 'unknown'}},
},
[`./testDir/${type}.generated.d.ts`]: {
schema: expectedSchema,
Expand Down Expand Up @@ -73,6 +74,7 @@ describe('shopifyApiTypes', () => {
[`./testDir/${type}.types.d.ts`]: {
schema: `./testDir/${type}-2024-10.schema.json`,
plugins: ['typescript'],
config: {defaultScalarType: 'string', scalars: {JSON: 'unknown'}},
},
[`./testDir/${type}.generated.d.ts`]: {
schema: `./testDir/${type}-2024-10.schema.json`,
Expand Down Expand Up @@ -102,6 +104,7 @@ describe('shopifyApiTypes', () => {
[`./${type}.types.d.ts`]: {
schema: expectedSchema,
plugins: ['typescript'],
config: {defaultScalarType: 'string', scalars: {JSON: 'unknown'}},
},
[`./${type}.generated.d.ts`]: {
schema: expectedSchema,
Expand Down Expand Up @@ -131,6 +134,7 @@ describe('shopifyApiTypes', () => {
[`./${type}.types.ts`]: {
schema: `./${type}.schema.json`,
plugins: ['typescript'],
config: {defaultScalarType: 'string', scalars: {JSON: 'unknown'}},
},
[`./${type}.generated.ts`]: {
schema: `./${type}.schema.json`,
Expand Down Expand Up @@ -161,6 +165,8 @@ describe('shopifyApiTypes', () => {
schema: `./${type}.schema.json`,
plugins: ['typescript'],
config: {
defaultScalarType: 'string',
scalars: {JSON: 'unknown'},
enumsAsConst: true,
},
}),
Expand All @@ -187,13 +193,15 @@ describe('shopifyApiTypes', () => {
schema: `./${type}.schema.json`,
plugins: ['typescript'],
config: {
defaultScalarType: 'string',
scalars: {JSON: 'unknown'},
enumsAsConst: false,
},
}),
);
});

it('excludes config when enumsAsConst is not provided', () => {
it('uses default scalar config when enumsAsConst is not provided', () => {
// GIVEN
const config: ShopifyApiProjectOptions = {
apiType,
Expand All @@ -210,10 +218,10 @@ describe('shopifyApiTypes', () => {
expect(projectConfig[`./${type}.types.d.ts`]).toEqual({
schema: `./${type}.schema.json`,
plugins: ['typescript'],
// No config property expected
config: {defaultScalarType: 'string', scalars: {JSON: 'unknown'}},
});
expect(projectConfig[`./${type}.types.d.ts`]).not.toHaveProperty(
'config',
'config.enumsAsConst',
);
});
},
Expand Down
Loading