@xylabs/express 4.13.14 → 4.13.16

package/dist/node/index.d.ts

@@ -1,354 +1,8 @@
-import { RequestHandler, Request, Response, NextFunction, Express, Application } from 'express';
-import { ParamsDictionary, Query, Request as Request$1 } from 'express-serve-static-core';
-import { Logger as Logger$1, LogFunction as LogFunction$1 } from '@xylabs/logger';
-import { Logger as Logger$2 } from 'winston';
-import { OptionsJson } from 'body-parser';
-import { NextHandleFunction } from 'connect';
-
-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>;
-interface Empty {
-}
-type NoReqParams = ParamsDictionary;
-type NoResBody = Empty;
-type NoReqBody = Empty;
-type NoReqQuery = Query;
-type NoLocals = Record<string, any>;
-
-interface ExpressError extends Error {
-    statusCode?: number;
-}
-
-declare const errorToJsonHandler: (error: ExpressError, req: Request, res: Response, next: NextFunction) => void;
-
-declare const notImplemented: RequestHandler;
-
-/**
- * Since there can be multiple of certain HTTP headers or
- * to prevent ugliness if someone did send us multiple
- * instances of a header we only expect one of, this
- * method grabs the 1st/only one of the desired header
- * @param header The header to find
- * @param req The received HTTP request (with headers)
- * @returns The first or only occurrence of the specified HTTP header
- */
-declare const getHttpHeader: (header: string, req: Request$1) => string | undefined;
-
-/**
- * Wrap Winston logger methods to adapt to familiar
- * console logging methods
- */
-declare class WrappedWinstonLogger implements Logger$1 {
-    protected readonly winston: Logger$2;
-    constructor(winston: Logger$2);
-    debug: LogFunction$1;
-    error: LogFunction$1;
-    info: LogFunction$1;
-    log: LogFunction$1;
-    trace: LogFunction$1;
-    warn: LogFunction$1;
-}
-
-/**
- * Static instance to prevent multiple instances of the same logger
- * with the same config
- */
-declare global {
-    var xy: {
-        defaultLogger?: WrappedWinstonLogger;
-    };
-}
-declare const getDefaultLogger: () => Logger$1;
-
-type LoggerVerbosity = 'error' | 'warn' | 'info' | 'debug' | 'all';
-
-declare const getLogger: (minVerbosity?: LoggerVerbosity) => Logger$1;
-
-type LoggerMeta = Record<string, string | number>;
-
-interface LoggerOptions {
-    defaultMeta?: LoggerMeta;
-    level?: LoggerVerbosity;
-}
-
-/** @deprecated use from @xylabs/logger instead */
-type LogFunction = LogFunction$1;
-/** @deprecated use from @xylabs/logger instead */
-type Logger = Logger$1;
-
-/**
- * Enable case sensitivity. When enabled, "/Foo" and "/foo" are different
- * routes. When disabled, "/Foo" and "/foo" are treated the same.
- * @param app The Express app to disable the header on.
- */
-declare const enableCaseSensitiveRouting: (app: Express) => void;
-/**
- * Disable case sensitivity. When enabled, "/Foo" and "/foo" are different
- * routes. When disabled, "/Foo" and "/foo" are treated the same.
- * @param app The Express app to disable the header on.
- */
-declare const disableCaseSensitiveRouting: (app: Express) => void;
-
-/**
- * By default Express appends the `X-Powered-By: Express` header to
- * all responses. Calling this method enables that behavior.
- * @param app The Express app to disable the header on.
- */
-declare const enableExpressDefaultPoweredByHeader: (app: Express) => void;
-/**
- * By default Express appends the `X-Powered-By: Express` header to
- * all responses. Calling this method disables that behavior.
- * @param app The Express app to disable the header on.
- */
-declare const disableExpressDefaultPoweredByHeader: (app: Express) => void;
-declare const customPoweredByHeader: (req: Request, res: Response, next: NextFunction) => void;
-
-/**
- * The default maximum request body size for the JSON Body Parser
- */
-declare const DefaultJsonBodyParserOptionsLimit = "100kb";
-/**
- * The default MIME types for the JSON Body Parser
- */
-declare const DefaultJsonBodyParserOptionsTypes: string[];
-/**
- * The default options for the JSON Body Parser
- */
-declare const DefaultJsonBodyParserOptions: OptionsJson;
-/**
- * Gets the default JSON Body Parser options merged with the supplied options
- * with the supplied options taking precedence
- * @param options The options to override the default JSON Body Parser options with
- * @returns The combined JSON Body Parser options with the supplied values taking
- * precedence over the default
- */
-declare const getJsonBodyParserOptions: (options?: Partial<OptionsJson>) => OptionsJson;
-/**
- * Get a JSON Body Parser connect middleware handler
- * @param options The options for the JSON Body Parser
- * @returns A middleware function that parses JSON bodies
- */
-declare const getJsonBodyParser: (options?: OptionsJson) => NextHandleFunction;
-/**
- * A JSON Body Parser middleware handler initialized with the default options
- */
-declare const jsonBodyParser: NextHandleFunction;
-
-declare const useRequestCounters: (app: Application) => void;
-
-/**
- * Connect middleware to enable profiling of response lifecycle timing. To effectively profile
- * the response timing, this middleware needs to be called first when initializing your Express
- * App
- * @example
- * const app = express()
- * app.use(responseProfiler)
- * // other initialization ...
- * @param _req The request
- * @param res The response
- * @param next The next function
- */
-declare const responseProfiler: (_req: Request, res: Response, next: NextFunction) => void;
-
-declare const getResponseMetadata: (res: Response) => Record<string, unknown>;
-
-interface HrefWithMeta {
-    href: string;
-    meta: Record<string, unknown>;
-}
-type ApiLink = string | HrefWithMeta;
-type ApiLinks = Record<string, ApiLink>;
-
-/**
- * An object containing references to the source of the error
- */
-interface Source {
-    /**
-     * A string indicating which URI query parameter caused the error.
-     */
-    parameter?: string;
-    /**
-     * A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object,
-     * or "/data/attributes/title" for a specific attribute].
-     */
-    pointer?: string;
-}
-interface ApiError {
-    /**
-     *  An application-specific error code, expressed as a string value.
-     */
-    code?: string;
-    /**
-     *  A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.
-     */
-    detail?: string;
-    /**
-     *  A unique identifier for this particular occurrence of the problem.
-     */
-    id?: string;
-    /**
-     *  A links object containing the following members:
-     *    about: a link that leads to further details about this particular occurrence of the problem
-     */
-    links?: ApiLinks;
-    /**
-     *  A meta object containing non-standard meta-information about the error.
-     */
-    meta?: Record<string, unknown>;
-    /**
-     *  An object containing references to the source of the error, optionally including any of the following members:
-     */
-    source?: Source;
-    /**
-     *  The HTTP status code applicable to this problem, expressed as a string value.
-     */
-    status?: string;
-    /**
-     *  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
-     */
-    title?: string;
-}
-
-/**
- * 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.)
- */
-interface ApiResourceIdentifierObject {
-    /**
-     * The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.
-     */
-    id: string;
-    /**
-     * The type member is used to describe resource objects that share common attributes and relationships.
-     * The values of type members MUST adhere to the same constraints as member names.
-     */
-    type: string;
-}
-
-interface IRelationshipSelfLink {
-    /**
-     * A link for the relationship itself (a "relationship link"). This link allows the client to directly manipulate the relationship.
-     * For example, removing an author through an article’s relationship URL would disconnect the person from the article without
-     * deleting the people resource itself. When fetched successfully, this link returns the linkage for the related resources as its primary data.
-     */
-    self: string;
-}
-interface IRelationshipRelatedLink {
-    /**
-     * A related resource link
-     */
-    related: string;
-}
-interface IRelationshipLinks {
-    links: IRelationshipRelatedLink | IRelationshipSelfLink;
-}
-/**
- * Resource linkage in a compound document allows a client to link together all of the included resource objects without having to GET any URLs via links.
- * Resource linkage MUST be represented as one of the following:
- *    • null for empty to-one relationships.
- *    • an empty array ([]) for empty to-many relationships.
- *    • a single resource identifier object for non-empty to-one relationships.
- *    • an array of resource identifier objects for non-empty to-many relationships.
- */
-type ResourceLinkage = null | [] | ApiResourceIdentifierObject | ApiResourceIdentifierObject[];
-interface IRelationshipData {
-    data: ResourceLinkage;
-}
-type RelationshipMeta = Record<string, unknown>;
-/**
- * The value of the relationships key MUST be an object (a "relationships object"). Members of the relationships object ("relationships")
- * represent references from the resource object in which it’s defined to other resource objects.
- * Relationships may be to-one or to-many.
- */
-type Relationship = IRelationshipLinks | IRelationshipData | RelationshipMeta;
-
-/**
- * Loosely following the JSON API 1.0 formats and conventions
- * https://jsonapi.org/format/
- */
-
-interface ApiResourceObject extends ApiResourceIdentifierObject {
-    /**
-     * An attributes object representing some of the resource's data.
-     */
-    attributes?: Record<string, unknown>;
-    /**
-     * A links object containing links related to the resource.
-     */
-    links?: ApiLinks;
-    /**
-     * A meta object containing non-standard meta-information about a resource that can not be represented as an attribute or relationship.
-     */
-    meta?: Record<string, unknown>;
-    /**
-     * A relationships object describing relationships between the resource and other JSON:API resources.
-     */
-    relationships?: Record<string, Relationship>;
-}
-interface JsonApi {
-    meta?: Record<string, unknown>;
-    version?: '1.0' | '1.1';
-}
-interface ApiResponseBase {
-    jsonapi?: JsonApi;
-    links?: ApiLinks;
-    meta?: Record<string, unknown>;
-}
-interface ApiDataResponse<T extends ApiResourceIdentifierObject> extends ApiResponseBase {
-    data: T;
-    included?: ApiResourceObject[];
-}
-interface ApiErrorResponse extends ApiResponseBase {
-    errors: ApiError[];
-}
-type ApiResponse<T extends ApiResourceIdentifierObject> = ApiDataResponse<T> | ApiErrorResponse;
-
-declare const standardErrors: (err: ExpressError | undefined, req: Request, res: Response, next: NextFunction) => void;
-
-/**
- * Flags the response to forgo the standard response envelope
- * and return the raw response body to the client
- * @param res The response to disable the standard response format on
- */
-declare const setRawResponseFormat: (res: Response) => void;
-/**
- * Clears any flags on the response, allowing the response to
- * use the default standard response envelope
- * @param res The response to set to the standard response format
- */
-declare const clearRawResponseFormat: (res: Response) => void;
-/**
- * Checks if there are any flags on the response that would cause it
- * to forgo the standard response envelope and return the raw response
- * body to the client
- * @param res
- * @returns True if there are any flags on the response, false otherwise
- */
-declare const isRawResponseFormatSet: (res: Response) => boolean;
-/**
- * Connect middleware to enable the transform of all responses to match
- * the standard response format (compatible with JSON API)
- */
-declare const standardResponses: RequestHandler;
-
-declare class Counters {
-    static counters: Record<string, number>;
-    static inc(name: string, count?: number): void;
-    static max(name: string, count: number): void;
-    static min(name: string, count: number): void;
-    private static catchError;
-}
-
-declare class Profiler {
-    stats: Record<string, number>;
-    profile<T>(name: string, promise: Promise<T>): Promise<T>;
-}
-
-declare const compactObject: <T extends Record<string, unknown>>(obj: T) => T;
-
-type ParseFunc<T = number> = (value: string) => T;
-declare const tryParse: <T = number>(func: ParseFunc<T>, value?: string) => (T & {}) | undefined;
-declare const tryParseFloat: (value?: string) => number | undefined;
-declare const tryParseInt: (value?: string) => number | undefined;
-
-export { Counters, DefaultJsonBodyParserOptions, DefaultJsonBodyParserOptionsLimit, DefaultJsonBodyParserOptionsTypes, Profiler, WrappedWinstonLogger, asyncHandler, clearRawResponseFormat, compactObject, customPoweredByHeader, disableCaseSensitiveRouting, disableExpressDefaultPoweredByHeader, enableCaseSensitiveRouting, enableExpressDefaultPoweredByHeader, errorToJsonHandler, getDefaultLogger, getHttpHeader, getJsonBodyParser, getJsonBodyParserOptions, getLogger, getResponseMetadata, isRawResponseFormatSet, jsonBodyParser, notImplemented, responseProfiler, setRawResponseFormat, standardErrors, standardResponses, tryParse, tryParseFloat, tryParseInt, useRequestCounters };
-export type { ApiDataResponse, ApiError, ApiErrorResponse, ApiLink, ApiLinks, ApiResourceIdentifierObject, ApiResourceObject, ApiResponse, ApiResponseBase, Empty, ExpressError, HrefWithMeta, IRelationshipData, IRelationshipLinks, IRelationshipRelatedLink, IRelationshipSelfLink, JsonApi, LogFunction, Logger, LoggerMeta, LoggerOptions, LoggerVerbosity, NoLocals, NoReqBody, NoReqParams, NoReqQuery, NoResBody, ParseFunc, Relationship, RelationshipMeta, ResourceLinkage, Source };
+export * from './Handler/index.ts';
+export * from './HttpUtil/index.ts';
+export * from './Logger/index.ts';
+export * from './middleware/index.ts';
+export * from './Model/index.ts';
+export * from './Performance/index.ts';
+export * from './Util/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA"}

