@necessarylion/adonis-autoswagger 0.0.3 → 0.0.5

package/dist/ui.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UIService = void 0;
+const scalar_custom_css_1 = require("./scalar_custom_css");
+class UIService {
+    /**
+     * Swagger UI
+     * @param url string
+     * @param options options
+     * @returns
+     */
+    ui(url, options) {
+        const persistAuthString = options?.persistAuthorization
+            ? "persistAuthorization: true,"
+            : "";
+        return `<!DOCTYPE html>
+		<html lang="en">
+		<head>
+				<meta charset="UTF-8">
+				<meta name="viewport" content="width=device-width, initial-scale=1.0">
+				<meta http-equiv="X-UA-Compatible" content="ie=edge">
+				<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.1.3/swagger-ui-standalone-preset.js"></script>
+				<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.1.3/swagger-ui-bundle.js"></script>
+				<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.1.3/swagger-ui.css" />
+				<title>Documentation</title>
+		</head>
+		<body>
+				<div id="swagger-ui"></div>
+				<script>
+						window.onload = function() {
+							SwaggerUIBundle({
+								url: "${url}",
+								dom_id: '#swagger-ui',
+								presets: [
+									SwaggerUIBundle.presets.apis,
+									SwaggerUIStandalonePreset
+								],
+								layout: "BaseLayout",
+                ${persistAuthString}
+							})
+						}
+				</script>
+		</body>
+		</html>`;
+    }
+    /**
+     * Rapidoc UI
+     * @param url string
+     * @param style string
+     * @returns
+     */
+    rapidoc(url, style = "view") {
+        return (`
+    <!doctype html> <!-- Important: must specify -->
+    <html>
+      <head>
+        <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 characters -->
+        <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+        <title>Documentation</title>
+      </head>
+      <body>
+        <rapi-doc
+          spec-url = "` +
+            url +
+            `"
+      theme = "dark"
+      bg-color = "#24283b"
+      schema-style="tree"
+      schema-expand-level = "10"
+      header-color = "#1a1b26"
+      allow-try = "true"
+      nav-hover-bg-color = "#1a1b26"
+      nav-bg-color = "#24283b"
+      text-color = "#c0caf5"
+      nav-text-color = "#c0caf5"
+      primary-color = "#9aa5ce"
+      heading-text = "Documentation"
+      sort-tags = "true"
+      render-style = "` +
+            style +
+            `"
+      default-schema-tab = "example"
+      show-components = "true"
+      allow-spec-url-load = "false"
+      allow-spec-file-load = "false"
+      sort-endpoints-by = "path"
+
+        > </rapi-doc>
+      </body>
+    </html>
+    `);
+    }
+    /**
+     * Scalar UI
+     * @param url string
+     * @param proxyUrl string
+     * @returns
+     */
+    scalar(url, proxyUrl = "https://proxy.scalar.com") {
+        return `
+      <!doctype html>
+      <html>
+        <head>
+          <title>API Reference</title>
+          <meta charset="utf-8" />
+          <meta
+            name="viewport"
+            content="width=device-width, initial-scale=1" />
+          <style>
+          ${scalar_custom_css_1.scalarCustomCss}
+          </style>
+        </head>
+        <body>
+          <div id="app"></div>
+          <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+          <script>
+            Scalar.createApiReference('#app', {
+              persistAuth: true,
+              url: '${url}',
+              proxyUrl: '${proxyUrl}',
+              theme: 'kepler',
+            })
+          </script>
+        </body>
+      </html>
+    `;
+    }
+    /**
+     * Stoplight UI
+     * @param url string
+     * @param theme "light" | "dark"
+     * @returns
+     */
+    stoplight(url, theme = "dark") {
+        return `
+      <!doctype html>
+      <html data-theme="${theme}">
+        <head>
+          <title>API Documentation - Stoplight</title>
+          <meta charset="utf-8" />
+          <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+		  <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
+          <link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css">
+        </head>
+        <body style="min-height:100vh">
+	      <elements-api
+		    style="display:block;height:100vh;width:100%;"
+		    apiDescriptionUrl=${url}
+		    router="hash"
+		    layout="sidebar"
+		  />
+        </body>
+      </html>
+    `;
+    }
+}
+exports.UIService = UIService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@necessarylion/adonis-autoswagger",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Auto-Generate swagger docs for AdonisJS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,4 +45,4 @@
     "arrowParens": "always"
   },
   "packageManager": "pnpm@8.11.0"
