Fix issue where apiProperty alter the class property

Author: kerwanp

.changeset/chilled-rules-judge.md

@@ -0,0 +1,39 @@
+# openapi-adonis
+
+## 0.0.0-20240826235548
+
+### Patch Changes
+
+- Updated dependencies []:
+  - [email protected]
+
+## 0.0.0-20240826232507
+
+### Patch Changes
+
+- Automatically append apiParam from route pattern
+
+## 0.0.0-20240826230314
+
+### Patch Changes
+
+- Updated dependencies []:
+  - [email protected]
+
+## 0.0.0-20240826225846
+
+### Patch Changes
+
+- Updated dependencies []:
+  - [email protected]
+
+## 0.0.0-20240826224734
+
+### Major Changes
+
+- Initial release
+
+### Patch Changes
+
+- Updated dependencies []:
+  - [email protected]

packages/openapi-adonis/CHANGELOG.md

@@ -1,7 +1,7 @@
 {
   "name": "openapi-adonis",
   "description": "Auto-Generate OpenAPI specifications for AdonisJS",
-  "version": "0.0.1",
+  "version": "0.0.0-20240826235548",
   "author": {
     "name": "Martin PAUCOT",
     "email": "[email protected]"

packages/openapi-adonis/package.json

@@ -1,15 +1,17 @@
 import type { OpenAPIV3 } from "openapi-types";
 import { OperationBuilder, type DocumentBuilder } from "openapi-metadata/builders";
 import type { AdonisRoute } from "../types";
-import { loadApiOperation, loadControllerOperation } from "openapi-metadata/loaders";
+import { loadApiOperation, loadApiParam, loadControllerOperation } from "openapi-metadata/loaders";
 import { normalizeRoutePattern } from "../utils/normalizeRoutePattern";
 
 export async function loadRoute(document: DocumentBuilder, route: AdonisRoute) {
   if (typeof route.handler !== "object" || !Array.isArray(route.handler.reference)) {
     return;
   }
 
-  const importer = route.handler.reference[0] as () => Promise<{ default: any }>;
+  const importer = route.handler.reference[0] as () => Promise<{
+    default: any;
+  }>;
   const propertyKey = route.handler.reference[1] as string;
 
   const target = (await importer().then((t: any) => t.default)) as any;
@@ -21,11 +23,17 @@ export async function loadRoute(document: DocumentBuilder, route: AdonisRoute) {
 
     const operation = new OperationBuilder();
 
+    const { params, pattern } = normalizeRoutePattern(route.pattern);
+
     loadApiOperation(operation, {
       method: method.toLowerCase() as `${OpenAPIV3.HttpMethods}`,
-      pattern: normalizeRoutePattern(route.pattern),
+      pattern,
     });
 
+    for (const name of params) {
+      loadApiParam(document, operation, { name, type: "string" });
+    }
+
     loadControllerOperation(document, operation, target.prototype, propertyKey);
 
     document.addOperation(operation);

packages/openapi-adonis/src/loaders/loadRoute.ts

@@ -32,6 +32,11 @@ export class VineTypeResolver<
     return this.#name;
   }
 
+  public static supports(type: any): boolean {
+    // console.log(type);
+    return true;
+  }
+
   async schema(): Promise<OpenAPIV3.SchemaObject> {
     const validator = this.validator.toJSON();
     const node = validator.schema.schema;

packages/openapi-adonis/src/resolvers/vine-type.resolver.ts

@@ -1,13 +1,18 @@
 export const normalizeRoutePattern = (pattern: string) => {
   const segments = pattern.split("/");
 
-  return segments
+  const params: string[] = [];
+  const path = segments
     .map((s) => {
       if (s.startsWith(":")) {
-        return `{${s.replace(":", "")}}`;
+        const param = s.replace(":", "");
+        params.push(param);
+        return `{${param}}`;
       }
 
       return s;
     })
     .join("/");
+
+  return { pattern: path, params };
 };

packages/openapi-adonis/src/utils/normalizeRoutePattern.ts

@@ -1,5 +1,12 @@
 import vine from "@vinejs/vine";
-import { enrichType, parseArrayNode, parseLiteralNode, parseObjectNode } from "../src/resolvers/vine-type.resolver";
+import {
+  VineTypeResolver,
+  enrichType,
+  parseArrayNode,
+  parseLiteralNode,
+  parseObjectNode,
+} from "../src/resolvers/vine-type.resolver";
+import { DocumentBuilder } from "openapi-metadata/builders";
 
 describe("parseLiteralNode", () => {
   // INFO: This test is not really necessary
@@ -27,13 +34,15 @@ describe("parseObjectNode", () => {
   it("should parse object", () => {
     const validator = vine.compile(
       vine.object({
-        example: vine.string(),
+        email: vine.string().email(),
+        password: vine.string(),
       }),
     );
     const json = validator.toJSON();
     const result: any = parseObjectNode(json.schema.schema as any, json.refs);
 
-    expect(result.properties.example).toBeDefined();
+    expect(result.properties.email).toBeDefined();
+    expect(result.properties.password).toBeDefined();
   });
 
   it("should parse nested object", () => {

packages/openapi-adonis/test/vine.test.ts

@@ -0,0 +1,25 @@
+# openapi-metadata
+
+## 0.0.0-20240826235548
+
+### Patch Changes
+
+- Fix issue where apiProperty alter the class property
+
+## 0.0.0-20240826230314
+
+### Patch Changes
+
+- Add ability to provide arrays as type
+
+## 0.0.0-20240826225846
+
+### Major Changes
+
+- Add ability to provide arrays as type
+
+## 0.0.0-20240826224734
+
+### Major Changes
+
+- Initial release

packages/openapi-metadata/CHANGELOG.md

@@ -1,7 +1,7 @@
 {
   "name": "openapi-metadata",
   "description": "Auto-Generate OpenAPI specifications from Typescript decorators",
-  "version": "0.0.1",
+  "version": "0.0.0-20240826235548",
   "author": {
     "name": "Martin PAUCOT",
     "email": "[email protected]"

packages/openapi-metadata/package.json

@@ -16,7 +16,6 @@ export function apiProperty(options: ApiPropertyOptions = {}): PropertyDecorator
     }
 
     Reflect.defineMetadata(`${ApiPropertyMetadataKeyPrefix}${propertyKey.toString()}`, options, target);
-    return target;
   };
 }
 

packages/openapi-metadata/src/decorators/api-property.ts

@@ -6,6 +6,13 @@ export async function resolveType(
   document: DocumentBuilder,
   type: SchemaType,
 ): Promise<OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject> {
+  if (Array.isArray(type)) {
+    return {
+      type: "array",
+      items: await resolveType(document, type[0]),
+    };
+  }
+
   if (typeof type === "string") {
     return {
       type: type as OpenAPIV3.NonArraySchemaObjectType, // TODO: Fix that

packages/openapi-metadata/src/loaders/loadType.ts

@@ -210,6 +210,11 @@ describe("loaders", () => {
       expect(await resolveType(document, Number)).toEqual({ type: "number" });
       expect(await resolveType(document, String)).toEqual({ type: "string" });
     });
+
+    it("should properly resolve array", async () => {
+      const document = new DocumentBuilder();
+      expect(await resolveType(document, [Boolean])).toEqual({ type: "array", items: { type: "boolean" } });
+    });
   });
 });