@stacksjs/api 0.61.22 → 0.62.0

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@stacksjs/api",
   "type": "module",
-  "version": "0.61.22",
+  "version": "0.62.0",
   "description": "The Stacks array utilities.",
   "author": "Chris Breuer",
+  "contributors": [
+    "Chris Breuer <chris@stacksjs.org>"
+  ],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/arrays#readme",
@@ -35,9 +38,6 @@
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
   "files": [
     "README.md",
     "dist",
@@ -45,6 +45,7 @@
   ],
   "scripts": {
     "build": "bun --bun build.ts",
+    "generate-types": "openapi-typescript ./../../api/openapi.json --output ./../../api/api-types.ts",
     "typecheck": "bun --bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
@@ -53,7 +54,8 @@
   },
   "dependencies": {
     "@stacksjs/utils": "latest",
-    "ofetch": "^1.3.4"
+    "ofetch": "^1.3.4",
+    "openapi-typescript": "^7.0.2"
   },
   "devDependencies": {
     "@stacksjs/development": "latest"

package/src/generate-openapi.ts

@@ -0,0 +1,82 @@
+import { path } from '@stacksjs/path'
+import { route } from '@stacksjs/router'
+
+async function generateOpenAPISpec() {
+  const routeLists: any[] = await route.getRoutes()
+
+  const openAPISpec = {
+    openapi: '3.0.0',
+    info: {
+      title: 'Generated API',
+      version: '1.0.0',
+    },
+    paths: {} as Record<string, any>,
+    components: {
+      schemas: {} as Record<string, any>,
+    },
+  }
+
+  routeLists.forEach((route) => {
+    const path = route.url.replace(/{([^}]+)}/g, '{$1}')
+    if (!openAPISpec.paths[path]) {
+      openAPISpec.paths[path] = {}
+    }
+
+    openAPISpec.paths[path][route.method.toLowerCase()] = {
+      summary: route.name,
+      operationId: route.callback,
+      parameters: route.paramNames.map((param) => ({
+        name: param,
+        in: 'path',
+        required: true,
+        schema: {
+          type: 'string',
+        },
+      })),
+      responses: {
+        [route.statusCode]: {
+          description: 'Successful response',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {},
+              },
+            },
+          },
+        },
+      },
+    }
+
+    // Add schemas to components if they are not already defined
+    if (route.responseSchema) {
+      const schemaName = `${route.name.replace(/\./g, '')}Response`
+      openAPISpec.components.schemas[schemaName] = route.responseSchema
+      openAPISpec.paths[path][route.method.toLowerCase()].responses[route.statusCode].content[
+        'application/json'
+      ].schema = {
+        $ref: `#/components/schemas/${schemaName}`,
+      }
+    }
+
+    if (route.requestSchema) {
+      const schemaName = `${route.name.replace(/\./g, '')}Request`
+      openAPISpec.components.schemas[schemaName] = route.requestSchema
+      openAPISpec.paths[path][route.method.toLowerCase()].requestBody.content['application/json'].schema = {
+        $ref: `#/components/schemas/${schemaName}`,
+      }
+    }
+  })
+
+  return openAPISpec
+}
+
+const openAPISpec = await generateOpenAPISpec()
+
+const file = Bun.file(path.projectStoragePath(`framework/api/openapi.json`))
+
+const writer = file.writer()
+
+writer.write(JSON.stringify(openAPISpec.toString()))
+
+await writer.end()