arri 0.34.0 → 0.36.1

package/dist/shared/{arri.1b62504f.mjs → arri.b1ff441a.mjs}

@@ -1,21 +1,39 @@
 import { isRpcHttpMethod, removeDisallowedChars, SCHEMA_VERSION } from 'arri-codegen-utils';
-import { createError, isError, setResponseStatus, send, eventHandler, isPreflightRequest, setResponseHeader, readRawBody, getValidatedQuery, defineEventHandler, getQuery, setHeader, createRouter, createApp, sendError } from 'h3';
+import consola from 'consola';
+import { isError, setResponseStatus, setResponseHeader, send, eventHandler, isPreflightRequest, readRawBody, getValidatedQuery, defineEventHandler, getQuery, setHeader, createRouter, createApp } from 'h3';
 import { a, isAObjectSchema, isADiscriminatorSchema } from 'arri-validate';
 import { createEventStream } from 'h3-sse';
 import { kebabCase, pascalCase } from 'scule';
 
-const ErrorResponse = a.object({
-  statusCode: a.int8(),
-  statusMessage: a.string(),
-  stack: a.optional(a.string()),
+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 = a.object({
+  code: a.int16(),
+  message: a.string(),
+  stack: a.optional(a.array(a.string())),
   data: a.optional(a.any())
 });
 function defineError(statusCode, input = {}) {
   const defaultVals = errorResponseDefaults[statusCode];
-  return 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
   });
 }
@@ -23,7 +41,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("."))) {
@@ -31,7 +49,7 @@ function errorResponseFromValidationErrors(errors, prefixText = `Missing or inva
     }
   }
   throw defineError(400, {
-    statusMessage: `${prefixText}: [${errorParts.join(",")}]`,
+    message: `${prefixText}: [${errorParts.join(",")}]`,
     data: errors
   });
 }
@@ -185,28 +203,55 @@ const errorResponseDefaults = {
     message: "Network Authentication Required"
   }
 };
-async function handleH3Error(err, event, onError) {
-  const error = 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}`
-  });
-  setResponseStatus(event, error.statusCode);
+async function handleH3Error(err, event, onError, debug) {
+  let arriErr;
+  if (err instanceof ArriServerError) {
+    arriErr = err;
+  } else if (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;
+  }
+  setResponseStatus(event, arriErr.code);
   if (onError) {
-    await onError(error, event);
+    await onError(arriErr, event);
   }
   if (event.handled) {
     return;
   }
-  await 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());
+  }
+  setResponseHeader(event, "Content-Type", "application/json");
+  setResponseStatus(event, error.code);
+  return send(event, JSON.stringify(payload));
 }
 
 function isRpcParamSchema(input) {
@@ -319,7 +364,7 @@ function registerRpc(router, path, procedure, opts) {
         if (!responseValidator?.validate(response)) {
           const errors = 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
           });
         }
@@ -342,7 +387,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 "";
   });
@@ -388,7 +433,7 @@ async function validateRpcRequestInput(event, httpMethod, schema) {
           ", "
         )}]`;
         throw defineError(400, {
-          statusMessage: message,
+          message,
           data: parsedParams.error
         });
       }
@@ -401,7 +446,7 @@ async function validateRpcRequestInput(event, httpMethod, schema) {
       const body = await 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 = a.safeParse(schema, body);
@@ -415,7 +460,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
@@ -488,11 +533,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",
@@ -511,11 +555,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",
@@ -601,9 +644,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 a.errors(procedure.response, input);
@@ -620,7 +666,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 "";
   });
@@ -687,7 +733,7 @@ function handleRoute(router, method, route, opts) {
             ", "
           )}]`;
           throw defineError(400, {
-            statusMessage: message
+            message
           });
         }
         event.context.query = parsedQuery.value;
@@ -711,7 +757,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
@@ -739,7 +785,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 "";
   });
@@ -813,32 +859,39 @@ class ArriApp {
     __publicField(this, "__isArri__", true);
     __publicField(this, "h3App");
     __publicField(this, "h3Router", 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 = 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,
       eventHandler(() => this.getAppDefinition())
     );
     if (process.env.ARRI_DEV_MODE === "true") {
+      consola.info(
+        `Arri definition available at \`http://<host>${this.definitionPath}\``
+      );
       this.h3Router.get(
         DEV_DEFINITION_ENDPOINT,
         eventHandler(() => this.getAppDefinition())
@@ -850,22 +903,16 @@ class ArriApp {
         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;
-        }
-        sendError(event, error);
+        return handleH3Error(error, event, this._onError, this._debug);
       })
     );
   }
@@ -880,11 +927,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
@@ -892,45 +939,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() {
@@ -938,10 +988,10 @@ class ArriApp {
       arriSchemaVersion: 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;
@@ -1007,4 +1057,4 @@ function defineConfig(config) {
   };
 }
 
-export { ArriApp as A, DEV_ENDPOINT_ROOT as D, ErrorResponse as E, DEV_DEFINITION_ENDPOINT as a, isRpc as b, createAppDefinition as c, defineRpc as d, createHttpRpcDefinition as e, getRpcParamName as f, getRpcPath as g, getRpcResponseName as h, isRpcParamSchema as i, defineError as j, errorResponseFromValidationErrors as k, handleH3Error as l, isArriConfig as m, isResolvedArriConfig as n, defaultConfig as o, defineConfig as p, ArriRouter as q, registerRpc as r, defineRoute as s, registerRoute as t, handleRoute as u, validateRpcRequestInput as v, defineEventStreamRpc as w, isEventStreamRpc as x, EventStreamConnection as y, registerEventStreamRpc as z };
+export { ArriApp as A, registerEventStreamRpc as B, DEV_ENDPOINT_ROOT as D, EventStreamConnection as E, DEV_DEFINITION_ENDPOINT as a, isRpc as b, createAppDefinition as c, defineRpc as d, createHttpRpcDefinition as e, getRpcParamName as f, getRpcPath as g, getRpcResponseName as h, isRpcParamSchema as i, ArriServerError as j, ArriServerErrorResponse as k, defineError as l, errorResponseFromValidationErrors as m, handleH3Error as n, isArriConfig as o, isResolvedArriConfig as p, defaultConfig as q, registerRpc as r, defineConfig as s, ArriRouter as t, defineRoute as u, validateRpcRequestInput as v, registerRoute as w, handleRoute as x, defineEventStreamRpc as y, isEventStreamRpc as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arri",
-  "version": "0.34.0",
+  "version": "0.36.1",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -43,10 +43,10 @@
     "prettier": "^3.2.5",
     "scule": "^1.3.0",
     "uncrypto": "^0.1.3",
-    "arri-codegen-dart": "0.34.0",
-    "arri-codegen-ts": "0.34.0",
-    "arri-validate": "0.34.0",
-    "arri-codegen-utils": "0.34.0"
+    "arri-codegen-utils": "0.36.1",
+    "arri-validate": "0.36.1",
+    "arri-codegen-ts": "0.36.1",
+    "arri-codegen-dart": "0.36.1"
   },
   "devDependencies": {
     "@types/degit": "^2.8.6",