feat(@sirutils/wizard): adjust swagger automaticly when an action is created

Author: siaeyy

packages/wizard/src/definitions/wizard.ts

@@ -147,6 +147,7 @@ declare global {
           Hr,
         >(
           meta: {
+            description?: string
             body?: B
             params?: P
             queries?: Q

packages/wizard/src/utils/internals/action.ts

@@ -11,7 +11,9 @@ export const actionActions = createActions(
       const queriesSchema = meta.queries && createAsyncSchema(meta.queries)
 
       return serviceOptions => ({
-        ...((meta.rest ? { rest: meta.rest } : {}) as BlobType),
+        // We dont have access to service's name in here
+        // so we return meta datas for adding these to swagger in service module
+        meta: meta,
         handler: capsule(
           // biome-ignore lint/complexity/noExcessiveCognitiveComplexity: Redundant
           async ctx => {

packages/wizard/src/utils/internals/service.ts

@@ -19,10 +19,14 @@ export const serviceActions = createActions(
         ) as BlobType
 
         for (const [key, value] of Object.entries(serviceOptions.actions ?? {})) {
-          if (value.rest) {
-            aliases[
-              typeof value.rest === 'boolean' ? `${toMethod(key)} /` : (value.rest as string)
-            ] = async (req: IncomingRequest, res: GatewayResponse) => {
+          if (value.meta.rest) {
+            // Create alias for redirecting
+            const alias =
+              typeof value.meta.rest === 'boolean'
+                ? `${toMethod(key)} /`
+                : (value.meta.rest as string)
+
+            aliases[alias] = async (req: IncomingRequest, res: GatewayResponse) => {
               const result = await group(() =>
                 // biome-ignore lint/style/noNonNullAssertion: Redundant
                 serviceOptions.actions![key]?.handler!(req.$ctx)
@@ -42,6 +46,70 @@ export const serviceActions = createActions(
                 res.end(result.error.stringify())
               }
             }
+
+            // Extract method and path from alias
+            const [method, path] = alias.split(' ') as [string, string]
+
+            // Format param variables
+            const formattedPath = path
+              .substring(1)
+              .split('/')
+              .map(val => (val.startsWith(':') ? `\{${val.substring(1)}\}` : val))
+              .join('/')
+
+            // Get the paths object of swagger
+            const paths = context.api.gateway.settings.swagger.paths
+
+            // Original path
+            const oriPath = `/${serviceOptions.name}\/${serviceOptions.version}\/${formattedPath}`
+
+            // Omit $$async to get body content
+            // and create swagger struct
+            const { $$async: _$b, ...omittedBody } = value.meta.body ?? {}
+            // biome-ignore lint/complexity/noForEach: <explanation>
+            Object.keys(omittedBody).forEach(key => {
+              omittedBody[key] = {
+                type: omittedBody[key],
+              }
+            })
+
+            // Omit $$async to get params
+            // and create swagger struct
+            const { $$async: _$p, ...omittedParams } = value.meta.queries ?? {}
+            // biome-ignore lint/complexity/noForEach: <explanation>
+            Object.keys(omittedParams).forEach(key => {
+              omittedParams[key] = {
+                name: key,
+                in: 'path',
+                required: true,
+                schema: {
+                  type: omittedParams[key],
+                },
+              }
+            })
+
+            // Create request body struct for swagger
+            const bodyDef = value.meta.body
+              ? {
+                  required: true,
+                  content: {
+                    'application/json': {
+                      schema: {
+                        type: 'object',
+                        properties: omittedBody,
+                      },
+                    },
+                  },
+                }
+              : {}
+
+            // Add struct of the endpoint to swagger
+            paths[oriPath] = {}
+            paths[oriPath][method.toLowerCase()] = {
+              ...(value.meta.description ? { description: value.meta.description } : {}),
+              parameters: Object.values(omittedParams),
+              requestBody: bodyDef,
+            }
           }
         }