arri 0.34.0 → 0.36.1

package/dist/shared/{arri.0dce1db1.cjs → arri.8e96548e.cjs}

@@ -1,23 +1,45 @@
 'use strict';
 
 const arriCodegenUtils = require('arri-codegen-utils');
+const consola = require('consola');
 const h3 = require('h3');
 const arriValidate = require('arri-validate');
 const h3Sse = require('h3-sse');
 const scule = require('scule');
 
-const ErrorResponse = arriValidate.a.object({
-  statusCode: arriValidate.a.int8(),
-  statusMessage: arriValidate.a.string(),
-  stack: arriValidate.a.optional(arriValidate.a.string()),
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const consola__default = /*#__PURE__*/_interopDefaultCompat(consola);
+
+var __defProp$3 = Object.defineProperty;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$3 = (obj, key, value) => {
+  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ArriServerError extends Error {
+  constructor(err) {
+    super(err.message);
+    __publicField$3(this, "code");
+    __publicField$3(this, "data");
+    this.code = err.code;
+    this.data = err.data;
+    if (err.stack) {
+      this.stack = err.stack;
+    }
+  }
+}
+const ArriServerErrorResponse = arriValidate.a.object({
+  code: arriValidate.a.int16(),
+  message: arriValidate.a.string(),
+  stack: arriValidate.a.optional(arriValidate.a.array(arriValidate.a.string())),
   data: arriValidate.a.optional(arriValidate.a.any())
 });
 function defineError(statusCode, input = {}) {
   const defaultVals = errorResponseDefaults[statusCode];
-  return h3.createError({
-    statusCode,
-    statusMessage: input.statusMessage ?? defaultVals.message ?? "An unknown error occurred",
-    stack: input.stack ?? "",
+  return new ArriServerError({
+    code: statusCode,
+    message: input.message ?? defaultVals?.message ?? "An unknown error occurred",
     data: input.data
   });
 }
@@ -25,7 +47,7 @@ function errorResponseFromValidationErrors(errors, prefixText = `Missing or inva
   const errorParts = [];
   for (const err of errors) {
     const propName = err.instancePath?.split("/") ?? [];
-    if (propName.length) {
+    if (propName.length > 0) {
       propName.shift();
     }
     if (!errorParts.includes(propName.join("."))) {
@@ -33,7 +55,7 @@ function errorResponseFromValidationErrors(errors, prefixText = `Missing or inva
     }
   }
   throw defineError(400, {
-    statusMessage: `${prefixText}: [${errorParts.join(",")}]`,
+    message: `${prefixText}: [${errorParts.join(",")}]`,
     data: errors
   });
 }
@@ -187,28 +209,55 @@ const errorResponseDefaults = {
     message: "Network Authentication Required"
   }
 };
-async function handleH3Error(err, event, onError) {
-  const error = h3.isError(err) ? err : defineError(500, {
-    statusMessage: typeof err === "object" && err != null && "message" in err && typeof err.message === "string" ? err.message : void 0,
-    data: err,
-    stack: `${err}`
-  });
-  h3.setResponseStatus(event, error.statusCode);
+async function handleH3Error(err, event, onError, debug) {
+  let arriErr;
+  if (err instanceof ArriServerError) {
+    arriErr = err;
+  } else if (h3.isError(err)) {
+    arriErr = new ArriServerError({
+      code: err.statusCode,
+      message: err.message,
+      stack: err.stack,
+      data: err.data
+    });
+  } else if (err instanceof Error) {
+    arriErr = new ArriServerError({
+      code: 500,
+      message: err.message,
+      data: err,
+      stack: err.stack
+    });
+  } else {
+    arriErr = new ArriServerError({
+      code: 500,
+      message: `An unknown error occurred`,
+      data: err
+    });
+  }
+  if (!arriErr) {
+    return;
+  }
+  h3.setResponseStatus(event, arriErr.code);
   if (onError) {
-    await onError(error, event);
+    await onError(arriErr, event);
   }
   if (event.handled) {
     return;
   }
-  await h3.send(
-    event,
-    JSON.stringify({
-      statusCode: error.statusCode,
-      statusMessage: error.statusMessage,
-      data: error.data,
-      stack: error.stack
-    })
-  );
+  return sendArriError(event, arriErr, debug);
+}
+async function sendArriError(event, error, debug) {
+  const payload = {
+    code: error.code,
+    message: error.message,
+    data: error.data
+  };
+  if (debug) {
+    payload.stack = error.stack?.split("\n").map((l) => l.trim());
+  }
+  h3.setResponseHeader(event, "Content-Type", "application/json");
+  h3.setResponseStatus(event, error.code);
+  return h3.send(event, JSON.stringify(payload));
 }
 
 function isRpcParamSchema(input) {
@@ -321,7 +370,7 @@ function registerRpc(router, path, procedure, opts) {
         if (!responseValidator?.validate(response)) {
           const errors = arriValidate.a.errors(procedure.response, response);
           throw defineError(500, {
-            statusMessage: "Failed to serialize response. Response does not match specified schema",
+            message: "Failed to serialize response. Response does not match specified schema",
             data: errors
           });
         }
@@ -344,7 +393,7 @@ function registerRpc(router, path, procedure, opts) {
         );
       }
     } catch (err) {
-      await handleH3Error(err, event, opts.onError);
+      await handleH3Error(err, event, opts.onError, opts.debug ?? false);
     }
     return "";
   });
@@ -390,7 +439,7 @@ async function validateRpcRequestInput(event, httpMethod, schema) {
           ", "
         )}]`;
         throw defineError(400, {
-          statusMessage: message,
+          message,
           data: parsedParams.error
         });
       }
@@ -403,7 +452,7 @@ async function validateRpcRequestInput(event, httpMethod, schema) {
       const body = await h3.readRawBody(event);
       if (!body) {
         throw defineError(400, {
-          statusMessage: `Invalid request body. Expected object. Got undefined.`
+          message: `Invalid request body. Expected object. Got undefined.`
         });
       }
       const parsedParams = arriValidate.a.safeParse(schema, body);
@@ -417,7 +466,7 @@ async function validateRpcRequestInput(event, httpMethod, schema) {
           }
         }
         throw defineError(400, {
-          statusMessage: `Invalid request body. Affected properties [${errorParts.join(
+          message: `Invalid request body. Affected properties [${errorParts.join(
             ", "
           )}]`,
           data: parsedParams.error
@@ -490,11 +539,10 @@ class EventStreamConnection {
           continue;
         }
         const errors2 = this.validationErrors(item);
-        const errorResponse2 = {
-          statusCode: 500,
-          statusMessage: "Failed to serialize response. Response does not match specified schema.",
+        const errorResponse2 = defineError(500, {
+          message: "Failed to serialize response. Response does not match specified schema.",
           data: errors2
-        };
+        });
         events.push({
           id: eventId,
           event: "error",
@@ -513,11 +561,10 @@ class EventStreamConnection {
       return;
     }
     const errors = this.validationErrors(data);
-    const errorResponse = {
-      statusCode: 500,
-      statusMessage: "Failed to serialize response. Response does not match specified schema.",
+    const errorResponse = defineError(500, {
+      message: "Failed to serialize response. Response does not match specified schema.",
       data: errors
-    };
+    });
     await this.eventStream.push({
       id: eventId,
       event: "error",
@@ -603,9 +650,12 @@ function registerEventStreamRpc(router, path, procedure, opts) {
         validator: responseValidator?.validate ?? function() {
           return true;
         },
-        serializer: responseValidator?.serialize ?? function(_) {
-          return "";
-        },
+        serializer: (
+          // eslint-disable-next-line @typescript-eslint/unbound-method
+          responseValidator?.serialize ?? function(_) {
+            return "";
+          }
+        ),
         validationErrors(input) {
           if (procedure.response) {
             return arriValidate.a.errors(procedure.response, input);
@@ -622,7 +672,7 @@ function registerEventStreamRpc(router, path, procedure, opts) {
         stream.send();
       }
     } catch (err) {
-      await handleH3Error(err, event, opts.onError);
+      await handleH3Error(err, event, opts.onError, opts.debug ?? false);
     }
     return "";
   });
@@ -689,7 +739,7 @@ function handleRoute(router, method, route, opts) {
             ", "
           )}]`;
           throw defineError(400, {
-            statusMessage: message
+            message
           });
         }
         event.context.query = parsedQuery.value;
@@ -713,7 +763,7 @@ function handleRoute(router, method, route, opts) {
             }
           }
           throw defineError(400, {
-            statusMessage: `Invalid request body. Affected properties [${errorParts.join(
+            message: `Invalid request body. Affected properties [${errorParts.join(
               ", "
             )}]`,
             data: parsedBody.error
@@ -741,7 +791,7 @@ function handleRoute(router, method, route, opts) {
         await route.postHandler(event);
       }
     } catch (err) {
-      await handleH3Error(err, event, opts.onError);
+      await handleH3Error(err, event, opts.onError, opts.debug ?? false);
     }
     return "";
   });
@@ -815,32 +865,39 @@ class ArriApp {
     __publicField(this, "__isArri__", true);
     __publicField(this, "h3App");
     __publicField(this, "h3Router", h3.createRouter());
-    __publicField(this, "rpcDefinitionPath");
-    __publicField(this, "rpcRoutePrefix");
+    __publicField(this, "_rpcDefinitionPath");
+    __publicField(this, "_rpcRoutePrefix");
     __publicField(this, "appInfo");
-    __publicField(this, "procedures", {});
-    __publicField(this, "models", {});
-    __publicField(this, "middlewares", []);
-    __publicField(this, "onRequest");
-    __publicField(this, "onAfterResponse");
-    __publicField(this, "onBeforeResponse");
-    __publicField(this, "onError");
+    __publicField(this, "_procedures", {});
+    __publicField(this, "_models", {});
+    __publicField(this, "_middlewares", []);
+    __publicField(this, "_onRequest");
+    __publicField(this, "_onAfterResponse");
+    __publicField(this, "_onBeforeResponse");
+    __publicField(this, "_onError");
+    __publicField(this, "_debug");
+    __publicField(this, "definitionPath");
     this.appInfo = opts?.appInfo;
     this.h3App = h3.createApp({
       debug: opts?.debug
     });
-    this.onRequest = opts.onRequest;
-    this.onError = opts.onError;
-    this.onAfterResponse = opts.onAfterResponse;
-    this.onBeforeResponse = opts.onBeforeResponse;
-    this.rpcRoutePrefix = opts?.rpcRoutePrefix ?? "";
-    this.rpcDefinitionPath = opts?.rpcDefinitionPath ?? "__definition";
+    this._debug = opts.debug ?? false;
+    this._onRequest = opts.onRequest;
+    this._onError = opts.onError;
+    this._onAfterResponse = opts.onAfterResponse;
+    this._onBeforeResponse = opts.onBeforeResponse;
+    this._rpcRoutePrefix = opts?.rpcRoutePrefix ?? "";
+    this._rpcDefinitionPath = opts?.rpcDefinitionPath ?? "__definition";
     this.h3App.use(this.h3Router);
+    this.definitionPath = this._rpcRoutePrefix ? `/${this._rpcRoutePrefix}/${this._rpcDefinitionPath}`.split("//").join("/") : `/${this._rpcDefinitionPath}`;
     this.h3Router.get(
-      this.rpcRoutePrefix ? `/${this.rpcRoutePrefix}/${this.rpcDefinitionPath}`.split("//").join("/") : `/${this.rpcDefinitionPath}`,
+      this.definitionPath,
       h3.eventHandler(() => this.getAppDefinition())
     );
     if (process.env.ARRI_DEV_MODE === "true") {
+      consola__default.info(
+        `Arri definition available at \`http://<host>${this.definitionPath}\``
+      );
       this.h3Router.get(
         DEV_DEFINITION_ENDPOINT,
         h3.eventHandler(() => this.getAppDefinition())
@@ -852,22 +909,16 @@ class ArriApp {
         h3.setResponseStatus(event, 404);
         const error = defineError(404);
         try {
-          if (this.onRequest) {
-            await this.onRequest(event);
+          if (this._onRequest) {
+            await this._onRequest(event);
           }
         } catch (err) {
-          await handleH3Error(err, event, this.onError);
+          await handleH3Error(err, event, this._onError, this._debug);
         }
         if (event.handled) {
           return;
         }
-        if (this.onError) {
-          await this.onError(error, event);
-        }
-        if (event.handled) {
-          return;
-        }
-        h3.sendError(event, error);
+        return handleH3Error(error, event, this._onError, this._debug);
       })
     );
   }
@@ -882,11 +933,11 @@ class ArriApp {
       this.registerModels(input.getModels());
       return;
     }
-    this.middlewares.push(input);
+    this._middlewares.push(input);
   }
   rpc(procedure) {
-    const path = procedure.path ?? getRpcPath(procedure.name, this.rpcRoutePrefix);
-    this.procedures[procedure.name] = createHttpRpcDefinition(
+    const path = procedure.path ?? getRpcPath(procedure.name, this._rpcRoutePrefix);
+    this._procedures[procedure.name] = createHttpRpcDefinition(
       procedure.name,
       path,
       procedure
@@ -894,45 +945,48 @@ class ArriApp {
     if (isRpcParamSchema(procedure.params)) {
       const paramName = getRpcParamName(procedure.name, procedure);
       if (paramName) {
-        this.models[paramName] = procedure.params;
+        this._models[paramName] = procedure.params;
       }
     }
     if (isRpcParamSchema(procedure.response)) {
       const responseName = getRpcResponseName(procedure.name, procedure);
       if (responseName) {
-        this.models[responseName] = procedure.response;
+        this._models[responseName] = procedure.response;
       }
     }
     if (isEventStreamRpc(procedure)) {
       registerEventStreamRpc(this.h3Router, path, procedure, {
-        middleware: this.middlewares,
-        onRequest: this.onRequest,
-        onError: this.onError,
-        onAfterResponse: this.onAfterResponse,
-        onBeforeResponse: this.onBeforeResponse
+        middleware: this._middlewares,
+        onRequest: this._onRequest,
+        onError: this._onError,
+        onAfterResponse: this._onAfterResponse,
+        onBeforeResponse: this._onBeforeResponse,
+        debug: this._debug
       });
       return;
     }
     registerRpc(this.h3Router, path, procedure, {
-      middleware: this.middlewares,
-      onRequest: this.onRequest,
-      onError: this.onError,
-      onAfterResponse: this.onAfterResponse,
-      onBeforeResponse: this.onBeforeResponse
+      middleware: this._middlewares,
+      onRequest: this._onRequest,
+      onError: this._onError,
+      onAfterResponse: this._onAfterResponse,
+      onBeforeResponse: this._onBeforeResponse,
+      debug: this._debug
     });
   }
   route(route) {
     registerRoute(this.h3Router, route, {
-      middleware: this.middlewares,
-      onRequest: this.onRequest,
-      onError: this.onError,
-      onAfterResponse: this.onAfterResponse,
-      onBeforeResponse: this.onBeforeResponse
+      middleware: this._middlewares,
+      onRequest: this._onRequest,
+      onError: this._onError,
+      onAfterResponse: this._onAfterResponse,
+      onBeforeResponse: this._onBeforeResponse,
+      debug: this._debug
     });
   }
   registerModels(models) {
     for (const key of Object.keys(models)) {
-      this.models[key] = models[key];
+      this._models[key] = models[key];
     }
   }
   getAppDefinition() {
@@ -940,10 +994,10 @@ class ArriApp {
       arriSchemaVersion: arriCodegenUtils.SCHEMA_VERSION,
       info: this.appInfo,
       procedures: {},
-      models: this.models
+      models: this._models
     };
-    for (const key of Object.keys(this.procedures)) {
-      const rpc = this.procedures[key];
+    for (const key of Object.keys(this._procedures)) {
+      const rpc = this._procedures[key];
       appDef.procedures[key] = rpc;
     }
     return appDef;
@@ -1011,9 +1065,10 @@ function defineConfig(config) {
 
 exports.ArriApp = ArriApp;
 exports.ArriRouter = ArriRouter;
+exports.ArriServerError = ArriServerError;
+exports.ArriServerErrorResponse = ArriServerErrorResponse;
 exports.DEV_DEFINITION_ENDPOINT = DEV_DEFINITION_ENDPOINT;
 exports.DEV_ENDPOINT_ROOT = DEV_ENDPOINT_ROOT;
-exports.ErrorResponse = ErrorResponse;
 exports.EventStreamConnection = EventStreamConnection;
 exports.createAppDefinition = createAppDefinition;
 exports.createHttpRpcDefinition = createHttpRpcDefinition;