fix (types): changed document type to a discriminating union (#807)

fastify · Jul 23, 2024 · ce8c75a · ce8c75a
1 parent a32dea4
commit ce8c75a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 15 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -58,19 +58,24 @@ declare module 'fastify' {
   }
 }
 
+type SwaggerDocumentObject = {
+  swaggerObject: Partial<OpenAPIV2.Document>;
+} | {
+  openapiObject: Partial<OpenAPIV3.Document | OpenAPIV3_1.Document>;
+}
+
 type SwaggerTransform = <S extends FastifySchema = FastifySchema>({
   schema,
   url,
   route,
-  swaggerObject,
-  openapiObject,
+  ...documentObject
 }: {
   schema: S;
   url: string;
   route: RouteOptions;
-  swaggerObject: Partial<OpenAPIV2.Document>;
-  openapiObject: Partial<OpenAPIV3.Document | OpenAPIV3_1.Document>;
-}) => { schema: FastifySchema; url: string }
+} & SwaggerDocumentObject) => { schema: FastifySchema; url: string }
+
+type SwaggerTransformObject = (documentObject: SwaggerDocumentObject) => Partial<OpenAPIV2.Document> | Partial<OpenAPIV3.Document | OpenAPIV3_1.Document>;
 
 type FastifySwagger = FastifyPluginCallback<fastifySwagger.SwaggerOptions>
 
@@ -147,10 +152,7 @@ declare namespace fastifySwagger {
     /**
      * custom function to transform the openapi or swagger object before it is rendered
      */
-    transformObject?: ({ swaggerObject, openapiObject }: {
-      swaggerObject: Partial<OpenAPIV2.Document>;
-      openapiObject: Partial<OpenAPIV3.Document | OpenAPIV3_1.Document>;
-    }) => Partial<OpenAPIV2.Document> | Partial<OpenAPIV3.Document | OpenAPIV3_1.Document>;
+    transformObject?: SwaggerTransformObject;
 
     refResolver?: {
       /** Clone the input schema without changing it. Default to `false`. */

diff --git a/test/types/types.test.ts b/test/types/types.test.ts
@@ -220,16 +220,12 @@ app.get(
         schema,
         url,
         route,
-        swaggerObject,
-        openapiObject,
+        ...documentObject
       }) => {
         schema satisfies FastifySchema;
         url satisfies string;
         route satisfies RouteOptions;
-        swaggerObject satisfies Partial<OpenAPIV2.Document>;
-        openapiObject satisfies Partial<
-          OpenAPIV3.Document | OpenAPIV3_1.Document
-        >;
+        documentObject satisfies { swaggerObject: Partial<OpenAPIV2.Document> } | { openapiObject: Partial<OpenAPIV3.Document | OpenAPIV3_1.Document> };
         return { schema, url };
       },
     },