@types/sap__approuter 14.3.3 → 23.0.0

sap__approuter/README.md

@@ -8,8 +8,8 @@ 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: Thu, 07 Mar 2024 17:35:52 GMT
- * Dependencies: [@types/http-server](https://npmjs.com/package/@types/http-server), [@types/node](https://npmjs.com/package/@types/node)
+ * Last updated: Wed, 30 Sep 2026 20:04:57 GMT
+ * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
 
 # Credits
-These definitions were written by [Nico Blum](https://github.com/nbblum), and [Laurens von Assel](https://github.com/biolauri).
+These definitions were written by [Nico Blum](https://github.com/nbblum), [Laurens von Assel](https://github.com/biolauri), and [StenCalDabran](https://github.com/StenCalDabran).

sap__approuter/index.d.ts

@@ -103,14 +103,21 @@ declare namespace approuter {
             beforeRequestHandler?: Array<MiddlewareHandler | { path: string; handler: MiddlewareHandler }>;
             /** A MiddlewareSlot before the standard application router error handling */
             beforeErrorHandler?: Array<MiddlewareHandler | { path: string; handler: MiddlewareHandler }>;
+            /** A MiddlewareSlot for WebSocket requests, before the first application router middleware. Requires HANDLE_WEBSOCKET_EXT environment variable to be enabled. */
+            firstWS?: Array<MiddlewareHandler | { path: string; handler: MiddlewareHandler }>;
+            /** A MiddlewareSlot for WebSocket requests, before the standard request handling. Requires HANDLE_WEBSOCKET_EXT environment variable to be enabled. */
+            beforeRequestHandlerWS?: Array<MiddlewareHandler | { path: string; handler: MiddlewareHandler }>;
         };
     }
 
     type RouterConfig = unknown;
 
+    /**
+     * lib/configuration/schemas/options-schema.json
+     */
     interface StartOptions {
         /** A TCP port the application router will listen to */
-        port?: string;
+        port?: string | number;
 
         /** The working directory for the application router, should contain the xs-app.json file */
         workingDir?: string;
@@ -119,13 +126,13 @@ declare namespace approuter {
         extensions?: Extensions[];
 
         /**  An object representing the content which is usually put in xs-app.json file. If this property is present it will take precedence over the content of xs-app.json. */
-        xsAppConfig?: ComSapXsappSchema_82;
+        xsappConfig?: ComSapXsappSchema_82;
 
         /**
          * Options similar to [https.createServer](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener).
          * If this property is present, application router will be started as an https server.
          */
-        httpsConfig?: ServerOptions;
+        httpsOptions?: ServerOptions;
 
         /**
          * Provide custom access token
@@ -284,6 +291,18 @@ declare namespace approuter {
          */
         beforeErrorHandler: MiddlewareSlot;
 
+        /**
+         * A {@link MiddlewareSlot} for WebSocket requests, before the first application router middleware.
+         * Requires the `HANDLE_WEBSOCKET_EXT` environment variable to be enabled.
+         */
+        firstWS: MiddlewareSlot;
+
+        /**
+         * A {@link MiddlewareSlot} for WebSocket requests, before the standard request handling.
+         * Requires the `HANDLE_WEBSOCKET_EXT` environment variable to be enabled.
+         */
+        beforeRequestHandlerWS: MiddlewareSlot;
+
         /**
          * **Note**: the cmdParser is currently not typed, feel free to create a pr and add the missing types
          *
@@ -355,6 +374,24 @@ declare namespace approuter {
          */
         getSessionStore(): SessionStore;
 
+        /**
+         * Resolves remote routing configuration from the HTML5 Application Repository for a given request.
+         * Derives the application key from the request URL and fetches the corresponding xs-app.json,
+         * destinations, and xsappname.
+         *
+         * **Note**: This method is exposed on the prototype but not documented in the official API reference.
+         *
+         * @param request - Node request object used to derive the application key from the URL
+         * @param callback - Called with the resolved configuration options, or null if no application key was found
+         */
+        getRemoteConfigurationOptions(
+            request: AppRouterIncomingMessage,
+            callback: (
+                error: Error | string | null,
+                options?: { xsappConfig: object; destinations: object | null; xsappname: string | null } | null,
+            ) => void,
+        ): void;
+
         /**
          * Emitted when a new user session is created.
          *
@@ -383,6 +420,12 @@ declare namespace approuter {
     }
 }
 
+/**
+ * Creates a new instance of the application router.
+ *
+ * **Note**: The underlying implementation also supports `new approuter()` (constructor invocation),
+ * but the factory function pattern is the documented API.
+ */
 declare function approuter(): approuter.Approuter;
 
 export = approuter;

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

@@ -32,9 +32,3 @@ export function checkToken(req: IncomingMessage): checkTokenResult;
  * @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.3",
+    "version": "23.0.0",
     "description": "TypeScript definitions for @sap/approuter",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sap__approuter",
     "license": "MIT",
@@ -14,6 +14,11 @@
             "name": "Laurens von Assel",
             "githubUsername": "biolauri",
             "url": "https://github.com/biolauri"
+        },
+        {
+            "name": "StenCalDabran",
+            "githubUsername": "StenCalDabran",
+            "url": "https://github.com/StenCalDabran"
         }
     ],
     "main": "",
@@ -25,9 +30,9 @@
     },
     "scripts": {},
     "dependencies": {
-        "@types/http-server": "*",
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "b16894028d86512b2ffa88bda2060a3d6577b0108b2ec9fb2e1ecef3ca2656a3",
-    "typeScriptVersion": "4.7"
+    "peerDependencies": {},
+    "typesPublisherContentHash": "1c312819690b5f012b06129670b6cfa71abda7239dbf35c088fd3f8ddf49c6e7",
+    "typeScriptVersion": "5.6"
 }

sap__approuter/xs-app.schema.d.ts

@@ -29,28 +29,49 @@ export type ScopesSchema =
     };
 export type ScopeTemplate = string | [string, ...string[]];
 
