@kaapi/kaapi 0.0.12 → 0.0.14

package/lib/services/plugins/auth-designs/basic-auth-design.js

@@ -0,0 +1,88 @@
+"use strict";
+// BasicAuthDesign
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicAuthDesign = void 0;
+const tslib_1 = require("tslib");
+const boom_1 = tslib_1.__importDefault(require("@hapi/boom"));
+const api_doc_generator_1 = require("@novice1/api-doc-generator");
+const plugin_1 = require("../plugin");
+class BasicAuthDesign extends plugin_1.AuthDesign {
+    constructor(arg) {
+        super();
+        this.key = 'Authorization';
+        this.strategyName = 'basic-auth-design';
+        if (arg === null || arg === void 0 ? void 0 : arg.strategyName)
+            this.strategyName = arg.strategyName;
+        this.auth = (arg === null || arg === void 0 ? void 0 : arg.auth) ? Object.assign({}, arg.auth) : {};
+    }
+    setDescription(description) {
+        this.description = description;
+        return this;
+    }
+    getStrategyName() {
+        return this.strategyName;
+    }
+    getDescription() {
+        return this.description;
+    }
+    docs() {
+        const docs = new api_doc_generator_1.BasicAuthUtil(this.strategyName);
+        if (this.description) {
+            docs.setDescription(this.description);
+        }
+        return docs;
+    }
+    integrateStrategy(t) {
+        const strategyName = this.strategyName;
+        t.scheme(strategyName, (_server, options) => {
+            return {
+                authenticate: (request, h) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    var _a;
+                    const settings = options || {};
+                    const authorization = request.raw.req.headers[this.key.toLowerCase()];
+                    const authSplit = typeof authorization === 'string' ? authorization.split(/\s+/) : ['', ''];
+                    const tokenType = authSplit[0];
+                    let token = authSplit[1];
+                    if (tokenType.toLowerCase() !== 'basic') {
+                        token = '';
+                        return boom_1.default.unauthorized(null, strategyName);
+                    }
+                    const [username, password] = Buffer.from(token, 'base64').toString().split(':', 2);
+                    if (settings.validate) {
+                        try {
+                            const result = yield ((_a = settings.validate) === null || _a === void 0 ? void 0 : _a.call(settings, request, username, password, h));
+                            if (result && 'isAuth' in result) {
+                                return result;
+                            }
+                            if (result && 'isBoom' in result) {
+                                return result;
+                            }
+                            if (result) {
+                                const { isValid, credentials, artifacts, message } = result;
+                                if (isValid && credentials) {
+                                    return h.authenticated({ credentials, artifacts });
+                                }
+                                if (message) {
+                                    return h.unauthenticated(boom_1.default.unauthorized(message, 'Basic'), {
+                                        credentials: credentials || {},
+                                        artifacts
+                                    });
+                                }
+                            }
+                        }
+                        catch (err) {
+                            return boom_1.default.internal(err instanceof Error ? err : `${err}`);
+                        }
+                    }
+                    return boom_1.default.unauthorized(null, 'Basic');
+                }),
+            };
+        });
+        t.strategy(strategyName, strategyName, this.auth);
+    }
+    toString() {
+        return this.getStrategyName();
+    }
+}
+exports.BasicAuthDesign = BasicAuthDesign;
+//# sourceMappingURL=basic-auth-design.js.map

