@riddl/core 0.2.5 → 0.2.7

package/dist/adapters.js

@@ -1,6 +1,7 @@
 import express from "express";
 import { toFetchRequest } from "./utils.js";
 import * as set_cookie_parser from "set-cookie-parser";
+import { logError } from "./log.js";
 export const mountApi = (app, prefix, apiHandler) => app.use(prefix, expressAdapter(apiHandler));
 export const setResponse = async (res, response) => {
     for (const [key, value] of response.headers) {
@@ -10,6 +11,7 @@ export const setResponse = async (res, response) => {
                 : value);
         }
         catch (error) {
+            logError("failed to set response header", error);
             res.getHeaderNames().forEach((name) => res.removeHeader(name));
             res.writeHead(500).end(String(error));
             return;

package/dist/api.d.ts

@@ -1,2 +1,2 @@
-import type { APIOptions, API } from "./types";
-export declare const api: ({ routeModuleMap, config, base, cors, registry, }: APIOptions) => Promise<API>;
+import type { APIOptions, API } from './types';
+export declare const api: ({ routeModuleMap, config, base, cors, registry, onInternalError, }: APIOptions) => Promise<API>;

package/dist/api.js

@@ -1,45 +1,56 @@
-import { OpenAPIRegistry } from "@asteasolutions/zod-to-openapi";
-import { json, recursiveAwait } from "./utils.js";
-import { CORS_DEFAULT, METHOD } from "./constants.js";
-import { log } from "./log.js";
-import { parseBody, parseOutput, parseParam, parseQuery } from "./validation.js";
-import { cleanupTempFiles } from "./multipart.js";
-import { parseRouteId } from "./parser.js";
-import { buildRouter } from "./routing.js";
-import { openapiHandler, registerRoutes } from "./openapi.js";
-import { error } from "./errors.js";
-export const api = async ({ routeModuleMap, config, base = "", cors = true, registry = new OpenAPIRegistry(), }) => {
-    const { routes, middlewares } = await Object.entries(routeModuleMap)
-        .reduce(async (accPromise, [path, module]) => {
+import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
+import { json, recursiveAwait } from './utils.js';
+import { CORS_DEFAULT, METHOD } from './constants.js';
+import { log, logError } from './log.js';
+import { parseBody, parseOutput, parseParam, parseQuery } from './validation.js';
+import { cleanupTempFiles } from './multipart.js';
+import { parseRouteId } from './parser.js';
+import { buildRouter } from './routing.js';
+import { openapiHandler, registerRoutes } from './openapi.js';
+import { error } from './errors.js';
+export const api = async ({ routeModuleMap, config, base = '', cors = true, registry = new OpenAPIRegistry(), onInternalError, }) => {
+    const reportInternalError = (error) => {
+        logError('internal error', error);
+        onInternalError === null || onInternalError === void 0 ? void 0 : onInternalError(error);
+    };
+    const { routes, middlewares } = await Object.entries(routeModuleMap).reduce(async (accPromise, [path, module]) => {
         var _a, _b, _c;
         const acc = await accPromise;
-        const parts = path.split("/");
-        const last = parts[parts.length - 1].split(".")[0];
+        const parts = path.split('/');
+        const last = parts[parts.length - 1].split('.')[0];
         parts[parts.length - 1] = last;
-        const id = parts.slice(0, -1).join("/");
+        const id = parts.slice(0, -1).join('/');
         if (METHOD.test(last)) {
             const method = last.toUpperCase();
-            const endpoint = (await module()).apiEndpoint;
+            const endpoint = (await module())
+                .apiEndpoint;
             acc.routes[id] = {
                 matcher: parseRouteId(id),
                 handlers: {
                     ...((_c = (_b = (_a = acc.routes) === null || _a === void 0 ? void 0 : _a[id]) === null || _b === void 0 ? void 0 : _b.handlers) !== null && _c !== void 0 ? _c : {}),
                     [method]: endpoint,
-                }
+                },
             };
         }
-        if (last === "middleware") {
+        if (last === 'middleware') {
             acc.middlewares[id] = (await module());
         }
         return acc;
-    }, Promise.resolve({ routes: {}, middlewares: {} }));
-    log("routes: %O", routes);
-    log("middlewares: %O", middlewares);
-    log("config: %O", config);
-    log("base: %s", base);
+    }, Promise.resolve({
+        routes: {},
+        middlewares: {},
+    }));
+    log('routes: %O', routes);
+    log('middlewares: %O', middlewares);
+    log('config: %O', config);
+    log('base: %s', base);
     registerRoutes({ routes, registry, base });
     const router = buildRouter(routes, middlewares);
-    const effectiveCorsSettings = cors ? typeof cors === "object" ? cors : CORS_DEFAULT : undefined;
+    const effectiveCorsSettings = cors
+        ? typeof cors === 'object'
+            ? cors
+            : CORS_DEFAULT
+        : undefined;
     const handler = async (request) => {
         var _a, _b, _c;
         // Temp files produced by streamed multipart uploads; removed once the
@@ -47,7 +58,7 @@ export const api = async ({ routeModuleMap, config, base = "", cors = true, regi
         // storage before returning).
         const tempFiles = [];
         try {
-            log("request: %O", request);
+            log('request: %O', request);
             const event = {
                 request,
                 url: new URL(request.url),
@@ -55,18 +66,18 @@ export const api = async ({ routeModuleMap, config, base = "", cors = true, regi
             };
             const { id, params, routeWithMiddlewares } = (_a = router(event.url.pathname)) !== null && _a !== void 0 ? _a : {};
             if (!id || !params || !routeWithMiddlewares) {
-                throw error(404, "Route not found");
+                throw error(404, 'Route not found');
             }
-            log("route id: %s", id);
+            log('route id: %s', id);
             // handle OPTIONS
-            if (request.method.toUpperCase() === "OPTIONS") {
+            if (request.method.toUpperCase() === 'OPTIONS') {
                 return new Response(null, {
-                    headers: (_b = effectiveCorsSettings) !== null && _b !== void 0 ? _b : {}
+                    headers: (_b = effectiveCorsSettings) !== null && _b !== void 0 ? _b : {},
                 });
             }
             const endpoint = routeWithMiddlewares.handlers[request.method.toUpperCase()];
             if (!(endpoint === null || endpoint === void 0 ? void 0 : endpoint.handle)) {
-                throw error(405, "Method not allowed");
+                throw error(405, 'Method not allowed');
             }
             let ctxEvent = event;
             for (const mw of routeWithMiddlewares.middlewares) {
@@ -75,12 +86,17 @@ export const api = async ({ routeModuleMap, config, base = "", cors = true, regi
             const param = await parseParam(params !== null && params !== void 0 ? params : {}, endpoint);
             const query = await parseQuery(request, endpoint);
             const body = await parseBody(request, endpoint, tempFiles);
-            log("handler: %O", endpoint.handle);
-            const output = await endpoint.handle({ body, query, param, event: ctxEvent });
+            log('handler: %O', endpoint.handle);
+            const output = await endpoint.handle({
+                body,
+                query,
+                param,
+                event: ctxEvent,
+            });
             for (const mw of [...routeWithMiddlewares.middlewares].reverse()) {
                 ctxEvent = await mw.post(ctxEvent);
             }
-            log("output: %O", output);
+            log('output: %O', output);
             if (output instanceof Response) {
                 if (effectiveCorsSettings) {
                     for (const [key, value] of Object.entries(effectiveCorsSettings)) {
@@ -93,9 +109,9 @@ export const api = async ({ routeModuleMap, config, base = "", cors = true, regi
             if (output instanceof ReadableStream) {
                 const res = new Response(output, {
                     headers: {
-                        "Content-Type": "text/event-stream",
-                        "Cache-Control": "no-cache",
-                        Connection: "keep-alive",
+                        'Content-Type': 'text/event-stream',
+                        'Cache-Control': 'no-cache',
+                        Connection: 'keep-alive',
                         ...(effectiveCorsSettings !== null && effectiveCorsSettings !== void 0 ? effectiveCorsSettings : {}),
                     },
                 });
@@ -104,7 +120,7 @@ export const api = async ({ routeModuleMap, config, base = "", cors = true, regi
             if (output instanceof ArrayBuffer) {
                 const res = new Response(output, {
                     headers: {
-                        "Content-Type": "application/octet-stream",
+                        'Content-Type': 'application/octet-stream',
                         ...(effectiveCorsSettings !== null && effectiveCorsSettings !== void 0 ? effectiveCorsSettings : {}),
                     },
                 });
@@ -119,12 +135,16 @@ export const api = async ({ routeModuleMap, config, base = "", cors = true, regi
             }
         }
         catch (e) {
-            if ('__HTTP_ERROR__' in e) {
+            if (e && typeof e === 'object' && '__HTTP_ERROR__' in e) {
+                const httpError = e;
+                if (typeof httpError.status === 'number' && httpError.status >= 500) {
+                    reportInternalError(e);
+                }
                 return json(e, {
-                    status: e.status,
+                    status: httpError.status,
                 });
             }
-            log("internal error: %O", e);
+            reportInternalError(e);
             return json({ message: 'Internal server error', status: 500 }, {
                 status: 500,
             });

package/dist/log.d.ts

@@ -1,2 +1,4 @@
 import debug from "debug";
 export declare const log: debug.Debugger;
+/** Always-on stderr log for internal errors (independent of DEBUG). */
+export declare const logError: (message: string, error: unknown) => void;

package/dist/log.js

@@ -1,2 +1,6 @@
 import debug from "debug";
 export const log = debug("riddl");
+/** Always-on stderr log for internal errors (independent of DEBUG). */
+export const logError = (message, error) => {
+    console.error(`riddl: ${message}`, error);
+};

package/dist/types.d.ts

@@ -76,6 +76,8 @@ export interface APIOptions {
     base?: string;
     cors?: boolean | CORS;
     registry?: OpenAPIRegistry;
+    /** Called for unexpected throws and HTTP errors with status >= 500. */
+    onInternalError?: (error: unknown) => void;
 }
 export interface OpenAPIOptions {
     base?: string;

package/dist/validation.d.ts

@@ -1,4 +1,4 @@
-import { GenericApiEndpoint } from "./types";
+import { GenericApiEndpoint } from './types';
 export declare const parseBody: (req: Request, module: GenericApiEndpoint, tempFiles?: string[]) => Promise<unknown>;
 export declare const parseQuery: (request: Request, module: GenericApiEndpoint) => Promise<Record<string, string | string[]>>;
 export declare const parseParam: (params: Record<string, string>, module: GenericApiEndpoint) => Promise<Record<string, string | never>>;

package/dist/validation.js

@@ -1,20 +1,20 @@
-import { fromZodError } from "zod-validation-error";
-import { log } from "./log.js";
-import { z } from "./zod.js";
-import { error } from "./errors.js";
-import { parseMultipart } from "./multipart.js";
+import { fromZodError } from 'zod-validation-error';
+import { log } from './log.js';
+import { z } from './zod.js';
+import { error } from './errors.js';
+import { parseMultipart } from './multipart.js';
 const parseJsonBody = async (req) => {
     var _a;
     const clonedRequest = req.clone();
-    if ((_a = clonedRequest.headers.get("content-type")) === null || _a === void 0 ? void 0 : _a.startsWith("application/json")) {
+    if ((_a = clonedRequest.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.startsWith('application/json')) {
         try {
             const json = await clonedRequest.json();
-            if (typeof json === "object") {
+            if (typeof json === 'object') {
                 return json;
             }
         }
         catch {
-            throw error(400, "Invalid JSON body");
+            throw error(400, 'Invalid JSON body');
         }
     }
 };
@@ -23,26 +23,29 @@ export const parseBody = async (req, module, tempFiles = []) => {
     let body = {};
     // GET, HEAD, DELETE, OPTIONS have no body
     const method = req.method.toUpperCase();
-    if (["GET", "HEAD", "DELETE", "OPTIONS"].includes(method)) {
+    if (['GET', 'HEAD', 'DELETE', 'OPTIONS'].includes(method)) {
         return body;
     }
-    const contentType = (_a = req.headers.get("content-type")) !== null && _a !== void 0 ? _a : "";
+    const contentType = (_a = req.headers.get('content-type')) !== null && _a !== void 0 ? _a : '';
     // JSON body
-    if (contentType.startsWith("application/json")) {
-        body = await req.clone().json().catch(() => {
-            throw error(400, "Invalid JSON body");
+    if (contentType.startsWith('application/json')) {
+        body = await req
+            .clone()
+            .json()
+            .catch(() => {
+            throw error(400, 'Invalid JSON body');
         });
     }
     // Multipart form body: stream uploads to disk rather than buffering the
     // whole payload in memory. Consume `req` directly (no `clone()` — a tee
     // would re-buffer the unread branch, defeating the point).
-    else if (contentType.startsWith("multipart/form-data")) {
+    else if (contentType.startsWith('multipart/form-data')) {
         const result = await parseMultipart(req);
         tempFiles.push(...result.tempFiles);
         body = result.body;
     }
     // URL-encoded form body (always small — buffering is fine)
-    else if (contentType.startsWith("application/x-www-form-urlencoded")) {
+    else if (contentType.startsWith('application/x-www-form-urlencoded')) {
         const formBody = {};
         const form = await req.clone().formData();
         for (const [key, value] of form.entries()) {
@@ -62,15 +65,15 @@ export const parseBody = async (req, module, tempFiles = []) => {
         body = formBody;
     }
     // Text body
-    else if (contentType.startsWith("text/plain")) {
+    else if (contentType.startsWith('text/plain')) {
         body = { text: await req.clone().text() };
     }
     // Binary body
-    else if (contentType.startsWith("application/octet-stream")) {
+    else if (contentType.startsWith('application/octet-stream')) {
         const buffer = await req.clone().arrayBuffer();
         body = { buffer };
     }
-    log("body: %O", body);
+    log('body: %O', body);
     const validator = (_b = module.Input) !== null && _b !== void 0 ? _b : z.object({});
     const validation = validator.safeParse(body);
     if (!validation.success) {
@@ -98,7 +101,7 @@ export const parseQuery = async (request, module) => {
             query[key] = value;
         }
     }
-    log("query: %O", query);
+    log('query: %O', query);
     const validator = (_a = module.Query) !== null && _a !== void 0 ? _a : z.object({});
     const validation = validator.safeParse(query);
     if (!validation.success) {
@@ -111,7 +114,7 @@ export const parseQuery = async (request, module) => {
 };
 export const parseParam = async (params, module) => {
     var _a;
-    log("param: %O", params);
+    log('param: %O', params);
     const validator = (_a = module.Param) !== null && _a !== void 0 ? _a : z.object({});
     const validation = validator.safeParse(params);
     if (!validation.success) {
@@ -125,12 +128,15 @@ export const parseOutput = async (out, module) => {
     var _a;
     let output = Array.isArray(out)
         ? out
-        : out && typeof out === "object" ? out : {};
+        : out && typeof out === 'object'
+            ? out
+            : {};
     const validator = (_a = module.Output) !== null && _a !== void 0 ? _a : z.object({});
     const validation = await validator.spa(output);
     if (!validation.success) {
-        log.extend("error")("output: %O failed validation: %O", output, validation.error);
-        throw error(500, "Output validation failed. Please report this error to the developer.");
+        const details = fromZodError(validation.error).message;
+        log.extend('error')('output: %O failed validation: %O', output, validation.error);
+        throw error(500, `Output validation failed. ${details}`);
     }
     else {
         output = validation.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riddl/core",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "license": "MIT",
   "type": "module",
   "dependencies": {