+export type HttpMethod = "DELETE" | "GET" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "TRACE" | "PATCH";
+
+export type ErrorPageEntry =
+    | { status: number | [number, ...number[]]; file: string; path?: never }
+    | { status: number | [number, ...number[]]; path: string; file?: never };
+
+export interface CorsConfig {
+    uriPattern: SourceSchema;
+    hostPattern?: string;
+    allowedOrigin: Array<{ host: string; protocol?: string; port?: number }>;
+    allowedMethods?: HttpMethod[];
+    allowedHeaders?: string[];
+    allowedCredentials?: boolean;
+    exposeHeaders?: string[];
+    maxAge?: number;
+}
+
 /**
  * Application Router Configuration Schema
  */
 export interface ComSapXsappSchema_82 {
     welcomeFile?: string;
     authenticationMethod?: "none" | "route";
+    stateProtection?: boolean;
     sessionTimeout?: number;
     pluginMetadataEndpoint?: string;
     routes?: Array<{
         source: SourceSchema;
         httpMethods?: [
-            "DELETE" | "GET" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "TRACE" | "PATCH",
-            ...Array<"DELETE" | "GET" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "TRACE" | "PATCH">,
+            HttpMethod,
+            ...HttpMethod[],
         ];
         target?: string;
         destination?: string;
+        setBackendSessionCookies?: boolean;
         localDir?: string;
         csrfProtection?: boolean;
+        preferLocal?: boolean;
         service?: string;
         endpoint?: string;
-        authenticationType?: "xsuaa" | "basic" | "none";
+        authenticationType?: "xsuaa" | "ias" | "basic" | "none";
         identityProvider?: string;
+        dynamicIdentityProvider?: boolean;
         scope?: ScopesSchema;
         replace?: {
             pathSuffixes: string[];
@@ -61,6 +82,10 @@ export interface ComSapXsappSchema_82 {
         };
         cacheControl?: string;
     }>;
+    responseHeaders?: Array<{
+        name: string;
+        value: string;
+    }>;
     destinations?: {
         [k: string]: {
             logoutPath?: string;
@@ -75,8 +100,11 @@ export interface ComSapXsappSchema_82 {
         };
     };
     logout?: {
+        backChannelLogoutEndpoint?: string;
         logoutEndpoint?: string;
         logoutPage?: string;
+        logoutMethod?: "POST" | "GET";
+        csrfProtection?: boolean;
     };
     login?: {
         callbackEndpoint: string;
@@ -87,14 +115,11 @@ export interface ComSapXsappSchema_82 {
     compression?: {
         enabled?: boolean;
         minSize?: number;
+        compressResponseMixedTypeContent?: boolean;
     };
     websockets?: {
         enabled: boolean;
     };
-    errorPage?: Array<{
-        status: number | [number, ...number[]];
-        file: string;
-        [k: string]: unknown;
-    }>;
-    [k: string]: unknown;
+    errorPage?: ErrorPageEntry[];
+    cors?: CorsConfig[];
 }