@xylabs/express 5.0.83 → 5.0.84

package/README.md

@@ -113,6 +113,8 @@ SDK for base code for Api repos that use express and deploy on AWS ECS
 
 ***
 
+Static counter registry for tracking named numeric metrics.
+
 ## Constructors
 
 ### Constructor
@@ -205,6 +207,8 @@ static min(name, count): void;
 
 ***
 
+Measures and records the execution duration of async operations by name.
+
 ## Constructors
 
 ### Constructor
@@ -388,16 +392,22 @@ Logger.warn
 function addRouteDefinitions(app, routeDefinitions): void;
 ```
 
+Registers an array of route definitions on an Express application.
+
 ## Parameters
 
 ### app
 
 `Express`
 
+The Express application to register routes on.
+
 ### routeDefinitions
 
 [`RouteDefinition`](#../interfaces/RouteDefinition)\<`RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>\>[]
 
+The route definitions to register.
+
 ## Returns
 
 `void`
@@ -412,6 +422,8 @@ function addRouteDefinitions(app, routeDefinitions): void;
 function asyncHandler<P, ResBody, ReqBody, ReqQuery, Locals>(fn): (req, res, next) => Promise<unknown>;
 ```
 
+Wraps an async Express request handler to forward rejected promises to the error handler.
+
 ## Type Parameters
 
 ### P
@@ -440,8 +452,12 @@ function asyncHandler<P, ResBody, ReqBody, ReqQuery, Locals>(fn): (req, res, nex
 
 `RequestHandler`\<`P`, `ResBody`, `ReqBody`, `ReqQuery`, `Locals`\>
 
+The async request handler to wrap.
+
 ## Returns
 
+A request handler that catches async errors and passes them to next().
+
 ```ts
 (
    req, 
@@ -502,6 +518,8 @@ The response to set to the standard response format
 function compactObject<T>(obj): T;
 ```
 
+Returns a shallow copy of the object with all null and undefined values removed.
+
 ## Type Parameters
 
 ### T
@@ -514,10 +532,14 @@ function compactObject<T>(obj): T;
 
 `T`
 
+The object to compact.
+
 ## Returns
 
 `T`
 
+A new object with only defined, non-null properties.
+
   ### <a id="customPoweredByHeader"></a>customPoweredByHeader
 
 [**@xylabs/express**](#../README)
@@ -531,6 +553,8 @@ function customPoweredByHeader(
    next): void;
 ```
 
+Express middleware that sets the X-Powered-By header to 'XYO'.
+
 ## Parameters
 
 ### req
@@ -663,24 +687,34 @@ function errorToJsonHandler(
    next): void;
 ```
 
+Express error handler that logs the error and sends a JSON response with the error message and status code.
+
 ## Parameters
 
 ### error
 
 [`ExpressError`](#../interfaces/ExpressError)
 
+The Express error to handle.
+
 ### req
 
 `Request`
 
+The incoming request.
+
 ### res
 
 `Response`
 
+The outgoing response.
+
 ### next
 
 `NextFunction`
 
+The next middleware function.
+
 ## Returns
 
 `void`
@@ -695,10 +729,14 @@ function errorToJsonHandler(
 function getDefaultLogger(): Logger;
 ```
 
+Returns the singleton default logger instance, creating one if it does not exist.
+
 ## Returns
 
 `Logger`
 
+The default logger.
+
   ### <a id="getHttpHeader"></a>getHttpHeader
 
 [**@xylabs/express**](#../README)
@@ -798,16 +836,22 @@ precedence over the default
 function getLogger(minVerbosity?): Logger;
 ```
 
+Returns a cached Winston-backed logger at the specified verbosity level.
+
 ## Parameters
 
 ### minVerbosity?
 
 [`LoggerVerbosity`](#../type-aliases/LoggerVerbosity) = `'info'`
 
+The minimum log level to output. Defaults to 'info'.
+
 ## Returns
 
 `Logger`
 
+A logger instance configured for the given verbosity.
+
   ### <a id="getResponseMetadata"></a>getResponseMetadata
 
 [**@xylabs/express**](#../README)
@@ -818,16 +862,22 @@ function getLogger(minVerbosity?): Logger;
 function getResponseMetadata(res): Record<string, unknown>;
 ```
 
+Extracts response metadata from res.locals, computing profile duration if profiling was started.
+
 ## Parameters
 
 ### res
 
 `Response`
 
+The Express response to extract metadata from.
+
 ## Returns
 
 `Record`\<`string`, `unknown`\>
 
+The metadata record including any profiling information.
+
   ### <a id="isRawResponseFormatSet"></a>isRawResponseFormatSet
 
 [**@xylabs/express**](#../README)
@@ -1011,24 +1061,34 @@ function standardErrors(
    next): void;
 ```
 
+Express error handler that logs the error and sends a JSON:API-compliant error response.
+
 ## Parameters
 
 ### err
 
+The error to handle, or undefined if no error.
+
 [`ExpressError`](#../interfaces/ExpressError) | `undefined`
 
 ### req
 
 `Request`
 
+The incoming request.
+
 ### res
 
 `Response`
 
+The outgoing response.
+
 ### next
 
 `NextFunction`
 
+The next middleware function.
+
 ## Returns
 
 `void`
@@ -1077,12 +1137,16 @@ use zod instead
 function useRequestCounters(app): void;
 ```
 
+Registers middleware that increments per-path request counters and exposes a /stats endpoint.
+
 ## Parameters
 
 ### app
 
 `Application`
 
+The Express application to attach counters to.
+
 ## Returns
 
 `void`
@@ -1095,6 +1159,8 @@ function useRequestCounters(app): void;
 
 ***
 
+A successful JSON:API response containing primary data and optional included resources.
+
 ## Extends
 
 - [`ApiResponseBase`](#ApiResponseBase)
@@ -1250,6 +1316,8 @@ A short, human-readable summary of the problem that SHOULD NOT change from occur
 
 ***
 
+A JSON:API error response containing one or more error objects.
+
 ## Extends
 
 - [`ApiResponseBase`](#ApiResponseBase)
@@ -1338,8 +1406,7 @@ The values of type members MUST adhere to the same constraints as member names.
 
 ***
 
-Within a given API, each resource object's type and id pair MUST identify a single, unique resource.
-(The set of URIs controlled by a server, or multiple servers acting as one, constitute an API.)
+A JSON:API resource object with optional attributes, links, meta, and relationships.
 
 ## Extends
 
@@ -1420,6 +1487,8 @@ A relationships object describing relationships between the resource and other J
 
 ***
 
+Base interface for all JSON:API responses, including optional links and metadata.
+
 ## Extended by
 
 - [`ApiDataResponse`](#ApiDataResponse)
@@ -1455,12 +1524,16 @@ optional meta: Record<string, unknown>;
 
 ***
 
+Empty object type used as a default for request/response body generics.
+
   ### <a id="ExpressError"></a>ExpressError
 
 [**@xylabs/express**](#../README)
 
 ***
 
+An Error with an optional HTTP status code for Express error handling.
+
 ## Extends
 
 - `Error`
@@ -1479,6 +1552,8 @@ optional statusCode: number;
 
 ***
 
+A link with an href and associated metadata.
+
 ## Properties
 
 ### href
@@ -1501,6 +1576,8 @@ meta: Record<string, unknown>;
 
 ***
 
+Contains the resource linkage data for a JSON:API relationship.
+
 ## Properties
 
 ### data
@@ -1515,6 +1592,8 @@ data: ResourceLinkage;
 
 ***
 
+Contains the links for a JSON:API relationship.
+
 ## Properties
 
 ### links
@@ -1531,6 +1610,8 @@ links:
 
 ***
 
+A relationship link pointing to a related resource.
+
 ## Properties
 
 ### related
@@ -1547,6 +1628,8 @@ A related resource link
 
 ***
 
+A relationship link pointing to the relationship itself.
+
 ## Properties
 
 ### self
@@ -1565,6 +1648,8 @@ deleting the people resource itself. When fetched successfully, this link return
 
 ***
 
+JSON:API version and metadata descriptor.
+
 ## Properties
 
 ### meta?
@@ -1587,6 +1672,8 @@ optional version: "1.0" | "1.1";
 
 ***
 
+Configuration options for creating a logger instance.
+
 ## Properties
 
 ### defaultMeta?
@@ -1609,6 +1696,8 @@ optional level: LoggerVerbosity;
 
 ***
 
+Defines an Express route with its HTTP method, path, and handler(s).
+
 ## Type Parameters
 
 ### H
@@ -1680,6 +1769,8 @@ or "/data/attributes/title" for a specific attribute].
 type ApiLink = string | HrefWithMeta;
 ```
 
+A JSON:API link, either a simple URL string or an object with href and metadata.
+
   ### <a id="ApiLinks"></a>ApiLinks
 
 [**@xylabs/express**](#../README)
@@ -1690,6 +1781,8 @@ type ApiLink = string | HrefWithMeta;
 type ApiLinks = Record<string, ApiLink>;
 ```
 
+A collection of named JSON:API links.
+
   ### <a id="ApiResponse"></a>ApiResponse
 
 [**@xylabs/express**](#../README)
@@ -1702,6 +1795,8 @@ type ApiResponse<T> =
   | ApiErrorResponse;
 ```
 
+A JSON:API response, either a data response or an error response.
+
 ## Type Parameters
 
 ### T
@@ -1718,6 +1813,8 @@ type ApiResponse<T> =
 type HttpMethod = "get" | "post" | "put" | "patch" | "delete" | "options" | "head";
 ```
 
+Supported HTTP methods for route definitions.
+
   ### <a id="LogFunction"></a>LogFunction
 
 [**@xylabs/express**](#../README)
@@ -1756,6 +1853,8 @@ use from @xylabs/logger instead
 type LoggerMeta = Record<string, string | number>;
 ```
 
+Metadata key-value pairs attached to log entries.
+
   ### <a id="LoggerVerbosity"></a>LoggerVerbosity
 
 [**@xylabs/express**](#../README)
@@ -1766,6 +1865,8 @@ type LoggerMeta = Record<string, string | number>;
 type LoggerVerbosity = "error" | "warn" | "info" | "debug" | "all";
 ```
 
+Application-level log verbosity levels.
+
   ### <a id="NoLocals"></a>NoLocals
 
 [**@xylabs/express**](#../README)
@@ -1776,6 +1877,8 @@ type LoggerVerbosity = "error" | "warn" | "info" | "debug" | "all";
 type NoLocals = Record<string, any>;
 ```
 
+Default type for response locals.
+
   ### <a id="NoReqBody"></a>NoReqBody
 
 [**@xylabs/express**](#../README)
@@ -1786,6 +1889,8 @@ type NoLocals = Record<string, any>;
 type NoReqBody = Empty;
 ```
 
+Default type for request body when none is specified.
+
   ### <a id="NoReqParams"></a>NoReqParams
 
 [**@xylabs/express**](#../README)
@@ -1796,6 +1901,8 @@ type NoReqBody = Empty;
 type NoReqParams = ParamsDictionary;
 ```
 
+Default type for request route parameters.
+
   ### <a id="NoReqQuery"></a>NoReqQuery
 
 [**@xylabs/express**](#../README)
@@ -1806,6 +1913,8 @@ type NoReqParams = ParamsDictionary;
 type NoReqQuery = Query;
 ```
 
+Default type for request query parameters.
+
   ### <a id="NoResBody"></a>NoResBody
 
 [**@xylabs/express**](#../README)
@@ -1816,6 +1925,8 @@ type NoReqQuery = Query;
 type NoResBody = Empty;
 ```
 
+Default type for response body when none is specified.
+
   ### <a id="ParseFunc"></a>ParseFunc
 
 [**@xylabs/express**](#../README)
@@ -1826,6 +1937,8 @@ type NoResBody = Empty;
 type ParseFunc<T> = (value) => T;
 ```
 
+A function that parses a string value into the target type.
+
 ## Type Parameters
 
 ### T
@@ -1869,6 +1982,8 @@ Relationships may be to-one or to-many.
 type RelationshipMeta = Record<string, unknown>;
 ```
 
+Non-standard metadata associated with a JSON:API relationship.
+
   ### <a id="ResourceLinkage"></a>ResourceLinkage
 
 [**@xylabs/express**](#../README)
@@ -2016,6 +2131,8 @@ A JSON Body Parser middleware handler initialized with the default options
 const notImplemented: RequestHandler;
 ```
 
+Express request handler that responds with a 501 Not Implemented error.
+
   ### <a id="standardResponses"></a>standardResponses
 
 [**@xylabs/express**](#../README)

package/dist/node/Handler/RouteDefinition/RouteDefinition.d.ts

@@ -1,5 +1,7 @@
 import type { RequestHandler } from 'express-serve-static-core';
+/** Supported HTTP methods for route definitions. */
 export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head';
+/** Defines an Express route with its HTTP method, path, and handler(s). */
 export interface RouteDefinition<H extends RequestHandler = RequestHandler> {
     handlers: H[] | H;
     method: HttpMethod;

package/dist/node/Handler/RouteDefinition/RouteDefinition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RouteDefinition.d.ts","sourceRoot":"","sources":["../../../../src/Handler/RouteDefinition/RouteDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE/D,MAAM,MAAM,UAAU,GAChB,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,CAAA;AAEZ,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,cAAc,GAAG,cAAc;IAEzC,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB"}
+{"version":3,"file":"RouteDefinition.d.ts","sourceRoot":"","sources":["../../../../src/Handler/RouteDefinition/RouteDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE/D,oDAAoD;AACpD,MAAM,MAAM,UAAU,GAChB,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,CAAA;AAEZ,2EAA2E;AAC3E,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,cAAc,GAAG,cAAc;IAEzC,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB"}

package/dist/node/Handler/RouteDefinition/addRouteDefinitions.d.ts

@@ -1,4 +1,9 @@
 import type { Express } from 'express-serve-static-core';
 import type { RouteDefinition } from './RouteDefinition.ts';
+/**
+ * Registers an array of route definitions on an Express application.
+ * @param app The Express application to register routes on.
+ * @param routeDefinitions The route definitions to register.
+ */
 export declare const addRouteDefinitions: (app: Express, routeDefinitions: RouteDefinition[]) => void;
 //# sourceMappingURL=addRouteDefinitions.d.ts.map

package/dist/node/Handler/RouteDefinition/addRouteDefinitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addRouteDefinitions.d.ts","sourceRoot":"","sources":["../../../../src/Handler/RouteDefinition/addRouteDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,eAAO,MAAM,mBAAmB,GAAI,KAAK,OAAO,EAAE,kBAAkB,eAAe,EAAE,SAIpF,CAAA"}
+{"version":3,"file":"addRouteDefinitions.d.ts","sourceRoot":"","sources":["../../../../src/Handler/RouteDefinition/addRouteDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAExD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,OAAO,EAAE,kBAAkB,eAAe,EAAE,SAIpF,CAAA"}

package/dist/node/Handler/StatusCodeHandlers/notImplemented.d.ts

@@ -1,3 +1,4 @@
 import type { RequestHandler } from 'express-serve-static-core';
+/** Express request handler that responds with a 501 Not Implemented error. */
 export declare const notImplemented: RequestHandler;
 //# sourceMappingURL=notImplemented.d.ts.map

package/dist/node/Handler/StatusCodeHandlers/notImplemented.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notImplemented.d.ts","sourceRoot":"","sources":["../../../../src/Handler/StatusCodeHandlers/notImplemented.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAG/D,eAAO,MAAM,cAAc,EAAE,cAE5B,CAAA"}
+{"version":3,"file":"notImplemented.d.ts","sourceRoot":"","sources":["../../../../src/Handler/StatusCodeHandlers/notImplemented.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAG/D,8EAA8E;AAC9E,eAAO,MAAM,cAAc,EAAE,cAE5B,CAAA"}

package/dist/node/Handler/asyncHandler.d.ts

@@ -1,10 +1,21 @@
 import type { NextFunction, ParamsDictionary, Query, Request, RequestHandler, Response } from 'express-serve-static-core';
+/**
+ * Wraps an async Express request handler to forward rejected promises to the error handler.
+ * @param fn The async request handler to wrap.
+ * @returns A request handler that catches async errors and passes them to next().
+ */
 export declare function asyncHandler<P = NoReqParams, ResBody = NoResBody, ReqBody = NoReqBody, ReqQuery = NoReqQuery, Locals extends NoLocals = NoLocals>(fn: RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>): (req: Request<P, ResBody, ReqBody, ReqQuery, Locals>, res: Response<ResBody, Locals>, next: NextFunction) => Promise<unknown>;
+/** Empty object type used as a default for request/response body generics. */
 export interface Empty {
 }
+/** Default type for request route parameters. */
 export type NoReqParams = ParamsDictionary;
+/** Default type for response body when none is specified. */
 export type NoResBody = Empty;
+/** Default type for request body when none is specified. */
 export type NoReqBody = Empty;
+/** Default type for request query parameters. */
 export type NoReqQuery = Query;
+/** Default type for response locals. */
 export type NoLocals = Record<string, any>;
 //# sourceMappingURL=asyncHandler.d.ts.map

package/dist/node/Handler/asyncHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"asyncHandler.d.ts","sourceRoot":"","sources":["../../../src/Handler/asyncHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EACzE,MAAM,2BAA2B,CAAA;AAElC,wBAAgB,YAAY,CAAC,CAAC,GAAG,WAAW,EAAE,OAAO,GAAG,SAAS,EAAE,OAAO,GAAG,SAAS,EAAE,QAAQ,GAAG,UAAU,EAAE,MAAM,SAAS,QAAQ,GAAG,QAAQ,EAC/I,EAAE,EAAE,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,IAEjD,KAAK,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,YAAY,sBAGhH;AAED,MAAM,WAAW,KAAK;CAAG;AAEzB,MAAM,MAAM,WAAW,GAAG,gBAAgB,CAAA;AAC1C,MAAM,MAAM,SAAS,GAAG,KAAK,CAAA;AAC7B,MAAM,MAAM,SAAS,GAAG,KAAK,CAAA;AAC7B,MAAM,MAAM,UAAU,GAAG,KAAK,CAAA;AAE9B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA"}
+{"version":3,"file":"asyncHandler.d.ts","sourceRoot":"","sources":["../../../src/Handler/asyncHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EACzE,MAAM,2BAA2B,CAAA;AAElC;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,GAAG,WAAW,EAAE,OAAO,GAAG,SAAS,EAAE,OAAO,GAAG,SAAS,EAAE,QAAQ,GAAG,UAAU,EAAE,MAAM,SAAS,QAAQ,GAAG,QAAQ,EAC/I,EAAE,EAAE,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,IAEjD,KAAK,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,YAAY,sBAGhH;AAED,8EAA8E;AAC9E,MAAM,WAAW,KAAK;CAAG;AAEzB,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG,gBAAgB,CAAA;AAC1C,6DAA6D;AAC7D,MAAM,MAAM,SAAS,GAAG,KAAK,CAAA;AAC7B,4DAA4D;AAC5D,MAAM,MAAM,SAAS,GAAG,KAAK,CAAA;AAC7B,iDAAiD;AACjD,MAAM,MAAM,UAAU,GAAG,KAAK,CAAA;AAC9B,wCAAwC;AAExC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA"}

package/dist/node/Handler/errorToJsonHandler.d.ts

@@ -1,4 +1,11 @@
 import type { NextFunction, Request, Response } from 'express-serve-static-core';
 import type { ExpressError } from '../Model/index.ts';
+/**
+ * Express error handler that logs the error and sends a JSON response with the error message and status code.
+ * @param error The Express error to handle.
+ * @param req The incoming request.
+ * @param res The outgoing response.
+ * @param next The next middleware function.
+ */
 export declare const errorToJsonHandler: (error: ExpressError, req: Request, res: Response, next: NextFunction) => void;
 //# sourceMappingURL=errorToJsonHandler.d.ts.map

package/dist/node/Handler/errorToJsonHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorToJsonHandler.d.ts","sourceRoot":"","sources":["../../../src/Handler/errorToJsonHandler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,QAAQ,EAChC,MAAM,2BAA2B,CAAA;AAGlC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,kBAAkB,GAAI,OAAO,YAAY,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAOtG,CAAA"}
+{"version":3,"file":"errorToJsonHandler.d.ts","sourceRoot":"","sources":["../../../src/Handler/errorToJsonHandler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,QAAQ,EAChC,MAAM,2BAA2B,CAAA;AAGlC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,YAAY,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAOtG,CAAA"}

package/dist/node/Logger/LogFormats/LocalDev/logFormatLocalDev.d.ts

@@ -1,2 +1,3 @@
+/** Winston log format for local development with colorized output and timestamps. */
 export declare const logFormatLocalDev: import(".store/logform-npm-2.7.0-7a34a0bd17/package").Format;
 //# sourceMappingURL=logFormatLocalDev.d.ts.map

package/dist/node/Logger/LogFormats/LocalDev/logFormatLocalDev.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logFormatLocalDev.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/LogFormats/LocalDev/logFormatLocalDev.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,iBAAiB,8DAI7B,CAAA"}
+{"version":3,"file":"logFormatLocalDev.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/LogFormats/LocalDev/logFormatLocalDev.ts"],"names":[],"mappings":"AAMA,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,8DAI7B,CAAA"}

package/dist/node/Logger/LogFormats/Rollbar/logFormatRollbar.d.ts

@@ -1,2 +1,3 @@
+/** Winston log format for Rollbar using simple text output. */
 export declare const logFormatRollbar: import(".store/logform-npm-2.7.0-7a34a0bd17/package").Format;
 //# sourceMappingURL=logFormatRollbar.d.ts.map

package/dist/node/Logger/LogFormats/Rollbar/logFormatRollbar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logFormatRollbar.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/LogFormats/Rollbar/logFormatRollbar.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gBAAgB,8DAAW,CAAA"}
+{"version":3,"file":"logFormatRollbar.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/LogFormats/Rollbar/logFormatRollbar.ts"],"names":[],"mappings":"AAIA,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB,8DAAW,CAAA"}

package/dist/node/Logger/LogFormats/Structured/logFormatStructured.d.ts

@@ -1,2 +1,3 @@
+/** Winston log format for production with structured JSON output and timestamps. */
 export declare const logFormatStructured: import(".store/logform-npm-2.7.0-7a34a0bd17/package").Format;
 //# sourceMappingURL=logFormatStructured.d.ts.map

package/dist/node/Logger/LogFormats/Structured/logFormatStructured.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logFormatStructured.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/LogFormats/Structured/logFormatStructured.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,mBAAmB,8DAA+B,CAAA"}
+{"version":3,"file":"logFormatStructured.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/LogFormats/Structured/logFormatStructured.ts"],"names":[],"mappings":"AAMA,oFAAoF;AACpF,eAAO,MAAM,mBAAmB,8DAA+B,CAAA"}

package/dist/node/Logger/LoggerMeta.d.ts

@@ -1,2 +1,3 @@
+/** Metadata key-value pairs attached to log entries. */
 export type LoggerMeta = Record<string, string | number>;
 //# sourceMappingURL=LoggerMeta.d.ts.map

package/dist/node/Logger/LoggerMeta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LoggerMeta.d.ts","sourceRoot":"","sources":["../../../src/Logger/LoggerMeta.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA"}
+{"version":3,"file":"LoggerMeta.d.ts","sourceRoot":"","sources":["../../../src/Logger/LoggerMeta.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA"}

package/dist/node/Logger/LoggerOptions.d.ts

@@ -1,5 +1,6 @@
 import type { LoggerMeta } from './LoggerMeta.ts';
 import type { LoggerVerbosity } from './LoggerVerbosity.ts';
+/** Configuration options for creating a logger instance. */
 export interface LoggerOptions {
     defaultMeta?: LoggerMeta;
     level?: LoggerVerbosity;

package/dist/node/Logger/LoggerOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LoggerOptions.d.ts","sourceRoot":"","sources":["../../../src/Logger/LoggerOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB,KAAK,CAAC,EAAE,eAAe,CAAA;CACxB"}
+{"version":3,"file":"LoggerOptions.d.ts","sourceRoot":"","sources":["../../../src/Logger/LoggerOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,4DAA4D;AAC5D,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB,KAAK,CAAC,EAAE,eAAe,CAAA;CACxB"}

package/dist/node/Logger/LoggerVerbosity.d.ts

@@ -1,2 +1,3 @@
+/** Application-level log verbosity levels. */
 export type LoggerVerbosity = 'error' | 'warn' | 'info' | 'debug' | 'all';
 //# sourceMappingURL=LoggerVerbosity.d.ts.map

package/dist/node/Logger/LoggerVerbosity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LoggerVerbosity.d.ts","sourceRoot":"","sources":["../../../src/Logger/LoggerVerbosity.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAA"}
+{"version":3,"file":"LoggerVerbosity.d.ts","sourceRoot":"","sources":["../../../src/Logger/LoggerVerbosity.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAA"}

package/dist/node/Logger/Transports/Rollbar/RollbarTransport.d.ts

@@ -1,6 +1,7 @@
 import type Rollbar from 'rollbar';
 import type { TransportStreamOptions } from 'winston-transport';
 import Transport from 'winston-transport';
+/** Winston transport that forwards error-level log messages to Rollbar. */
 export declare class RollbarTransport extends Transport {
     protected readonly rollbar?: Rollbar;
     constructor(opts: TransportStreamOptions, rollbar?: Rollbar);

package/dist/node/Logger/Transports/Rollbar/RollbarTransport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RollbarTransport.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/Transports/Rollbar/RollbarTransport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,SAAS,MAAM,mBAAmB,CAAA;AAIzC,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;gBAElC,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,OAAO;IAQV,GAAG,CAAC,IAAI,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,MAAM,IAAI;CAK1D"}
+{"version":3,"file":"RollbarTransport.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/Transports/Rollbar/RollbarTransport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,SAAS,MAAM,mBAAmB,CAAA;AAIzC,2EAA2E;AAC3E,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;gBAElC,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,OAAO;IAQV,GAAG,CAAC,IAAI,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,MAAM,IAAI;CAK1D"}

package/dist/node/Logger/Transports/Rollbar/canGetDefaultRollbarTransport.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Checks whether the ROLLBAR_ACCESS_TOKEN environment variable is set.
+ * @param env The environment variables to check.
+ * @returns True if the Rollbar access token is available.
+ */
 export declare const canGetDefaultRollbarTransport: (env: {
     [key: string]: string | undefined;
 }) => boolean;

package/dist/node/Logger/Transports/Rollbar/canGetDefaultRollbarTransport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"canGetDefaultRollbarTransport.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/Transports/Rollbar/canGetDefaultRollbarTransport.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,GAAI,KAAK;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,KAAG,OAE1F,CAAA"}
+{"version":3,"file":"canGetDefaultRollbarTransport.d.ts","sourceRoot":"","sources":["../../../../../src/Logger/Transports/Rollbar/canGetDefaultRollbarTransport.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,GAAI,KAAK;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,KAAG,OAE1F,CAAA"}