-}
+}

package/dist/adonishelpers.d.ts

@@ -1,6 +0,0 @@
-export declare function serializeV6Middleware(mw: any): string[];
-export declare function serializeV6Handler(handler: any): Promise<any>;
-export declare function parseBindingReference(binding: string | [any | any, any]): Promise<{
-    moduleNameOrPath: string;
-    method: string;
-}>;

package/dist/autoswagger.d.ts

@@ -1,30 +0,0 @@
-import type { options } from "./types";
-export declare class AutoSwagger {
-    private options;
-    private schemas;
-    private commentParser;
-    private modelParser;
-    private interfaceParser;
-    private enumParser;
-    private routeParser;
-    private validatorParser;
-    private customPaths;
-    ui(url: string, options?: options): string;
-    rapidoc(url: string, style?: string): string;
-    scalar(url: string, proxyUrl?: string): string;
-    stoplight(url: string, theme?: "light" | "dark"): string;
-    jsonToYaml(json: any): any;
-    json(routes: any, options: options): Promise<any>;
-    writeFile(routes: any, options: options): Promise<void>;
-    private readFile;
-    docs(routes: any, options: options): Promise<any>;
-    private generate;
-    private getDataBasedOnAdonisVersion;
-    private getSchemas;
-    private getValidators;
-    private getSerializers;
-    private getModels;
-    private getInterfaces;
-    private getFiles;
-    private getEnums;
-}

package/dist/parsers.d.ts

@@ -1,83 +0,0 @@
-import ExampleGenerator from "./example";
-import type { options } from "./types";
-import { VineValidator } from "@vinejs/vine";
-export declare class CommentParser {
-    private parsedFiles;
-    exampleGenerator: ExampleGenerator;
-    options: options;
-    constructor(options: options);
-    private parseAnnotations;
-    private parseParam;
-    private parseResponseHeader;
-    private parseResponseBody;
-    private parseRequestFormDataBody;
-    private parseBody;
-    arrayItems(json: any): {
-        oneOf: any[];
-        type?: undefined;
-    } | {
-        type: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-        oneOf?: undefined;
-    };
-    jsonToObj(json: any): {
-        type: string;
-        properties: {
-            [x: string]: any;
-        };
-    };
-    getAnnotations(file: string, action: string): Promise<{}>;
-}
-export declare class RouteParser {
-    options: options;
-    constructor(options: options);
-    extractInfos(p: string): {
-        tags: any[];
-        parameters: {};
-        pattern: string;
-    };
-}
-export declare class ModelParser {
-    exampleGenerator: ExampleGenerator;
-    snakeCase: boolean;
-    constructor(snakeCase: boolean);
-    parseModelProperties(data: any): {
-        name: string;
-        props: {};
-        required: any[];
-    };
-}
-export declare class ValidatorParser {
-    exampleGenerator: ExampleGenerator;
-    constructor();
-    validatorToObject(validator: VineValidator<any, any>): Promise<any>;
-    parsePropsAndMeta(obj: any, testObj: any, validator: VineValidator<any, any>): Promise<any>;
-    objToTest(obj: any): {};
-    parseSchema(json: any, refs: any): {
-        properties: {};
-    };
-    getType(type: string): string;
-    getMetaFromValidations(validations: any, refs: any): {
-        minimum?: number;
-        maximum?: number;
-        enum?: any;
-        pattern?: string;
-        example?: any;
-    };
-}
-export declare class InterfaceParser {
-    exampleGenerator: ExampleGenerator;
-    snakeCase: boolean;
-    schemas: any;
-    constructor(snakeCase: boolean, schemas?: any);
-    objToExample(obj: any): {};
-    parseProps(obj: any): {};
-    getInheritedProperties(baseType: string): any;
-    parseInterfaces(data: any): {};
-    parseExtends(line: string): string[];
-    parseType(type: string | any, field: string): any;
-}
-export declare class EnumParser {
-    constructor();
-    parseEnums(data: string): Record<string, any>;
-    private parseEnumValue;
-}