@types/sap__approuter 14.3.0 → 14.3.2

sap__approuter/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for @sap/approuter (https://www.npmjs.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sap__approuter.
 
 ### Additional Details
- * Last updated: Tue, 21 Nov 2023 10:39:42 GMT
+ * Last updated: Wed, 29 Nov 2023 13:08:30 GMT
  * Dependencies: [@types/http-server](https://npmjs.com/package/@types/http-server), [@types/node](https://npmjs.com/package/@types/node), [@types/verror](https://npmjs.com/package/@types/verror)
 
 # Credits

sap__approuter/index.d.ts

@@ -60,22 +60,36 @@ declare namespace approuter {
          */
         backendTimeout?: (req: IncomingMessage, done: () => void) => void;
 
-        /**
-         * Callback for {@link afterRequestHandler}
-         *
-         * @param error - Error object in case of error
-         * @param incomingResponse - Modified incomingResponse
-         */
+        /** In order to make it easier to write middlewares being agnostic of the route, the `req.url` will be altered to remove the route part and the original URL will be set to this value */
+        originalUrl?: string;
+
+        /** Note: On each request, the application router executes registered middlewares in a certain order and the session is not available to all of them. */
+        sessionID?: string;
+
+        sessionStore?: SessionStore;
     }
 
     /**
      * A handler for requests, called Middleware.
      *
+     * The generic type T can be used to add custom properties to the request object type
+     * this is useful if a middleware adds custom properties to the request object
+     *
+     * @example
+     *   interface RequestWithSession = {
+     *     session?: {}
+     *   }
+     *   MiddlewareHandler<RequestWithSession>
+     *
      * @param request - Data of the incoming Request
      * @param response - Object for the outgoing Response; can be manipulated to alter the response
      * @param next - Call next to give control back to Application Router Middleware
      */
-    type MiddlewareHandler = (request: AppRouterIncomingMessage, response: ServerResponse, next: () => void) => void;
+    type MiddlewareHandler<T = {}> = (
+        request: AppRouterIncomingMessage & T,
+        response: ServerResponse,
+        next: (value?: Error | string) => void,
+    ) => void;
 
     interface Extensions {
         /**
@@ -253,21 +267,6 @@ declare namespace approuter {
 
     /**
      * SAP Application Router
-     *
-     * For full help, please consult the README file in @sap/approuter (the source npm package) or
-     * https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/LATEST/en-US/050d87a61faa4fb88f687abd7bdf16ce.html
-     *
-     * These types (and their tests) are mostly extracted from the above mentioned README file and `doc/extending.md`
-     * in @sap/approuter (the source npm package). If some types are incorrect or missing, please open up an issue at
-     * {@link https://github.com/DefinitelyTyped/DefinitelyTyped}, or, even better, add them by yourself via a Pull Request.
-     *
-     * ## Command Parser
-     * The {@link cmdParser} property is set to a {@link Command} instance when instantiating an Approuter. It is possible
-     * to disable this feature by setting {@link cmdParser} to false. To do this typesafe, you have to use
-     * `Approuter<false>` as a type when creating the Approuter instance.
-     * @example
-     *   const ar = new Approuter<false>();
-     *   ar.cmdParser = false;
      */
     interface Approuter extends EventEmitter {
         /**

sap__approuter/lib/middleware/xsrf-token-handler.d.ts

@@ -0,0 +1,40 @@
+import { IncomingMessage } from "http";
+
+export type checkTokenResult = {
+    isValid: boolean;
+    details: string;
+};
+
+/**
+ * Checks if a token is required for an incoming request:
+ *  - GET and HEAD requests do not require a token (except if they are used to fetch a new token)
+ *  - public path requests do not require a token
+ *
+ * @param req
+ * @returns true if a token is required, else false
+ */
+export function isTokenRequired(req: IncomingMessage): boolean;
+
+export function isTokenFetchRequest(req: IncomingMessage): boolean;
+
+/**
+ * Check a token send by the client
+ *
+ * @param req
+ * @returns {isValid: boolean, details: string}
+ */
+export function checkToken(req: IncomingMessage): checkTokenResult;
+
+/**
+ * Returns a new token and stores it in the session (or returns an existing one from the session)
+ *
+ * @param req
+ * @param cb function cb(err, token)
+ */
+export function getToken<T = void>(req: IncomingMessage, cb: (error: Error | null, xsrfToken?: string) => T): T;
+
+export function hasTokenFetchHeader(req: IncomingMessage): boolean;
+
+export function isGetRequest(req: IncomingMessage): boolean;
+
+export function isHeadRequest(req: IncomingMessage): boolean;

sap__approuter/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/sap__approuter",
-    "version": "14.3.0",
+    "version": "14.3.2",
     "description": "TypeScript definitions for @sap/approuter",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sap__approuter",
     "license": "MIT",
@@ -29,6 +29,6 @@
         "@types/node": "*",
         "@types/verror": "*"
     },
-    "typesPublisherContentHash": "6e90fefa56f7582b3db68e3977022dbabc5b4038b85d7cf8178a5fd1f8d6d89c",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "e06bafbc8452e284b708f640bc11cef75aef577c429bcd01f0185f0c62f1cb13",
+    "typeScriptVersion": "4.6"
 }