package/lib/services/plugins/auth-designs/basic-auth-design.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-auth-design.js","sourceRoot":"","sources":["../../../../src/services/plugins/auth-designs/basic-auth-design.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;;AAElB,8DAA8B;AAS9B,kEAA2D;AAC3D,sCAGmB;AAkBnB,MAAa,eAAgB,SAAQ,mBAAU;IAO3C,YACI,GAAkB;QAElB,KAAK,EAAE,CAAA;QARF,QAAG,GAAG,eAAe,CAAA;QACpB,iBAAY,GAAW,mBAAmB,CAAA;QAShD,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,YAAY;YACjB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,EAAC,CAAC,mBAAM,GAAG,CAAC,IAAI,EAAG,CAAC,CAAC,EAAE,CAAA;IAChD,CAAC;IAED,cAAc,CAAC,WAAmB;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,eAAe;QACX,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAI;QACA,MAAM,IAAI,GAAG,IAAI,iCAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAEjD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACzC,CAAC;QAED,OAAO,IAAI,CAAA;IACf,CAAC;IAED,iBAAiB,CAAC,CAAa;QAE3B,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QAEtC,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YAExC,OAAO;gBACH,YAAY,EAAE,CAAO,OAAO,EAAE,CAAC,EAAE,EAAE;;oBAE/B,MAAM,QAAQ,GAAqB,OAAO,IAAI,EAAE,CAAC;oBAEjD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;oBAGtE,MAAM,SAAS,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBAE5F,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;oBAC9B,IAAI,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;oBAExB,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;wBACtC,KAAK,GAAG,EAAE,CAAA;wBACV,OAAO,cAAI,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;oBAChD,CAAC;oBAED,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;oBAEnF,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;wBACpB,IAAI,CAAC;4BACD,MAAM,MAAM,GAAG,MAAM,CAAA,MAAA,QAAQ,CAAC,QAAQ,yDAAG,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA,CAAA;4BAExE,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;gCAC/B,OAAO,MAAM,CAAA;4BACjB,CAAC;4BAED,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;gCAC/B,OAAO,MAAM,CAAA;4BACjB,CAAC;4BAED,IAAI,MAAM,EAAE,CAAC;gCACT,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;gCAE5D,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;oCACzB,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;gCACtD,CAAC;gCAED,IAAI,OAAO,EAAE,CAAC;oCACV,OAAO,CAAC,CAAC,eAAe,CAAC,cAAI,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE;wCAC1D,WAAW,EAAE,WAAW,IAAI,EAAE;wCAC9B,SAAS;qCACZ,CAAC,CAAA;gCACN,CAAC;4BACL,CAAC;wBACL,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACX,OAAO,cAAI,CAAC,QAAQ,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;wBAC/D,CAAC;oBACL,CAAC;oBAED,OAAO,cAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;gBAC3C,CAAC,CAAA;aACJ,CAAA;QACL,CAAC,CAAC,CAAA;QACF,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,eAAe,EAAE,CAAA;IACjC,CAAC;CACJ;AA5GD,0CA4GC"}

package/lib/services/plugins/auth-designs/bearer-auth-design.d.ts

@@ -0,0 +1,29 @@
+import Boom from '@hapi/boom';
+import { Auth, AuthCredentials, ReqRef, ReqRefDefaults, Request, ResponseToolkit } from '@hapi/hapi';
+import { BearerUtil } from '@novice1/api-doc-generator';
+import { AuthDesign, KaapiTools } from '../plugin';
+export type BearerAuthOptions<Refs extends ReqRef = ReqRefDefaults> = {
+    validate?(request: Request<Refs>, token: string, h: ResponseToolkit<Refs>): Promise<{
+        isValid?: boolean;
+        artifacts?: unknown;
+        credentials?: AuthCredentials;
+        message?: string;
+    } | Auth | Boom.Boom>;
+};
+export interface BearerAuthArg {
+    auth?: BearerAuthOptions;
+    strategyName?: string;
+}
+export declare class BearerAuthDesign extends AuthDesign {
+    readonly key = "Authorization";
+    protected strategyName: string;
+    protected description?: string;
+    protected auth: BearerAuthOptions;
+    constructor(arg?: BearerAuthArg);
+    setDescription(description: string): this;
+    getStrategyName(): string;
+    getDescription(): string | undefined;
+    docs(): BearerUtil;
+    integrateStrategy(t: KaapiTools): void | Promise<void>;
+    toString(): string;
+}

package/lib/services/plugins/auth-designs/bearer-auth-design.js