package/dist/node/middleware/caseInsensitiveRouting/caseInsensitiveRouting.d.ts

@@ -0,0 +1,14 @@
+import type { Express } from 'express';
+/**
+ * Enable case sensitivity. When enabled, "/Foo" and "/foo" are different
+ * routes. When disabled, "/Foo" and "/foo" are treated the same.
+ * @param app The Express app to disable the header on.
+ */
+export declare const enableCaseSensitiveRouting: (app: Express) => void;
+/**
+ * Disable case sensitivity. When enabled, "/Foo" and "/foo" are different
+ * routes. When disabled, "/Foo" and "/foo" are treated the same.
+ * @param app The Express app to disable the header on.
+ */
+export declare const disableCaseSensitiveRouting: (app: Express) => void;
+//# sourceMappingURL=caseInsensitiveRouting.d.ts.map

package/dist/node/middleware/caseInsensitiveRouting/caseInsensitiveRouting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caseInsensitiveRouting.d.ts","sourceRoot":"","sources":["../../../../src/middleware/caseInsensitiveRouting/caseInsensitiveRouting.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAItC;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GAAI,KAAK,OAAO,SAEtD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GAAI,KAAK,OAAO,SAEvD,CAAA"}

package/dist/node/middleware/caseInsensitiveRouting/index.d.ts

