@kaapi/kaapi 0.0.15 → 0.0.17
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 +62 -7
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/lib/services/docs/api-doc-mix-helpers.d.ts +88 -0
- package/lib/services/docs/api-doc-mix-helpers.js +95 -0
- package/lib/services/docs/api-doc-mix-helpers.js.map +1 -0
- package/lib/services/docs/generators.d.ts +17 -1
- package/lib/services/docs/generators.js +54 -13
- package/lib/services/docs/generators.js.map +1 -1
- package/package.json +9 -4
- package/types/overrides.d.ts +17 -1
- package/lib/base-app.d.ts +0 -23
- package/lib/base-app.js +0 -23
- package/lib/base-app.js.map +0 -1
- package/lib/baseApp.d.ts +0 -23
- package/lib/baseApp.js +0 -23
- package/lib/baseApp.js.map +0 -1
- package/lib/services/docs/SwaggerUiGenerator.d.ts +0 -19
- package/lib/services/docs/SwaggerUiGenerator.js +0 -245
- package/lib/services/docs/SwaggerUiGenerator.js.map +0 -1
- package/lib/services/docs/ui/swagger-ui.d.ts +0 -21
- package/lib/services/docs/ui/swagger-ui.js +0 -321
- package/lib/services/docs/ui/swagger-ui.js.map +0 -1
- package/lib/services/plugin.d.ts +0 -88
- package/lib/services/plugin.js +0 -87
- package/lib/services/plugin.js.map +0 -1
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"swagger-ui.js","sourceRoot":"","sources":["../../../../src/services/docs/ui/swagger-ui.ts"],"names":[],"mappings":";;;AAyBA,8BAEC;;AA3BD,uDAAuD;AACvD,0FAAoE;AACpE,8DAA6B;AAC7B,oDAAmB;AAgBnB,MAAM,WAAW,GAAG,+EAA+E;IAC/F,+EAA+E,CAAA;AACxE,QAAA,WAAW,GAAG,EAAE,CAAA;AAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;AAE5B,SAAgB,SAAS,CAAC,CAAS;IAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,SAAS,GAAG,UAAU,GAAQ;IAChC,MAAM,WAAW,GAAG,6BAA6B,CAAA;IACjD,MAAM,GAAG,GAAU,EAAE,CAAA;IACrB,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,IAAI,EAAE,KAAK;QAChD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACf,OAAO,WAAW,CAAA;QACtB,CAAC;QACD,OAAO,KAAK,CAAA;IAChB,CAAC,EAAE,CAAC,CAAC,CAAA;IACL,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,GAAG,WAAW,GAAG,GAAG,EAAE,GAAG,CAAC,EAAE;QAC1D,OAAO,GAAG,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IACF,OAAO,gBAAgB,GAAG,IAAI,GAAG,GAAG,CAAA;AACxC,CAAC,CAAA;AAED,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFnB,CAAA;AAEH,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDjB,CAAA;AAEH,SAAS,mBAAmB,CAAC,GAAQ;IACjC,OAAO,gBAAgB,GAAG,aAAa,CAAA;AAC3C,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAW;IAClC,OAAO,WAAW,MAAM,WAAW,CAAA;AACvC,CAAC;AAED,SAAS,uBAAuB,CAAC,GAAQ;IACrC,OAAO,eAAe,GAAG,qBAAqB,CAAA;AAClD,CAAC;AAED,SAAS,MAAM,CAAC,UAAe,EAAE,QAAa;IAC1C,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC/B,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACnC,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;SAAM,CAAC;QACJ,OAAO,EAAE,CAAA;IACb,CAAC;AACL,CAAC;AAEM,MAAM,YAAY,GAAG,UACxB,UAAe,EACf,IAAS,EACT,OAAa,EACb,SAAe,EACf,aAAmB,EACnB,UAAgB,EAChB,eAAqB,EACrB,cAAoB,EACpB,YAAkB;IAElB,IAAI,UAAU,CAAA;IACd,IAAI,QAAQ,CAAA;IACZ,IAAI,WAAW,CAAA;IACf,IAAI,WAAW,CAAA;IACf,IAAI,YAAY,CAAA;IAChB,IAAI,YAAY,CAAA;IAChB,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAA;QAC7B,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC1B,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACxB,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QAC9B,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QAClC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QAChC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QAC5B,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QAC9B,UAAU,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,WAAW,CAAA;QAC3C,eAAe,GAAG,IAAI,CAAC,eAAe,CAAA;QACtC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;IACpC,CAAC;SAAM,CAAC;QACJ,sCAAsC;QACtC,UAAU,GAAG,IAAI,CAAA;IACrB,CAAC;IACD,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IACvB,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,6DAA6D,CAAA;IACtG,SAAS,GAAG,cAAc,GAAG,GAAG,GAAG,SAAS,IAAI,cAAc,CAAA;IAC9D,aAAa,GAAG,aAAa,IAAI,KAAK,CAAA;IACtC,eAAe,GAAG,eAAe,IAAI,YAAY,CAAA;IACjD,cAAc,GAAG,cAAc,IAAI,aAAa,CAAA;IAChD,YAAY,GAAG,YAAY,IAAI,WAAW,CAAA;IAE1C,MAAM,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,+BAA+B,GAAG,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;IACpG,MAAM,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,yBAAyB,GAAG,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAA;IACtG,MAAM,iBAAiB,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAA;IACzF,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,OAAO,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,CAAA;IAClG,MAAM,eAAe,GAAG,oBAAoB,CAAC,OAAO,CAAC,qBAAqB,EAAE,aAAa,CAAC,CAAA;IAC1F,MAAM,mBAAmB,GAAG,eAAe,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAC5G,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAA;IACjH,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC,CAAA;IAE1H,MAAM,WAAW,GAAG;QAChB,UAAU,EAAE,UAAU,IAAI,SAAS;QACnC,aAAa,EAAE,OAAO;QACtB,UAAU,EAAE,UAAU,IAAI,SAAS;QACnC,WAAW,EAAE,WAAW,IAAI,SAAS;KACxC,CAAA;IAED,mBAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,sBAAsB,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;IAC7F,OAAO,oBAAoB,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,CAAA;AACvE,CAAC,CAAA;AA3DY,QAAA,YAAY,gBA2DxB;AAED,MAAM,KAAK,GAAG,UACV,UAAe,EACf,IAAU,EACV,OAAa,EACb,SAAe,EACf,aAAmB,EACnB,UAAgB,EAChB,eAAqB;IAErB,MAAM,IAAI,GAAG,IAAA,oBAAY,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;IACvI,OAAO,UAAU,GAAQ,EAAE,GAAQ;QAC/B,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACjB,MAAM,OAAO,GAAG,IAAA,oBAAY,EAAC,GAAG,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;YAC9I,GAAG,CAAC,OAAO,CAAC,CAAA;QAChB,CAAC;aAAM,CAAC;YACJ,GAAG,CAAC,IAAI,CAAC,CAAA;QACb,CAAC;IACL,CAAC,CAAA;AACL,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,UAAU,GAAQ,EAAE,GAAQ,EAAE,MAAY;IACrD,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QACxD,GAAG,CAAC,cAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;SAAM,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;QACrE,GAAG,CAAC,mBAAW,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,CAAC;QACD,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,KAAK;QAEhD,MAAM,UAAU,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,KAAI,OAAO,MAAM,CAAC,UAAU,IAAI,QAAQ;YACzE,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzF,MAAM,WAAW,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAEjE,IAAI,QAAQ,GAAG,EAAE,CAAA;QAEjB,MAAM,SAAS,GAAG,SAAS,GAAG,eAAe;cACvC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAC9D,MAAM,aAAa,GAAG,IAAA,uBAAwB,GAAE;cAC1C,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/E,kEAAkE;QAElE,IAAI,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,QAAQ,GAAG,SAAS,CAAA;QACxB,CAAC;aAAM,IAAI,YAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACtC,QAAQ,GAAG,aAAa,CAAA;QAC5B,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,iBAAiB,GAAkC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;YAC5E,IAAI,EAAE,GAAG,0BAA0B,CAAA;YACnC,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3B,EAAE,GAAG,wBAAwB,CAAA;YACjC,CAAC;iBAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnC,EAAE,GAAG,UAAU,CAAA;YACnB,CAAC;iBAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnC,iBAAiB,GAAG,EAAE,CAAA;gBACtB,EAAE,GAAG,WAAW,CAAA;YACpB,CAAC;YACD,GAAG,CAAC,YAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;iBAChD,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CACtB,eAAe,EACf,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CACrC,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED,OAAO,KAAK,CAAA;AAChB,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,UAClB,IAAY,EACZ,cAAkC,EAClC,IAAuB;IAEvB,oCAAoC;IACpC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAE;IAC9F,OAAO,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;QAC1B,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC3B,KAAK,CAAC,cAAc,EAAE,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC;YAC7E,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAA;QAC5B,CAAC;aAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;YAC3C,GAAG,CAAC,cAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QACxB,CAAC;IACL,CAAC,CAAA;AACL,CAAC,CAAA;AAEY,QAAA,SAAS,GAAG;IACrB,aAAa,EAAE,aAAa;IAC5B,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,KAAK;CACf,CAAA"}
|
package/lib/services/plugin.d.ts
DELETED
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
import { HandlerDecorations, InternalRouteOptionType, Lifecycle, MergeType, ReqRef, ReqRefDefaults, RouteOptionTypes, Server, ServerAuthScheme } from '@hapi/hapi';
|
|
2
|
-
import { ILogger } from './log';
|
|
3
|
-
import { KaapiServerRoute } from '@kaapi/server';
|
|
4
|
-
import { KaapiOpenAPI, KaapiPostman } from './docs/generators';
|
|
5
|
-
import { BaseAuthUtil } from '@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils';
|
|
6
|
-
import { KaapiGroupAuthUtil } from './docs/utils';
|
|
7
|
-
/**
|
|
8
|
-
*
|
|
9
|
-
* Set of tools
|
|
10
|
-
*
|
|
11
|
-
* ```ts
|
|
12
|
-
* log
|
|
13
|
-
* openapi
|
|
14
|
-
* postman
|
|
15
|
-
* server
|
|
16
|
-
* route(...)
|
|
17
|
-
* scheme(...)
|
|
18
|
-
* strategy(...)
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
21
|
-
export interface KaapiTools {
|
|
22
|
-
readonly log: ILogger;
|
|
23
|
-
route<Refs extends ReqRef = ReqRefDefaults>(serverRoute: KaapiServerRoute<Refs>, handler?: HandlerDecorations | Lifecycle.Method<Refs, Lifecycle.ReturnValue<Refs>>): this;
|
|
24
|
-
openapi?: KaapiOpenAPI;
|
|
25
|
-
postman?: KaapiPostman;
|
|
26
|
-
scheme<Refs extends ReqRef = ReqRefDefaults, Options extends object = {}>(name: string, scheme: ServerAuthScheme<Options, Refs>): void;
|
|
27
|
-
strategy(name: MergeType<InternalRouteOptionType, RouteOptionTypes>['Strategy'], scheme: string, options?: object): void;
|
|
28
|
-
server: Server;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Interface to extend kaapi app functionalities.
|
|
32
|
-
* ```ts
|
|
33
|
-
* const app = new Kaapi({
|
|
34
|
-
* extend: [plugin]
|
|
35
|
-
* })
|
|
36
|
-
* // or
|
|
37
|
-
* app.extend(plugin)
|
|
38
|
-
* // or
|
|
39
|
-
* app.extend([plugin1, plugin2])
|
|
40
|
-
* ```
|
|
41
|
-
*/
|
|
42
|
-
export interface KaapiPlugin {
|
|
43
|
-
integrate(t: KaapiTools): void | Promise<void>;
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* AuthDesign plugin
|
|
47
|
-
*/
|
|
48
|
-
export declare abstract class AuthDesign implements KaapiPlugin {
|
|
49
|
-
integrate(t: KaapiTools): Promise<void>;
|
|
50
|
-
/**
|
|
51
|
-
* Whatever needs to be done to complete the integration.
|
|
52
|
-
* (e.g.: register a route, ...)
|
|
53
|
-
*/
|
|
54
|
-
integrateHook(_t: KaapiTools): void | Promise<void>;
|
|
55
|
-
/**
|
|
56
|
-
* Returns the schema used for the documentation
|
|
57
|
-
*/
|
|
58
|
-
abstract docs(): BaseAuthUtil | undefined;
|
|
59
|
-
/**
|
|
60
|
-
* Where authentication schemes and strategies should be registered.
|
|
61
|
-
*/
|
|
62
|
-
abstract integrateStrategy(t: KaapiTools): void;
|
|
63
|
-
/**
|
|
64
|
-
* The name of the strategy, for info purpose
|
|
65
|
-
*/
|
|
66
|
-
abstract getStrategyName(): string;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* An auth design that groups multiple auth designs.
|
|
70
|
-
*
|
|
71
|
-
* Usefull to regroup the auth schemes in the documentation and register the strategies in parallel.
|
|
72
|
-
* ```ts
|
|
73
|
-
* const authdesigns = new GroupAuthDesign([
|
|
74
|
-
* authdesign1,
|
|
75
|
-
* authdesign2
|
|
76
|
-
* ])
|
|
77
|
-
* app.extend(authdesigns)
|
|
78
|
-
* ```
|
|
79
|
-
*/
|
|
80
|
-
export declare class GroupAuthDesign extends AuthDesign {
|
|
81
|
-
protected designs: AuthDesign[];
|
|
82
|
-
constructor(designs: AuthDesign[]);
|
|
83
|
-
docs(): KaapiGroupAuthUtil;
|
|
84
|
-
integrateStrategy(t: KaapiTools): void;
|
|
85
|
-
integrateHook(t: KaapiTools): Promise<void>;
|
|
86
|
-
getStrategyName(): string;
|
|
87
|
-
getStrategies(): string[];
|
|
88
|
-
}
|
package/lib/services/plugin.js
DELETED
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.GroupAuthDesign = exports.AuthDesign = void 0;
|
|
4
|
-
const tslib_1 = require("tslib");
|
|
5
|
-
const api_doc_generator_1 = require("@novice1/api-doc-generator");
|
|
6
|
-
const utils_1 = require("./docs/utils");
|
|
7
|
-
/**
|
|
8
|
-
* AuthDesign plugin
|
|
9
|
-
*/
|
|
10
|
-
class AuthDesign {
|
|
11
|
-
integrate(t) {
|
|
12
|
-
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
13
|
-
var _a, _b, _c;
|
|
14
|
-
try {
|
|
15
|
-
this.integrateStrategy(t);
|
|
16
|
-
t.log.debug(`Auth Design "${this.constructor.name}" set strategy (integrateStrategy).`);
|
|
17
|
-
}
|
|
18
|
-
catch (err) {
|
|
19
|
-
t.log.error(`Auth Design "${this.constructor.name}" failed to integrate auth strategy: ${err}`);
|
|
20
|
-
throw err;
|
|
21
|
-
}
|
|
22
|
-
const securityScheme = this.docs();
|
|
23
|
-
if (securityScheme) {
|
|
24
|
-
(_a = t.openapi) === null || _a === void 0 ? void 0 : _a.addSecurityScheme(securityScheme).setDefaultSecurity(securityScheme);
|
|
25
|
-
if (securityScheme instanceof api_doc_generator_1.OAuth2Util && !securityScheme.getHost() && ((_b = t.postman) === null || _b === void 0 ? void 0 : _b.getHost().length)) {
|
|
26
|
-
securityScheme.setHost(t.postman.getHost()[0]);
|
|
27
|
-
}
|
|
28
|
-
(_c = t.postman) === null || _c === void 0 ? void 0 : _c.setDefaultSecurity(securityScheme);
|
|
29
|
-
t.log.debug(`Auth Design "${this.constructor.name}" set security scheme (docs).`);
|
|
30
|
-
}
|
|
31
|
-
else {
|
|
32
|
-
t.log.warn(`Auth Design "${this.constructor.name}" did not provide a security scheme (docs()).`);
|
|
33
|
-
}
|
|
34
|
-
yield this.integrateHook(t);
|
|
35
|
-
});
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Whatever needs to be done to complete the integration.
|
|
39
|
-
* (e.g.: register a route, ...)
|
|
40
|
-
*/
|
|
41
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
42
|
-
integrateHook(_t) {
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
exports.AuthDesign = AuthDesign;
|
|
46
|
-
/**
|
|
47
|
-
* An auth design that groups multiple auth designs.
|
|
48
|
-
*
|
|
49
|
-
* Usefull to regroup the auth schemes in the documentation and register the strategies in parallel.
|
|
50
|
-
* ```ts
|
|
51
|
-
* const authdesigns = new GroupAuthDesign([
|
|
52
|
-
* authdesign1,
|
|
53
|
-
* authdesign2
|
|
54
|
-
* ])
|
|
55
|
-
* app.extend(authdesigns)
|
|
56
|
-
* ```
|
|
57
|
-
*/
|
|
58
|
-
class GroupAuthDesign extends AuthDesign {
|
|
59
|
-
constructor(designs) {
|
|
60
|
-
super();
|
|
61
|
-
this.designs = designs;
|
|
62
|
-
}
|
|
63
|
-
docs() {
|
|
64
|
-
return new utils_1.KaapiGroupAuthUtil(this.designs
|
|
65
|
-
.map(d => d.docs())
|
|
66
|
-
.filter(d => typeof d != 'undefined'));
|
|
67
|
-
}
|
|
68
|
-
integrateStrategy(t) {
|
|
69
|
-
for (const d of this.designs) {
|
|
70
|
-
d.integrateStrategy(t);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
integrateHook(t) {
|
|
74
|
-
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
75
|
-
yield Promise.all(this.designs
|
|
76
|
-
.map(d => d.integrateHook(t)));
|
|
77
|
-
});
|
|
78
|
-
}
|
|
79
|
-
getStrategyName() {
|
|
80
|
-
return this.getStrategies()[0] || '';
|
|
81
|
-
}
|
|
82
|
-
getStrategies() {
|
|
83
|
-
return this.designs.map(d => d.getStrategyName()).filter(n => n);
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
exports.GroupAuthDesign = GroupAuthDesign;
|
|
87
|
-
//# sourceMappingURL=plugin.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/services/plugin.ts"],"names":[],"mappings":";;;;AAKA,kEAAwD;AACxD,wCAAkD;AAoDlD;;GAEG;AACH,MAAsB,UAAU;IACtB,SAAS,CAAC,CAAa;;;YAEzB,IAAI,CAAC;gBACD,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBAC1B,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,IAAI,qCAAqC,CAAC,CAAC;YAC5F,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,IAAI,wCAAwC,GAAG,EAAE,CAAC,CAAC;gBAChG,MAAM,GAAG,CAAC;YACd,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,cAAc,EAAE,CAAC;gBACjB,MAAA,CAAC,CAAC,OAAO,0CAAE,iBAAiB,CAAC,cAAc,EACtC,kBAAkB,CAAC,cAAc,CAAC,CAAC;gBACxC,IAAI,cAAc,YAAY,8BAAU,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,KAAI,MAAA,CAAC,CAAC,OAAO,0CAAE,OAAO,GAAG,MAAM,CAAA,EAAE,CAAC;oBACnG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;gBAClD,CAAC;gBACD,MAAA,CAAC,CAAC,OAAO,0CAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;gBAC9C,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,IAAI,+BAA+B,CAAC,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACJ,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,IAAI,+CAA+C,CAAC,CAAC;YACrG,CAAC;YAED,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;QAC/B,CAAC;KAAA;IAED;;;OAGG;IACH,6DAA6D;IAC7D,aAAa,CAAC,EAAc;IAE5B,CAAC;CAgBJ;AAlDD,gCAkDC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,eAAgB,SAAQ,UAAU;IAI3C,YAAY,OAAqB;QAC7B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI;QACA,OAAO,IAAI,0BAAkB,CAAC,IAAI,CAAC,OAAO;aACrC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,WAAW,CAAC,CACxC,CAAA;IACL,CAAC;IACD,iBAAiB,CAAC,CAAa;QAC3B,KAAI,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1B,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;QAC1B,CAAC;IACL,CAAC;IACK,aAAa,CAAC,CAAa;;YAC7B,MAAM,OAAO,CAAC,GAAG,CACb,IAAI,CAAC,OAAO;iBACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAChC,CAAA;QACL,CAAC;KAAA;IAED,eAAe;QACX,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACxC,CAAC;IAED,aAAa;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACpE,CAAC;CACJ;AAlCD,0CAkCC"}
|