@@ -0,0 +1,87 @@
+"use strict";
+// BearerAuthDesign
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BearerAuthDesign = void 0;
+const tslib_1 = require("tslib");
+const boom_1 = tslib_1.__importDefault(require("@hapi/boom"));
+const api_doc_generator_1 = require("@novice1/api-doc-generator");
+const plugin_1 = require("../plugin");
+class BearerAuthDesign extends plugin_1.AuthDesign {
+    constructor(arg) {
+        super();
+        this.key = 'Authorization';
+        this.strategyName = 'bearer-auth-design';
+        if (arg === null || arg === void 0 ? void 0 : arg.strategyName)
+            this.strategyName = arg.strategyName;
+        this.auth = (arg === null || arg === void 0 ? void 0 : arg.auth) ? Object.assign({}, arg.auth) : {};
+    }
+    setDescription(description) {
+        this.description = description;
+        return this;
+    }
+    getStrategyName() {
+        return this.strategyName;
+    }
+    getDescription() {
+        return this.description;
+    }
+    docs() {
+        const docs = new api_doc_generator_1.BearerUtil(this.strategyName);
+        if (this.description) {
+            docs.setDescription(this.description);
+        }
+        return docs;
+    }
+    integrateStrategy(t) {
+        const strategyName = this.strategyName;
+        t.scheme(strategyName, (_server, options) => {
+            return {
+                authenticate: (request, h) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    var _a;
+                    const settings = options || {};
+                    const authorization = request.raw.req.headers[this.key.toLowerCase()];
+                    const authSplit = typeof authorization === 'string' ? authorization.split(/\s+/) : ['', ''];
+                    const tokenType = authSplit[0];
+                    let token = authSplit[1];
+                    if (tokenType.toLowerCase() !== 'bearer') {
+                        token = '';
+                        return boom_1.default.unauthorized(null, strategyName);
+                    }
+                    if (settings.validate) {
+                        try {
+                            const result = yield ((_a = settings.validate) === null || _a === void 0 ? void 0 : _a.call(settings, request, token, h));
+                            if (result && 'isAuth' in result) {
+                                return result;
+                            }
+                            if (result && 'isBoom' in result) {
+                                return result;
+                            }
+                            if (result) {
+                                const { isValid, credentials, artifacts, message } = result;
+                                if (isValid && credentials) {
+                                    return h.authenticated({ credentials, artifacts });
+                                }
+                                if (message) {
+                                    return h.unauthenticated(boom_1.default.unauthorized(message, 'Bearer'), {
+                                        credentials: credentials || {},
+                                        artifacts
+                                    });
+                                }
+                            }
+                        }
+                        catch (err) {
+                            return boom_1.default.internal(err instanceof Error ? err : `${err}`);
+                        }
+                    }
+                    return boom_1.default.unauthorized(null, 'Bearer');
+                }),
+            };
+        });
+        t.strategy(strategyName, strategyName, this.auth);
+    }
+    toString() {
+        return this.getStrategyName();
+    }
+}
+exports.BearerAuthDesign = BearerAuthDesign;
+//# sourceMappingURL=bearer-auth-design.js.map

package/lib/services/plugins/auth-designs/bearer-auth-design.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bearer-auth-design.js","sourceRoot":"","sources":["../../../../src/services/plugins/auth-designs/bearer-auth-design.ts"],"names":[],"mappings":";AAAA,mBAAmB;;;;AAEnB,8DAA8B;AAS9B,kEAAwD;AACxD,sCAGmB;AAkBnB,MAAa,gBAAiB,SAAQ,mBAAU;IAO5C,YACI,GAAmB;QAEnB,KAAK,EAAE,CAAA;QARF,QAAG,GAAG,eAAe,CAAA;QACpB,iBAAY,GAAW,oBAAoB,CAAA;QASjD,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,YAAY;YACjB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,EAAC,CAAC,mBAAM,GAAG,CAAC,IAAI,EAAG,CAAC,CAAC,EAAE,CAAA;IAChD,CAAC;IAED,cAAc,CAAC,WAAmB;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,eAAe;QACX,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAI;QACA,MAAM,IAAI,GAAG,IAAI,8BAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAE9C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACzC,CAAC;QAED,OAAO,IAAI,CAAA;IACf,CAAC;IAED,iBAAiB,CAAC,CAAa;QAE3B,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QAEtC,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YAExC,OAAO;gBACH,YAAY,EAAE,CAAO,OAAO,EAAE,CAAC,EAAE,EAAE;;oBAE/B,MAAM,QAAQ,GAAsB,OAAO,IAAI,EAAE,CAAC;oBAElD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;oBAGtE,MAAM,SAAS,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBAE5F,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;oBAC9B,IAAI,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;oBAExB,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,QAAQ,EAAE,CAAC;wBACvC,KAAK,GAAG,EAAE,CAAA;wBACV,OAAO,cAAI,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;oBAChD,CAAC;oBAED,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;wBACpB,IAAI,CAAC;4BACD,MAAM,MAAM,GAAG,MAAM,CAAA,MAAA,QAAQ,CAAC,QAAQ,yDAAG,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA,CAAA;4BAE3D,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;gCAC/B,OAAO,MAAM,CAAA;4BACjB,CAAC;4BAED,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;gCAC/B,OAAO,MAAM,CAAA;4BACjB,CAAC;4BAED,IAAI,MAAM,EAAE,CAAC;gCACT,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;gCAE5D,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;oCACzB,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;gCACtD,CAAC;gCAED,IAAI,OAAO,EAAE,CAAC;oCACV,OAAO,CAAC,CAAC,eAAe,CAAC,cAAI,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;wCAC3D,WAAW,EAAE,WAAW,IAAI,EAAE;wCAC9B,SAAS;qCACZ,CAAC,CAAA;gCACN,CAAC;4BACL,CAAC;wBACL,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACX,OAAO,cAAI,CAAC,QAAQ,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAA;wBAC/D,CAAC;oBACL,CAAC;oBAED,OAAO,cAAI,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;gBAC5C,CAAC,CAAA;aACJ,CAAA;QACL,CAAC,CAAC,CAAA;QACF,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,eAAe,EAAE,CAAA;IACjC,CAAC;CACJ;AA1GD,4CA0GC"}