@@ -0,0 +1,2 @@
+export * from './caseInsensitiveRouting.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/caseInsensitiveRouting/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/middleware/caseInsensitiveRouting/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAA"}

package/dist/node/middleware/customPoweredByHeader/customPoweredByHeader.d.ts

@@ -0,0 +1,15 @@
+import type { Express, NextFunction, Request, Response } from 'express';
+/**
+ * By default Express appends the `X-Powered-By: Express` header to
+ * all responses. Calling this method enables that behavior.
+ * @param app The Express app to disable the header on.
+ */
+export declare const enableExpressDefaultPoweredByHeader: (app: Express) => void;
+/**
+ * By default Express appends the `X-Powered-By: Express` header to
+ * all responses. Calling this method disables that behavior.
+ * @param app The Express app to disable the header on.
+ */
+export declare const disableExpressDefaultPoweredByHeader: (app: Express) => void;
+export declare const customPoweredByHeader: (req: Request, res: Response, next: NextFunction) => void;
+//# sourceMappingURL=customPoweredByHeader.d.ts.map

package/dist/node/middleware/customPoweredByHeader/customPoweredByHeader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customPoweredByHeader.d.ts","sourceRoot":"","sources":["../../../../src/middleware/customPoweredByHeader/customPoweredByHeader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EACzC,MAAM,SAAS,CAAA;AAKhB;;;;GAIG;AACH,eAAO,MAAM,mCAAmC,GAAI,KAAK,OAAO,SAE/D,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,GAAI,KAAK,OAAO,SAEhE,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAGpF,CAAA"}

package/dist/node/middleware/customPoweredByHeader/index.d.ts

@@ -0,0 +1,2 @@
+export * from './customPoweredByHeader.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/customPoweredByHeader/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/middleware/customPoweredByHeader/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA"}

package/dist/node/middleware/index.d.ts

@@ -0,0 +1,6 @@
+export * from './caseInsensitiveRouting/index.ts';
+export * from './customPoweredByHeader/index.ts';
+export * from './jsonBodyParser/index.ts';
+export * from './metrics/index.ts';
+export * from './standardResponses/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/middleware/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAA;AACjD,cAAc,kCAAkC,CAAA;AAChD,cAAc,2BAA2B,CAAA;AACzC,cAAc,oBAAoB,CAAA;AAClC,cAAc,8BAA8B,CAAA"}

package/dist/node/middleware/jsonBodyParser/index.d.ts

@@ -0,0 +1,2 @@
+export * from './jsonBodyParser.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/jsonBodyParser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/middleware/jsonBodyParser/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA"}

package/dist/node/middleware/jsonBodyParser/jsonBodyParser.d.ts

@@ -0,0 +1,33 @@
+import type { OptionsJson } from 'body-parser';
+import type { NextHandleFunction } from 'connect';
+/**
+ * The default maximum request body size for the JSON Body Parser
+ */
+export declare const DefaultJsonBodyParserOptionsLimit = "100kb";
+/**
+ * The default MIME types for the JSON Body Parser
+ */
+export declare const DefaultJsonBodyParserOptionsTypes: string[];
+/**
+ * The default options for the JSON Body Parser
+ */
+export declare const DefaultJsonBodyParserOptions: OptionsJson;
+/**
+ * Gets the default JSON Body Parser options merged with the supplied options
+ * with the supplied options taking precedence
+ * @param options The options to override the default JSON Body Parser options with
+ * @returns The combined JSON Body Parser options with the supplied values taking
+ * precedence over the default
+ */
+export declare const getJsonBodyParserOptions: (options?: Partial<OptionsJson>) => OptionsJson;
+/**
+ * Get a JSON Body Parser connect middleware handler
+ * @param options The options for the JSON Body Parser
+ * @returns A middleware function that parses JSON bodies
+ */
+export declare const getJsonBodyParser: (options?: OptionsJson) => NextHandleFunction;
+/**
+ * A JSON Body Parser middleware handler initialized with the default options
+ */
+export declare const jsonBodyParser: NextHandleFunction;
+//# sourceMappingURL=jsonBodyParser.d.ts.map

