feat: Feature/swagger options

.github/workflows/core.yml

@@ -7,6 +7,7 @@ on:
       - development
     paths:
       - packages/rejs/**
+      - package-lock.json
       - .github/workflows/core.yml
 
 jobs:

.github/workflows/swagger.yml

@@ -7,6 +7,7 @@ on:
       - development
     paths:
       - packages/rejs-swagger/**
+      - package-lock.json
       - .github/workflows/swagger.yml
 
 jobs:

.gitignore

@@ -102,7 +102,6 @@ dist
 
 # vuepress v2.x temp and cache directory
 .temp
-.cache
 
 # Docusaurus cache and generated files
 .docusaurus
@@ -131,3 +130,4 @@ dist
 
 .idea
 lib
+

packages/rejs-swagger/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@relab/rejs-swagger",
   "version": "1.0.0",
-  "description": "",
+  "description": "re.js is a framework built on top of Express that facilitates the development of API endpoints using the capabilities of Typescript and Zod.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -48,7 +48,6 @@
   },
   "peerDependencies": {
     "@asteasolutions/zod-to-openapi": "^6.0.0",
-    "@relab/rejs": "1.0.0",
     "@types/express": "^4.0.0",
     "@types/swagger-ui-dist": "^3.0.0",
     "express": "^4.0.0",

packages/rejs-swagger/src/options.ts

@@ -1,3 +1,4 @@
+import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi'
 import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator'
 import { UrlSchema } from '@relab/rejs'
 
@@ -6,7 +7,8 @@ export type SwaggerOptions = {
     version?: string
     title?: string
     description?: string
-    options?: OpenAPIObjectConfig
+    configure?: (registry: OpenAPIRegistry) => void
+    options?: Partial<OpenAPIObjectConfig>
     ui?:
         | {
               enabled: true

packages/rejs-swagger/src/swagger.ts

@@ -16,6 +16,10 @@ export const swagger: (options?: SwaggerOptions) => Middleware = options => conf
         if (request.path === swaggerPath) {
             const registry = new OpenAPIRegistry()
 
+            if (options?.configure) {
+                options.configure(registry)
+            }
+
             register(
                 registry,
                 configuration.prefix,

packages/rejs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@relab/rejs",
   "version": "1.0.0",
-  "description": "",
+  "description": "re.js is a framework built on top of Express that facilitates the development of API endpoints using the capabilities of Typescript and Zod.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [