directus-extension-api-docs 1.4.7 → 1.5.0

package/README.md

@@ -27,6 +27,7 @@ Create a `oasconfig.yaml` file under `/extensions/endpoints` folder.
 Options:
 
 -   `docsPath` _optional_ path where the interface will be (default 'api-docs')
+-   `info` _optional_ openapi server info (default extract from package.json)
 -   `tags` _optional_ openapi custom tags (will be merged with all standard and all customs tags)
 -   `paths` _optional_ openapi custom paths (will be merged with all standard and all customs paths)
 -   `components` _optional_ openapi custom components (will be merged with all standard and all customs tags)
@@ -35,6 +36,10 @@ Example below:
 
 ```
 docsPath: 'api-docs'
+info:
+  title: my-directus-bo
+  version: 1.5.0
+  description: my server description
 tags:
 - name: MyCustomTag
   description: MyCustomTag description

package/dist/index.js

@@ -1 +1 @@
-"use strict";const e=require("js-yaml"),s=require("path"),t=require("fs"),n=process.cwd();let o;async function a(e,s){if(o)return JSON.parse(o);const{SpecificationService:t}=e,n=new t({accountability:{admin:!0},schema:s});return o=JSON.stringify(await n.oas.generate()),JSON.parse(o)}function i(e,s){return Object.entries(s).reduce(((e,[s,t])=>(e[s]=t&&"object"==typeof t?i(e[s]=e[s]||(Array.isArray(t)?[]:{}),t):t,e)),e)}const c=require("swagger-ui-express"),r=require("express-openapi-validator"),{findWorkspaceDir:p}=require("@pnpm/find-workspace-dir"),u=function(){const o=function(){const o={docsPath:"api-docs",tags:[],paths:{},components:{}};try{const a=s.join(n,"./extensions/endpoints/oasconfig.yaml"),i=e.load(t.readFileSync(a,{encoding:"utf-8"}));return i.docsPath=i.docsPath||o.docsPath,i.tags=i.tags||o.tags,i.paths=i.paths||o.paths,i.components=i.components||o.components,i}catch{return o}}();try{const a=s.join(n,"./extensions/endpoints"),c=t.readdirSync(a,{withFileTypes:!0});for(const s of c){const n=`${a}/${s.name}/oas.yaml`;if(s.isDirectory()&&t.existsSync(n)){const s=e.load(t.readFileSync(n,{encoding:"utf-8"}));o.tags=[...o.tags,...s.tags],o.paths={...o.paths,...s.paths},o.components=i(o.components||{},s.components||{})}}return o}catch(e){return o}}(),d=u.docsPath;var l={id:d,validate:async function(e,s,t,n){if(null==u?void 0:u.paths){const o=await a(s,t);if(n)for(const e of n)o.paths[e]=u.paths[e];else o.paths=u.paths;u.components?o.components=u.components:(delete o.components.definitions,delete o.components.schemas),e.use(r.middleware({apiSpec:o})),e.use(((e,s,t,n)=>{t.status(e.status||500).json({message:e.message,errors:e.errors})}))}return e},handler:(e,{services:s,exceptions:t,logger:n,getSchema:o})=>{const{ServiceUnavailableException:r}=t,l={swaggerOptions:{url:`/${d}/oas`}};e.use("/",c.serve),e.get("/",c.setup({},l)),e.get("/oas",(async(e,t,c)=>{try{const e=await o(),c=await a(s,e);try{const e=require(`${await p(".")}/package.json`);(null==e?void 0:e.name)&&(c.info.title=null==e?void 0:e.name),(null==e?void 0:e.version)&&(c.info.version=null==e?void 0:e.version),(null==e?void 0:e.description)&&(c.info.description=null==e?void 0:e.description)}catch(e){}try{if(null==u?void 0:u.paths)for(const e in u.paths)c.paths[e]=u.paths[e];if(null==u?void 0:u.tags)for(const e of u.tags)c.tags.push(e);(null==u?void 0:u.components)&&(c.components=i(u.components,c.components))}catch(e){n.info("No custom definitions")}t.json(c)}catch(e){return c(new r(e.message||e[0].message))}}))}};module.exports=l;
+"use strict";const e=require("js-yaml"),n=require("path"),s=require("fs"),t=()=>process.cwd();let o;async function i(e,n){if(o)return JSON.parse(o);const{SpecificationService:s}=e,t=new s({accountability:{admin:!0},schema:n});return o=JSON.stringify(await t.oas.generate()),JSON.parse(o)}function a(e,n){return Object.entries(n).reduce(((e,[n,s])=>(e[n]=s&&"object"==typeof s?a(e[n]=e[n]||(Array.isArray(s)?[]:{}),s):s,e)),e)}const c=require("swagger-ui-express"),r=require("express-openapi-validator"),{findWorkspaceDir:p}=require("@pnpm/find-workspace-dir"),d=function(){const o=function(){const o={docsPath:"api-docs",info:{},tags:[],paths:{},components:{}};try{const i=n.join(t(),"./extensions/endpoints/oasconfig.yaml"),a=e.load(s.readFileSync(i,{encoding:"utf-8"}));return a.docsPath=a.docsPath||o.docsPath,a.info=a.info||o.info,a.tags=a.tags||o.tags,a.paths=a.paths||o.paths,a.components=a.components||o.components,a}catch{return o}}();try{const i=n.join(t(),"./extensions/endpoints"),c=s.readdirSync(i,{withFileTypes:!0});for(const n of c){const t=`${i}/${n.name}/oas.yaml`;if(n.isDirectory()&&s.existsSync(t)){const n=e.load(s.readFileSync(t,{encoding:"utf-8"}));o.tags=[...o.tags,...n.tags],o.paths={...o.paths,...n.paths},o.components=a(o.components||{},n.components||{})}}return o}catch(e){return o}}(),u=d.docsPath;var f={id:u,validate:async function(e,n,s,t){if(null==d?void 0:d.paths){const o=await i(n,s);if(t)for(const e of t)o.paths[e]=d.paths[e];else o.paths=d.paths;d.components?o.components=d.components:(delete o.components.definitions,delete o.components.schemas),e.use(r.middleware({apiSpec:o})),e.use(((e,n,s,t)=>{s.status(e.status||500).json({message:e.message,errors:e.errors})}))}return e},handler:(e,{services:n,exceptions:s,logger:t,getSchema:o})=>{const{ServiceUnavailableException:r}=s,f={swaggerOptions:{url:`/${u}/oas`}};e.use("/",c.serve),e.get("/",c.setup({},f)),e.get("/oas",(async(e,s,c)=>{try{const e=await o(),c=await i(n,e);try{const e=require(`${await p(".")}/package.json`);c.info.title=d.info.title||(null==e?void 0:e.name)||c.info.title,c.info.version=d.info.version||(null==e?void 0:e.version)||c.info.version,c.info.description=d.info.description||(null==e?void 0:e.description)||c.info.description}catch(e){}try{if(null==d?void 0:d.paths)for(const e in d.paths)c.paths[e]=d.paths[e];if(null==d?void 0:d.tags)for(const e of d.tags)c.tags.push(e);(null==d?void 0:d.components)&&(c.components=a(d.components,c.components))}catch(e){t.info("No custom definitions")}s.json(c)}catch(e){return c(new r(e.message||e[0].message))}}))}};module.exports=f;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "directus-extension-api-docs",
-    "version": "1.4.7",
+    "version": "1.5.0",
     "description": "directus extension for swagger interface and custom endpoints definitions",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -46,7 +46,7 @@
         "@types/node": "^18.13.0",
         "@typescript-eslint/eslint-plugin": "^5.51.0",
         "@typescript-eslint/parser": "^5.51.0",
-        "eslint": "^8.33.0",
+        "eslint": "^8.34.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-import": "^2.27.5",
         "eslint-plugin-prettier": "^4.2.1",