@h4ad/serverless-adapter 2.3.1 → 2.5.0

package/lib/core/constants.d.ts

@@ -1,4 +1,31 @@
+/**
+ * Default encodings that are treated as binary, they are compared with the `Content-Encoding` header.
+ *
+ * @breadcrumb Core / Constants
+ * @defaultValue ['gzip', 'deflate', 'br']
+ * @public
+ */
 export declare const DEFAULT_BINARY_ENCODINGS: string[];
+/**
+ * Default content types that are treated as binary, they are compared with the `Content-Type` header.
+ *
+ * @breadcrumb Core / Constants
+ * @defaultValue [new RegExp('^image/.*$'), new RegExp('^video/.*$'), 'application/pdf']
+ * @public
+ */
 export declare const DEFAULT_BINARY_CONTENT_TYPES: (string | RegExp)[];
+/**
+ * Type alias for empty response and can be used on some adapters when the adapter does not need to return a response.
+ *
+ * @breadcrumb Core / Constants
+ * @public
+ */
 export declare type IEmptyResponse = {};
+/**
+ * Constant for empty response and can be used on some adapters when the adapter does not need to return a response.
+ *
+ * @breadcrumb Core / Constants
+ * @public
+ */
 export declare const EmptyResponse: IEmptyResponse;
+//# sourceMappingURL=constants.d.ts.map

package/lib/core/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,EAA8B,CAAC;AAE5E;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAI3D,CAAC;AAEF;;;;;GAKG;AAEH,oBAAY,cAAc,GAAG,EAAE,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,cAAmB,CAAC"}

package/lib/core/constants.js

@@ -1,10 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmptyResponse = exports.DEFAULT_BINARY_CONTENT_TYPES = exports.DEFAULT_BINARY_ENCODINGS = void 0;
+/**
+ * Default encodings that are treated as binary, they are compared with the `Content-Encoding` header.
+ *
+ * @breadcrumb Core / Constants
+ * @defaultValue ['gzip', 'deflate', 'br']
+ * @public
+ */
 exports.DEFAULT_BINARY_ENCODINGS = ['gzip', 'deflate', 'br'];
+/**
+ * Default content types that are treated as binary, they are compared with the `Content-Type` header.
+ *
+ * @breadcrumb Core / Constants
+ * @defaultValue [new RegExp('^image/.*$'), new RegExp('^video/.*$'), 'application/pdf']
+ * @public
+ */
 exports.DEFAULT_BINARY_CONTENT_TYPES = [
     new RegExp('^image/.*$'),
     new RegExp('^video/.*$'),
     'application/pdf',
 ];
+/**
+ * Constant for empty response and can be used on some adapters when the adapter does not need to return a response.
+ *
+ * @breadcrumb Core / Constants
+ * @public
+ */
 exports.EmptyResponse = {};
+//# sourceMappingURL=constants.js.map

package/lib/core/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACU,QAAA,wBAAwB,GAAa,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAE5E;;;;;;GAMG;AACU,QAAA,4BAA4B,GAAwB;IAC/D,IAAI,MAAM,CAAC,YAAY,CAAC;IACxB,IAAI,MAAM,CAAC,YAAY,CAAC;IACxB,iBAAiB;CAClB,CAAC;AAWF;;;;;GAKG;AACU,QAAA,aAAa,GAAmB,EAAE,CAAC"}

package/lib/core/current-invoke.d.ts

