npm - azurajs-scalar - Versions diffs - 1.0.3 → 2.0.1 - Mend

azurajs-scalar 1.0.3 → 2.0.1

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.

Files changed (7) hide show

package/README.md CHANGED Viewed

@@ -48,44 +48,23 @@ import * from "./controllers"
 const app = new AzuraClient();
-const __filename = fileURLToPath(import.meta.url); // Optional
-const __dirname = path.dirname(__filename); // Optional
-const scalar = new Scalar({
-  apiSpecUrl: "http://localhost:4002/api-spec.json",
-  proxyUrl: "http://localhost:4002",
-  customHtmlPath: path.join(__dirname, "./public/html/api-docs.html"), // Optional
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const baseUrl = env.APP_URL || "http://localhost:4002";
+new Scalar({
+  apiSpecPath: "/api-spec.json",
+  proxyPath: "/scalar/proxy/",
+  docPath: "/docs/",
+  customHtmlPath: path.join(__dirname, "./public/html/api-docs.html"),
+  app,
+  baseUrl,
 });
 applyDecorators(app, Object.values(Controllers))
 ```
-### Controller Setup
-#### src/controllers/docs.controller.ts
-```ts
-import { Controller, Get, Res } from "azurajs/decorators";
-import { ResponseServer } from "azurajs/types";
-import { getScalarDocs } from "azurajs-scalar";
-@Controller("/docs")
-export class DocsController {
-  @Get("/")
-  scalarDocs(@Res() res: ResponseServer) {
-    getScalarDocs(res);
-  }
-}
-```
-### Export Controllers
-#### src/controllers/index.ts
-```ts
-export * from "./docs.controller.ts";
-```
 ---
 ## 🎨 Custom HTML Template

package/azurajs-scalar-2.0.0.tgz ADDED Viewed

Binary file

package/dist/api-docs.html CHANGED Viewed

@@ -1,41 +1,29 @@
-<!doctype html>
-<html>
-  <head>
-    <title>Versum API - Sistine Chapel Theme</title>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-  </head>
-  <body>
-    <div id="app">Carregando...</div>
-    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
-    <script>
-      fetch("&{api_spec_url}")
-        .then((res) => {
-          if (!res.ok) throw new Error(`HTTP ${res.status}`);
-          return res.json();
-        })
-        .then((spec) => {
-          console.log("Spec carregado:", spec);
-          Scalar.createApiReference("#app", {
-            spec: {
-              content: spec,
-            },
-            proxy: "&{proxy_url}",
-            theme: "default",
-          });
-        })
-        .catch((err) => {
-          console.error("Erro ao carregar spec:", err);
-          document.getElementById("app").innerHTML =
-            `<pre style="color: red; padding: 20px;">
-Erro ao carregar API spec: ${err.message}
-Verifique se a API está rodando em &{proxy_url}
-            </pre>`;
-        });
-    </script>
-  </body>
-</html>
+<!doctype html>
+<html>
+  <head>
+    <title>Scalar API Documentation</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+  </head>
+  <body>
+    <div id="app">Loading...</div>
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+    <script>
+      fetch("&{api_spec_url}")
+        .then(res => res.json())
+        .then(spec => {
+          Scalar.createApiReference("#app", {
+            spec: { content: spec },
+            proxy: "&{proxy_url}",
+            theme: "default"
+          });
+        })
+        .catch(err => {
+          document.getElementById("app").innerHTML =
+            `<pre>Error loading API spec: ${err.message}</pre>`;
+        });
+    </script>
+  </body>
+</html>

package/dist/index.d.ts CHANGED Viewed

@@ -1,70 +1,53 @@
+import { AzuraClient } from 'azurajs';
 import { RequestServer, ResponseServer, NextFunction } from 'azurajs/types';
 interface ScalarConfigType {
-    apiSpecUrl: string;
-    proxyUrl: string;
+    baseUrl: string;
+    proxyPath?: string;
+    docPath?: string;
+    apiSpecPath?: string;
     customHtmlPath?: string;
+    app: AzuraClient;
 }
 interface ScalarStoreType {
     proxy_url?: string;
     api_spec_url?: string;
+    doc_url?: string;
     custom_html_path?: string;
 }
 type ProxyMiddlewareType = (req: RequestServer, res: ResponseServer, next?: NextFunction) => Promise<void>;
+declare class ScalarError extends Error {
+    readonly message: string;
+    readonly code: string;
+    readonly statusCode: number;
+    constructor(message: string, code: string, statusCode: number);
+}
 interface ProxyOptions {
     apiSpecUrl: string;
+    proxyUrlPath: string;
+    app: AzuraClient;
+}
+interface SetupDocsRouteOptions extends ScalarConfigType {
+    docPath: string;
+    proxyUrl: string;
+    apiSpecUrl: string;
 }
 /**
- * @fileoverview Scalar client for API documentation proxy
- * This module provides a client for setting up API documentation with proxy capabilities
+ * Scalar client for API documentation
  */
-/**
- * Scalar client class for managing API documentation proxy
- */
 declare class Scalar {
-    /**
-     * Middleware function that handles proxying requests to the API specification
-     */
-    proxyMiddleware: ProxyMiddlewareType;
-    /**
-     * Creates a new Scalar client instance
-     * @param config Configuration object for the Scalar client
-     */
     constructor(config: ScalarConfigType);
-    /**
-     * Validates the provided configuration
-     * @param config Configuration object to validate
-     * @throws ScalarError if configuration is invalid
-     */
+    private joinUrl;
+    private normalizeBaseUrl;
     private validateConfig;
+    private isValidPath;
 }
-/**
- * @fileoverview Controller for serving Scalar API documentation
- * This module handles serving the API documentation HTML with proper URL replacements
- */
-/**
- * Serves the Scalar API documentation HTML page
- * Replaces placeholders in the HTML template with actual URLs from the store
- * @param res Response object to send the HTML to
- * @returns Promise that resolves when the response is sent
- */
-declare function getScalarDocs(res: ResponseServer): Promise<ResponseServer>;
-/**
- * @fileoverview Proxy middleware for API requests
- * This module provides a proxy middleware that forwards requests to the API specification
- */
+declare function setupScalarDocs({ app, docPath, customHtmlPath, apiSpecUrl, proxyUrl, }: SetupDocsRouteOptions): Promise<void>;
-/**
- * Creates a proxy middleware function that forwards requests to the API specification
- * @param options Configuration options for the proxy
- * @returns Middleware function that handles proxying requests
- */
-declare function proxyMiddleware({ apiSpecUrl, }: ProxyOptions): (req: RequestServer, res: ResponseServer, next?: NextFunction) => Promise<void>;
+declare function proxyMiddleware({ apiSpecUrl, app, proxyUrlPath, }: ProxyOptions): void;
 /**
  * @fileoverview Store utility for managing application state
@@ -113,4 +96,4 @@ declare class ScalarStore {
 }
 declare const store: ScalarStore;
-export { type ProxyMiddlewareType, Scalar, type ScalarConfigType, getScalarDocs, proxyMiddleware, store };
+export { type ProxyMiddlewareType, type ProxyOptions, Scalar, type ScalarConfigType, ScalarError, type ScalarStoreType, type SetupDocsRouteOptions, proxyMiddleware, setupScalarDocs, store };

package/dist/index.js CHANGED Viewed

@@ -2,6 +2,7 @@
 var ScalarError = class _ScalarError extends Error {
   constructor(message, code, statusCode) {
     super(message);
+    this.message = message;
     this.code = code;
     this.statusCode = statusCode;
     Object.setPrototypeOf(this, _ScalarError.prototype);
@@ -10,21 +11,53 @@ var ScalarError = class _ScalarError extends Error {
 // src/middleware/proxy.ts
 import { logger } from "azurajs/logger";
+// src/utils/debug.ts
+function debug(message, ...optionalParams) {
+  if (process.env.DEBUG === "true" || process.env.DEBUG === "1") {
+    console.log(`[DEBUG] ${message}`, ...optionalParams);
+  }
+}
+// src/middleware/proxy.ts
 function proxyMiddleware({
-  apiSpecUrl
+  apiSpecUrl,
+  app,
+  proxyUrlPath
 }) {
-  return async (req, res, _next) => {
+  debug("Setting up proxy middleware with options:", {
+    apiSpecUrl,
+    proxyUrlPath
+  });
+  app.get(proxyUrlPath, () => {
+  });
+  return app.use(proxyUrlPath, async (req, res) => {
+    debug("Proxy middleware hit with request:", req.method, req.url, "headers:", req.headers);
     try {
       if (!req.url || !req.method) {
-        res.status(400).json({
-          error: "Request URL and method are required",
-          code: "INVALID_REQUEST"
-        });
+        debug("Invalid request - missing url or method");
+        res.status(400).json({ error: "Invalid request" });
         return;
       }
       logger("info", `[PROXY] ${req.method} ${req.url}`);
-      const url = new URL(req.url, "http://localhost");
-      const targetUrl = apiSpecUrl + url.pathname + url.search;
+      const url = new URL(`http://localhost${req.url}`);
+      const scalarUrl = url.searchParams.get("scalar_url");
+      debug("Extracted scalar_url from query params:", scalarUrl);
+      const targetUrl = scalarUrl || apiSpecUrl + url.pathname + url.search;
+      debug("Determined target URL:", targetUrl);
+      const target = new URL(targetUrl);
+      const apiBase = new URL(apiSpecUrl);
+      debug(
+        "Validating same origin - target origin:",
+        target.origin,
+        "apiBase origin:",
+        apiBase.origin
+      );
+      if (target.origin !== apiBase.origin) {
+        logger("warn", `Blocked cross-origin: ${targetUrl}`);
+        res.status(403).json({ error: "Cross-origin blocked" });
+        return;
+      }
       logger("info", `[PROXY] Forwarding to: ${targetUrl}`);
       const headers = {};
       for (const [key, value] of Object.entries(req.headers)) {
@@ -32,50 +65,99 @@ function proxyMiddleware({
           headers[key] = Array.isArray(value) ? value.join(", ") : value;
         }
       }
-      headers.host = new URL(apiSpecUrl).host;
-      let body = null;
-      if (!["GET", "HEAD"].includes(req.method)) {
-        if (req.body) {
-          if (typeof req.body === "string") {
-            body = req.body;
-          } else if (typeof req.body === "object") {
-            body = JSON.stringify(req.body);
-          }
-        }
-      }
+      headers.host = apiBase.host;
+      debug("Prepared headers:", headers);
+      const body = ["GET", "HEAD"].includes(req.method) ? void 0 : typeof req.body === "string" ? req.body : JSON.stringify(req.body);
+      debug("Request body:", body);
+      debug("Making fetch request to target URL:", targetUrl);
       const proxyRes = await fetch(targetUrl, {
         method: req.method,
         headers,
         body
       });
-      logger("info", `[PROXY] Response: ${proxyRes.status}`);
-      const responseHeaders = {
-        "Access-Control-Allow-Origin": "*",
-        "Access-Control-Allow-Methods": "GET,POST,PUT,PATCH,DELETE,OPTIONS",
-        "Access-Control-Allow-Headers": "*"
-      };
+      debug(
+        "Fetch response received with status:",
+        proxyRes.status
+      );
+      res.setHeader("Access-Control-Allow-Origin", "*");
+      res.setHeader(
+        "Access-Control-Allow-Methods",
+        "GET,POST,PUT,PATCH,DELETE,OPTIONS"
+      );
+      res.setHeader("Access-Control-Allow-Headers", "*");
       for (const [key, value] of proxyRes.headers.entries()) {
         if (!key.toLowerCase().startsWith("access-control-")) {
-          responseHeaders[key] = value;
+          res.setHeader(key, value);
         }
       }
-      res.writeHead(proxyRes.status, responseHeaders);
       if (req.method === "OPTIONS") {
+        debug("OPTIONS request, ending response");
         res.end();
         return;
       }
       const buffer = Buffer.from(await proxyRes.arrayBuffer());
-      res.end(buffer);
+      debug(
+        "Response buffer created with length:",
+        buffer.length
+      );
+      res.send(buffer);
     } catch (err) {
+      debug("Error in proxy middleware:", err);
       logger("error", `[PROXY] Error: ${err}`);
-      res.writeHead(500, { "Content-Type": "application/json" });
-      res.end(JSON.stringify({
-        error: "Proxy error",
-        details: err instanceof Error ? err.message : String(err),
-        code: "PROXY_ERROR"
-      }));
+      res.status(500).json({ error: "Proxy error", details: String(err) });
+    }
+  });
+}
+// src/setupDocsRoute.ts
+import { logger as logger2 } from "azurajs/logger";
+import fs from "fs";
+import path from "path";
+async function setupScalarDocs({
+  app,
+  docPath,
+  customHtmlPath,
+  apiSpecUrl,
+  proxyUrl
+}) {
+  debug("Setting up docs route with options:", { docPath, customHtmlPath, apiSpecUrl, proxyUrl });
+  return app.get(docPath, (req, res) => {
+    debug("Docs route hit with request:", req.method, req.url);
+    try {
+      if (!proxyUrl || !apiSpecUrl) {
+        debug("Missing required URLs - proxyUrl:", proxyUrl, "apiSpecUrl:", apiSpecUrl);
+        throw new ScalarError(
+          "Missing required URLs",
+          "STORE_VALUES_MISSING",
+          500
+        );
+      }
+      const htmlPath = customHtmlPath || path.join(__dirname, "../api-docs.html");
+      debug("HTML template path:", htmlPath);
+      if (!fs.existsSync(htmlPath)) {
+        debug("HTML template not found at path:", htmlPath);
+        throw new ScalarError(
+          "HTML template not found",
+          "HTML_TEMPLATE_NOT_FOUND",
+          404
+        );
+      }
+      const html = fs.readFileSync(htmlPath, "utf-8");
+      debug("HTML template read successfully, length:", html.length);
+      const processedHtml = html.replace(/&{proxy_url}/g, proxyUrl).replace(/&{api_spec_url}/g, apiSpecUrl);
+      debug("HTML template processed with proxyUrl and apiSpecUrl");
+      return res.send(processedHtml);
+    } catch (error) {
+      debug("Error in docs route:", error);
+      if (error instanceof ScalarError) {
+        logger2("error", `[ScalarError] ${error.message}`);
+        return res.status(error.statusCode).json({ message: error.message });
+      } else {
+        logger2("error", String(error));
+        return res.status(500).json({ message: "Server error" });
+      }
     }
-  };
+  });
 }
 // src/utils/store.ts