package/lib/services/plugins/plugin.d.ts

@@ -0,0 +1,88 @@
+import { HandlerDecorations, InternalRouteOptionType, Lifecycle, MergeType, ReqRef, ReqRefDefaults, RouteOptionTypes, Server, ServerAuthScheme } from '@hapi/hapi';
+import { ILogger } from '../log';
+import { KaapiServerRoute } from '@kaapi/server';
+import { KaapiOpenAPI, KaapiPostman } from '../docs/generators';
+import { BaseAuthUtil } from '@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils';
+import { KaapiGroupAuthUtil } from '../docs/utils';
+/**
+ *
+ * Set of tools
+ *
+ * ```ts
+ * log
+ * openapi
+ * postman
+ * server
+ * route(...)
+ * scheme(...)
+ * strategy(...)
+ * ```
+ */
+export interface KaapiTools {
+    readonly log: ILogger;
+    route<Refs extends ReqRef = ReqRefDefaults>(serverRoute: KaapiServerRoute<Refs>, handler?: HandlerDecorations | Lifecycle.Method<Refs, Lifecycle.ReturnValue<Refs>>): this;
+    openapi?: KaapiOpenAPI;
+    postman?: KaapiPostman;
+    scheme<Refs extends ReqRef = ReqRefDefaults, Options extends object = {}>(name: string, scheme: ServerAuthScheme<Options, Refs>): void;
+    strategy(name: MergeType<InternalRouteOptionType, RouteOptionTypes>['Strategy'], scheme: string, options?: object): void;
+    server: Server;
+}
+/**
+ * Interface to extend kaapi app functionalities.
+ * ```ts
+ * const app = new Kaapi({
+ *   extend: [plugin]
+ * })
+ * // or
+ * await app.extend(plugin)
+ * // or
+ * await app.extend([plugin1, plugin2])
+ * ```
+ */
+export interface KaapiPlugin {
+    integrate(t: KaapiTools): void | Promise<void>;
+}
+/**
+ * AuthDesign plugin
+ */
+export declare abstract class AuthDesign implements KaapiPlugin {
+    integrate(t: KaapiTools): Promise<void>;
+    /**
+     * Whatever needs to be done to complete the integration.
+     * (e.g.: register a route, ...)
+     */
+    integrateHook(_t: KaapiTools): void | Promise<void>;
+    /**
+     * Returns the schema used for the documentation
+     */
+    abstract docs(): BaseAuthUtil | undefined;
+    /**
+     * Where authentication schemes and strategies should be registered.
+     */
+    abstract integrateStrategy(t: KaapiTools): void;
+    /**
+     * The name of the strategy, for info purpose
+     */
+    abstract getStrategyName(): string;
+}
+/**
+ * An auth design that groups multiple auth designs.
+ *
+ * Usefull to regroup the auth schemes in the documentation and register the strategies in parallel.
+ * ```ts
+ * const authdesigns = new GroupAuthDesign([
+ *     authdesign1,
+ *     authdesign2
+ * ])
+ * app.extend(authdesigns)
+ * ```
+ */
+export declare class GroupAuthDesign extends AuthDesign {
+    protected designs: AuthDesign[];
+    constructor(designs: AuthDesign[]);
+    docs(): KaapiGroupAuthUtil;
+    integrateStrategy(t: KaapiTools): void;
+    integrateHook(t: KaapiTools): Promise<void>;
+    getStrategyName(): string;
+    getStrategies(): string[];
+}

