Several todos.

RobinTail · RobinTail · commit 730bcaee7f09 · 2025-04-20T20:05:44.000+02:00
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -277,7 +277,7 @@ const makeNullableType = ({
   | SchemaObjectType
   | SchemaObjectType[] => {
   if (type === "null") return type;
-  if (typeof type === "string") return [type as SchemaObjectType, "null"];
+  if (typeof type === "string") return [type as SchemaObjectType, "null"]; // @todo make method instead of "as"
   return type ? [...new Set(type).add("null")] : "null";
 };
 
@@ -503,17 +503,18 @@ const fixReferences = (
           const actualName = entry.$ref.split("/").pop()!;
           const depiction = $defs[actualName];
           if (depiction)
-            entry.$ref = ctx.makeRef(depiction, depiction as SchemaObject).$ref;
+            entry.$ref = ctx.makeRef(depiction, depiction as SchemaObject).$ref; // @todo see below
           continue;
         }
       }
       stack.push(...R.values(entry));
     }
     if (R.is(Array, entry)) stack.push(...R.values(entry));
   }
-  return rest as SchemaObject;
+  return rest as SchemaObject; // @todo ideally, there should be a method to ensure that
 };
 
+// @todo rename?
 export const delegate = (
   schema: $ZodType,
   {
diff --git a/express-zod-api/tests/documentation-helpers.spec.ts b/express-zod-api/tests/documentation-helpers.spec.ts
@@ -17,6 +17,11 @@ import {
   delegate,
 } from "../src/documentation-helpers";
 
+/**
+ * @todo all these functions is now the one, and the tests naming is not relevant anymore
+ * @todo these tests should now be transformed into ones of particular postprocessors and assert exactly what they do.
+ * @todo So we would not test Zod here, but internal methods only.
+ */
 describe("Documentation helpers", () => {
   const makeRefMock = vi.fn();
   const requestCtx = {
diff --git a/express-zod-api/tests/documentation.spec.ts b/express-zod-api/tests/documentation.spec.ts
@@ -495,7 +495,7 @@ describe("Documentation", () => {
               method: "post",
               input: category,
               output: z.object({
-                zodExample: category,
+                zodExample: category, // @todo consider external registry to deduplicate it
               }),
               handler: async () => ({
                 zodExample: {

Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ const makeNullableType = ({`
`277`	`277`	`\| SchemaObjectType`
`278`	`278`	`\| SchemaObjectType[] => {`
`279`	`279`	`if (type === "null") return type;`
`280`		`- if (typeof type === "string") return [type as SchemaObjectType, "null"];`
	`280`	`+ if (typeof type === "string") return [type as SchemaObjectType, "null"]; // @todo make method instead of "as"`
`281`	`281`	`return type ? [...new Set(type).add("null")] : "null";`
`282`	`282`	`};`
`283`	`283`
`@@ -503,17 +503,18 @@ const fixReferences = (`
`503`	`503`	`const actualName = entry.$ref.split("/").pop()!;`
`504`	`504`	`const depiction = $defs[actualName];`
`505`	`505`	`if (depiction)`
`506`		`- entry.$ref = ctx.makeRef(depiction, depiction as SchemaObject).$ref;`
	`506`	`+ entry.$ref = ctx.makeRef(depiction, depiction as SchemaObject).$ref; // @todo see below`
`507`	`507`	`continue;`
`508`	`508`	`}`
`509`	`509`	`}`
`510`	`510`	`stack.push(...R.values(entry));`
`511`	`511`	`}`
`512`	`512`	`if (R.is(Array, entry)) stack.push(...R.values(entry));`
`513`	`513`	`}`
`514`		`- return rest as SchemaObject;`
	`514`	`+ return rest as SchemaObject; // @todo ideally, there should be a method to ensure that`
`515`	`515`	`};`
`516`	`516`
	`517`	`+// @todo rename?`
`517`	`518`	`export const delegate = (`
`518`	`519`	`schema: $ZodType,`
`519`	`520`	`{`