package/dist/node/middleware/jsonBodyParser/jsonBodyParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonBodyParser.d.ts","sourceRoot":"","sources":["../../../../src/middleware/jsonBodyParser/jsonBodyParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,iCAAiC,UAAU,CAAA;AAExD;;GAEG;AACH,eAAO,MAAM,iCAAiC,UAAoC,CAAA;AAElF;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,WAG1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,GAAI,UAAU,OAAO,CAAC,WAAW,CAAC,KAAG,WAEzE,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,UAAS,WAA0C,KAAG,kBAavF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,oBAAsB,CAAA"}

package/dist/node/middleware/jsonBodyParser/spec/jsonBodyParser.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=jsonBodyParser.spec.d.ts.map

package/dist/node/middleware/jsonBodyParser/spec/jsonBodyParser.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonBodyParser.spec.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/jsonBodyParser/spec/jsonBodyParser.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/node/middleware/metrics/counters.d.ts

@@ -0,0 +1,3 @@
+import type { Application } from 'express';
+export declare const useRequestCounters: (app: Application) => void;
+//# sourceMappingURL=counters.d.ts.map

package/dist/node/middleware/metrics/counters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"counters.d.ts","sourceRoot":"","sources":["../../../../src/middleware/metrics/counters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACZ,MAAM,SAAS,CAAA;AAIhB,eAAO,MAAM,kBAAkB,GAAI,KAAK,WAAW,KAAG,IAkBrD,CAAA"}

package/dist/node/middleware/metrics/index.d.ts

@@ -0,0 +1,3 @@
+export * from './counters.ts';
+export * from './responseProfiler.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/metrics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/middleware/metrics/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA"}

