@kronos-integration/interceptor 10.2.38 → 10.3.1

package/README.md

@@ -1,7 +1,5 @@
-[![npm](https://img.shields.io/npm/v/@kronos-integration/interceptor.svg)](https://www.npmjs.com/package/@kronos-integration/interceptor)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
-[![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/interceptor\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/interceptor)
-[![downloads](http://img.shields.io/npm/dm/@kronos-integration/interceptor.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/interceptor)
+[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
 [![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/interceptor.svg?style=flat-square)](https://github.com/Kronos-Integration/interceptor/issues)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Finterceptor%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/interceptor/goto)
 [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
@@ -30,6 +28,7 @@ const response = interceptor.receive(endpoint, arg1, arg2);
 
 ### Table of Contents
 
+*   [Endpoint](#endpoint)
 *   [Interceptor](#interceptor)
     *   [Parameters](#parameters)
     *   [type](#type)
@@ -61,6 +60,10 @@ const response = interceptor.receive(endpoint, arg1, arg2);
 *   [expand](#expand)
     *   [Parameters](#parameters-7)
 
+## Endpoint
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
 ## Interceptor
 
 Base interceptor. The base class for all the interceptors
@@ -117,11 +120,11 @@ and calls the trailing interceptor.
 
 #### Parameters
 
-*   `endpoint` **Endpoint** 
+*   `endpoint` **[Endpoint](#endpoint)** 
 *   `next` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
 *   `args` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<any>** the request from the leading interceptor
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**&#x20;
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
 
 ### configurationAttributes
 
@@ -219,7 +222,7 @@ Rejects promise when it is not resolved within given timeout.
 *   `timeout` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** in miliseconds
 *   `source` **[Interceptor](#interceptor)**&#x20;
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**&#x20;
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
 
 ## expand
 

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@kronos-integration/interceptor",
-  "version": "10.2.38",
+  "version": "10.3.1",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "types": "./types/index.d.mts",
   "exports": {
-    ".": "./src/index.mjs"
+    ".": {
+      "default": "./src/index.mjs",
+      "types": "./types/index.d.mts"
+    }
   },
   "description": "intercepects / modifies requests as they pass between endpoints",
   "keywords": [
@@ -24,27 +28,29 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
-    "test": "npm run test:ava",
+    "prepare": "node --run prepare:typescript",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
+    "test": "node --run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint": "node --run lint:docs && node --run lint:typescript",
     "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
     "model-attributes": "^4.2.2"
   },
   "devDependencies": {
     "@kronos-integration/test-interceptor": "^7.0.27",
-    "ava": "^6.1.1",
-    "c8": "^9.1.0",
+    "ava": "^6.1.3",
+    "c8": "^10.1.2",
     "documentation": "^14.0.3",
-    "semantic-release": "^23.0.2",
-    "typescript": "^5.3.3"
+    "semantic-release": "^24.1.2",
+    "typescript": "^5.7.0-beta"
   },
   "engines": {
-    "node": ">=20.11.0"
+    "node": ">=22.11.0"
   },
   "repository": {
     "type": "git",

package/src/interceptor.mjs

@@ -1,5 +1,9 @@
 import { setAttributes, getAttributes } from "model-attributes";
 
+/**
+ * @typedef {Object} Endpoint
+ */
+
 /**
  * Base interceptor. The base class for all the interceptors
  * Calls configure() and reset().

package/types/index.d.mts

@@ -0,0 +1,6 @@
+export * from "./interceptor.mjs";
+export * from "./timeout-interceptor.mjs";
+export * from "./stats-collector-interceptor.mjs";
+export * from "./limiting-interceptor.mjs";
+export * from "./logging-interceptor.mjs";
+export * from "./template-interceptor.mjs";

package/types/interceptor.d.mts

@@ -0,0 +1,58 @@
+/**
+ * @typedef {Object} Endpoint
+ */
+/**
+ * Base interceptor. The base class for all the interceptors
+ * Calls configure() and reset().
+ * @param {Object} config The interceptor configuration object.
+ */
+export class Interceptor {
+    /**
+     * Meta description of the configuration
+     * @return {Object}
+     */
+    static get configurationAttributes(): any;
+    constructor(config: any);
+    /**
+     * The instance method returning the type.
+     * Defaults to the constructors name (class name)
+     * @return {string}
+     */
+    get type(): string;
+    /**
+     * Meta description of the configuration.
+     * @return {Object}
+     */
+    get configurationAttributes(): any;
+    /**
+     * Takes attribute values from config parameters
+     * and copies them over to the object.
+     * Copying is done according to configurationAttributes.
+     * Which means we loop over all configuration attributes
+     * and then for each attribute decide if we use the default, call
+     * a setter function or simply assign the attribute value.
+     * @param {Object} config
+     */
+    configure(config: any): void;
+    toString(): string;
+    toJSON(): any;
+    /**
+     * Deliver the json representation.
+     * @return {Object} json representation
+     */
+    toJSONWithOptions(options: any): any;
+    /**
+     * Forget all accumulated information.
+     */
+    reset(): void;
+    /**
+     * The receive method. This method receives the request from the leading interceptor
+     * and calls the trailing interceptor.
+     * @param {Endpoint} endpoint
+     * @param {Function} next
+     * @param {any[]} args the request from the leading interceptor
+     * @return {Promise<any>}
+     */
+    receive(endpoint: Endpoint, next: Function, ...args: any[]): Promise<any>;
+}
+export type Endpoint = any;

package/types/limiting-interceptor.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Limits the number of concurrent requests.
+ * Requests can be delayed or rejected.
+ * Sample config:
+ * [
+ *  { count: 20 },
+ *  { count: 10, delay:  100 },
+ *  { count:  5, delay:   10 }
+ * ]
+ *  1 -  4 : no delay
+ *  5 -  9 : 10ms delay
+ * 10 - 19 : 100ms delay
+ * 20      : reject
+ * default is to reject when more than 10 requests are on the way
+ */
+export class LimitingInterceptor extends Interceptor {
+    limits: any;
+    ongoingResponses: Set<any>;
+    ongoingRequests: number;
+    receive(endpoint: any, next: any, ...args: any[]): Promise<any>;
+    _processRequest(next: any, ...args: any[]): any;
+}
+import { Interceptor } from "./interceptor.mjs";

package/types/logging-interceptor.d.mts

@@ -0,0 +1,7 @@
+/**
+ * logs args and result
+ */
+export class LoggingInterceptor extends Interceptor {
+    receive(endpoint: any, next: any, ...args: any[]): Promise<any>;
+}
+import { Interceptor } from "./interceptor.mjs";

package/types/stats-collector-interceptor.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Interceptor to collect processing time, number of
+ * processed and failed requests.
+ */
+export class StatsCollectorInterceptor extends Interceptor {
+    get numberOfRequests(): any;
+    get numberOfFailedRequests(): any;
+    get maxRequestProcessingTime(): any;
+    get minRequestProcessingTime(): any;
+    get totalRequestProcessingTime(): any;
+    /**
+     * Logs the time the requests takes
+     */
+    receive(endpoint: any, ...args: any[]): Promise<any>;
+    #private;
+}
+import { Interceptor } from './interceptor.mjs';

package/types/template-interceptor.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Map params into requests.
+ */
+export class TemplateInterceptor extends Interceptor {
+    receive(endpoint: any, next: any, params: any): Promise<any>;
+}
+import { Interceptor } from "./interceptor.mjs";

package/types/timeout-interceptor.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Rejects a request if it does not resolve in a given time.
+ * @property {number} timeout
+ */
+export class TimeoutInterceptor extends Interceptor {
+    receive(endpoint: any, next: any, ...args: any[]): Promise<any>;
+}
+import { Interceptor } from "./interceptor.mjs";

package/types/util.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Expands '{{exp}}' expressions.
+ * @param {any} value
+ * @param {Object} params
+ * @return {any} expanded value
+ */
+export function expand(value: any, params: any): any;