Skip to content

Helper to ensure valid type #2553

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

Merged
merged 1 commit into from
Apr 20, 2025
Merged

Helper to ensure valid type #2553

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
17 changes: 7 additions & 10 deletions express-zod-api/src/documentation-helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ const samples = {
object: {},
null: null,
array: [],
} satisfies Record<Extract<SchemaObjectType, string>, unknown>;
} satisfies Record<SchemaObjectType, unknown>;

export const reformatParamsInPath = (path: string) =>
path.replace(routePathParamsRegex, (param) => `{${param.slice(1)}}`);
Expand Down Expand Up @@ -197,18 +197,14 @@ const onNullable: Overrider = ({ jsonSchema }) => {
delete jsonSchema.anyOf;
};

const isSupportedType = (subject: string): subject is SchemaObjectType =>
subject in samples;

const getSupportedType = (value: unknown): SchemaObjectType | undefined => {
const detected = R.toLower(R.type(value)); // toLower is typed well unlike .toLowerCase()
const isSupported =
detected === "number" ||
detected === "string" ||
detected === "boolean" ||
detected === "object" ||
detected === "null" ||
detected === "array";
return typeof value === "bigint"
? "integer"
: isSupported
: isSupportedType(detected)
? detected
: undefined;
};
Expand Down Expand Up @@ -277,7 +273,8 @@ const makeNullableType = ({
| SchemaObjectType
| SchemaObjectType[] => {
if (type === "null") return type;
if (typeof type === "string") return [type as SchemaObjectType, "null"]; // @todo make method instead of "as"
if (typeof type === "string")
return isSupportedType(type) ? [type, "null"] : "null";
return type ? [...new Set(type).add("null")] : "null";
};

Expand Down