package/lib/services/plugins/plugin.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupAuthDesign = exports.AuthDesign = void 0;
+const tslib_1 = require("tslib");
+const api_doc_generator_1 = require("@novice1/api-doc-generator");
+const utils_1 = require("../docs/utils");
+/**
+ * AuthDesign plugin
+ */
+class AuthDesign {
+    integrate(t) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            try {
+                this.integrateStrategy(t);
+                t.log.debug(`Auth Design "${this.constructor.name}" set strategy (integrateStrategy).`);
+            }
+            catch (err) {
+                t.log.error(`Auth Design "${this.constructor.name}" failed to integrate auth strategy: ${err}`);
+                throw err;
+            }
+            const securityScheme = this.docs();
+            if (securityScheme) {
+                if (securityScheme instanceof api_doc_generator_1.OAuth2Util && !securityScheme.getHost() && ((_a = t.postman) === null || _a === void 0 ? void 0 : _a.getHost().length)) {
+                    securityScheme.setHost(t.postman.getHost()[0]);
+                }
+                (_b = t.openapi) === null || _b === void 0 ? void 0 : _b.addSecurityScheme(securityScheme).setDefaultSecurity(securityScheme);
+                (_c = t.postman) === null || _c === void 0 ? void 0 : _c.setDefaultSecurity(securityScheme);
+                t.log.debug(`Auth Design "${this.constructor.name}" set security scheme (docs).`);
+            }
+            else {
+                t.log.warn(`Auth Design "${this.constructor.name}" did not provide a security scheme (docs()).`);
+            }
+            yield this.integrateHook(t);
+        });
+    }
+    /**
+     * Whatever needs to be done to complete the integration.
+     * (e.g.: register a route, ...)
+     */
+    integrateHook(_t) {
+    }
+}
+exports.AuthDesign = AuthDesign;
+/**
+ * An auth design that groups multiple auth designs.
+ *
+ * Usefull to regroup the auth schemes in the documentation and register the strategies in parallel.
+ * ```ts
+ * const authdesigns = new GroupAuthDesign([
+ *     authdesign1,
+ *     authdesign2
+ * ])
+ * app.extend(authdesigns)
+ * ```
+ */
+class GroupAuthDesign extends AuthDesign {
+    constructor(designs) {
+        super();
+        this.designs = designs;
+    }
+    docs() {
+        return new utils_1.KaapiGroupAuthUtil(this.designs
+            .map(d => d.docs())
+            .filter(d => typeof d != 'undefined'));
+    }
+    integrateStrategy(t) {
+        for (const d of this.designs) {
+            d.integrateStrategy(t);
+        }
+    }
+    integrateHook(t) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            yield Promise.all(this.designs
+                .map(d => d.integrateHook(t)));
+        });
+    }
+    getStrategyName() {
+        return this.getStrategies()[0] || '';
+    }
+    getStrategies() {
+        return this.designs.map(d => d.getStrategyName()).filter(n => n);
+    }
+}
+exports.GroupAuthDesign = GroupAuthDesign;
+//# sourceMappingURL=plugin.js.map

package/lib/services/plugins/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/services/plugins/plugin.ts"],"names":[],"mappings":";;;;AAKA,kEAAwD;AACxD,yCAAmD;AAoDnD;;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,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,iBAAiB,CAAC,cAAc,EACtC,kBAAkB,CAAC,cAAc,CAAC,CAAC;gBACxC,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,aAAa,CAAC,EAAc;IAE5B,CAAC;CAgBJ;AAjDD,gCAiDC;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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaapi/kaapi",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "private": false,
   "description": "TypeScript-based framework",
   "main": "lib/index.js",
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "@hapi/boom": "^10.0.1",
-    "@hapi/hapi": "^21.4.2",
+    "@hapi/hapi": "^21.4.3",
     "@hapi/hoek": "^11.0.7",
     "@hapi/inert": "^7.1.0",
     "@novice1/api-doc-generator": "^1.0.2",
@@ -26,7 +26,7 @@
     "swagger-ui-dist": "^5.27.1",
     "tslib": "^2.8.1",
     "winston": "^3.17.0",
-    "@kaapi/server": "^0.0.12"
+    "@kaapi/server": "^0.0.14"
   },
   "scripts": {
     "lint": "eslint .",

package/types/overrides.d.ts

@@ -1,8 +1,11 @@
+import '@hapi/hapi'
+
 declare module '@hapi/hapi' {
   interface PluginSpecificConfiguration {
     kaapi?: {
       docs?: {
         disabled?: boolean;
+        story?: string;
       } | false
     };
   }