@@ -1,37 +1,48 @@
 /**
  * The type that represents the object that handles the references to the event created by the serverless trigger or context created by the serverless environment.
+ *
+ * @breadcrumb Core / Current Invoke
+ * @public
  */
 export declare type CurrentInvoke<TEvent, TContext> = {
     /**
      * The event created by the serverless trigger
      *
-     * @note It's only null when you call {@link getCurrentInvoke} outside this library's pipeline.
+     * @remarks It's only null when you call {@link getCurrentInvoke} outside this library's pipeline.
      */
     event: TEvent | null;
     /**
      * The context created by the serverless environment
      *
-     * @note It's only null when you call {@link getCurrentInvoke} outside this library's pipeline.
+     * @remarks It's only null when you call {@link getCurrentInvoke} outside this library's pipeline.
      */
     context: TContext | null;
 };
 /**
  * Get the reference to the event created by the serverless trigger or context created by the serverless environment.
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * import type { ALBEvent, Context } from 'aws-lambda';
  *
  * // inside the method that handles the aws alb request.
  * const { event, context } = getCurrentInvoke<ALBEvent, Context>();
  * ```
+ *
+ * @breadcrumb Core / Current Invoke
+ * @public
  */
 export declare function getCurrentInvoke<TEvent = any, TContext = any>(): CurrentInvoke<TEvent, TContext>;
 /**
  * Method that saves to the event created by the serverless trigger or context created by the serverless environment.
  *
- * @note This method MUST NOT be called by you, this method MUST only be used internally in this library.
+ * @remarks This method MUST NOT be called by you, this method MUST only be used internally in this library.
+ *
+ * @param event - The event created by the serverless trigger
+ * @param context - The context created by the serverless environment
  *
- * @param event The event created by the serverless trigger
- * @param context The context created by the serverless environment
+ * @breadcrumb Core / Current Invoke
+ * @public
  */
 export declare function setCurrentInvoke<TEvent = any, TContext = any>({ event, context, }: CurrentInvoke<TEvent, TContext>): void;
+//# sourceMappingURL=current-invoke.d.ts.map

package/lib/core/current-invoke.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"current-invoke.d.ts","sourceRoot":"","sources":["../../src/core/current-invoke.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oBAAY,aAAa,CAAC,MAAM,EAAE,QAAQ,IAAI;IAC5C;;;;OAIG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC1B,CAAC;AAOF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,GAAG,GAAG,EAAE,QAAQ,GAAG,GAAG,KAAK,aAAa,CAC7E,MAAM,EACN,QAAQ,CACT,CAEA;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,GAAG,GAAG,EAAE,QAAQ,GAAG,GAAG,EAAE,EAC7D,KAAK,EACL,OAAO,GACR,EAAE,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,QAGjC"}

package/lib/core/current-invoke.js

