Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

fix(console): fix the zod-to-ts type infer bug (#5566)

Browse source 
fix the zod-to-ts type infer bug
This commit is contained in:
simeng-li 2024-03-28 10:23:08 +08:00 committed by GitHub
parent d1b19851f0
commit 6990a3ebb5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
packages/console/scripts/generate-jwt-customizer-type-definition.ts
View file

@ -1,13 +1,13 @@
import fs from 'node:fs';
import {
jwtCustomizerUserContextGuard,
accessTokenPayloadGuard,
clientCredentialsPayloadGuard,
jwtCustomizerUserContextGuard,
} from '@logto/schemas';
import prettier from 'prettier';
import { type ZodTypeAny } from 'zod';
import { zodToTs, printNode } from 'zod-to-ts';
import { printNode, zodToTs } from 'zod-to-ts';
const filePath = 'src/consts/jwt-customizer-type-definition.ts';
@ -19,7 +19,18 @@ const typeIdentifiers = `export enum JwtCustomizerTypeDefinitionKey {
};`;
const inferTsDefinitionFromZod = (zodSchema: ZodTypeAny, identifier: string): string => {
const { node } = zodToTs(zodSchema, identifier);
/**
* We have z.lazy() used for defining Json objects in the zod schemas.
* @see https://zod.dev/?id=json-type
* zod-to-ts does not support z.lazy() yet. It will use the root type of the lazy schema. Which will be the identifier we pass to the function.
* @see https://github.com/sachinraja/zod-to-ts?tab=readme-ov-file#zlazy
*
* The second argument is the root type identifier for the schema.
* Here we use 'Record<string, unknown>' as the root type identifier. So all the Json objects will be inferred as Record<string, unknown>.
* This is a limitation of zod-to-ts. We can't infer the exact type of the Json objects.
* This solution is hacky but it works for now. The impact is it will always define the type identifer as Record<string, unknown>.
*/
const { node } = zodToTs(zodSchema, 'Record<string, unknown>', { nativeEnums: 'union' });
const typeDefinition = printNode(node);
return `type ${identifier} = ${typeDefinition};`;