@arkstack/common 0.14.21 → 0.15.0

package/dist/index.d.ts

@@ -325,7 +325,8 @@ type ArkstackErrorShape = Error & {
   errors?: unknown;
   getModelName?: () => string;
   status?: number;
-  statusCode?: number;
+  statusCode?: number; /** Custom properties merged into the error response payload. */
+  body?: Record<string, unknown>;
 };
 interface ArkstackErrorPayload {
   status: 'error';
@@ -333,6 +334,8 @@ interface ArkstackErrorPayload {
   message: string;
   errors?: unknown;
   stack?: string;
+  /** Custom fields contributed by an exception's `body`. */
+  [key: string]: unknown;
 }
 interface HookRegistry {}
 type Position = 'before' | 'after' | (string & {});
@@ -534,6 +537,21 @@ declare class AppException extends Exception {
     [key: string]: string[] | string;
   } | undefined;
   statusCode: number;
+  /**
+   * Custom properties merged into the error response payload.
+   *
+   * When set, these are merged over the standard error payload (`status`,
+   * `code`, `message`, …), letting a subclass add fields to — or reshape — the
+   * returned error body.
+   *
+   * @example
+   * ```ts
+   * class PaymentException extends AppException {
+   *   body = { error_code: 'PAYMENT_FAILED', retryable: true }
+   * }
+   * ```
+   */
+  body?: Record<string, unknown>;
   constructor(message?: string, statusCode?: number, options?: ErrorOptions);
 }
 //#endregion

package/dist/index.js

@@ -1,5 +1,5 @@
 import { _ as ConfigLoader, a as env, c as nodeEnv, d as resolveRuntimeDir, f as resolveRuntimeModule, g as CONFIG_KEY, h as envLoader, i as discoverCommands, l as outputDir, m as EnvLoader, n as appUrl, o as importFile, p as toOutputPath, r as config, s as interopDefault, t as appKey, u as rebuildOutput, v as configLoader } from "./system-DUaI4u99.js";
-import { _ as Hash, c as abortIf, d as initializeGlobalContext, f as isClass, g as Exception, h as AppException, l as assertFound, m as RequestException, p as perPage, s as abort, u as getModel, v as Encryption } from "./utils-Df3nH1sG.js";
+import { _ as Hash, c as abortIf, d as initializeGlobalContext, f as isClass, g as Exception, h as AppException, l as assertFound, m as RequestException, p as perPage, s as abort, u as getModel, v as Encryption } from "./utils-DLifcZWV.js";
 import { Hook as Hook$1 } from "@arkstack/foundry";
 import { Arkstack } from "@arkstack/contract";
 import { str } from "@h3ravel/support";
@@ -189,6 +189,7 @@ var ErrorHandler = class ErrorHandler {
 			delete payload.errors;
 			delete payload.stack;
 		}
+		if (detailedError?.body && typeof detailedError.body === "object") Object.assign(payload, detailedError.body);
 		return payload;
 	}
 	static logUnhandledError(err, request, message) {

package/dist/utils/index.js

@@ -1,2 +1,2 @@
-import { _ as Hash, a as use, c as abortIf, d as initializeGlobalContext, f as isClass, i as trait, l as assertFound, n as crc32, o as uses, p as perPage, r as getTraitMethods, s as abort, t as callTraitMethods, u as getModel, v as Encryption } from "../utils-Df3nH1sG.js";
+import { _ as Hash, a as use, c as abortIf, d as initializeGlobalContext, f as isClass, i as trait, l as assertFound, n as crc32, o as uses, p as perPage, r as getTraitMethods, s as abort, t as callTraitMethods, u as getModel, v as Encryption } from "../utils-DLifcZWV.js";
 export { Encryption, Hash, abort, abortIf, assertFound, callTraitMethods, crc32, getModel, getTraitMethods, initializeGlobalContext, isClass, perPage, trait, use, uses };

package/dist/{utils-Df3nH1sG.js → utils-DLifcZWV.js}

@@ -96,6 +96,21 @@ var Exception = class extends Error {
 var AppException = class extends Exception {
 	errors = void 0;
 	statusCode;
+	/**
+	* Custom properties merged into the error response payload.
+	*
+	* When set, these are merged over the standard error payload (`status`,
+	* `code`, `message`, …), letting a subclass add fields to — or reshape — the
+	* returned error body.
+	*
+	* @example
+	* ```ts
+	* class PaymentException extends AppException {
+	*   body = { error_code: 'PAYMENT_FAILED', retryable: true }
+	* }
+	* ```
+	*/
+	body;
 	constructor(message, statusCode = 400, options) {
 		super(message, options);
 		this.statusCode = statusCode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/common",
-  "version": "0.14.21",
+  "version": "0.15.0",
   "type": "module",
   "description": "Core utilities, primitives, and shared infrastructure for the Arkstack ecosystem.",
   "homepage": "https://arkstack.toneflix.net",
@@ -45,8 +45,8 @@
   "peerDependencies": {
     "@h3ravel/support": "^2.2.0",
     "arkormx": "^2.10.1",
-    "@arkstack/contract": "^0.14.21",
-    "@arkstack/foundry": "^0.14.21"
+    "@arkstack/contract": "^0.15.0",
+    "@arkstack/foundry": "^0.15.0"
   },
   "optionalDependencies": {
     "@faker-js/faker": "^10.4.0"