@flink-app/api-docs-plugin 0.11.0 → 0.11.4-next.0

package/dist/handlers/GetApiDocs.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response } from "express";
+declare const getApiDocs: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+export default getApiDocs;

package/dist/handlers/GetApiDocs.js

@@ -0,0 +1,44 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var getApiDocs = function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, res.send(200)];
+    });
+}); };
+exports.default = getApiDocs;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { FlinkPlugin } from "@flink-app/flink";
-export declare type ApiDocOptions = {
+export type ApiDocOptions = {
     /**
      * Path to where api docs can be accessed
      */

package/dist/index.js

@@ -19,7 +19,7 @@ function init(app, options) {
     }
     // NOTE: This will probably break if any other plugin "claims" pug as view engine
     expressApp.engine("pug", require("pug").__express);
-    expressApp.set("views", path_1.join(__dirname, "views"));
+    expressApp.set("views", (0, path_1.join)(__dirname, "views"));
     expressApp.set("view engine", "pug");
     expressApp === null || expressApp === void 0 ? void 0 : expressApp.get(options.path || "/docs", function (req, res) {
         var sortedHandlers = handlers.sort(function (routeA, routeB) {

package/package.json

@@ -1,30 +1,30 @@
 {
-  "name": "@flink-app/api-docs-plugin",
-  "version": "0.11.0",
-  "description": "Flink plugin that generates API documentation based on JSON schemas",
-  "scripts": {
-    "test": "echo \"Error: no test specified\"",
-    "prepublish": "tsc && npm run copy:assets",
-    "copy:assets": "mkdir -p dist/views && cp src/views/** dist/views/",
-    "watch": "npm run copy:assets && tsc-watch"
-  },
-  "author": "joel@frost.se",
-  "license": "MIT",
-  "types": "dist/index.d.ts",
-  "main": "dist/index.js",
-  "dependencies": {
-    "pug": "^3.0.2"
-  },
-  "devDependencies": {
-    "@flink-app/flink": "^0.11.0",
-    "@types/express": "^4.17.12",
-    "@types/got": "^9.6.11",
-    "@types/node": "^15.6.2",
-    "@types/pug": "^2.0.4",
-    "nodemon": "^2.0.7",
-    "ts-node": "^9.1.1",
-    "tsc-watch": "^4.2.9",
-    "typescript": "^4.2.4"
-  },
-  "gitHead": "3869def3e7e7e7105373ad31bc23a8ed68108015"
+    "name": "@flink-app/api-docs-plugin",
+    "version": "0.11.4-next.0",
+    "description": "Flink plugin that generates API documentation based on JSON schemas",
+    "scripts": {
+        "test": "echo \"Error: no test specified\"",
+        "prepublish": "tsc && npm run copy:assets",
+        "copy:assets": "mkdir -p dist/views && cp src/views/** dist/views/",
+        "watch": "npm run copy:assets && tsc-watch"
+    },
+    "author": "joel@frost.se",
+    "license": "MIT",
+    "types": "dist/index.d.ts",
+    "main": "dist/index.js",
+    "dependencies": {
+        "pug": "^3.0.2"
+    },
+    "devDependencies": {
+        "@flink-app/flink": "^0.11.4-next.0",
+        "@types/express": "^4.17.12",
+        "@types/got": "^9.6.11",
+        "@types/node": "^22.10.1",
+        "@types/pug": "^2.0.4",
+        "nodemon": "^2.0.7",
+        "ts-node": "^9.1.1",
+        "tsc-watch": "^4.2.9",
+        "typescript": "5.6.2"
+    },
+    "gitHead": "6a44df1b6601c86ea3402750b939784d003202c3"
 }