remove trailing slash & fix missing .d.ts files

Author: DylanBulmer

package.json

@@ -6,7 +6,7 @@
   "license": "MIT",
   "scripts": {
     "test": "jest --config jest.config.json --passWithNoTests --coverage",
-    "build": "yarn clean && swc src -d lib && cp package.json lib/",
+    "build": "yarn clean && swc src -d lib && tsc && cp package.json lib/",
     "clean": "rm -rf ./lib",
     "format": "prettier --write \"src/**/*.(ts|js)\"",
     "lint": "eslint -c .eslintrc.json --ignore-path .eslintignore --ext .ts src",

src/__tests__/DirectoryIndexRoute/DirectoryIndexRoute.test.ts

@@ -19,14 +19,18 @@ test("Index routes", () => {
       // url: "/docs/elements"
     },
   }).then(doc => {
-    // check if the static route exists
-    expect(Object.keys(doc.paths as OpenAPIV3_1.PathsObject)).toContain(
-      "/",
+    // check if the root index route exists
+    expect(Object.keys(doc.paths as OpenAPIV3_1.PathsObject)).toContain("/");
+    expect((doc.paths as OpenAPIV3_1.PathsObject)["/"]?.get?.description).toBe(
+      "Testing index route",
     );
 
-    // check if static route's GET description is set
+    // check if the nested index route exists
+    expect(Object.keys(doc.paths as OpenAPIV3_1.PathsObject)).toContain(
+      "/test",
+    );
     expect(
-      (doc.paths as OpenAPIV3_1.PathsObject)["/"]?.get?.description,
-    ).toBe("Testing index route");
+      (doc.paths as OpenAPIV3_1.PathsObject)["/test"]?.get?.description,
+    ).toBe("Testing nested index route");
   });
 });

src/__tests__/DirectoryIndexRoute/routes/test/index.ts

@@ -0,0 +1,35 @@
+import { Operation } from "../../../../types/Route";
+
+export const GET: Operation =
+  /* business middleware not expressible by OpenAPI documentation goes here */
+  (req, res) => {
+    res.status(200).json({ detail: { message: "OK" } });
+  };
+
+// 3.0 specification
+GET.apiDoc = {
+  description: "Testing nested index route",
+  tags: ["TEST"],
+  responses: {
+    "200": {
+      $ref: "#/components/responses/200",
+      content: {
+        "application/json": {
+          schema: {
+            properties: {
+              detail: {
+                type: "object",
+                properties: {
+                  message: {
+                    type: "string",
+                    examples: ["OK"],
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};

src/index.ts

@@ -135,8 +135,14 @@ const getFiles = async function* getFiles(
         expressUrl = `${basePath}:${routeName}`;
         openapiUrl = `${basePath}{${routeName}}`;
       } else if (routeName === "index") {
-        expressUrl = `${basePath}`;
-        openapiUrl = `${basePath}`;
+        if (basePath === "/") {
+          expressUrl = `${basePath}`;
+          openapiUrl = `${basePath}`;
+        } else {
+          const base = basePath.substring(0, basePath.length - 1);
+          expressUrl = `${base}`;
+          openapiUrl = `${base}`;
+        }
       } else {
         expressUrl = `${basePath}${routeName}`;
         openapiUrl = `${basePath}${routeName}`;

tsconfig.json

@@ -27,7 +27,7 @@
     "module": "commonjs",                                /* Specify what module code is generated. */
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./src",                                  /* Specify the base directory to resolve non-relative module names. */
+    "baseUrl": "./src",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
     // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
@@ -44,11 +44,11 @@
     /* Emit */
     "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "emitDeclarationOnly": true,                         /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
     "outDir": "./lib",                                   /* Specify an output folder for all emitted files. */
-    "removeComments": true,                           /* Disable emitting comments. */
+    "removeComments": true,                              /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
     // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */