npm - te.js - Versions diffs - 2.1.0 → 2.1.1 - Mend

te.js 2.1.0 → 2.1.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 (66) hide show

package/README.md +197 -196
package/auto-docs/analysis/handler-analyzer.js +58 -58
package/auto-docs/analysis/source-resolver.js +101 -101
package/auto-docs/constants.js +37 -37
package/auto-docs/docs-llm/index.js +7 -7
package/auto-docs/docs-llm/prompts.js +222 -222
package/auto-docs/docs-llm/provider.js +132 -132
package/auto-docs/index.js +146 -146
package/auto-docs/openapi/endpoint-processor.js +277 -277
package/auto-docs/openapi/generator.js +107 -107
package/auto-docs/openapi/level3.js +131 -131
package/auto-docs/openapi/spec-builders.js +244 -244
package/auto-docs/ui/docs-ui.js +186 -186
package/auto-docs/utils/logger.js +17 -17
package/auto-docs/utils/strip-usage.js +10 -10
package/cli/docs-command.js +315 -315
package/cli/fly-command.js +71 -71
package/cli/index.js +56 -56
package/database/index.js +165 -165
package/database/mongodb.js +146 -146
package/database/redis.js +201 -201
package/docs/README.md +36 -36
package/docs/ammo.md +362 -362
package/docs/api-reference.md +490 -490
package/docs/auto-docs.md +216 -216
package/docs/cli.md +152 -152
package/docs/configuration.md +275 -275
package/docs/database.md +390 -390
package/docs/error-handling.md +438 -438
package/docs/file-uploads.md +333 -333
package/docs/getting-started.md +214 -214
package/docs/middleware.md +355 -355
package/docs/rate-limiting.md +393 -393
package/docs/routing.md +302 -302
package/package.json +62 -62
package/rate-limit/algorithms/fixed-window.js +141 -141
package/rate-limit/algorithms/sliding-window.js +147 -147
package/rate-limit/algorithms/token-bucket.js +115 -115
package/rate-limit/base.js +165 -165
package/rate-limit/index.js +147 -147
package/rate-limit/storage/base.js +104 -104
package/rate-limit/storage/memory.js +101 -101
package/rate-limit/storage/redis.js +88 -88
package/server/ammo/body-parser.js +220 -220
package/server/ammo/dispatch-helper.js +103 -103
package/server/ammo/enhancer.js +57 -57
package/server/ammo.js +454 -415
package/server/endpoint.js +97 -74
package/server/error.js +9 -9
package/server/errors/code-context.js +125 -125
package/server/errors/llm-error-service.js +140 -140
package/server/files/helper.js +33 -33
package/server/files/uploader.js +143 -143
package/server/handler.js +158 -119
package/server/target.js +185 -175
package/server/targets/middleware-validator.js +22 -22
package/server/targets/path-validator.js +21 -21
package/server/targets/registry.js +160 -160
package/server/targets/shoot-validator.js +21 -21
package/te.js +428 -402
package/utils/auto-register.js +17 -17
package/utils/configuration.js +64 -64
package/utils/errors-llm-config.js +84 -84
package/utils/request-logger.js +43 -43
package/utils/status-codes.js +82 -82
package/utils/tejas-entrypoint-html.js +18 -18

package/auto-docs/ui/docs-ui.js CHANGED Viewed

@@ -1,186 +1,186 @@
-/**
- * Serves interactive API docs at /docs with try-out functionality.
- * Uses Scalar API Reference (modern UI, try-it-out, themes). MIT.
- * Registers internal routes: GET /docs (HTML page) and GET /docs/openapi.json (spec).
- *
- * @see https://scalar.com/products/api-references/integrations/html-js
- * @see https://scalar.com/products/api-references/configuration
- */
-import Endpoint from '../../server/endpoint.js';
-import targetRegistry from '../../server/targets/registry.js';
-/** Scalar API Reference browser standalone (IIFE, sets window.Scalar). Pinned for stability. */
-const SCALAR_VERSION = '1.46.0';
-const SCALAR_STANDALONE = `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${SCALAR_VERSION}/dist/browser/standalone.js`;
-/**
- * Default Scalar API Reference config. Use layout: 'classic' to show the test request
- * inline on the same page instead of opening a dialog (modern layout).
- *
- * @see https://scalar.com/products/api-references/configuration
- */
-const DEFAULT_SCALAR_CONFIG = {
-  layout: 'modern',
-  theme: 'default',
-  showSidebar: true,
-  hideDownloadButton: false,
-  hideModels: false,
-  hideSearch: false,
-  hideDarkModeToggle: false,
-  hideTestRequestButton: false,
-  showDeveloperTools: 'localhost',
-  documentDownloadType: 'both',
-  defaultOpenAllTags: false,
-  defaultOpenFirstTag: true,
-  expandAllModelSections: false,
-  expandAllResponses: false,
-  withDefaultFonts: true,
-};
-/**
- * Build HTML shell for Scalar docs: script tag + inline config and mount logic.
- * @param {string} scriptUrl - URL to Scalar standalone JS
- * @param {string} configJson - JSON string (already escaped for embedding in JS)
- * @returns {string} Full HTML document
- */
-function buildDocsHtmlShell(scriptUrl, configJson) {
-  return `<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>API Reference</title>
-  <style>
-    body { margin: 0; min-height: 100vh; font-family: system-ui, sans-serif; }
-    #scalar-app { min-height: 100vh; width: 100%; }
-  </style>
-</head>
-<body>
-  <div id="scalar-app"></div>
-  <script src="${scriptUrl}" id="scalar-script"><\/script>
-  <script>
-    (function() {
-      var config = JSON.parse('${configJson}');
-      function mount() {
-        if (typeof Scalar !== 'undefined' && typeof Scalar.createApiReference === 'function') {
-          Scalar.createApiReference('#scalar-app', config);
-          return true;
-        }
-        return false;
-      }
-      var el = document.getElementById('scalar-script');
-      if (el) {
-        el.addEventListener('load', function() { mount(); });
-        if (el.readyState === 'complete') setTimeout(function() { mount(); }, 0);
-      }
-      if (!mount()) setTimeout(function() { mount(); }, 100);
-    })();
-  </script>
-</body>
-</html>`;
-}
-/**
- * Builds the HTML page that embeds Scalar and points to the spec URL.
- * @param {string} specUrl - URL to the OpenAPI spec (e.g. '/docs/openapi.json' or full URL).
- * @param {object} [scalarConfig] - Optional Scalar API Reference config (merged with defaults).
- * @returns {string} Full HTML document.
- */
-function buildDocsPage(specUrl, scalarConfig = {}) {
-  const url = specUrl || '/docs/openapi.json';
-  const config = { ...DEFAULT_SCALAR_CONFIG, ...scalarConfig, url };
-  const configJson = JSON.stringify(config)
-    .replace(/</g, '\\u003c')
-    .replace(/>/g, '\\u003e');
-  return buildDocsHtmlShell(SCALAR_STANDALONE, configJson);
-}
-/**
- * Create endpoint that serves the docs HTML page at GET docsPath.
- * @param {string} docsPath - e.g. '/docs'
- * @param {string} htmlContent - Full HTML document
- * @returns {Endpoint}
- */
-function createDocsHtmlEndpoint(docsPath, htmlContent) {
-  const endpoint = new Endpoint();
-  endpoint.setPath('', docsPath);
-  endpoint.setMiddlewares([]);
-  endpoint.setHandler((ammo) => {
-    if (!ammo.GET) return ammo.notAllowed();
-    ammo.fire(200, htmlContent, 'text/html');
-  });
-  return endpoint;
-}
-/**
- * Create endpoint that serves the OpenAPI spec JSON at GET specPath.
- * @param {string} specPath - e.g. '/docs/openapi.json'
- * @param {() => object | Promise<object>} getSpec - Function that returns the current spec
- * @returns {Endpoint}
- */
-function createSpecJsonEndpoint(specPath, getSpec) {
-  const endpoint = new Endpoint();
-  endpoint.setPath('', specPath);
-  endpoint.setMiddlewares([]);
-  endpoint.setHandler(async (ammo) => {
-    if (!ammo.GET) return ammo.notAllowed();
-    try {
-      const spec = await Promise.resolve(getSpec());
-      ammo.fire(200, spec);
-    } catch (err) {
-      ammo.fire(500, {
-        error: 'Failed to generate OpenAPI spec',
-        message: err?.message,
-      });
-    }
-  });
-  return endpoint;
-}
-/**
- * Registers the docs and openapi.json routes (or returns endpoints when mutateRegistry is false).
- * Call this after the OpenAPI spec is available (e.g. after generateOpenAPISpec).
- *
- * @param {object} [options]
- * @param {() => object | Promise<object>} options.getSpec - Function that returns the current OpenAPI spec (sync or async). Used for GET {docsPath}/openapi.json.
- * @param {string} [options.docsPath='/docs'] - Base path for docs (HTML page and spec URL). Routes: GET {docsPath}, GET {docsPath}/openapi.json.
- * @param {string} [options.specUrl] - Override for the spec URL shown in the docs page (default: '{docsPath}/openapi.json'). Use when serving behind a proxy with a different base path.
- * @param {object} [options.scalarConfig] - Optional Scalar API Reference config (e.g. { layout: 'classic' } for try-it on the same page).
- * @param {boolean} [options.mutateRegistry=true] - If true, push endpoints to registry. If false, return [docsEndpoint, specEndpoint] without mutating.
- * @param {object} [registry] - Target registry to register routes on when mutateRegistry is true. Defaults to the module's targetRegistry.
- * @returns {undefined | [Endpoint, Endpoint]} When mutateRegistry is false, returns the two endpoints for the caller to register.
- */
-export function registerDocRoutes(options = {}, registry = targetRegistry) {
-  const {
-    getSpec,
-    docsPath = '/docs',
-    specUrl: specUrlOption,
-    scalarConfig,
-    mutateRegistry = true,
-  } = options;
-  if (typeof getSpec !== 'function') {
-    throw new Error(
-      'registerDocRoutes requires options.getSpec (function returning the OpenAPI spec)',
-    );
-  }
-  const basePath = docsPath.replace(/\/$/, '');
-  const specUrl = specUrlOption ?? `${basePath}/openapi.json`;
-  const specPath = `${basePath}/openapi.json`;
-  const htmlContent = buildDocsPage(specUrl, scalarConfig);
-  const docsEndpoint = createDocsHtmlEndpoint(docsPath, htmlContent);
-  const specEndpoint = createSpecJsonEndpoint(specPath, getSpec);
-  if (mutateRegistry) {
-    registry.targets.push(docsEndpoint);
-    registry.targets.push(specEndpoint);
-    return;
-  }
-  return [docsEndpoint, specEndpoint];
-}
-export { buildDocsPage };
-export default registerDocRoutes;
+/**
+ * Serves interactive API docs at /docs with try-out functionality.
+ * Uses Scalar API Reference (modern UI, try-it-out, themes). MIT.
+ * Registers internal routes: GET /docs (HTML page) and GET /docs/openapi.json (spec).
+ *
+ * @see https://scalar.com/products/api-references/integrations/html-js
+ * @see https://scalar.com/products/api-references/configuration
+ */
+import Endpoint from '../../server/endpoint.js';
+import targetRegistry from '../../server/targets/registry.js';
+/** Scalar API Reference browser standalone (IIFE, sets window.Scalar). Pinned for stability. */
+const SCALAR_VERSION = '1.46.0';
+const SCALAR_STANDALONE = `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${SCALAR_VERSION}/dist/browser/standalone.js`;
+/**
+ * Default Scalar API Reference config. Use layout: 'classic' to show the test request
+ * inline on the same page instead of opening a dialog (modern layout).
+ *
+ * @see https://scalar.com/products/api-references/configuration
+ */
+const DEFAULT_SCALAR_CONFIG = {
+  layout: 'modern',
+  theme: 'default',
+  showSidebar: true,
+  hideDownloadButton: false,
+  hideModels: false,
+  hideSearch: false,
+  hideDarkModeToggle: false,
+  hideTestRequestButton: false,
+  showDeveloperTools: 'localhost',
+  documentDownloadType: 'both',
+  defaultOpenAllTags: false,
+  defaultOpenFirstTag: true,
+  expandAllModelSections: false,
+  expandAllResponses: false,
+  withDefaultFonts: true,
+};
+/**
+ * Build HTML shell for Scalar docs: script tag + inline config and mount logic.
+ * @param {string} scriptUrl - URL to Scalar standalone JS
+ * @param {string} configJson - JSON string (already escaped for embedding in JS)
+ * @returns {string} Full HTML document
+ */
+function buildDocsHtmlShell(scriptUrl, configJson) {
+  return `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>API Reference</title>
+  <style>
+    body { margin: 0; min-height: 100vh; font-family: system-ui, sans-serif; }
+    #scalar-app { min-height: 100vh; width: 100%; }
+  </style>
+</head>
+<body>
+  <div id="scalar-app"></div>
+  <script src="${scriptUrl}" id="scalar-script"><\/script>
+  <script>
+    (function() {
+      var config = JSON.parse('${configJson}');
+      function mount() {
+        if (typeof Scalar !== 'undefined' && typeof Scalar.createApiReference === 'function') {
+          Scalar.createApiReference('#scalar-app', config);
+          return true;
+        }
+        return false;
+      }
+      var el = document.getElementById('scalar-script');
+      if (el) {
+        el.addEventListener('load', function() { mount(); });
+        if (el.readyState === 'complete') setTimeout(function() { mount(); }, 0);
+      }
+      if (!mount()) setTimeout(function() { mount(); }, 100);
+    })();
+  </script>
+</body>
+</html>`;
+}
+/**
+ * Builds the HTML page that embeds Scalar and points to the spec URL.
+ * @param {string} specUrl - URL to the OpenAPI spec (e.g. '/docs/openapi.json' or full URL).
+ * @param {object} [scalarConfig] - Optional Scalar API Reference config (merged with defaults).
+ * @returns {string} Full HTML document.
+ */
+function buildDocsPage(specUrl, scalarConfig = {}) {
+  const url = specUrl || '/docs/openapi.json';
+  const config = { ...DEFAULT_SCALAR_CONFIG, ...scalarConfig, url };
+  const configJson = JSON.stringify(config)
+    .replace(/</g, '\\u003c')
+    .replace(/>/g, '\\u003e');
+  return buildDocsHtmlShell(SCALAR_STANDALONE, configJson);
+}
+/**
+ * Create endpoint that serves the docs HTML page at GET docsPath.
+ * @param {string} docsPath - e.g. '/docs'
+ * @param {string} htmlContent - Full HTML document
+ * @returns {Endpoint}
+ */
+function createDocsHtmlEndpoint(docsPath, htmlContent) {
+  const endpoint = new Endpoint();
+  endpoint.setPath('', docsPath);
+  endpoint.setMiddlewares([]);
+  endpoint.setHandler((ammo) => {
+    if (!ammo.GET) return ammo.notAllowed();
+    ammo.fire(200, htmlContent, 'text/html');
+  });
+  return endpoint;
+}
+/**
+ * Create endpoint that serves the OpenAPI spec JSON at GET specPath.
+ * @param {string} specPath - e.g. '/docs/openapi.json'
+ * @param {() => object | Promise<object>} getSpec - Function that returns the current spec
+ * @returns {Endpoint}
+ */
+function createSpecJsonEndpoint(specPath, getSpec) {
+  const endpoint = new Endpoint();
+  endpoint.setPath('', specPath);
+  endpoint.setMiddlewares([]);
+  endpoint.setHandler(async (ammo) => {
+    if (!ammo.GET) return ammo.notAllowed();
+    try {
+      const spec = await Promise.resolve(getSpec());
+      ammo.fire(200, spec);
+    } catch (err) {
+      ammo.fire(500, {
+        error: 'Failed to generate OpenAPI spec',
+        message: err?.message,
+      });
+    }
+  });
+  return endpoint;
+}
+/**
+ * Registers the docs and openapi.json routes (or returns endpoints when mutateRegistry is false).
+ * Call this after the OpenAPI spec is available (e.g. after generateOpenAPISpec).
+ *
+ * @param {object} [options]
+ * @param {() => object | Promise<object>} options.getSpec - Function that returns the current OpenAPI spec (sync or async). Used for GET {docsPath}/openapi.json.
+ * @param {string} [options.docsPath='/docs'] - Base path for docs (HTML page and spec URL). Routes: GET {docsPath}, GET {docsPath}/openapi.json.
+ * @param {string} [options.specUrl] - Override for the spec URL shown in the docs page (default: '{docsPath}/openapi.json'). Use when serving behind a proxy with a different base path.
+ * @param {object} [options.scalarConfig] - Optional Scalar API Reference config (e.g. { layout: 'classic' } for try-it on the same page).
+ * @param {boolean} [options.mutateRegistry=true] - If true, push endpoints to registry. If false, return [docsEndpoint, specEndpoint] without mutating.
+ * @param {object} [registry] - Target registry to register routes on when mutateRegistry is true. Defaults to the module's targetRegistry.
+ * @returns {undefined | [Endpoint, Endpoint]} When mutateRegistry is false, returns the two endpoints for the caller to register.
+ */
+export function registerDocRoutes(options = {}, registry = targetRegistry) {
+  const {
+    getSpec,
+    docsPath = '/docs',
+    specUrl: specUrlOption,
+    scalarConfig,
+    mutateRegistry = true,
+  } = options;
+  if (typeof getSpec !== 'function') {
+    throw new Error(
+      'registerDocRoutes requires options.getSpec (function returning the OpenAPI spec)',
+    );
+  }
+  const basePath = docsPath.replace(/\/$/, '');
+  const specUrl = specUrlOption ?? `${basePath}/openapi.json`;
+  const specPath = `${basePath}/openapi.json`;
+  const htmlContent = buildDocsPage(specUrl, scalarConfig);
+  const docsEndpoint = createDocsHtmlEndpoint(docsPath, htmlContent);
+  const specEndpoint = createSpecJsonEndpoint(specPath, getSpec);
+  if (mutateRegistry) {
+    registry.targets.push(docsEndpoint);
+    registry.targets.push(specEndpoint);
+    return;
+  }
+  return [docsEndpoint, specEndpoint];
+}
+export { buildDocsPage };
+export default registerDocRoutes;