@@ -8,12 +8,16 @@ const currentInvoke = {
 /**
  * Get the reference to the event created by the serverless trigger or context created by the serverless environment.
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * import type { ALBEvent, Context } from 'aws-lambda';
  *
  * // inside the method that handles the aws alb request.
  * const { event, context } = getCurrentInvoke<ALBEvent, Context>();
  * ```
+ *
+ * @breadcrumb Core / Current Invoke
+ * @public
  */
 function getCurrentInvoke() {
     return currentInvoke;
@@ -22,13 +26,17 @@ exports.getCurrentInvoke = getCurrentInvoke;
 /**
  * Method that saves to the event created by the serverless trigger or context created by the serverless environment.
  *
- * @note This method MUST NOT be called by you, this method MUST only be used internally in this library.
+ * @remarks This method MUST NOT be called by you, this method MUST only be used internally in this library.
+ *
+ * @param event - The event created by the serverless trigger
+ * @param context - The context created by the serverless environment
  *
- * @param event The event created by the serverless trigger
- * @param context The context created by the serverless environment
+ * @breadcrumb Core / Current Invoke
+ * @public
  */
 function setCurrentInvoke({ event, context, }) {
     currentInvoke.event = event;
     currentInvoke.context = context;
 }
 exports.setCurrentInvoke = setCurrentInvoke;
+//# sourceMappingURL=current-invoke.js.map

package/lib/core/current-invoke.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"current-invoke.js","sourceRoot":"","sources":["../../src/core/current-invoke.ts"],"names":[],"mappings":";;;AAsBA,MAAM,aAAa,GAA4B;IAC7C,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;CACZ,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAgB,gBAAgB;IAI9B,OAAO,aAAa,CAAC;AACvB,CAAC;AALD,4CAKC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAA+B,EAC7D,KAAK,EACL,OAAO,GACyB;IAChC,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;IAC5B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;AAClC,CAAC;AAND,4CAMC"}

package/lib/core/event-body.d.ts

@@ -2,15 +2,21 @@
 /**
  * Get the event body as buffer from body string with content length
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const body = '{}';
  * const [buffer, contentLength] = getEventBodyAsBuffer(body, false);
  * console.log(buffer);
  * // <Buffer 7b 7d>
  * console.log(contentLength);
  * // 2
+ * ```
  *
- * @param body The body string that can be encoded or not
- * @param isBase64Encoded Tells if body string is encoded in base64
+ * @param body - The body string that can be encoded or not
+ * @param isBase64Encoded - Tells if body string is encoded in base64
+ *
+ * @breadcrumb Core
+ * @public
  */
 export declare function getEventBodyAsBuffer(body: string, isBase64Encoded: boolean): [body: Buffer, contentLength: number];
+//# sourceMappingURL=event-body.d.ts.map

package/lib/core/event-body.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-body.d.ts","sourceRoot":"","sources":["../../src/core/event-body.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,OAAO,GACvB,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAOvC"}

package/lib/core/event-body.js

@@ -4,16 +4,21 @@ exports.getEventBodyAsBuffer = void 0;
 /**
  * Get the event body as buffer from body string with content length
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const body = '{}';
  * const [buffer, contentLength] = getEventBodyAsBuffer(body, false);
  * console.log(buffer);
  * // <Buffer 7b 7d>
  * console.log(contentLength);
  * // 2
+ * ```
  *
- * @param body The body string that can be encoded or not
- * @param isBase64Encoded Tells if body string is encoded in base64
+ * @param body - The body string that can be encoded or not
+ * @param isBase64Encoded - Tells if body string is encoded in base64
+ *
+ * @breadcrumb Core
+ * @public
  */
 function getEventBodyAsBuffer(body, isBase64Encoded) {
     const encoding = isBase64Encoded ? 'base64' : 'utf8';
@@ -22,3 +27,4 @@ function getEventBodyAsBuffer(body, isBase64Encoded) {
     return [buffer, contentLength];
 }
 exports.getEventBodyAsBuffer = getEventBodyAsBuffer;
+//# sourceMappingURL=event-body.js.map

package/lib/core/event-body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-body.js","sourceRoot":"","sources":["../../src/core/event-body.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,oBAAoB,CAClC,IAAY,EACZ,eAAwB;IAExB,MAAM,QAAQ,GAAmB,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IAErE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3C,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAE1D,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AACjC,CAAC;AAVD,oDAUC"}

package/lib/core/headers.d.ts

@@ -2,26 +2,37 @@ import { BothValueHeaders } from '../@types';
 /**
  * Transform a header map and make sure the value is not an array
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'accept-encoding': 'gzip', 'accept-language': ['en-US', 'en;q=0.9'] };
  * const flattenedHeaders = getFlattenedHeadersMap(headers, ',', true);
  * console.log(flattenedHeaders);
  * // { 'accept-encoding': 'gzip', 'accept-language': 'en-US,en;q=0.9' }
  * ```
- * @param headersMap The initial headers
- * @param separator The separator used when we join the array of header's value
- * @param lowerCaseKey Should put all keys in lowercase
+ *
+ * @param headersMap - The initial headers
+ * @param separator - The separator used when we join the array of header's value
+ * @param lowerCaseKey - Should put all keys in lowercase
+ *
+ * @breadcrumb Core / Headers
+ * @public
  */
 export declare function getFlattenedHeadersMap(headersMap: BothValueHeaders, separator?: string, lowerCaseKey?: boolean): Record<string, string>;
 /**
  * Transforms a header map into a multi-value map header.
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'accept-encoding': 'gzip', 'connection': ['keep-alive'] };
  * const multiValueHeaders = getMultiValueHeadersMap(headers);
  * console.log(multiValueHeaders);
  * // { 'accept-encoding': ['gzip'], 'connection': ['keep-alive'] }
  * ```
- * @param headersMap The initial headers
+ *
+ * @param headersMap - The initial headers
+ *
+ * @breadcrumb Core / Headers
+ * @public
  */
 export declare function getMultiValueHeadersMap(headersMap: BothValueHeaders): Record<string, string[]>;
+//# sourceMappingURL=headers.d.ts.map

package/lib/core/headers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../src/core/headers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAI7C;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,gBAAgB,EAC5B,SAAS,GAAE,MAAY,EACvB,YAAY,GAAE,OAAe,GAC5B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAaxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,gBAAgB,GAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAW1B"}

package/lib/core/headers.js

@@ -6,15 +6,20 @@ exports.getMultiValueHeadersMap = exports.getFlattenedHeadersMap = void 0;
 /**
  * Transform a header map and make sure the value is not an array
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'accept-encoding': 'gzip', 'accept-language': ['en-US', 'en;q=0.9'] };
  * const flattenedHeaders = getFlattenedHeadersMap(headers, ',', true);
  * console.log(flattenedHeaders);
  * // { 'accept-encoding': 'gzip', 'accept-language': 'en-US,en;q=0.9' }
  * ```
- * @param headersMap The initial headers
- * @param separator The separator used when we join the array of header's value
- * @param lowerCaseKey Should put all keys in lowercase
+ *
+ * @param headersMap - The initial headers
+ * @param separator - The separator used when we join the array of header's value
+ * @param lowerCaseKey - Should put all keys in lowercase
+ *
+ * @breadcrumb Core / Headers
+ * @public
  */
 function getFlattenedHeadersMap(headersMap, separator = ',', lowerCaseKey = false) {
     const commaDelimitedHeaders = {};
@@ -32,13 +37,18 @@ exports.getFlattenedHeadersMap = getFlattenedHeadersMap;
 /**
  * Transforms a header map into a multi-value map header.
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'accept-encoding': 'gzip', 'connection': ['keep-alive'] };
  * const multiValueHeaders = getMultiValueHeadersMap(headers);
  * console.log(multiValueHeaders);
  * // { 'accept-encoding': ['gzip'], 'connection': ['keep-alive'] }
  * ```
- * @param headersMap The initial headers
+ *
+ * @param headersMap - The initial headers
+ *
+ * @breadcrumb Core / Headers
+ * @public
  */
 function getMultiValueHeadersMap(headersMap) {
     const multiValueHeaders = {};
@@ -51,3 +61,4 @@ function getMultiValueHeadersMap(headersMap) {
     return multiValueHeaders;
 }
 exports.getMultiValueHeadersMap = getMultiValueHeadersMap;
+//# sourceMappingURL=headers.js.map

package/lib/core/headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../src/core/headers.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAIjB,YAAY;AAEZ;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,sBAAsB,CACpC,UAA4B,EAC5B,YAAoB,GAAG,EACvB,eAAwB,KAAK;IAE7B,MAAM,qBAAqB,GAA2B,EAAE,CAAC;IACzD,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAErD,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,iBAAiB,EAAE;QACxD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAElE,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;YAC5B,qBAAqB,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;;YACzD,qBAAqB,CAAC,MAAM,CAAC,GAAG,WAAW,IAAI,EAAE,CAAC;KACxD;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAjBD,wDAiBC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,uBAAuB,CACrC,UAA4B;IAE5B,MAAM,iBAAiB,GAA6B,EAAE,CAAC;IACvD,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAErD,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,iBAAiB,EAAE;QACxD,iBAAiB,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;YACrE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;YACzB,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;KAC3B;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAbD,0DAaC"}

package/lib/core/index.d.ts

@@ -9,3 +9,4 @@ export * from './no-op';
 export * from './optional';
 export * from './path';
 export * from './stream';
+//# sourceMappingURL=index.d.ts.map

package/lib/core/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/lib/core/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -21,3 +25,4 @@ __exportStar(require("./no-op"), exports);
 __exportStar(require("./optional"), exports);
 __exportStar(require("./path"), exports);
 __exportStar(require("./stream"), exports);
+//# sourceMappingURL=index.js.map

package/lib/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,8CAA4B;AAC5B,mDAAiC;AACjC,+CAA6B;AAC7B,4CAA0B;AAC1B,8CAA4B;AAC5B,2CAAyB;AACzB,0CAAwB;AACxB,6CAA2B;AAC3B,yCAAuB;AACvB,2CAAyB"}

package/lib/core/is-binary.d.ts

@@ -2,54 +2,72 @@ import { BinarySettings, BothValueHeaders } from '../@types';
 /**
  * The function that determines by the content encoding whether the response should be treated as binary
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Encoding': 'gzip' };
  * const isBinary = isContentEncodingBinary(headers, ['gzip']);
  * console.log(isBinary);
  * // true
  * ```
  *
- * @param headers The headers of the response
- * @param binaryEncodingTypes The list of content encodings that will be treated as binary
+ * @param headers - The headers of the response
+ * @param binaryEncodingTypes - The list of content encodings that will be treated as binary
+ *
+ * @breadcrumb Core / isBinary
+ * @public
  */
 export declare function isContentEncodingBinary(headers: BothValueHeaders, binaryEncodingTypes: string[]): boolean;
 /**
  * The function that returns the content type of headers
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Type': 'application/json' };
  * const contentType = getContentType(headers);
  * console.log(contentType);
  * // application/json
  * ```
  *
- * @param headers The headers of the response
+ * @param headers - The headers of the response
+ *
+ * @breadcrumb Core / isBinary
+ * @public
  */
 export declare function getContentType(headers: BothValueHeaders): string;
 /**
  * The function that determines by the content type whether the response should be treated as binary
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Type': 'image/png' };
  * const isBinary = isContentTypeBinary(headers, [new RegExp('^image/.*$')]);
  * console.log(isBinary);
  * // true
  * ```
  *
- * @param headers The headers of the response
- * @param binaryContentTypes The list of content types that will be treated as binary
+ * @param headers - The headers of the response
+ * @param binaryContentTypes - The list of content types that will be treated as binary
+ *
+ * @breadcrumb Core / isBinary
+ * @public
  */
 export declare function isContentTypeBinary(headers: BothValueHeaders, binaryContentTypes: (string | RegExp)[]): boolean;
 /**
  * The function used to determine from the headers and the binary settings if a response should be encoded or not
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Type': 'image/png', 'Content-Encoding': 'gzip' };
  * const isContentBinary = isBinary(headers, { contentEncodings: ['gzip'], contentTypes: [new RegExp('^image/.*$')] });
  * console.log(isContentBinary);
  * // true
+ * ```
+ *
+ * @param headers - The headers of the response
+ * @param binarySettings - The settings for the validation
  *
- * @param headers The headers of the response
- * @param binarySettings The settings for the validation
+ * @breadcrumb Core / isBinary
+ * @public
  */
 export declare function isBinary(headers: BothValueHeaders, binarySettings: BinarySettings): boolean;
+//# sourceMappingURL=is-binary.d.ts.map

package/lib/core/is-binary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-binary.d.ts","sourceRoot":"","sources":["../../src/core/is-binary.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAK7D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,gBAAgB,EACzB,mBAAmB,EAAE,MAAM,EAAE,GAC5B,OAAO,CAUT;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM,CAMhE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,gBAAgB,EACzB,kBAAkB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,WAexC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,gBAAgB,EACzB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAWT"}

package/lib/core/is-binary.js

@@ -7,15 +7,19 @@ const headers_1 = require("./headers");
 /**
  * The function that determines by the content encoding whether the response should be treated as binary
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Encoding': 'gzip' };
  * const isBinary = isContentEncodingBinary(headers, ['gzip']);
  * console.log(isBinary);
  * // true
  * ```
  *
- * @param headers The headers of the response
- * @param binaryEncodingTypes The list of content encodings that will be treated as binary
+ * @param headers - The headers of the response
+ * @param binaryEncodingTypes - The list of content encodings that will be treated as binary
+ *
+ * @breadcrumb Core / isBinary
+ * @public
  */
 function isContentEncodingBinary(headers, binaryEncodingTypes) {
     const multiValueHeaders = (0, headers_1.getMultiValueHeadersMap)(headers);
@@ -28,14 +32,18 @@ exports.isContentEncodingBinary = isContentEncodingBinary;
 /**
  * The function that returns the content type of headers
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Type': 'application/json' };
  * const contentType = getContentType(headers);
  * console.log(contentType);
  * // application/json
  * ```
  *
- * @param headers The headers of the response
+ * @param headers - The headers of the response
+ *
+ * @breadcrumb Core / isBinary
+ * @public
  */
 function getContentType(headers) {
     const flattenedHeaders = (0, headers_1.getFlattenedHeadersMap)(headers, ';', true);
@@ -47,15 +55,19 @@ exports.getContentType = getContentType;
 /**
  * The function that determines by the content type whether the response should be treated as binary
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Type': 'image/png' };
  * const isBinary = isContentTypeBinary(headers, [new RegExp('^image/.*$')]);
  * console.log(isBinary);
  * // true
  * ```
  *
- * @param headers The headers of the response
- * @param binaryContentTypes The list of content types that will be treated as binary
+ * @param headers - The headers of the response
+ * @param binaryContentTypes - The list of content types that will be treated as binary
+ *
+ * @breadcrumb Core / isBinary
+ * @public
  */
 function isContentTypeBinary(headers, binaryContentTypes) {
     const binaryContentTypesRegexes = binaryContentTypes.map(binaryContentType => binaryContentType instanceof RegExp
@@ -70,14 +82,19 @@ exports.isContentTypeBinary = isContentTypeBinary;
 /**
  * The function used to determine from the headers and the binary settings if a response should be encoded or not
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const headers = { 'Content-Type': 'image/png', 'Content-Encoding': 'gzip' };
  * const isContentBinary = isBinary(headers, { contentEncodings: ['gzip'], contentTypes: [new RegExp('^image/.*$')] });
  * console.log(isContentBinary);
  * // true
+ * ```
+ *
+ * @param headers - The headers of the response
+ * @param binarySettings - The settings for the validation
  *
- * @param headers The headers of the response
- * @param binarySettings The settings for the validation
+ * @breadcrumb Core / isBinary
+ * @public
  */
 function isBinary(headers, binarySettings) {
     if ('isBinary' in binarySettings) {
@@ -89,3 +106,4 @@ function isBinary(headers, binarySettings) {
         isContentTypeBinary(headers, binarySettings.contentTypes));
 }
 exports.isBinary = isBinary;
+//# sourceMappingURL=is-binary.js.map

package/lib/core/is-binary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-binary.js","sourceRoot":"","sources":["../../src/core/is-binary.ts"],"names":[],"mappings":";AAAA,8DAA8D;;;AAK9D,uCAA4E;AAE5E,YAAY;AAEZ;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,uBAAuB,CACrC,OAAyB,EACzB,mBAA6B;IAE7B,MAAM,iBAAiB,GAAG,IAAA,iCAAuB,EAAC,OAAO,CAAC,CAAC;IAE3D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IAE/D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;QAAE,OAAO,KAAK,CAAC;IAEnD,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CACnC,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAC3E,CAAC;AACJ,CAAC;AAbD,0DAaC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,cAAc,CAAC,OAAyB;IACtD,MAAM,gBAAgB,GAAG,IAAA,gCAAsB,EAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACpE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IAEjE,+CAA+C;IAC/C,OAAO,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACzC,CAAC;AAND,wCAMC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,mBAAmB,CACjC,OAAyB,EACzB,kBAAuC;IAEvC,MAAM,yBAAyB,GAAG,kBAAkB,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAC3E,iBAAiB,YAAY,MAAM;QACjC,CAAC,CAAC,iBAAiB;QACnB,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,EAAE,CAAC,CACvC,CAAC;IAEF,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAE5C,IAAI,CAAC,WAAW;QAAE,OAAO,KAAK,CAAC;IAE/B,OAAO,yBAAyB,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CACxD,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CACpC,CAAC;AACJ,CAAC;AAjBD,kDAiBC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,QAAQ,CACtB,OAAyB,EACzB,cAA8B;IAE9B,IAAI,UAAU,IAAI,cAAc,EAAE;QAChC,IAAI,cAAc,CAAC,QAAQ,KAAK,KAAK;YAAE,OAAO,KAAK,CAAC;QAEpD,OAAO,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACzC;IAED,OAAO,CACL,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,gBAAgB,CAAC;QACjE,mBAAmB,CAAC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAC1D,CAAC;AACJ,CAAC;AAdD,4BAcC"}

package/lib/core/logger.d.ts

@@ -1,38 +1,64 @@
 /**
  * The type representing the possible log levels to choose from.
+ *
+ * @breadcrumb Core / Logger
+ * @public
  */
 export declare type LogLevels = 'debug' | 'verbose' | 'info' | 'warn' | 'error' | 'none';
 /**
  * The options to customize {@link ILogger}
+ *
+ * @breadcrumb Core / Logger
+ * @public
  */
 export declare type LoggerOptions = {
     /**
-     * Select the log level, {@link LogLevels see more}.
+     * Select the log level, {@link LogLevels | see more}.
      *
-     * @default error
+     * @defaultValue error
      */
     level: LogLevels;
 };
 /**
  * The log function used in any level.
+ *
+ * @breadcrumb Core / Logger
+ * @public
  */
 export declare type LoggerFN = (message: any, ...additional: any[]) => void;
 /**
  * The interface representing the logger, you can provide a custom logger by implementing this interface.
+ *
+ * @breadcrumb Core / Logger
+ * @public
  */
 export declare type ILogger = Record<Exclude<LogLevels, 'none'>, LoggerFN>;
 /**
  * The method used to create a simple logger instance to use in this library.
  *
- * @note Behind the scenes, this simple logger sends the message to the `console` methods.
+ * @remarks Behind the scenes, this simple logger sends the message to the `console` methods.
  *
- * @example```typescript
+ * @example
+ * ```typescript
  * const logger = createDefaultLogger();
  *
  * logger.error('An error happens.');
  * // An error happens.
  * ```
  *
- * @param level Select the level of the log
+ * @param level - Select the level of the log
+ *
+ * @breadcrumb Core / Logger
+ * @public
  */
 export declare function createDefaultLogger({ level }?: LoggerOptions): ILogger;
+/**
+ * The method used to chck if logger was created by this library, or it was defined by the user.
+ *
+ * @param logger - The instance of the logger to check
+ *
+ * @breadcrumb Core / Logger
+ * @public
+ */
+export declare function isInternalLogger(logger: ILogger): boolean;
+//# sourceMappingURL=logger.d.ts.map

package/lib/core/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/core/logger.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oBAAY,SAAS,GACjB,OAAO,GACP,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,CAAC;AAEX;;;;;GAKG;AACH,oBAAY,aAAa,GAAG;IAC1B;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,QAAQ,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;AAEpE;;;;;GAKG;AACH,oBAAY,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;AAUnE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CACjC,EAAE,KAAK,EAAE,GAAE,aAAkC,GAC5C,OAAO,CAkCT;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAEzD"}