Removing depictEnum() and depictLiteral().

RobinTail · RobinTail · commit a4e75f9c7a67 · 2025-06-13T16:37:56.000+02:00
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -140,31 +140,6 @@ export const depictNullable: Depicter = ({ jsonSchema }) => {
   return Object.assign(original, { type: makeNullableType(original.type) });
 };
 
-const isSupportedType = (subject: string): subject is SchemaObjectType =>
-  subject in samples;
-
-/**
- * @todo remove in v25
- * @since zod 3.25.45
- */
-export const depictEnum: Depicter = ({ jsonSchema }) => {
-  const suggestedType = typeof jsonSchema.enum?.[0];
-  if (!jsonSchema.type && isSupportedType(suggestedType))
-    jsonSchema.type = suggestedType;
-  return jsonSchema;
-};
-
-/**
- * @todo remove in v25
- * @since zod 3.25.49
- * */
-export const depictLiteral: Depicter = ({ jsonSchema }) => {
-  const suggestedType = typeof (jsonSchema.const || jsonSchema.enum?.[0]);
-  if (!jsonSchema.type && isSupportedType(suggestedType))
-    jsonSchema.type = suggestedType;
-  return jsonSchema;
-};
-
 /** @since v24.3.1 schema compliance is fully delegated to Zod */
 const asOAS = (subject: JSONSchema.BaseSchema) =>
   subject as SchemaObject | ReferenceObject;
@@ -380,8 +355,6 @@ const depicters: Partial<Record<FirstPartyKind | ProprietaryBrand, Depicter>> =
     intersection: depictIntersection,
     tuple: depictTuple,
     pipe: depictPipeline,
-    literal: depictLiteral,
-    enum: depictEnum,
     [ezDateInBrand]: depictDateIn,
     [ezDateOutBrand]: depictDateOut,
     [ezUploadBrand]: depictUpload,
diff --git a/express-zod-api/tests/__snapshots__/documentation-helpers.spec.ts.snap b/express-zod-api/tests/__snapshots__/documentation-helpers.spec.ts.snap
@@ -106,16 +106,6 @@ DocumentationError({
 })
 `;
 
-exports[`Documentation helpers > depictEnum() > should set type 1`] = `
-{
-  "enum": [
-    "test",
-    "jest",
-  ],
-  "type": "string",
-}
-`;
-
 exports[`Documentation helpers > depictIntersection() > should NOT flatten object schemas having conflicting props 1`] = `
 {
   "allOf": [
@@ -200,23 +190,6 @@ exports[`Documentation helpers > depictIntersection() > should merge examples de
 }
 `;
 
-exports[`Documentation helpers > depictLiteral() > should set type from either const or enum prop 0 1`] = `
-{
-  "const": "test",
-  "type": "string",
-}
-`;
-
-exports[`Documentation helpers > depictLiteral() > should set type from either const or enum prop 1 1`] = `
-{
-  "enum": [
-    "test",
-    "jest",
-  ],
-  "type": "string",
-}
-`;
-
 exports[`Documentation helpers > depictNullable() > should add null type to the first of anyOf 0 1`] = `
 {
   "type": [
diff --git a/express-zod-api/tests/documentation-helpers.spec.ts b/express-zod-api/tests/documentation-helpers.spec.ts
@@ -25,8 +25,6 @@ import {
   depictDateIn,
   depictDateOut,
   depictBody,
-  depictEnum,
-  depictLiteral,
   depictRequest,
 } from "../src/documentation-helpers";
 
@@ -309,28 +307,6 @@ describe("Documentation helpers", () => {
     });
   });
 
-  describe("depictEnum()", () => {
-    test("should set type", () => {
-      expect(
-        depictEnum(
-          { zodSchema: z.never(), jsonSchema: { enum: ["test", "jest"] } },
-          requestCtx,
-        ),
-      ).toMatchSnapshot();
-    });
-  });
-
-  describe("depictLiteral()", () => {
-    test.each([{ const: "test" }, { enum: ["test", "jest"] }])(
-      "should set type from either const or enum prop %#",
-      (jsonSchema) => {
-        expect(
-          depictLiteral({ zodSchema: z.never(), jsonSchema }, requestCtx),
-        ).toMatchSnapshot();
-      },
-    );
-  });
-
   describe("depictBigInt()", () => {
     test("should set type:string and format:bigint", () => {
       expect(
