@arkyn/server 3.0.1-beta.143 → 3.0.1-beta.144

package/dist/http/successResponses/success.js

@@ -1,13 +1,16 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 200 Success response.
+ * HTTP 200 OK — the request succeeded and the response body contains the result.
+ *
+ * @example
+ * ```typescript
+ * return new Success("Order fetched", { order }).toJson();
+ * ```
  */
 class Success extends SuccessResponse {
     /**
-     * Creates an instance of the `Success` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message, body) {
         super();
@@ -17,10 +20,7 @@ class Success extends SuccessResponse {
         this.body = body || undefined;
         this.onDebug();
     }
-    /**
-     * Converts the `Success` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -29,11 +29,7 @@ class Success extends SuccessResponse {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
-    /**
-     * Converts the `Success` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/http/successResponses/updated.d.ts

@@ -1,25 +1,22 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 200 Updated response.
+ * HTTP 200 OK — the request succeeded and the resource was updated.
+ * Semantically equivalent to `Success` but signals an update operation to consumers.
+ *
+ * @example
+ * ```typescript
+ * return new Updated("Profile updated", { user }).toJson();
+ * ```
  */
 declare class Updated extends SuccessResponse {
     /**
-     * Creates an instance of the `Updated` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message: string, body?: any);
-    /**
-     * Converts the `Updated` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse(): Response;
-    /**
-     * Converts the `Updated` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson(): Response;
 }
 export { Updated };

package/dist/http/successResponses/updated.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updated.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/updated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AAEH,cAAM,OAAQ,SAAQ,eAAe;IACnC;;;;;OAKG;gBAES,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC;;;OAGG;IAEH,UAAU,IAAI,QAAQ;IAUtB;;;;OAIG;IAEH,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"updated.d.ts","sourceRoot":"","sources":["../../../src/http/successResponses/updated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;GAQG;AACH,cAAM,OAAQ,SAAQ,eAAe;IACnC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAWvC,6EAA6E;IAC7E,UAAU,IAAI,QAAQ;IAUtB,uFAAuF;IACvF,MAAM,IAAI,QAAQ;CAQnB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/http/successResponses/updated.js

@@ -1,13 +1,17 @@
 import { SuccessResponse } from "./_successResponse";
 /**
- * Class representing a successful HTTP 200 Updated response.
+ * HTTP 200 OK — the request succeeded and the resource was updated.
+ * Semantically equivalent to `Success` but signals an update operation to consumers.
+ *
+ * @example
+ * ```typescript
+ * return new Updated("Profile updated", { user }).toJson();
+ * ```
  */
 class Updated extends SuccessResponse {
     /**
-     * Creates an instance of the `Updated` class.
-     *
-     * @param {string} message - A message describing the creation status.
-     * @param {any} body - The response body to be included in the HTTP response.
+     * @param message - Description included in the response status text.
+     * @param body - Data to include in the response body.
      */
     constructor(message, body) {
         super();
@@ -17,10 +21,7 @@ class Updated extends SuccessResponse {
         this.body = body || undefined;
         this.onDebug();
     }
-    /**
-     * Converts the `Updated` instance into a `Response` object.
-     * @returns {Response} A `Response` object with the body and response metadata.
-     */
+    /** Converts to a `Response` with `Content-Type: application/json` header. */
     toResponse() {
         const responseInit = {
             headers: { "Content-Type": "application/json" },
@@ -29,11 +30,7 @@ class Updated extends SuccessResponse {
         };
         return new Response(JSON.stringify(this.body), responseInit);
     }
-    /**
-     * Converts the `Updated` instance into a `Response` object using the `Response.json` method.
-     * This method is an alternative to `toResponse` for generating JSON responses.
-     * @returns {Response["json"]} A `Response` object with the JSON body and response metadata.
-     */
+    /** Converts to a `Response` using `Response.json()`. Alternative to `toResponse()`. */
     toJson() {
         const responseInit = {
             status: this.status,

package/dist/services/apiService.d.ts

@@ -1,7 +1,11 @@
 type ApiServiceConstructorProps = {
+    /** Base URL prepended to every request path (e.g. `"https://api.example.com"`). */
     baseUrl: string;
+    /** Default headers merged into every request. */
     baseHeaders?: HeadersInit;
+    /** Default Bearer token; can be overridden per request via `data.token`. */
     baseToken?: string | null;
+    /** When `true`, logs each request and response to the console in development. */
     enableDebug?: boolean;
 };
 type ApiRequestDataWithoutBodyProps = {
@@ -15,6 +19,22 @@ type ApiRequestDataWithBodyProps = {
     token?: string;
     urlParams?: Record<string, string>;
 };
+/**
+ * HTTP client for external API calls. Wraps fetch with base URL, default headers, optional auth token,
+ * and per-request overrides for all standard HTTP methods.
+ *
+ * @example
+ * ```typescript
+ * const api = new ApiService({
+ *   baseUrl: "https://api.example.com",
+ *   baseToken: session.token,
+ *   enableDebug: true,
+ * });
+ *
+ * const { data } = await api.get("/users/me");
+ * const { data: created } = await api.post("/orders", { body: { productId: 1 } });
+ * ```
+ */
 declare class ApiService {
     private baseUrl;
     private baseHeaders?;

package/dist/services/apiService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apiService.d.ts","sourceRoot":"","sources":["../../src/services/apiService.ts"],"names":[],"mappings":"AAOA,KAAK,0BAA0B,GAAG;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,KAAK,8BAA8B,GAAG;IACpC,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;AAEF,KAAK,2BAA2B,GAAG;IACjC,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;AASF,cAAM,UAAU;IACd,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAc;IAClC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,WAAW,CAAC,CAAU;gBAElB,KAAK,EAAE,0BAA0B;IAO7C,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,eAAe;IAcvB;;;;;OAKG;IAEG,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,8BAA8B;IAkBjE;;;;;OAKG;IAEG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAqB/D;;;;;OAKG;IAEG,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAqB9D;;;;;OAKG;IAEG,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAqBhE;;;;;OAKG;IAEG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;CAoBlE;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"apiService.d.ts","sourceRoot":"","sources":["../../src/services/apiService.ts"],"names":[],"mappings":"AAOA,KAAK,0BAA0B,GAAG;IAChC,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,iFAAiF;IACjF,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,KAAK,8BAA8B,GAAG;IACpC,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;AAEF,KAAK,2BAA2B,GAAG;IACjC,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;AASF;;;;;;;;;;;;;;;GAeG;AACH,cAAM,UAAU;IACd,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAc;IAClC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,WAAW,CAAC,CAAU;gBAElB,KAAK,EAAE,0BAA0B;IAO7C,OAAO,CAAC,OAAO;IAiBf,OAAO,CAAC,eAAe;IAcvB;;;;;OAKG;IAEG,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,8BAA8B;IAkBjE;;;;;OAKG;IAEG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAqB/D;;;;;OAKG;IAEG,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAqB9D;;;;;OAKG;IAEG,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAqBhE;;;;;OAKG;IAEG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;CAoBlE;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/services/apiService.js

@@ -4,6 +4,22 @@ import { patchRequest } from "../http/api/patchRequest";
 import { postRequest } from "../http/api/postRequest";
 import { putRequest } from "../http/api/putRequest";
 import { flushDebugLogs } from "../utilities/flushDebugLogs";
+/**
+ * HTTP client for external API calls. Wraps fetch with base URL, default headers, optional auth token,
+ * and per-request overrides for all standard HTTP methods.
+ *
+ * @example
+ * ```typescript
+ * const api = new ApiService({
+ *   baseUrl: "https://api.example.com",
+ *   baseToken: session.token,
+ *   enableDebug: true,
+ * });
+ *
+ * const { data } = await api.get("/users/me");
+ * const { data: created } = await api.post("/orders", { body: { productId: 1 } });
+ * ```
+ */
 class ApiService {
     baseUrl;
     baseHeaders;

package/dist/services/debugService.d.ts

@@ -1,17 +1,11 @@
 /**
- * Service for managing HTTP debug configuration and behavior.
- *
- * This service provides functionality to configure how the `getCaller` function
- * identifies the actual caller in the stack trace by allowing specific files
- * to be ignored during stack trace analysis.
+ * Manages stack-trace configuration for debug output, allowing specific adapter/wrapper files
+ * to be skipped so logs show the actual business-logic caller.
  *
  * @example
  * ```typescript
- * // Configure to ignore httpAdapter.ts in stack traces
- * HttpDebugService.setIgnoreFile("httpAdapter.ts");
- *
- * // Now when httpDebug is called from within httpAdapter.ts,
- * // it will show the actual caller (e.g., cart.ts) instead
+ * // Skip httpAdapter.ts so debug output shows the calling route instead
+ * DebugService.setIgnoreFile("httpAdapter.ts");
  * ```
  */
 declare class DebugService {
@@ -21,44 +15,18 @@ declare class DebugService {
      */
     static ignoreFiles: string[];
     /**
-     * Sets the file name to be ignored during stack trace analysis.
-     *
-     * This method configures the debug service to skip specific files when
-     * determining the actual caller of a function. This is useful when you have
-     * adapter or wrapper functions that you want to be transparent in the debug output.
+     * Adds a file name to the ignore list so it is skipped when resolving the caller in stack traces.
      *
-     * @param {string} file - The name of the file to ignore in stack traces (e.g., "httpAdapter.ts")
-     *
-     * @example
-     * ```typescript
-     * // Ignore the HTTP adapter file so debug shows the actual business logic caller
-     * DebugService.setIgnoreFile("httpAdapter.ts");
-     * ```
+     * @param file - File name to ignore (e.g. `"httpAdapter.ts"`).
      */
     static setIgnoreFile(file: string): void;
-    /**
-     * Clears all configured ignore files.
-     *
-     * This method resets the ignore file configuration, allowing all files to be
-     * considered in stack trace analysis again.
-     *
-     * @example
-     * ```typescript
-     * // Clear all ignore file configurations
-     * DebugService.clearIgnoreFiles();
-     * ```
-     */
+    /** Resets the ignore list, restoring full stack trace analysis. */
     static clearIgnoreFiles(): void;
     /**
-     * Retrieves information about the caller of the current function.
-     *
-     * This function analyzes the stack trace to determine the file path and function name
-     * of the caller. It excludes stack trace entries related to the `@arkyn/server` package
-     * and attempts to resolve the file path relative to the project root directory.
+     * Resolves the file path and function name of the code that triggered the current debug call,
+     * skipping internal node modules and any files registered with `setIgnoreFile`.
      *
-     * @returns An object containing:
-     * - `functionName`: The name of the function that called the current function, or "Unknown function" if it cannot be determined.
-     * - `callerInfo`: The file path of the caller relative to the project root, or "Unknown caller" if it cannot be determined.
+     * @returns `{ functionName, callerInfo }` — caller function name and file path relative to `process.cwd()`.
      */
     static getCaller(): {
         functionName: string;

package/dist/services/debugService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"debugService.d.ts","sourceRoot":"","sources":["../../src/services/debugService.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AAEH,cAAM,YAAY;IAChB;;;OAGG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,CAAM;IAElC;;;;;;;;;;;;;;OAcG;IAEH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIxC;;;;;;;;;;;OAWG;IAEH,MAAM,CAAC,gBAAgB,IAAI,IAAI;IAI/B;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,SAAS;;;;CAgEjB;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"debugService.d.ts","sourceRoot":"","sources":["../../src/services/debugService.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AAEH,cAAM,YAAY;IAChB;;;OAGG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,CAAM;IAElC;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIxC,mEAAmE;IACnE,MAAM,CAAC,gBAAgB,IAAI,IAAI;IAI/B;;;;;OAKG;IACH,MAAM,CAAC,SAAS;;;;CAgEjB;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/services/debugService.js

@@ -1,18 +1,12 @@
 import path from "node:path";
 /**
- * Service for managing HTTP debug configuration and behavior.
- *
- * This service provides functionality to configure how the `getCaller` function
- * identifies the actual caller in the stack trace by allowing specific files
- * to be ignored during stack trace analysis.
+ * Manages stack-trace configuration for debug output, allowing specific adapter/wrapper files
+ * to be skipped so logs show the actual business-logic caller.
  *
  * @example
  * ```typescript
- * // Configure to ignore httpAdapter.ts in stack traces
- * HttpDebugService.setIgnoreFile("httpAdapter.ts");
- *
- * // Now when httpDebug is called from within httpAdapter.ts,
- * // it will show the actual caller (e.g., cart.ts) instead
+ * // Skip httpAdapter.ts so debug output shows the calling route instead
+ * DebugService.setIgnoreFile("httpAdapter.ts");
  * ```
  */
 class DebugService {
@@ -22,48 +16,22 @@ class DebugService {
      */
     static ignoreFiles = [];
     /**
-     * Sets the file name to be ignored during stack trace analysis.
-     *
-     * This method configures the debug service to skip specific files when
-     * determining the actual caller of a function. This is useful when you have
-     * adapter or wrapper functions that you want to be transparent in the debug output.
+     * Adds a file name to the ignore list so it is skipped when resolving the caller in stack traces.
      *
-     * @param {string} file - The name of the file to ignore in stack traces (e.g., "httpAdapter.ts")
-     *
-     * @example
-     * ```typescript
-     * // Ignore the HTTP adapter file so debug shows the actual business logic caller
-     * DebugService.setIgnoreFile("httpAdapter.ts");
-     * ```
+     * @param file - File name to ignore (e.g. `"httpAdapter.ts"`).
      */
     static setIgnoreFile(file) {
         this.ignoreFiles.push(file);
     }
-    /**
-     * Clears all configured ignore files.
-     *
-     * This method resets the ignore file configuration, allowing all files to be
-     * considered in stack trace analysis again.
-     *
-     * @example
-     * ```typescript
-     * // Clear all ignore file configurations
-     * DebugService.clearIgnoreFiles();
-     * ```
-     */
+    /** Resets the ignore list, restoring full stack trace analysis. */
     static clearIgnoreFiles() {
         this.ignoreFiles = [];
     }
     /**
-     * Retrieves information about the caller of the current function.
-     *
-     * This function analyzes the stack trace to determine the file path and function name
-     * of the caller. It excludes stack trace entries related to the `@arkyn/server` package
-     * and attempts to resolve the file path relative to the project root directory.
+     * Resolves the file path and function name of the code that triggered the current debug call,
+     * skipping internal node modules and any files registered with `setIgnoreFile`.
      *
-     * @returns An object containing:
-     * - `functionName`: The name of the function that called the current function, or "Unknown function" if it cannot be determined.
-     * - `callerInfo`: The file path of the caller relative to the project root, or "Unknown caller" if it cannot be determined.
+     * @returns `{ functionName, callerInfo }` — caller function name and file path relative to `process.cwd()`.
      */
     static getCaller() {
         const projectRoot = process.cwd();

package/dist/services/logService.d.ts

@@ -7,23 +7,18 @@
 declare class LogService {
     private static config?;
     /**
-     * Sets the log service configuration only once.
-     * If the configuration is already set, the call is ignored.
+     * Sets the log service configuration once. Subsequent calls are ignored.
      *
-     * @param {object} config - Service configuration parameters.
-     * @param {string} config.trafficSourceId - Traffic source identifier.
-     * @param {string} config.userToken - User token for authentication.
-     * @param {string} [config.logBaseApiUrl] - Optional base URL for the log service.
+     * @param config.trafficSourceId - Traffic source identifier.
+     * @param config.userToken - User token for authentication.
+     * @param config.logBaseApiUrl - Override the default log ingestion base URL.
      */
     static setConfig(config: {
         trafficSourceId: string;
         userToken: string;
         logBaseApiUrl?: string;
     }): void;
-    /**
-     * Returns the current service configuration, if it exists.
-     * @returns {{ trafficSourceId: string; userToken: string; apiUrl: string } | undefined} The stored configuration or `undefined` if not set.
-     */
+    /** Returns the stored configuration, or `undefined` if `setConfig` has not been called. */
     static getConfig(): {
         trafficSourceId: string;
         userToken: string;

package/dist/services/logService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logService.d.ts","sourceRoot":"","sources":["../../src/services/logService.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAIpB;IAEF;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,IAAI;IAUR;;;OAGG;IACH,MAAM,CAAC,SAAS,IACZ;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAC9D,SAAS;IAIb;;OAEG;IACH,MAAM,CAAC,WAAW;CAGnB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"logService.d.ts","sourceRoot":"","sources":["../../src/services/logService.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAIpB;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,IAAI;IAUR,2FAA2F;IAC3F,MAAM,CAAC,SAAS,IACZ;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAC9D,SAAS;IAIb;;OAEG;IACH,MAAM,CAAC,WAAW;CAGnB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/services/logService.js

@@ -7,13 +7,11 @@
 class LogService {
     static config;
     /**
-     * Sets the log service configuration only once.
-     * If the configuration is already set, the call is ignored.
+     * Sets the log service configuration once. Subsequent calls are ignored.
      *
-     * @param {object} config - Service configuration parameters.
-     * @param {string} config.trafficSourceId - Traffic source identifier.
-     * @param {string} config.userToken - User token for authentication.
-     * @param {string} [config.logBaseApiUrl] - Optional base URL for the log service.
+     * @param config.trafficSourceId - Traffic source identifier.
+     * @param config.userToken - User token for authentication.
+     * @param config.logBaseApiUrl - Override the default log ingestion base URL.
      */
     static setConfig(config) {
         if (!!this.config)
@@ -23,10 +21,7 @@ class LogService {
         const apiUrl = `${baseUrl}/ingest-log`;
         this.config = { trafficSourceId, userToken, apiUrl };
     }
-    /**
-     * Returns the current service configuration, if it exists.
-     * @returns {{ trafficSourceId: string; userToken: string; apiUrl: string } | undefined} The stored configuration or `undefined` if not set.
-     */
+    /** Returns the stored configuration, or `undefined` if `setConfig` has not been called. */
     static getConfig() {
         return this.config;
     }

package/dist/utilities/decodeRequestBody.d.ts

@@ -1,15 +1,17 @@
 /**
- * Decodes the body of an incoming request into a JavaScript object.
+ * Decodes a request body into a plain object, trying JSON first then URL-encoded form data.
+ * Throws `BadRequest` if neither format can be parsed.
  *
- * This function attempts to parse the request body in the following order:
- * 1. Tries to parse the body as JSON.
- * 2. If JSON parsing fails, attempts to parse the body as URL-encoded form data.
- * 3. If both parsing attempts fail, logs the errors and returns an empty object.
+ * @param request - The incoming request whose body will be decoded.
+ * @returns The decoded body as a plain object.
  *
- * @param {Request} request - The incoming request object containing the body to decode.
- * @returns {Promise<any>} A promise that resolves to the decoded data as a JavaScript object.
- *
- * @throws Logs errors to the console if the request body cannot be read or parsed.
+ * @example
+ * ```typescript
+ * export async function action({ request }: ActionFunctionArgs) {
+ *   const body = await decodeRequestBody(request);
+ *   // body is now a plain JS object
+ * }
+ * ```
  */
 declare function decodeRequestBody(request: Request): Promise<any>;
 export { decodeRequestBody };

package/dist/utilities/decodeRequestBody.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decodeRequestBody.d.ts","sourceRoot":"","sources":["../../src/utilities/decodeRequestBody.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AAEH,iBAAe,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAsB/D;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"decodeRequestBody.d.ts","sourceRoot":"","sources":["../../src/utilities/decodeRequestBody.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AAEH,iBAAe,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAsB/D;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/utilities/decodeRequestBody.js

@@ -1,16 +1,18 @@
 import { BadRequest } from "../http/badResponses/badRequest";
 /**
- * Decodes the body of an incoming request into a JavaScript object.
+ * Decodes a request body into a plain object, trying JSON first then URL-encoded form data.
+ * Throws `BadRequest` if neither format can be parsed.
  *
- * This function attempts to parse the request body in the following order:
- * 1. Tries to parse the body as JSON.
- * 2. If JSON parsing fails, attempts to parse the body as URL-encoded form data.
- * 3. If both parsing attempts fail, logs the errors and returns an empty object.
+ * @param request - The incoming request whose body will be decoded.
+ * @returns The decoded body as a plain object.
  *
- * @param {Request} request - The incoming request object containing the body to decode.
- * @returns {Promise<any>} A promise that resolves to the decoded data as a JavaScript object.
- *
- * @throws Logs errors to the console if the request body cannot be read or parsed.
+ * @example
+ * ```typescript
+ * export async function action({ request }: ActionFunctionArgs) {
+ *   const body = await decodeRequestBody(request);
+ *   // body is now a plain JS object
+ * }
+ * ```
  */
 async function decodeRequestBody(request) {
     let data;

package/dist/utilities/decodeRequestErrorMessage.d.ts

@@ -1,16 +1,18 @@
 /**
- * Decodes an error message from a given request data object or response object.
+ * Extracts a human-readable error message from an API response body or a `Response` object.
+ * Checks `data.message`, `data.operator_erro_message`, `data.error`, `data.error.message`,
+ * and `response.statusText` in that order. Falls back to `"Missing error message"`.
  *
- * This function attempts to extract a meaningful error message from the provided
- * `data` or `response` objects by checking various properties in a specific order.
- * If no valid error message is found, it returns a default message: "Missing error message".
+ * @param data - Parsed response body that may contain error info.
+ * @param response - The raw `Response` object, used as a fallback for `statusText`.
+ * @returns The first non-empty string error message found.
  *
- * @param {any} data - The data object that may contain error information. It can have properties
- * such as `message`, `error`, or `error.message` that are checked for a string value.
- * @param {Response} response - The response object that may contain a `statusText` property
- * representing the HTTP status text.
- * @returns {string} A string representing the decoded error message, or a default message
- * if no error message is found.
+ * @example
+ * ```typescript
+ * const res = await fetch("/api/orders");
+ * const data = await res.json().catch(() => null);
+ * const message = decodeRequestErrorMessage(data, res);
+ * ```
  */
 declare function decodeRequestErrorMessage(data: any, response: Response): string;
 export { decodeRequestErrorMessage };

package/dist/utilities/decodeRequestErrorMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decodeRequestErrorMessage.d.ts","sourceRoot":"","sources":["../../src/utilities/decodeRequestErrorMessage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,iBAAS,yBAAyB,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAyBxE;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAC"}
+{"version":3,"file":"decodeRequestErrorMessage.d.ts","sourceRoot":"","sources":["../../src/utilities/decodeRequestErrorMessage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,iBAAS,yBAAyB,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAyBxE;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAC"}

package/dist/utilities/decodeRequestErrorMessage.js

@@ -1,16 +1,18 @@
 /**
- * Decodes an error message from a given request data object or response object.
+ * Extracts a human-readable error message from an API response body or a `Response` object.
+ * Checks `data.message`, `data.operator_erro_message`, `data.error`, `data.error.message`,
+ * and `response.statusText` in that order. Falls back to `"Missing error message"`.
  *
- * This function attempts to extract a meaningful error message from the provided
- * `data` or `response` objects by checking various properties in a specific order.
- * If no valid error message is found, it returns a default message: "Missing error message".
+ * @param data - Parsed response body that may contain error info.
+ * @param response - The raw `Response` object, used as a fallback for `statusText`.
+ * @returns The first non-empty string error message found.
  *
- * @param {any} data - The data object that may contain error information. It can have properties
- * such as `message`, `error`, or `error.message` that are checked for a string value.
- * @param {Response} response - The response object that may contain a `statusText` property
- * representing the HTTP status text.
- * @returns {string} A string representing the decoded error message, or a default message
- * if no error message is found.
+ * @example
+ * ```typescript
+ * const res = await fetch("/api/orders");
+ * const data = await res.json().catch(() => null);
+ * const message = decodeRequestErrorMessage(data, res);
+ * ```
  */
 function decodeRequestErrorMessage(data, response) {
     if (data?.message && typeof data?.message === "string") {

package/dist/utilities/errorHandler.d.ts

@@ -1,47 +1,22 @@
 /**
- * Handles errors and success responses, converting them into standard HTTP Response objects.
+ * Converts any thrown value into a `Response`. Recognizes all `@arkyn/server` success and error
+ * response classes, native `Response` objects, and falls back to a 500 `ServerError` for anything else.
  *
- * This function acts as a centralized error and response handler that processes various
- * response types (both success and error responses) and converts them into HTTP Response
- * objects. If the error is not recognized, it defaults to returning a ServerError response.
+ * Intended to be used as the catch handler of a route action or loader:
  *
- * @param {any} error - The error or response object to be handled. Can be:
- *   - A native Response object
- *   - A success response instance (Found, Created, Updated, Success, NoContent)
- *   - An error response instance (BadGateway, BadRequest, Conflict, Forbidden, NotFound, NotImplemented, ServerError, Unauthorized, UnprocessableEntity)
- *   - Any other error object (will be wrapped in ServerError)
- *
- * @returns {Response} A standard HTTP Response object with appropriate status code, headers, and body
- *
- * @example
- * ```typescript
- * // Handling a success response
- * try {
- *   const result = await someOperation();
- *   throw new Success("Operation successful", result);
- * } catch (error) {
- *   return errorHandler(error);
- * }
- * ```
- *
- * @example
- * ```typescript
- * // Handling an error response
- * try {
- *   const user = await findUser(id);
- *   if (!user) throw new NotFound("User not found");
- * } catch (error) {
- *   return errorHandler(error);
- * }
- * ```
+ * @param error - The thrown value to convert.
+ * @returns A `Response` with the appropriate HTTP status, headers, and JSON body.
  *
  * @example
  * ```typescript
- * // Handling unexpected errors
- * try {
- *   await riskyOperation();
- * } catch (error) {
- *   return errorHandler(error); // Returns ServerError response
+ * export async function action({ request }: ActionFunctionArgs) {
+ *   try {
+ *     const user = await findUser(id);
+ *     if (!user) throw new NotFound("User not found");
+ *     return new Success("User retrieved", { user }).toJson();
+ *   } catch (error) {
+ *     return errorHandler(error);
+ *   }
  * }
  * ```
  */

package/dist/utilities/errorHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/utilities/errorHandler.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,GAAG,GAAG,QAAQ,CAsC1C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/utilities/errorHandler.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,GAAG,GAAG,QAAQ,CAsC1C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}