directus-extension-api-docs 1.5.1 → 1.6.1

package/README.md

@@ -29,6 +29,7 @@ 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)
+-   `publishedTags` _optional_ if specified, will be published definitions only for specified 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)
 
@@ -43,6 +44,8 @@ info:
 tags:
 - name: MyCustomTag
   description: MyCustomTag description
+publishedTags:
+- MyCustomTag
 components:
   schemas:
     UserId:

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "directus-extension-api-docs",
-    "version": "1.5.1",
+    "version": "1.6.1",
     "description": "directus extension for swagger interface and custom endpoints definitions",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -36,25 +36,25 @@
         "@pnpm/find-workspace-dir": "^5.0.1",
         "express-openapi-validator": "^4.13.8",
         "js-yaml": "^4.1.0",
-        "swagger-ui-express": "^4.6.0"
+        "swagger-ui-express": "^4.6.2"
     },
     "devDependencies": {
         "@directus/extensions-sdk": "^9.22.4",
         "@directus/shared": "^9.22.3",
         "@types/express": "^4.17.17",
         "@types/jest": "^29.4.0",
-        "@types/node": "^18.13.0",
-        "@typescript-eslint/eslint-plugin": "^5.51.0",
-        "@typescript-eslint/parser": "^5.51.0",
-        "eslint": "^8.34.0",
+        "@types/node": "^18.14.2",
+        "@typescript-eslint/eslint-plugin": "^5.53.0",
+        "@typescript-eslint/parser": "^5.53.0",
+        "eslint": "^8.35.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-plugin-import": "^2.27.5",
         "eslint-plugin-prettier": "^4.2.1",
         "express": "^4.18.2",
-        "jest": "^29.4.2",
-        "jest-extended": "^3.2.3",
+        "jest": "^29.4.3",
+        "jest-extended": "^3.2.4",
         "openapi-schema-validator": "^12.1.0",
-        "pino": "^8.10.0",
+        "pino": "^8.11.0",
         "prettier": "^2.8.4",
         "ts-jest": "^29.0.5",
         "ts-node": "^10.9.1",