@kaapi/kaapi 0.0.11 → 0.0.12

package/lib/services/plugin.d.ts

@@ -2,6 +2,21 @@ import { HandlerDecorations, InternalRouteOptionType, Lifecycle, MergeType, ReqR
 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';
+/**
+ *
+ * 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;
@@ -11,6 +26,37 @@ export interface KaapiTools {
     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
+ * app.extend(plugin)
+ * // or
+ * 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 | Promise<void>;
+}

package/lib/services/plugin.js

@@ -1,3 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthDesign = void 0;
+const tslib_1 = require("tslib");
+const api_doc_generator_1 = require("@novice1/api-doc-generator");
+/**
+ * AuthDesign plugin
+ */
+class AuthDesign {
+    integrate(t) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            yield this.integrateStrategy(t);
+            const securityScheme = this.docs();
+            if (securityScheme) {
+                (_a = t.openapi) === null || _a === void 0 ? void 0 : _a.addSecurityScheme(securityScheme).setDefaultSecurity(securityScheme);
+                if (securityScheme instanceof api_doc_generator_1.OAuth2Util && !securityScheme.getHost() && ((_b = t.postman) === null || _b === void 0 ? void 0 : _b.getHost().length)) {
+                    securityScheme.setHost(t.postman.getHost()[0]);
+                }
+                (_c = t.postman) === null || _c === void 0 ? void 0 : _c.setDefaultSecurity(securityScheme);
+            }
+            yield this.integrateHook(t);
+        });
+    }
+    /**
+     * Whatever needs to be done to complete the integration.
+     * (e.g.: register a route, ...)
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    integrateHook(_t) {
+    }
+}
+exports.AuthDesign = AuthDesign;
 //# sourceMappingURL=plugin.js.map

package/lib/services/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/services/plugin.ts"],"names":[],"mappings":""}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/services/plugin.ts"],"names":[],"mappings":";;;;AAKA,kEAAwD;AAoDxD;;GAEG;AACH,MAAsB,UAAU;IACtB,SAAS,CAAC,CAAa;;;YAEzB,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAA;YAE/B,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;YAClD,CAAC;YAED,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;QAC/B,CAAC;KAAA;IAED;;;OAGG;IACH,6DAA6D;IAC7D,aAAa,CAAC,EAAc;IAE5B,CAAC;CAWJ;AApCD,gCAoCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaapi/kaapi",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "private": false,
   "description": "TypeScript-based framework",
   "main": "lib/index.js",
@@ -26,7 +26,7 @@
     "swagger-ui-dist": "^5.27.1",
     "tslib": "^2.8.1",
     "winston": "^3.17.0",
-    "@kaapi/server": "^0.0.11"
+    "@kaapi/server": "^0.0.12"
   },
   "scripts": {
     "lint": "eslint .",