directus-extension-api-docs 1.5.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/index.js +1 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -29,6 +29,7 @@ Options:
|
|
|
29
29
|
- `docsPath` _optional_ path where the interface will be (default 'api-docs')
|
|
30
30
|
- `info` _optional_ openapi server info (default extract from package.json)
|
|
31
31
|
- `tags` _optional_ openapi custom tags (will be merged with all standard and all customs tags)
|
|
32
|
+
- `publishedTags` _optional_ if specified, will be published definitions only for specified tags
|
|
32
33
|
- `paths` _optional_ openapi custom paths (will be merged with all standard and all customs paths)
|
|
33
34
|
- `components` _optional_ openapi custom components (will be merged with all standard and all customs tags)
|
|
34
35
|
|
|
@@ -43,6 +44,8 @@ info:
|
|
|
43
44
|
tags:
|
|
44
45
|
- name: MyCustomTag
|
|
45
46
|
description: MyCustomTag description
|
|
47
|
+
publishedTags:
|
|
48
|
+
- MyCustomTag
|
|
46
49
|
components:
|
|
47
50
|
schemas:
|
|
48
51
|
UserId:
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";const
|
|
1
|
+
"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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "directus-extension-api-docs",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.6.0",
|
|
4
4
|
"description": "directus extension for swagger interface and custom endpoints definitions",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -36,25 +36,25 @@
|
|
|
36
36
|
"@pnpm/find-workspace-dir": "^5.0.1",
|
|
37
37
|
"express-openapi-validator": "^4.13.8",
|
|
38
38
|
"js-yaml": "^4.1.0",
|
|
39
|
-
"swagger-ui-express": "^4.6.
|
|
39
|
+
"swagger-ui-express": "^4.6.1"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@directus/extensions-sdk": "^9.22.4",
|
|
43
43
|
"@directus/shared": "^9.22.3",
|
|
44
44
|
"@types/express": "^4.17.17",
|
|
45
45
|
"@types/jest": "^29.4.0",
|
|
46
|
-
"@types/node": "^18.
|
|
47
|
-
"@typescript-eslint/eslint-plugin": "^5.
|
|
48
|
-
"@typescript-eslint/parser": "^5.
|
|
49
|
-
"eslint": "^8.
|
|
46
|
+
"@types/node": "^18.14.1",
|
|
47
|
+
"@typescript-eslint/eslint-plugin": "^5.53.0",
|
|
48
|
+
"@typescript-eslint/parser": "^5.53.0",
|
|
49
|
+
"eslint": "^8.35.0",
|
|
50
50
|
"eslint-config-prettier": "^8.6.0",
|
|
51
51
|
"eslint-plugin-import": "^2.27.5",
|
|
52
52
|
"eslint-plugin-prettier": "^4.2.1",
|
|
53
53
|
"express": "^4.18.2",
|
|
54
|
-
"jest": "^29.4.
|
|
55
|
-
"jest-extended": "^3.2.
|
|
54
|
+
"jest": "^29.4.3",
|
|
55
|
+
"jest-extended": "^3.2.4",
|
|
56
56
|
"openapi-schema-validator": "^12.1.0",
|
|
57
|
-
"pino": "^8.
|
|
57
|
+
"pino": "^8.11.0",
|
|
58
58
|
"prettier": "^2.8.4",
|
|
59
59
|
"ts-jest": "^29.0.5",
|
|
60
60
|
"ts-node": "^10.9.1",
|