package/dist/node/middleware/metrics/responseProfiler.d.ts

@@ -0,0 +1,15 @@
+import type { NextFunction, Request, Response } from 'express';
+/**
+ * Connect middleware to enable profiling of response lifecycle timing. To effectively profile
+ * the response timing, this middleware needs to be called first when initializing your Express
+ * App
+ * @example
+ * const app = express()
+ * app.use(responseProfiler)
+ * // other initialization ...
+ * @param _req The request
+ * @param res The response
+ * @param next The next function
+ */
+export declare const responseProfiler: (_req: Request, res: Response, next: NextFunction) => void;
+//# sourceMappingURL=responseProfiler.d.ts.map

package/dist/node/middleware/metrics/responseProfiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseProfiler.d.ts","sourceRoot":"","sources":["../../../../src/middleware/metrics/responseProfiler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAAE,OAAO,EAAE,QAAQ,EAChC,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAMhF,CAAA"}

package/dist/node/middleware/standardResponses/getResponseMetadata.d.ts

@@ -0,0 +1,3 @@
+import type { Response } from 'express';
+export declare const getResponseMetadata: (res: Response) => Record<string, unknown>;
+//# sourceMappingURL=getResponseMetadata.d.ts.map

package/dist/node/middleware/standardResponses/getResponseMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getResponseMetadata.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/getResponseMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,eAAO,MAAM,mBAAmB,GAAI,KAAK,QAAQ,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAezE,CAAA"}

package/dist/node/middleware/standardResponses/index.d.ts

@@ -0,0 +1,5 @@
+export * from './getResponseMetadata.ts';
+export * from './jsonApi/index.ts';
+export * from './standardErrors.ts';
+export * from './standardResponses.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/standardResponses/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/middleware/standardResponses/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA"}

package/dist/node/middleware/standardResponses/jsonApi/error.d.ts

@@ -0,0 +1,51 @@
+import type { ApiLinks } from './links.ts';
+/**
+ * An object containing references to the source of the error
+ */
+export interface Source {
+    /**
+     * A string indicating which URI query parameter caused the error.
+     */
+    parameter?: string;
+    /**
+     * A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object,
+     * or "/data/attributes/title" for a specific attribute].
+     */
+    pointer?: string;
+}
+export interface ApiError {
+    /**
+     *  An application-specific error code, expressed as a string value.
+     */
+    code?: string;
+    /**
+     *  A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.
+     */
+    detail?: string;
+    /**
+     *  A unique identifier for this particular occurrence of the problem.
+     */
+    id?: string;
+    /**
+     *  A links object containing the following members:
+     *    about: a link that leads to further details about this particular occurrence of the problem
+     */
+    links?: ApiLinks;
+    /**
+     *  A meta object containing non-standard meta-information about the error.
+     */
+    meta?: Record<string, unknown>;
+    /**
+     *  An object containing references to the source of the error, optionally including any of the following members:
+     */
+    source?: Source;
+    /**
+     *  The HTTP status code applicable to this problem, expressed as a string value.
+     */
+    status?: string;
+    /**
+     *  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
+     */
+    title?: string;
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/node/middleware/standardResponses/jsonApi/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}

package/dist/node/middleware/standardResponses/jsonApi/index.d.ts

@@ -0,0 +1,6 @@
+export * from './error.ts';
+export * from './links.ts';
+export * from './relationship.ts';
+export * from './resourceIdentifier.ts';
+export * from './response.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/middleware/standardResponses/jsonApi/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,eAAe,CAAA"}

package/dist/node/middleware/standardResponses/jsonApi/links.d.ts

@@ -0,0 +1,7 @@
+export interface HrefWithMeta {
+    href: string;
+    meta: Record<string, unknown>;
+}
+export type ApiLink = string | HrefWithMeta;
+export type ApiLinks = Record<string, ApiLink>;
+//# sourceMappingURL=links.d.ts.map

package/dist/node/middleware/standardResponses/jsonApi/links.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"links.d.ts","sourceRoot":"","sources":["../../../../../src/middleware/standardResponses/jsonApi/links.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B;AACD,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,YAAY,CAAA;AAC3C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA"}