@@ -137,109 +219,116 @@ var store = new ScalarStore();
 // src/client.ts
 var Scalar = class {
-  /**
-   * Creates a new Scalar client instance
-   * @param config Configuration object for the Scalar client
-   */
   constructor(config) {
-    this.validateConfig(config);
-    store.set("proxy_url", config.proxyUrl);
-    store.set("api_spec_url", config.apiSpecUrl);
-    store.set("custom_html_path", config.customHtmlPath);
-    this.proxyMiddleware = proxyMiddleware({ apiSpecUrl: config.apiSpecUrl });
+    debug("Scalar constructor called with config:", config);
+    const normalizedConfig = { ...config };
+    normalizedConfig.baseUrl = this.normalizeBaseUrl(config.baseUrl);
+    debug("Normalized config:", normalizedConfig);
+    this.validateConfig(normalizedConfig);
+    const proxyPath = normalizedConfig.proxyPath || "/scalar/proxy";
+    const docPath = normalizedConfig.docPath || "/docs";
+    const apiSpecPath = normalizedConfig.apiSpecPath || "";
+    debug(
+      "Using paths - proxyPath:",
+      proxyPath,
+      "docPath:",
+      docPath,
+      "apiSpecPath:",
+      apiSpecPath
+    );
+    const proxyUrl = this.joinUrl(normalizedConfig.baseUrl, proxyPath);
+    const docUrl = this.joinUrl(normalizedConfig.baseUrl, docPath);
+    const apiSpecUrl = this.joinUrl(normalizedConfig.baseUrl, apiSpecPath);
+    debug(
+      "Calculated URLs - proxyUrl:",
+      proxyUrl,
+      "docUrl:",
+      docUrl,
+      "apiSpecUrl:",
+      apiSpecUrl
+    );
+    store.set("proxy_url", proxyUrl);
+    store.set("api_spec_url", apiSpecUrl);
+    store.set("doc_url", docUrl);
+    debug("Stored URLs in store");
+    setupScalarDocs({
+      ...normalizedConfig,
+      proxyUrl,
+      docPath,
+      apiSpecUrl
+    });
+    debug("setupScalarDocs called");
+    proxyMiddleware({
+      apiSpecUrl,
+      proxyUrlPath: proxyPath,
+      app: normalizedConfig.app
+    });
+    debug("proxyMiddleware called");
   }
-  /**
-   * Validates the provided configuration
-   * @param config Configuration object to validate
-   * @throws ScalarError if configuration is invalid
-   */
-  validateConfig(config) {
-    if (!config.apiSpecUrl) {
+  joinUrl(baseUrl, path2) {
+    const normalizedBaseUrl = baseUrl.endsWith("/") ? baseUrl : baseUrl + "/";
+    const normalizedPath = path2.startsWith("/") ? path2 : "/" + path2;
+    return normalizedBaseUrl.replace(/\/$/, "") + normalizedPath;
+  }
+  normalizeBaseUrl(baseUrl) {
+    if (!baseUrl) {
       throw new ScalarError(
-        "apiSpecUrl is required",
-        "MISSING_API_SPEC_URL",
+        "baseUrl is required",
+        "MISSING_REQUIRED_CONFIG",
         400
       );
     }
-    if (!config.proxyUrl) {
-      throw new ScalarError(
-        "proxyUrl is required",
-        "MISSING_PROXY_URL",
-        400
-      );
+    if (!/^https?:\/\//i.test(baseUrl)) {
+      return "http://" + baseUrl;
     }
-    try {
-      new URL(config.apiSpecUrl);
-    } catch (error) {
+    return baseUrl;
+  }
+  validateConfig(config) {
+    if (!config.baseUrl) {
       throw new ScalarError(
-        "apiSpecUrl must be a valid URL",
-        "INVALID_API_SPEC_URL",
+        "baseUrl is required",
+        "MISSING_REQUIRED_CONFIG",
         400
       );
     }
     try {
-      new URL(config.proxyUrl);
+      debug("Validating baseUrl:", config.baseUrl);
+      new URL(config.baseUrl);
+      if (config.proxyPath) {
+        debug("Validating proxyPath:", config.proxyPath);
+        if (!this.isValidPath(config.proxyPath)) {
+          debug("proxyPath validation FAILED");
+          throw new Error("Invalid proxyPath");
+        }
+      }
+      if (config.docPath) {
+        debug("Validating docPath:", config.docPath);
+        if (!this.isValidPath(config.docPath)) {
+          debug("docPath validation FAILED");
+          throw new Error("Invalid docPath");
+        }
+      }
+      if (config.apiSpecPath) {
+        debug("Validating apiSpecPath:", config.apiSpecPath);
+        if (!this.isValidPath(config.apiSpecPath)) {
+          debug("apiSpecPath validation FAILED");
+          throw new Error("Invalid apiSpecPath");
+        }
+      }
     } catch (error) {
-      throw new ScalarError(
-        "proxyUrl must be a valid URL",
-        "INVALID_PROXY_URL",
-        400
-      );
+      debug("Validation error:", error);
+      throw new ScalarError("Invalid URL provided", "INVALID_URL", 400);
     }
   }
-};
-// src/controller.ts
-import { fileURLToPath } from "url";
-import path from "path";
-import fs from "fs";
-import { logger as logger2 } from "azurajs/logger";
-var __filename = fileURLToPath(import.meta.url);
-var __dirname = path.dirname(__filename);
-async function getScalarDocs(res) {
-  try {
-    const customHtmlPath = store.get("custom_html_path");
-    const proxyUrl = store.get("proxy_url");
-    const apiSpecUrl = store.get("api_spec_url");
-    if (!proxyUrl || !apiSpecUrl) {
-      throw new ScalarError(
-        "Proxy URL or API Spec URL not defined in store",
-        "STORE_VALUES_MISSING",
-        500
-      );
-    }
-    const htmlPath = customHtmlPath || path.join(__dirname, "./api-docs.html");
-    if (!fs.existsSync(htmlPath)) {
-      throw new ScalarError(
-        `HTML template file not found at path: ${htmlPath}`,
-        "HTML_TEMPLATE_NOT_FOUND",
-        404
-      );
-    }
-    const html = fs.readFileSync(htmlPath, "utf-8");
-    const processedHtml = html.replace(/&{proxy_url}/g, proxyUrl).replace(/&{api_spec_url}/g, apiSpecUrl);
-    return res.send(processedHtml);
-  } catch (error) {
-    if (error instanceof ScalarError) {
-      logger2("error", `[ScalarError] ${error.message}`);
-      return res.status(error.statusCode).json({
-        message: error.message,
-        code: error.code
-      });
-    } else {
-      logger2("error", String(error));
-      return res.status(500).json({
-        message: "Internal server error occurred while serving documentation",
-        code: "INTERNAL_SERVER_ERROR"
-      });
-    }
+  isValidPath(path2) {
+    return typeof path2 === "string" && /^\/[a-zA-Z0-9\-._~:\/@!$&'()*+,;=]*\/?$/.test(path2);
   }
-}
+};
 export {
   Scalar,
   ScalarError,
-  getScalarDocs,
   proxyMiddleware,
+  setupScalarDocs,
   store
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/config/types.ts","../src/middleware/proxy.ts","../src/utils/store.ts","../src/client.ts","../src/controller.ts"],"sourcesContent":["import { NextFunction, RequestServer, ResponseServer } from \"azurajs/types\";\n\nexport interface ScalarConfigType {\n apiSpecUrl: string;\n proxyUrl: string;\n customHtmlPath?: string; // Optional since it might not always be provided\n}\n\nexport interface ScalarStoreType {\n proxy_url?: string;\n api_spec_url?: string;\n custom_html_path?: string;\n}\n\nexport type ProxyMiddlewareType = (\n req: RequestServer,\n res: ResponseServer,\n next?: NextFunction,\n) => Promise<void>;\n\n// Define specific error types\nexport class ScalarError extends Error {\n public readonly code: string;\n public readonly statusCode: number;\n\n constructor(message: string, code: string, statusCode: number) {\n super(message);\n this.code = code;\n this.statusCode = statusCode;\n Object.setPrototypeOf(this, ScalarError.prototype);\n }\n}\n\nexport interface ProxyOptions {\n apiSpecUrl: string;\n}\n","/*\n @fileoverview Proxy middleware for API requests\n * This module provides a proxy middleware that forwards requests to the API specification\n /\n\nimport { ProxyOptions } from \"../config/types\";\nimport { NextFunction, RequestServer, ResponseServer } from \"azurajs/types\";\nimport { logger } from \"azurajs/logger\";\n\n/\n Creates a proxy middleware function that forwards requests to the API specification\n * @param options Configuration options for the proxy\n * @returns Middleware function that handles proxying requests\n /\nexport function proxyMiddleware({\n apiSpecUrl,\n}: ProxyOptions): (\n req: RequestServer,\n res: ResponseServer,\n next?: NextFunction,\n) => Promise<void> {\n return async (\n req: RequestServer,\n res: ResponseServer,\n _next?: NextFunction,\n ): Promise<void> => {\n try {\n if (!req.url \|\| !req.method) {\n res.status(400).json({\n error: \"Request URL and method are required\",\n code: \"INVALID_REQUEST\"\n });\n return;\n }\n\n logger(\"info\", `[PROXY] ${req.method} ${req.url}`);\n\n const url = new URL(req.url, \"http://localhost\");\n const targetUrl = apiSpecUrl + url.pathname + url.search;\n\n logger(\"info\", `[PROXY] Forwarding to: ${targetUrl}`);\n\n // Convert Node.js headers to a format compatible with fetch\n const headers: Record<string, string> = {};\n for (const [key, value] of Object.entries(req.headers)) {\n if (value) {\n headers[key] = Array.isArray(value) ? value.join(\", \") : value;\n }\n }\n headers.host = new URL(apiSpecUrl).host;\n\n // Prepare request body\n let body: BodyInit \| null = null;\n if (![\"GET\", \"HEAD\"].includes(req.method)) {\n // For non-GET/HEAD requests, we need to properly serialize the body\n // Since req might contain various data types, we need to handle appropriately\n if (req.body) {\n if (typeof req.body === 'string') {\n body = req.body;\n } else if (typeof req.body === 'object') {\n body = JSON.stringify(req.body);\n }\n }\n }\n\n const proxyRes = await fetch(targetUrl, {\n method: req.method,\n headers,\n body,\n });\n\n logger(\"info\", `[PROXY] Response: ${proxyRes.status}`);\n\n // CORS - IMPORTANT: define before copying response headers\n const responseHeaders: Record<string, string> = {\n \"Access-Control-Allow-Origin\": \"\",\n \"Access-Control-Allow-Methods\": \"GET,POST,PUT,PATCH,DELETE,OPTIONS\",\n \"Access-Control-Allow-Headers\": \"\",\n };\n\n // Copy response headers, avoiding CORS header conflicts\n for (const [key, value] of proxyRes.headers.entries()) {\n // Don't overwrite CORS headers\n if (!key.toLowerCase().startsWith(\"access-control-\")) {\n responseHeaders[key] = value;\n }\n }\n\n res.writeHead(proxyRes.status, responseHeaders);\n\n if (req.method === \"OPTIONS\") {\n res.end();\n return;\n }\n\n const buffer = Buffer.from(await proxyRes.arrayBuffer());\n res.end(buffer);\n } catch (err) {\n logger(\"error\", `[PROXY] Error: ${err}`);\n res.writeHead(500, { \"Content-Type\": \"application/json\" });\n res.end(JSON.stringify({\n error: \"Proxy error\",\n details: err instanceof Error ? err.message : String(err),\n code: \"PROXY_ERROR\"\n }));\n }\n };\n}\n","/\n @fileoverview Store utility for managing application state\n * This module provides a typed store for managing scalar configuration values\n /\n\nimport { ScalarStoreType } from \"../config/types\";\n\n/\n Typed store class for managing scalar configuration values\n /\nclass ScalarStore {\n private store: Map<keyof ScalarStoreType, string \| undefined> = new Map();\n\n /\n Sets a value in the store\n * @param key The key to set\n * @param value The value to set (if undefined, the key will be removed)\n /\n set<K extends keyof ScalarStoreType>(key: K, value: ScalarStoreType[K]): void {\n this.store.set(key, value as string \| undefined);\n }\n\n /\n Gets a value from the store\n * @param key The key to get\n * @returns The value associated with the key\n /\n get<K extends keyof ScalarStoreType>(key: K): ScalarStoreType[K] {\n return this.store.get(key) as ScalarStoreType[K];\n }\n\n /\n Checks if a key exists in the store\n * @param key The key to check\n * @returns True if the key exists, false otherwise\n /\n has(key: keyof ScalarStoreType): boolean {\n return this.store.has(key);\n }\n\n /\n Deletes a key from the store\n * @param key The key to delete\n * @returns True if the key existed and was deleted, false otherwise\n /\n delete(key: keyof ScalarStoreType): boolean {\n return this.store.delete(key);\n }\n\n /\n Clears all values from the store\n /\n clear(): void {\n this.store.clear();\n }\n\n /\n Gets all values from the store\n * @returns An object containing all key-value pairs in the store\n /\n getAll(): ScalarStoreType {\n const result: Partial<ScalarStoreType> = {};\n for (const [key, value] of this.store.entries()) {\n result[key] = value as ScalarStoreType[keyof ScalarStoreType];\n }\n return result as ScalarStoreType;\n }\n\n // Index signature to allow direct property access\n [key: string]: any;\n}\n\nexport const store = new ScalarStore();\n","/\n @fileoverview Scalar client for API documentation proxy\n * This module provides a client for setting up API documentation with proxy capabilities\n /\n\nimport { ProxyMiddlewareType, ScalarConfigType, ScalarError } from \"./config/types\";\nimport { proxyMiddleware } from \"./middleware/proxy\";\nimport { store } from \"./utils/store\";\n\n/\n Scalar client class for managing API documentation proxy\n /\nexport class Scalar {\n /\n Middleware function that handles proxying requests to the API specification\n /\n public proxyMiddleware: ProxyMiddlewareType;\n\n /\n Creates a new Scalar client instance\n * @param config Configuration object for the Scalar client\n /\n constructor(config: ScalarConfigType) {\n this.validateConfig(config);\n\n store.set(\"proxy_url\", config.proxyUrl);\n store.set(\"api_spec_url\", config.apiSpecUrl);\n store.set(\"custom_html_path\", config.customHtmlPath);\n\n this.proxyMiddleware = proxyMiddleware({ apiSpecUrl: config.apiSpecUrl });\n }\n\n /\n Validates the provided configuration\n * @param config Configuration object to validate\n * @throws ScalarError if configuration is invalid\n /\n private validateConfig(config: ScalarConfigType): void {\n if (!config.apiSpecUrl) {\n throw new ScalarError(\n \"apiSpecUrl is required\",\n \"MISSING_API_SPEC_URL\",\n 400\n );\n }\n\n if (!config.proxyUrl) {\n throw new ScalarError(\n \"proxyUrl is required\",\n \"MISSING_PROXY_URL\",\n 400\n );\n }\n\n try {\n new URL(config.apiSpecUrl);\n } catch (error) {\n throw new ScalarError(\n \"apiSpecUrl must be a valid URL\",\n \"INVALID_API_SPEC_URL\",\n 400\n );\n }\n\n try {\n new URL(config.proxyUrl);\n } catch (error) {\n throw new ScalarError(\n \"proxyUrl must be a valid URL\",\n \"INVALID_PROXY_URL\",\n 400\n );\n }\n }\n}\n","/\n @fileoverview Controller for serving Scalar API documentation\n * This module handles serving the API documentation HTML with proper URL replacements\n /\n\nimport { fileURLToPath } from \"node:url\";\nimport path from \"node:path\";\nimport fs from \"fs\";\nimport { logger } from \"azurajs/logger\";\nimport { ResponseServer } from \"azurajs/types\";\nimport { store } from \"./utils/store\";\nimport { ScalarError } from \"./config/types\";\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = path.dirname(__filename);\n\n/\n Serves the Scalar API documentation HTML page\n * Replaces placeholders in the HTML template with actual URLs from the store\n * @param res Response object to send the HTML to\n * @returns Promise that resolves when the response is sent\n */\nexport async function getScalarDocs(res: ResponseServer) {\n try {\n const customHtmlPath = store.get(\"custom_html_path\");\n const proxyUrl = store.get(\"proxy_url\");\n const apiSpecUrl = store.get(\"api_spec_url\");\n\n if (!proxyUrl \|\| !apiSpecUrl) {\n throw new ScalarError(\n \"Proxy URL or API Spec URL not defined in store\",\n \"STORE_VALUES_MISSING\",\n 500\n );\n }\n\n const htmlPath = customHtmlPath \|\| path.join(__dirname, \"./api-docs.html\");\n\n if (!fs.existsSync(htmlPath)) {\n throw new ScalarError(\n `HTML template file not found at path: ${htmlPath}`,\n \"HTML_TEMPLATE_NOT_FOUND\",\n 404\n );\n }\n\n const html = fs.readFileSync(htmlPath, \"utf-8\");\n const processedHtml = html\n .replace(/&{proxy_url}/g, proxyUrl)\n .replace(/&{api_spec_url}/g, apiSpecUrl);\n\n return res.send(processedHtml);\n } catch (error) {\n if (error instanceof ScalarError) {\n logger(\"error\", `[ScalarError] ${error.message}`);\n return res.status(error.statusCode).json({\n message: error.message,\n code: error.code,\n });\n } else {\n logger(\"error\", String(error));\n return res.status(500).json({\n message: \"Internal server error occurred while serving documentation\",\n code: \"INTERNAL_SERVER_ERROR\",\n });\n }\n }\n}\n"],"mappings":";AAqBO,IAAM,cAAN,MAAM,qBAAoB,MAAM;AAAA,EAIrC,YAAY,SAAiB,MAAc,YAAoB;AAC7D,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,aAAa;AAClB,WAAO,eAAe,MAAM,aAAY,SAAS;AAAA,EACnD;AACF;;;ACxBA,SAAS,cAAc;AAOhB,SAAS,gBAAgB;AAAA,EAC9B;AACF,GAImB;AACjB,SAAO,OACL,KACA,KACA,UACkB;AAClB,QAAI;AACF,UAAI,CAAC,IAAI,OAAO,CAAC,IAAI,QAAQ;AAC3B,YAAI,OAAO,GAAG,EAAE,KAAK;AAAA,UACnB,OAAO;AAAA,UACP,MAAM;AAAA,QACR,CAAC;AACD;AAAA,MACF;AAEA,aAAO,QAAQ,WAAW,IAAI,MAAM,IAAI,IAAI,GAAG,EAAE;AAEjD,YAAM,MAAM,IAAI,IAAI,IAAI,KAAK,kBAAkB;AAC/C,YAAM,YAAY,aAAa,IAAI,WAAW,IAAI;AAElD,aAAO,QAAQ,0BAA0B,SAAS,EAAE;AAGpD,YAAM,UAAkC,CAAC;AACzC,iBAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,OAAO,GAAG;AACtD,YAAI,OAAO;AACT,kBAAQ,GAAG,IAAI,MAAM,QAAQ,KAAK,IAAI,MAAM,KAAK,IAAI,IAAI;AAAA,QAC3D;AAAA,MACF;AACA,cAAQ,OAAO,IAAI,IAAI,UAAU,EAAE;AAGnC,UAAI,OAAwB;AAC5B,UAAI,CAAC,CAAC,OAAO,MAAM,EAAE,SAAS,IAAI,MAAM,GAAG;AAGzC,YAAI,IAAI,MAAM;AACZ,cAAI,OAAO,IAAI,SAAS,UAAU;AAChC,mBAAO,IAAI;AAAA,UACb,WAAW,OAAO,IAAI,SAAS,UAAU;AACvC,mBAAO,KAAK,UAAU,IAAI,IAAI;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAEA,YAAM,WAAW,MAAM,MAAM,WAAW;AAAA,QACtC,QAAQ,IAAI;AAAA,QACZ;AAAA,QACA;AAAA,MACF,CAAC;AAED,aAAO,QAAQ,qBAAqB,SAAS,MAAM,EAAE;AAGrD,YAAM,kBAA0C;AAAA,QAC9C,+BAA+B;AAAA,QAC/B,gCAAgC;AAAA,QAChC,gCAAgC;AAAA,MAClC;AAGA,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS,QAAQ,QAAQ,GAAG;AAErD,YAAI,CAAC,IAAI,YAAY,EAAE,WAAW,iBAAiB,GAAG;AACpD,0BAAgB,GAAG,IAAI;AAAA,QACzB;AAAA,MACF;AAEA,UAAI,UAAU,SAAS,QAAQ,eAAe;AAE9C,UAAI,IAAI,WAAW,WAAW;AAC5B,YAAI,IAAI;AACR;AAAA,MACF;AAEA,YAAM,SAAS,OAAO,KAAK,MAAM,SAAS,YAAY,CAAC;AACvD,UAAI,IAAI,MAAM;AAAA,IAChB,SAAS,KAAK;AACZ,aAAO,SAAS,kBAAkB,GAAG,EAAE;AACvC,UAAI,UAAU,KAAK,EAAE,gBAAgB,mBAAmB,CAAC;AACzD,UAAI,IAAI,KAAK,UAAU;AAAA,QACrB,OAAO;AAAA,QACP,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,QACxD,MAAM;AAAA,MACR,CAAC,CAAC;AAAA,IACJ;AAAA,EACF;AACF;;;ACjGA,IAAM,cAAN,MAAkB;AAAA,EAAlB;AACE,SAAQ,QAAwD,oBAAI,IAAI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOxE,IAAqC,KAAQ,OAAiC;AAC5E,SAAK,MAAM,IAAI,KAAK,KAA2B;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAqC,KAA4B;AAC/D,WAAO,KAAK,MAAM,IAAI,GAAG;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,KAAqC;AACvC,WAAO,KAAK,MAAM,IAAI,GAAG;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAqC;AAC1C,WAAO,KAAK,MAAM,OAAO,GAAG;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AACZ,SAAK,MAAM,MAAM;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAA0B;AACxB,UAAM,SAAmC,CAAC;AAC1C,eAAW,CAAC,KAAK,KAAK,KAAK,KAAK,MAAM,QAAQ,GAAG;AAC/C,aAAO,GAAG,IAAI;AAAA,IAChB;AACA,WAAO;AAAA,EACT;AAIF;AAEO,IAAM,QAAQ,IAAI,YAAY;;;AC5D9B,IAAM,SAAN,MAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAUlB,YAAY,QAA0B;AACpC,SAAK,eAAe,MAAM;AAE1B,UAAM,IAAI,aAAa,OAAO,QAAQ;AACtC,UAAM,IAAI,gBAAgB,OAAO,UAAU;AAC3C,UAAM,IAAI,oBAAoB,OAAO,cAAc;AAEnD,SAAK,kBAAkB,gBAAgB,EAAE,YAAY,OAAO,WAAW,CAAC;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,eAAe,QAAgC;AACrD,QAAI,CAAC,OAAO,YAAY;AACtB,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,OAAO,UAAU;AACpB,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI;AACF,UAAI,IAAI,OAAO,UAAU;AAAA,IAC3B,SAAS,OAAO;AACd,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI;AACF,UAAI,IAAI,OAAO,QAAQ;AAAA,IACzB,SAAS,OAAO;AACd,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ACrEA,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AACjB,OAAO,QAAQ;AACf,SAAS,UAAAA,eAAc;AAKvB,IAAM,aAAa,cAAc,YAAY,GAAG;AAChD,IAAM,YAAY,KAAK,QAAQ,UAAU;AAQzC,eAAsB,cAAc,KAAqB;AACvD,MAAI;AACF,UAAM,iBAAiB,MAAM,IAAI,kBAAkB;AACnD,UAAM,WAAW,MAAM,IAAI,WAAW;AACtC,UAAM,aAAa,MAAM,IAAI,cAAc;AAE3C,QAAI,CAAC,YAAY,CAAC,YAAY;AAC5B,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAW,kBAAkB,KAAK,KAAK,WAAW,iBAAiB;AAEzE,QAAI,CAAC,GAAG,WAAW,QAAQ,GAAG;AAC5B,YAAM,IAAI;AAAA,QACR,yCAAyC,QAAQ;AAAA,QACjD;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,UAAM,OAAO,GAAG,aAAa,UAAU,OAAO;AAC9C,UAAM,gBAAgB,KACnB,QAAQ,iBAAiB,QAAQ,EACjC,QAAQ,oBAAoB,UAAU;AAEzC,WAAO,IAAI,KAAK,aAAa;AAAA,EAC/B,SAAS,OAAO;AACd,QAAI,iBAAiB,aAAa;AAChC,MAAAC,QAAO,SAAS,iBAAiB,MAAM,OAAO,EAAE;AAChD,aAAO,IAAI,OAAO,MAAM,UAAU,EAAE,KAAK;AAAA,QACvC,SAAS,MAAM;AAAA,QACf,MAAM,MAAM;AAAA,MACd,CAAC;AAAA,IACH,OAAO;AACL,MAAAA,QAAO,SAAS,OAAO,KAAK,CAAC;AAC7B,aAAO,IAAI,OAAO,GAAG,EAAE,KAAK;AAAA,QAC1B,SAAS;AAAA,QACT,MAAM;AAAA,MACR,CAAC;AAAA,IACH;AAAA,EACF;AACF;","names":["logger","logger"]}
1	+ {"version":3,"sources":["../src/config/types.ts","../src/middleware/proxy.ts","../src/utils/debug.ts","../src/setupDocsRoute.ts","../src/utils/store.ts","../src/client.ts"],"sourcesContent":["import { AzuraClient } from \"azurajs\";\nimport { NextFunction, RequestServer, ResponseServer } from \"azurajs/types\";\n\nexport interface ScalarConfigType {\n baseUrl: string;\n proxyPath?: string;\n docPath?: string;\n apiSpecPath?: string;\n customHtmlPath?: string;\n app: AzuraClient;\n}\n\nexport interface ScalarStoreType {\n proxy_url?: string;\n api_spec_url?: string;\n doc_url?: string;\n custom_html_path?: string;\n}\n\nexport type ProxyMiddlewareType = (\n req: RequestServer,\n res: ResponseServer,\n next?: NextFunction,\n) => Promise<void>;\n\nexport class ScalarError extends Error {\n constructor(\n public readonly message: string,\n public readonly code: string,\n public readonly statusCode: number,\n ) {\n super(message);\n Object.setPrototypeOf(this, ScalarError.prototype);\n }\n}\n\nexport interface ProxyOptions {\n apiSpecUrl: string;\n proxyUrlPath: string;\n app: AzuraClient;\n}\n\nexport interface SetupDocsRouteOptions extends ScalarConfigType {\n docPath: string;\n proxyUrl: string;\n apiSpecUrl: string;\n}\n","import { ProxyOptions } from \"../config/types\";\nimport { logger } from \"azurajs/logger\";\nimport { debug } from \"../utils/debug\";\n\nexport function proxyMiddleware({\n apiSpecUrl,\n app,\n proxyUrlPath,\n}: ProxyOptions) {\n debug(\"Setting up proxy middleware with options:\", {\n apiSpecUrl,\n proxyUrlPath,\n });\n app.get(proxyUrlPath, () => {});\n return app.use(proxyUrlPath, async (req, res) => {\n debug(\"Proxy middleware hit with request:\", req.method, req.url, \"headers:\", req.headers);\n try {\n if (!req.url \|\| !req.method) {\n debug(\"Invalid request - missing url or method\");\n res.status(400).json({ error: \"Invalid request\" });\n return;\n }\n\n logger(\"info\", `[PROXY] ${req.method} ${req.url}`);\n\n // Extract target URL from scalar_url query param\n const url = new URL(`http://localhost${req.url}`);\n const scalarUrl = url.searchParams.get(\"scalar_url\");\n debug(\"Extracted scalar_url from query params:\", scalarUrl);\n\n // Determine target URL\n const targetUrl = scalarUrl \|\| apiSpecUrl + url.pathname + url.search;\n debug(\"Determined target URL:\", targetUrl);\n\n // Validate same origin for security\n const target = new URL(targetUrl);\n const apiBase = new URL(apiSpecUrl);\n debug(\n \"Validating same origin - target origin:\",\n target.origin,\n \"apiBase origin:\",\n apiBase.origin,\n );\n if (target.origin !== apiBase.origin) {\n logger(\"warn\", `Blocked cross-origin: ${targetUrl}`);\n res.status(403).json({ error: \"Cross-origin blocked\" });\n return;\n }\n\n logger(\"info\", `[PROXY] Forwarding to: ${targetUrl}`);\n\n // Prepare headers and body\n const headers: Record<string, string> = {};\n for (const [key, value] of Object.entries(req.headers)) {\n if (value) {\n headers[key] = Array.isArray(value) ? value.join(\", \") : value;\n }\n }\n headers.host = apiBase.host;\n debug(\"Prepared headers:\", headers);\n\n const body = [\"GET\", \"HEAD\"].includes(req.method)\n ? undefined\n : typeof req.body === \"string\"\n ? req.body\n : JSON.stringify(req.body);\n debug(\"Request body:\", body);\n\n // Make request to target\n debug(\"Making fetch request to target URL:\", targetUrl);\n const proxyRes = await fetch(targetUrl, {\n method: req.method,\n headers,\n body,\n });\n debug(\n \"Fetch response received with status:\",\n proxyRes.status,\n );\n\n // Set response headers\n res.setHeader(\"Access-Control-Allow-Origin\", \"\");\n res.setHeader(\n \"Access-Control-Allow-Methods\",\n \"GET,POST,PUT,PATCH,DELETE,OPTIONS\",\n );\n res.setHeader(\"Access-Control-Allow-Headers\", \"\");\n\n for (const [key, value] of proxyRes.headers.entries()) {\n if (!key.toLowerCase().startsWith(\"access-control-\")) {\n res.setHeader(key, value);\n }\n }\n\n if (req.method === \"OPTIONS\") {\n debug(\"OPTIONS request, ending response\");\n res.end();\n return;\n }\n\n const buffer = Buffer.from(await proxyRes.arrayBuffer());\n debug(\n \"Response buffer created with length:\",\n buffer.length,\n );\n res.send(buffer);\n } catch (err) {\n debug(\"Error in proxy middleware:\", err);\n logger(\"error\", `[PROXY] Error: ${err}`);\n res.status(500).json({ error: \"Proxy error\", details: String(err) });\n }\n });\n}\n","/*\n Debug utility function that only logs when DEBUG environment variable is set to 'true'\n /\n\nexport function debug(message: string, ...optionalParams: any[]) {\n if (process.env.DEBUG === 'true' \|\| process.env.DEBUG === '1') {\n console.log(`[DEBUG] ${message}`, ...optionalParams);\n }\n}","import { logger } from \"azurajs/logger\";\nimport fs from \"fs\";\nimport path from \"node:path\";\nimport { ScalarError, SetupDocsRouteOptions } from \"./config/types\";\nimport { debug } from \"./utils/debug\";\n\nexport async function setupScalarDocs({\n app,\n docPath,\n customHtmlPath,\n apiSpecUrl,\n proxyUrl,\n}: SetupDocsRouteOptions) {\n debug(\"Setting up docs route with options:\", { docPath, customHtmlPath, apiSpecUrl, proxyUrl });\n\n return app.get(docPath, (req, res) => {\n debug(\"Docs route hit with request:\", req.method, req.url);\n try {\n if (!proxyUrl \|\| !apiSpecUrl) {\n debug(\"Missing required URLs - proxyUrl:\", proxyUrl, \"apiSpecUrl:\", apiSpecUrl);\n throw new ScalarError(\n \"Missing required URLs\",\n \"STORE_VALUES_MISSING\",\n 500,\n );\n }\n\n const htmlPath =\n customHtmlPath \|\| path.join(__dirname, \"../api-docs.html\");\n debug(\"HTML template path:\", htmlPath);\n\n if (!fs.existsSync(htmlPath)) {\n debug(\"HTML template not found at path:\", htmlPath);\n throw new ScalarError(\n \"HTML template not found\",\n \"HTML_TEMPLATE_NOT_FOUND\",\n 404,\n );\n }\n\n const html = fs.readFileSync(htmlPath, \"utf-8\");\n debug(\"HTML template read successfully, length:\", html.length);\n\n const processedHtml = html\n .replace(/&{proxy_url}/g, proxyUrl)\n .replace(/&{api_spec_url}/g, apiSpecUrl);\n debug(\"HTML template processed with proxyUrl and apiSpecUrl\");\n\n return res.send(processedHtml);\n } catch (error) {\n debug(\"Error in docs route:\", error);\n if (error instanceof ScalarError) {\n logger(\"error\", `[ScalarError] ${error.message}`);\n return res.status(error.statusCode).json({ message: error.message });\n } else {\n logger(\"error\", String(error));\n return res.status(500).json({ message: \"Server error\" });\n }\n }\n });\n}\n","/\n @fileoverview Store utility for managing application state\n * This module provides a typed store for managing scalar configuration values\n /\n\nimport { ScalarStoreType } from \"../config/types\";\n\n/\n Typed store class for managing scalar configuration values\n /\nclass ScalarStore {\n private store: Map<keyof ScalarStoreType, string \| undefined> = new Map();\n\n /\n Sets a value in the store\n * @param key The key to set\n * @param value The value to set (if undefined, the key will be removed)\n /\n set<K extends keyof ScalarStoreType>(\n key: K,\n value: ScalarStoreType[K],\n ): void {\n this.store.set(key, value as string \| undefined);\n }\n\n /\n Gets a value from the store\n * @param key The key to get\n * @returns The value associated with the key\n /\n get<K extends keyof ScalarStoreType>(key: K): ScalarStoreType[K] {\n return this.store.get(key) as ScalarStoreType[K];\n }\n\n /\n Checks if a key exists in the store\n * @param key The key to check\n * @returns True if the key exists, false otherwise\n /\n has(key: keyof ScalarStoreType): boolean {\n return this.store.has(key);\n }\n\n /\n Deletes a key from the store\n * @param key The key to delete\n * @returns True if the key existed and was deleted, false otherwise\n /\n delete(key: keyof ScalarStoreType): boolean {\n return this.store.delete(key);\n }\n\n /\n Clears all values from the store\n /\n clear(): void {\n this.store.clear();\n }\n\n /\n Gets all values from the store\n * @returns An object containing all key-value pairs in the store\n /\n getAll(): ScalarStoreType {\n const result: Partial<ScalarStoreType> = {};\n for (const [key, value] of this.store.entries()) {\n result[key] = value as ScalarStoreType[keyof ScalarStoreType];\n }\n return result as ScalarStoreType;\n }\n\n // Index signature to allow direct property access\n [key: string]: any;\n}\n\nexport const store = new ScalarStore();\n","/\n Scalar client for API documentation\n /\nimport {\n ScalarConfigType,\n ScalarError,\n SetupDocsRouteOptions,\n} from \"./config/types\";\nimport { proxyMiddleware } from \"./middleware/proxy\";\nimport { setupScalarDocs } from \"./setupDocsRoute\";\nimport { store } from \"./utils/store\";\nimport { debug } from \"./utils/debug\";\n\nexport class Scalar {\n constructor(config: ScalarConfigType) {\n debug(\"Scalar constructor called with config:\", config);\n\n // Normalize baseUrl to ensure it's a valid absolute URL before validation\n const normalizedConfig = { ...config };\n normalizedConfig.baseUrl = this.normalizeBaseUrl(config.baseUrl);\n debug(\"Normalized config:\", normalizedConfig);\n\n // Validate the configuration\n this.validateConfig(normalizedConfig);\n\n // Set default paths if not provided\n const proxyPath = normalizedConfig.proxyPath \|\| \"/scalar/proxy\";\n const docPath = normalizedConfig.docPath \|\| \"/docs\";\n const apiSpecPath = normalizedConfig.apiSpecPath \|\| \"\";\n debug(\n \"Using paths - proxyPath:\",\n proxyPath,\n \"docPath:\",\n docPath,\n \"apiSpecPath:\",\n apiSpecPath,\n );\n\n // Calculate full URLs from baseUrl and paths\n const proxyUrl = this.joinUrl(normalizedConfig.baseUrl, proxyPath);\n const docUrl = this.joinUrl(normalizedConfig.baseUrl, docPath);\n const apiSpecUrl = this.joinUrl(normalizedConfig.baseUrl, apiSpecPath);\n debug(\n \"Calculated URLs - proxyUrl:\",\n proxyUrl,\n \"docUrl:\",\n docUrl,\n \"apiSpecUrl:\",\n apiSpecUrl,\n );\n\n // Store the calculated URLs\n store.set(\"proxy_url\", proxyUrl);\n store.set(\"api_spec_url\", apiSpecUrl);\n store.set(\"doc_url\", docUrl);\n debug(\"Stored URLs in store\");\n\n // Call setup with the calculated URLs\n setupScalarDocs({\n ...normalizedConfig,\n proxyUrl,\n docPath,\n apiSpecUrl,\n });\n debug(\"setupScalarDocs called\");\n\n // Setup proxy middleware\n proxyMiddleware({\n apiSpecUrl,\n proxyUrlPath: proxyPath,\n app: normalizedConfig.app,\n });\n debug(\"proxyMiddleware called\");\n }\n\n private joinUrl(baseUrl: string, path: string): string {\n // Normalize the baseUrl to ensure it ends with a slash\n const normalizedBaseUrl = baseUrl.endsWith(\"/\") ? baseUrl : baseUrl + \"/\";\n\n // Normalize the path to ensure it starts with a slash\n const normalizedPath = path.startsWith(\"/\") ? path : \"/\" + path;\n\n // Join the baseUrl and path, removing any double slashes\n return normalizedBaseUrl.replace(/\\/$/, \"\") + normalizedPath;\n }\n\n private normalizeBaseUrl(baseUrl: string): string {\n if (!baseUrl) {\n throw new ScalarError(\n \"baseUrl is required\",\n \"MISSING_REQUIRED_CONFIG\",\n 400,\n );\n }\n\n // If baseUrl doesn't start with a protocol, prepend http://\n if (!/^https?:\\/\\//i.test(baseUrl)) {\n return \"http://\" + baseUrl;\n }\n\n return baseUrl;\n }\n\n private validateConfig(config: ScalarConfigType): void {\n if (!config.baseUrl) {\n throw new ScalarError(\n \"baseUrl is required\",\n \"MISSING_REQUIRED_CONFIG\",\n 400,\n );\n }\n\n try {\n // Validate baseUrl\n debug(\"Validating baseUrl:\", config.baseUrl);\n new URL(config.baseUrl);\n\n // Validate paths if provided\n if (config.proxyPath) {\n debug(\"Validating proxyPath:\", config.proxyPath);\n if (!this.isValidPath(config.proxyPath)) {\n debug(\"proxyPath validation FAILED\");\n throw new Error(\"Invalid proxyPath\");\n }\n }\n\n if (config.docPath) {\n debug(\"Validating docPath:\", config.docPath);\n if (!this.isValidPath(config.docPath)) {\n debug(\"docPath validation FAILED\");\n throw new Error(\"Invalid docPath\");\n }\n }\n\n if (config.apiSpecPath) {\n debug(\"Validating apiSpecPath:\", config.apiSpecPath);\n if (!this.isValidPath(config.apiSpecPath)) {\n debug(\"apiSpecPath validation FAILED\");\n throw new Error(\"Invalid apiSpecPath\");\n }\n }\n } catch (error) {\n debug(\"Validation error:\", error);\n throw new ScalarError(\"Invalid URL provided\", \"INVALID_URL\", 400);\n }\n }\n\n private isValidPath(path: string): boolean {\n // Aceita paths relativos com barras no meio e no final\n return (\n typeof path === \"string\" &&\n /^\\/[a-zA-Z0-9\\-._~:\\/@!$&'()+,;=]*\\/?$/.test(path)\n );\n }\n}\n"],"mappings":";AAyBO,IAAM,cAAN,MAAM,qBAAoB,MAAM;AAAA,EACrC,YACkB,SACA,MACA,YAChB;AACA,UAAM,OAAO;AAJG;AACA;AACA;AAGhB,WAAO,eAAe,MAAM,aAAY,SAAS;AAAA,EACnD;AACF;;;ACjCA,SAAS,cAAc;;;ACGhB,SAAS,MAAM,YAAoB,gBAAuB;AAC/D,MAAI,QAAQ,IAAI,UAAU,UAAU,QAAQ,IAAI,UAAU,KAAK;AAC7D,YAAQ,IAAI,WAAW,OAAO,IAAI,GAAG,cAAc;AAAA,EACrD;AACF;;;ADJO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AACF,GAAiB;AACf,QAAM,6CAA6C;AAAA,IACjD;AAAA,IACA;AAAA,EACF,CAAC;AACD,MAAI,IAAI,cAAc,MAAM;AAAA,EAAC,CAAC;AAC9B,SAAO,IAAI,IAAI,cAAc,OAAO,KAAK,QAAQ;AAC/C,UAAM,sCAAsC,IAAI,QAAQ,IAAI,KAAK,YAAY,IAAI,OAAO;AACxF,QAAI;AACF,UAAI,CAAC,IAAI,OAAO,CAAC,IAAI,QAAQ;AAC3B,cAAM,yCAAyC;AAC/C,YAAI,OAAO,GAAG,EAAE,KAAK,EAAE,OAAO,kBAAkB,CAAC;AACjD;AAAA,MACF;AAEA,aAAO,QAAQ,WAAW,IAAI,MAAM,IAAI,IAAI,GAAG,EAAE;AAGjD,YAAM,MAAM,IAAI,IAAI,mBAAmB,IAAI,GAAG,EAAE;AAChD,YAAM,YAAY,IAAI,aAAa,IAAI,YAAY;AACnD,YAAM,2CAA2C,SAAS;AAG1D,YAAM,YAAY,aAAa,aAAa,IAAI,WAAW,IAAI;AAC/D,YAAM,0BAA0B,SAAS;AAGzC,YAAM,SAAS,IAAI,IAAI,SAAS;AAChC,YAAM,UAAU,IAAI,IAAI,UAAU;AAClC;AAAA,QACE;AAAA,QACA,OAAO;AAAA,QACP;AAAA,QACA,QAAQ;AAAA,MACV;AACA,UAAI,OAAO,WAAW,QAAQ,QAAQ;AACpC,eAAO,QAAQ,yBAAyB,SAAS,EAAE;AACnD,YAAI,OAAO,GAAG,EAAE,KAAK,EAAE,OAAO,uBAAuB,CAAC;AACtD;AAAA,MACF;AAEA,aAAO,QAAQ,0BAA0B,SAAS,EAAE;AAGpD,YAAM,UAAkC,CAAC;AACzC,iBAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,OAAO,GAAG;AACtD,YAAI,OAAO;AACT,kBAAQ,GAAG,IAAI,MAAM,QAAQ,KAAK,IAAI,MAAM,KAAK,IAAI,IAAI;AAAA,QAC3D;AAAA,MACF;AACA,cAAQ,OAAO,QAAQ;AACvB,YAAM,qBAAqB,OAAO;AAElC,YAAM,OAAO,CAAC,OAAO,MAAM,EAAE,SAAS,IAAI,MAAM,IAC5C,SACA,OAAO,IAAI,SAAS,WAClB,IAAI,OACJ,KAAK,UAAU,IAAI,IAAI;AAC7B,YAAM,iBAAiB,IAAI;AAG3B,YAAM,uCAAuC,SAAS;AACtD,YAAM,WAAW,MAAM,MAAM,WAAW;AAAA,QACtC,QAAQ,IAAI;AAAA,QACZ;AAAA,QACA;AAAA,MACF,CAAC;AACD;AAAA,QACE;AAAA,QACA,SAAS;AAAA,MACX;AAGA,UAAI,UAAU,+BAA+B,GAAG;AAChD,UAAI;AAAA,QACF;AAAA,QACA;AAAA,MACF;AACA,UAAI,UAAU,gCAAgC,GAAG;AAEjD,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS,QAAQ,QAAQ,GAAG;AACrD,YAAI,CAAC,IAAI,YAAY,EAAE,WAAW,iBAAiB,GAAG;AACpD,cAAI,UAAU,KAAK,KAAK;AAAA,QAC1B;AAAA,MACF;AAEA,UAAI,IAAI,WAAW,WAAW;AAC5B,cAAM,kCAAkC;AACxC,YAAI,IAAI;AACR;AAAA,MACF;AAEA,YAAM,SAAS,OAAO,KAAK,MAAM,SAAS,YAAY,CAAC;AACvD;AAAA,QACE;AAAA,QACA,OAAO;AAAA,MACT;AACA,UAAI,KAAK,MAAM;AAAA,IACjB,SAAS,KAAK;AACZ,YAAM,8BAA8B,GAAG;AACvC,aAAO,SAAS,kBAAkB,GAAG,EAAE;AACvC,UAAI,OAAO,GAAG,EAAE,KAAK,EAAE,OAAO,eAAe,SAAS,OAAO,GAAG,EAAE,CAAC;AAAA,IACrE;AAAA,EACF,CAAC;AACH;;;AEhHA,SAAS,UAAAA,eAAc;AACvB,OAAO,QAAQ;AACf,OAAO,UAAU;AAIjB,eAAsB,gBAAgB;AAAA,EACpC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAA0B;AACxB,QAAM,uCAAuC,EAAE,SAAS,gBAAgB,YAAY,SAAS,CAAC;AAE9F,SAAO,IAAI,IAAI,SAAS,CAAC,KAAK,QAAQ;AACpC,UAAM,gCAAgC,IAAI,QAAQ,IAAI,GAAG;AACzD,QAAI;AACF,UAAI,CAAC,YAAY,CAAC,YAAY;AAC5B,cAAM,qCAAqC,UAAU,eAAe,UAAU;AAC9E,cAAM,IAAI;AAAA,UACR;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,YAAM,WACJ,kBAAkB,KAAK,KAAK,WAAW,kBAAkB;AAC3D,YAAM,uBAAuB,QAAQ;AAErC,UAAI,CAAC,GAAG,WAAW,QAAQ,GAAG;AAC5B,cAAM,oCAAoC,QAAQ;AAClD,cAAM,IAAI;AAAA,UACR;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,YAAM,OAAO,GAAG,aAAa,UAAU,OAAO;AAC9C,YAAM,4CAA4C,KAAK,MAAM;AAE7D,YAAM,gBAAgB,KACnB,QAAQ,iBAAiB,QAAQ,EACjC,QAAQ,oBAAoB,UAAU;AACzC,YAAM,sDAAsD;AAE5D,aAAO,IAAI,KAAK,aAAa;AAAA,IAC/B,SAAS,OAAO;AACd,YAAM,wBAAwB,KAAK;AACnC,UAAI,iBAAiB,aAAa;AAChC,QAAAC,QAAO,SAAS,iBAAiB,MAAM,OAAO,EAAE;AAChD,eAAO,IAAI,OAAO,MAAM,UAAU,EAAE,KAAK,EAAE,SAAS,MAAM,QAAQ,CAAC;AAAA,MACrE,OAAO;AACL,QAAAA,QAAO,SAAS,OAAO,KAAK,CAAC;AAC7B,eAAO,IAAI,OAAO,GAAG,EAAE,KAAK,EAAE,SAAS,eAAe,CAAC;AAAA,MACzD;AAAA,IACF;AAAA,EACF,CAAC;AACH;;;AClDA,IAAM,cAAN,MAAkB;AAAA,EAAlB;AACE,SAAQ,QAAwD,oBAAI,IAAI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOxE,IACE,KACA,OACM;AACN,SAAK,MAAM,IAAI,KAAK,KAA2B;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAqC,KAA4B;AAC/D,WAAO,KAAK,MAAM,IAAI,GAAG;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,KAAqC;AACvC,WAAO,KAAK,MAAM,IAAI,GAAG;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAqC;AAC1C,WAAO,KAAK,MAAM,OAAO,GAAG;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AACZ,SAAK,MAAM,MAAM;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAA0B;AACxB,UAAM,SAAmC,CAAC;AAC1C,eAAW,CAAC,KAAK,KAAK,KAAK,KAAK,MAAM,QAAQ,GAAG;AAC/C,aAAO,GAAG,IAAI;AAAA,IAChB;AACA,WAAO;AAAA,EACT;AAIF;AAEO,IAAM,QAAQ,IAAI,YAAY;;;AC9D9B,IAAM,SAAN,MAAa;AAAA,EAClB,YAAY,QAA0B;AACpC,UAAM,0CAA0C,MAAM;AAGtD,UAAM,mBAAmB,EAAE,GAAG,OAAO;AACrC,qBAAiB,UAAU,KAAK,iBAAiB,OAAO,OAAO;AAC/D,UAAM,sBAAsB,gBAAgB;AAG5C,SAAK,eAAe,gBAAgB;AAGpC,UAAM,YAAY,iBAAiB,aAAa;AAChD,UAAM,UAAU,iBAAiB,WAAW;AAC5C,UAAM,cAAc,iBAAiB,eAAe;AACpD;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGA,UAAM,WAAW,KAAK,QAAQ,iBAAiB,SAAS,SAAS;AACjE,UAAM,SAAS,KAAK,QAAQ,iBAAiB,SAAS,OAAO;AAC7D,UAAM,aAAa,KAAK,QAAQ,iBAAiB,SAAS,WAAW;AACrE;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGA,UAAM,IAAI,aAAa,QAAQ;AAC/B,UAAM,IAAI,gBAAgB,UAAU;AACpC,UAAM,IAAI,WAAW,MAAM;AAC3B,UAAM,sBAAsB;AAG5B,oBAAgB;AAAA,MACd,GAAG;AAAA,MACH;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,wBAAwB;AAG9B,oBAAgB;AAAA,MACd;AAAA,MACA,cAAc;AAAA,MACd,KAAK,iBAAiB;AAAA,IACxB,CAAC;AACD,UAAM,wBAAwB;AAAA,EAChC;AAAA,EAEQ,QAAQ,SAAiBC,OAAsB;AAErD,UAAM,oBAAoB,QAAQ,SAAS,GAAG,IAAI,UAAU,UAAU;AAGtE,UAAM,iBAAiBA,MAAK,WAAW,GAAG,IAAIA,QAAO,MAAMA;AAG3D,WAAO,kBAAkB,QAAQ,OAAO,EAAE,IAAI;AAAA,EAChD;AAAA,EAEQ,iBAAiB,SAAyB;AAChD,QAAI,CAAC,SAAS;AACZ,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAGA,QAAI,CAAC,gBAAgB,KAAK,OAAO,GAAG;AAClC,aAAO,YAAY;AAAA,IACrB;AAEA,WAAO;AAAA,EACT;AAAA,EAEQ,eAAe,QAAgC;AACrD,QAAI,CAAC,OAAO,SAAS;AACnB,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI;AAEF,YAAM,uBAAuB,OAAO,OAAO;AAC3C,UAAI,IAAI,OAAO,OAAO;AAGtB,UAAI,OAAO,WAAW;AACpB,cAAM,yBAAyB,OAAO,SAAS;AAC/C,YAAI,CAAC,KAAK,YAAY,OAAO,SAAS,GAAG;AACvC,gBAAM,6BAA6B;AACnC,gBAAM,IAAI,MAAM,mBAAmB;AAAA,QACrC;AAAA,MACF;AAEA,UAAI,OAAO,SAAS;AAClB,cAAM,uBAAuB,OAAO,OAAO;AAC3C,YAAI,CAAC,KAAK,YAAY,OAAO,OAAO,GAAG;AACrC,gBAAM,2BAA2B;AACjC,gBAAM,IAAI,MAAM,iBAAiB;AAAA,QACnC;AAAA,MACF;AAEA,UAAI,OAAO,aAAa;AACtB,cAAM,2BAA2B,OAAO,WAAW;AACnD,YAAI,CAAC,KAAK,YAAY,OAAO,WAAW,GAAG;AACzC,gBAAM,+BAA+B;AACrC,gBAAM,IAAI,MAAM,qBAAqB;AAAA,QACvC;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AACd,YAAM,qBAAqB,KAAK;AAChC,YAAM,IAAI,YAAY,wBAAwB,eAAe,GAAG;AAAA,IAClE;AAAA,EACF;AAAA,EAEQ,YAAYA,OAAuB;AAEzC,WACE,OAAOA,UAAS,YAChB,0CAA0C,KAAKA,KAAI;AAAA,EAEvD;AACF;","names":["logger","logger","path"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "azurajs-scalar",
-  "version": "1.0.3",
+  "version": "2.0.1",
   "description": "Proxy middleware and controller to scalar documentation.",
   "type": "module",
   "publishConfig": {
@@ -9,7 +9,7 @@
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts"
+    "build": "tsup"
   },
   "keywords": [],
   "author": "",