package/auto-docs/utils/logger.js CHANGED Viewed

@@ -1,17 +1,17 @@
-/**
- * Verbose logging helper for auto-docs.
- * Returns a no-op when verbose is false or logger has no info method.
- */
-/**
- * Create a logger that only logs when verbose is true and logger.info exists.
- * @param {object|null} logger - Logger with .info(msg) method
- * @param {boolean} verbose - Whether to log
- * @returns {(msg: string) => void} Function that logs or does nothing
- */
-export function createVerboseLogger(logger, verbose) {
-  if (!verbose || !logger || typeof logger.info !== 'function') {
-    return () => {};
-  }
-  return (msg) => logger.info(msg);
-}
+/**
+ * Verbose logging helper for auto-docs.
+ * Returns a no-op when verbose is false or logger has no info method.
+ */
+/**
+ * Create a logger that only logs when verbose is true and logger.info exists.
+ * @param {object|null} logger - Logger with .info(msg) method
+ * @param {boolean} verbose - Whether to log
+ * @returns {(msg: string) => void} Function that logs or does nothing
+ */
+export function createVerboseLogger(logger, verbose) {
+  if (!verbose || !logger || typeof logger.info !== 'function') {
+    return () => {};
+  }
+  return (msg) => logger.info(msg);
+}

package/auto-docs/utils/strip-usage.js CHANGED Viewed

@@ -1,10 +1,10 @@
-/**
- * Strip LLM-only fields from response so they are not merged into metadata.
- * @param {object|null} obj - Raw LLM response (may contain _usage, _fallback)
- * @returns {object|null} Same object without _usage and _fallback
- */
-export function stripLlmUsage(obj) {
-  if (!obj || typeof obj !== 'object') return obj;
-  const { _usage, _fallback, ...rest } = obj;
-  return rest;
-}
+/**
+ * Strip LLM-only fields from response so they are not merged into metadata.
+ * @param {object|null} obj - Raw LLM response (may contain _usage, _fallback)
+ * @returns {object|null} Same object without _usage and _fallback
+ */
+export function stripLlmUsage(obj) {
+  if (!obj || typeof obj !== 'object') return obj;
+  const { _usage, _fallback, ...rest } = obj;
+  return rest;
+}