Change extra headers params name and set to private appendExtraHeaders into JsonService

Author: Brice Broussolle

docs/oidc-client-ts.api.md

@@ -95,9 +95,6 @@ export type CreateSignoutRequestArgs = Omit<SignoutRequestArgs, "url" | "state_d
     state?: unknown;
 };
 
-// @public (undocumented)
-export type CustomHeader = string | (() => string);
-
 // @public
 export class ErrorResponse extends Error {
     constructor(args: {
@@ -124,6 +121,9 @@ export class ErrorTimeout extends Error {
     readonly name: string;
 }
 
+// @public (undocumented)
+export type ExtraHeader = string | (() => string);
+
 // @public (undocumented)
 export type ExtraSigninRequestArgs = Pick<CreateSigninRequestArgs, "nonce" | "extraQueryParams" | "extraTokenParams" | "state" | "redirect_uri" | "prompt" | "acr_values" | "login_hint" | "scope">;
 
@@ -342,9 +342,9 @@ export interface OidcClientSettings {
     client_secret?: string;
     // @deprecated (undocumented)
     clockSkewInSeconds?: number;
-    customHeaders?: Record<string, CustomHeader>;
     disablePKCE?: boolean;
     display?: string;
+    extraHeaders?: Record<string, ExtraHeader>;
     extraQueryParams?: Record<string, string | number | boolean>;
     // (undocumented)
     extraTokenParams?: Record<string, unknown>;
@@ -378,7 +378,7 @@ export interface OidcClientSettings {
 
 // @public
 export class OidcClientSettingsStore {
-    constructor({ authority, metadataUrl, metadata, signingKeys, metadataSeed, client_id, client_secret, response_type, scope, redirect_uri, post_logout_redirect_uri, client_authentication, prompt, display, max_age, ui_locales, acr_values, resource, response_mode, filterProtocolClaims, loadUserInfo, staleStateAgeInSeconds, clockSkewInSeconds, userInfoJwtIssuer, mergeClaims, disablePKCE, stateStore, refreshTokenCredentials, revokeTokenAdditionalContentTypes, fetchRequestCredentials, refreshTokenAllowedScope, extraQueryParams, extraTokenParams, customHeaders, }: OidcClientSettings);
+    constructor({ authority, metadataUrl, metadata, signingKeys, metadataSeed, client_id, client_secret, response_type, scope, redirect_uri, post_logout_redirect_uri, client_authentication, prompt, display, max_age, ui_locales, acr_values, resource, response_mode, filterProtocolClaims, loadUserInfo, staleStateAgeInSeconds, clockSkewInSeconds, userInfoJwtIssuer, mergeClaims, disablePKCE, stateStore, refreshTokenCredentials, revokeTokenAdditionalContentTypes, fetchRequestCredentials, refreshTokenAllowedScope, extraQueryParams, extraTokenParams, extraHeaders, }: OidcClientSettings);
     // (undocumented)
     readonly acr_values: string | undefined;
     // (undocumented)
@@ -392,12 +392,12 @@ export class OidcClientSettingsStore {
     // (undocumented)
     readonly clockSkewInSeconds: number;
     // (undocumented)
-    readonly customHeaders: Record<string, CustomHeader>;
-    // (undocumented)
     readonly disablePKCE: boolean;
     // (undocumented)
     readonly display: string | undefined;
     // (undocumented)
+    readonly extraHeaders: Record<string, ExtraHeader>;
+    // (undocumented)
     readonly extraQueryParams: Record<string, string | number | boolean>;
     // (undocumented)
     readonly extraTokenParams: Record<string, unknown>;

src/JsonService.test.ts

@@ -11,14 +11,14 @@ describe("JsonService", () => {
     let customStaticHeaderSubject: JsonService;
     let customDynamicHeaderSubject: JsonService;
 
-    const staticCustomHeaders = {
+    const staticExtraHeaders = {
         "Custom-Header-1": "this-is-header-1",
         "Custom-Header-2": "this-is-header-2",
         "acCept" : "application/fake",
         "AuthoriZation" : "not good",
         "Content-Type": "application/fail",
     };
-    const dynamicCustomHeaders = {
+    const dynamicExtraHeaders = {
         "Custom-Header-1": () => "my-name-is-header-1",
         "Custom-Header-2": () => {
             return "my-name-is-header-2";
@@ -30,8 +30,8 @@ describe("JsonService", () => {
 
     beforeEach(() =>{
         subject = new JsonService();
-        customStaticHeaderSubject = new JsonService(undefined, null, staticCustomHeaders);
-        customDynamicHeaderSubject = new JsonService(undefined, null, dynamicCustomHeaders);
+        customStaticHeaderSubject = new JsonService(undefined, null, staticExtraHeaders);
+        customDynamicHeaderSubject = new JsonService(undefined, null, dynamicExtraHeaders);
     });
 
     describe("getJson", () => {

src/JsonService.ts

@@ -12,7 +12,7 @@ export type JwtHandler = (text: string) => Promise<Record<string, unknown>>;
 /**
  * @public
  */
-export type CustomHeader = string | (() => string);
+export type ExtraHeader = string | (() => string);
 
 /**
  * @internal
@@ -32,35 +32,6 @@ export interface PostFormOpts {
     initCredentials?: "same-origin" | "include" | "omit";
 }
 
-/**
- * @internal
- */
-function appendCustomHeaders(
-    headers: Record<string, string>,
-    customs: Record<string, CustomHeader>,
-): void {
-    const customKeys = Object.keys(customs);
-    const protectedHeaders = [
-        "authorization",
-        "accept",
-        "content-type",
-    ];
-    if (customKeys.length === 0) {
-        return;
-    }
-    customKeys.forEach((headerName) => {
-        if (protectedHeaders.includes(headerName.toLocaleLowerCase())) {
-            return;
-        }
-        const content = (typeof customs[headerName] === "function") ?
-            (customs[headerName] as ()=>string)() :
-            customs[headerName];
-        if (content && content !== "") {
-            headers[headerName] = content as string;
-        }
-    });
-}
-
 /**
  * @internal
  */
@@ -72,7 +43,7 @@ export class JsonService {
     public constructor(
         additionalContentTypes: string[] = [],
         private _jwtHandler: JwtHandler | null = null,
-        private _customHeaders: Record<string, CustomHeader> = {},
+        private _extraHeaders: Record<string, ExtraHeader> = {},
     ) {
         this._contentTypes.push(...additionalContentTypes, "application/json");
         if (_jwtHandler) {
@@ -120,7 +91,7 @@ export class JsonService {
             headers["Authorization"] = "Bearer " + token;
         }
 
-        appendCustomHeaders(headers, this._customHeaders);
+        this.appendExtraHeaders(headers);
 
         let response: Response;
         try {
@@ -173,7 +144,7 @@ export class JsonService {
         if (basicAuth !== undefined) {
             headers["Authorization"] = "Basic " + basicAuth;
         }
-        appendCustomHeaders(headers, this._customHeaders);
+        this.appendExtraHeaders(headers);
 
         let response: Response;
         try {
@@ -215,4 +186,29 @@ export class JsonService {
 
         return json;
     }
+
+    private appendExtraHeaders(
+        headers: Record<string, string>,
+    ): void {
+        const customKeys = Object.keys(this._extraHeaders);
+        const protectedHeaders = [
+            "authorization",
+            "accept",
+            "content-type",
+        ];
+        if (customKeys.length === 0) {
+            return;
+        }
+        customKeys.forEach((headerName) => {
+            if (protectedHeaders.includes(headerName.toLocaleLowerCase())) {
+                return;
+            }
+            const content = (typeof this._extraHeaders[headerName] === "function") ?
+                (this._extraHeaders[headerName] as ()=>string)() :
+                this._extraHeaders[headerName];
+            if (content && content !== "") {
+                headers[headerName] = content as string;
+            }
+        });
+    }
 }

src/MetadataService.ts

@@ -24,7 +24,7 @@ export class MetadataService {
         this._jsonService = new JsonService(
             ["application/jwk-set+json"],
             null,
-            this._settings.customHeaders,
+            this._settings.extraHeaders,
         );
         if (this._settings.signingKeys) {
             this._logger.debug("using signingKeys from settings");

src/OidcClientSettings.test.ts

@@ -527,7 +527,7 @@ describe("OidcClientSettings", () => {
         });
     });
 
-    describe("customHeaders", () => {
+    describe("extraHeaders", () => {
 
         it("should use default value", () => {
             // act
@@ -538,24 +538,24 @@ describe("OidcClientSettings", () => {
             });
 
             // assert
-            expect(subject.customHeaders).toEqual({});
+            expect(subject.extraHeaders).toEqual({});
         });
 
         it("should return value from initial settings", () => {
             // act
-            const customHeaders = {
+            const extraHeaders = {
                 "Header-1": "this-is-a-test",
                 "Header-3": () => "dynamic header",
             };
             const subject = new OidcClientSettingsStore({
                 authority: "authority",
                 client_id: "client",
                 redirect_uri: "redirect",
-                customHeaders: customHeaders,
+                extraHeaders: extraHeaders,
             });
 
             // assert
-            expect(subject.customHeaders).toEqual(customHeaders);
+            expect(subject.extraHeaders).toEqual(extraHeaders);
         });
     });
 });

src/OidcClientSettings.ts

@@ -5,7 +5,7 @@ import { WebStorageStateStore } from "./WebStorageStateStore";
 import type { OidcMetadata } from "./OidcMetadata";
 import type { StateStore } from "./StateStore";
 import { InMemoryWebStorage } from "./InMemoryWebStorage";
-import type { CustomHeader } from "./JsonService";
+import type { ExtraHeader } from "./JsonService";
 
 const DefaultResponseType = "code";
 const DefaultScope = "openid";
@@ -108,6 +108,11 @@ export interface OidcClientSettings {
 
     extraTokenParams?: Record<string, unknown>;
 
+    /**
+     * An object containing additional header to be including in request.
+     */
+    extraHeaders?: Record<string, ExtraHeader>;
+
     /**
      * @deprecated since version 2.1.0. Use fetchRequestCredentials instead.
      */
@@ -131,11 +136,6 @@ export interface OidcClientSettings {
      * Only scopes in this list will be passed in the token refresh request.
      */
     refreshTokenAllowedScope?: string | undefined;
-
-    /**
-     * Set additional custom headers to be passed to the client
-     */
-    customHeaders?: Record<string, CustomHeader>;
 }
 
 /**
@@ -183,14 +183,12 @@ export class OidcClientSettingsStore {
     // extra
     public readonly extraQueryParams: Record<string, string | number | boolean>;
     public readonly extraTokenParams: Record<string, unknown>;
-
+    public readonly extraHeaders: Record<string, ExtraHeader>;
+    
     public readonly revokeTokenAdditionalContentTypes?: string[];
     public readonly fetchRequestCredentials: RequestCredentials;
     public readonly refreshTokenAllowedScope: string | undefined;
     public readonly disablePKCE: boolean;
-
-    // headers
-    public readonly customHeaders: Record<string, CustomHeader>;
 
     public constructor({
         // metadata related
@@ -218,8 +216,7 @@ export class OidcClientSettingsStore {
         // extra query params
         extraQueryParams = {},
         extraTokenParams = {},
-        // custom headers
-        customHeaders = {},
+        extraHeaders = {},
     }: OidcClientSettings) {
 
         this.authority = authority;
@@ -283,6 +280,6 @@ export class OidcClientSettingsStore {
 
         this.extraQueryParams = extraQueryParams;
         this.extraTokenParams = extraTokenParams;
-        this.customHeaders = customHeaders;
+        this.extraHeaders = extraHeaders;
     }
 }

src/TokenClient.ts

@@ -69,7 +69,7 @@ export class TokenClient {
         this._jsonService = new JsonService(
             this._settings.revokeTokenAdditionalContentTypes,
             null,
-            this._settings.customHeaders,
+            this._settings.extraHeaders,
         );
     }
 

src/UserInfoService.ts

@@ -20,7 +20,7 @@ export class UserInfoService {
         this._jsonService = new JsonService(
             undefined,
             this._getClaimsFromJwt,
-            this._settings.customHeaders,
+            this._settings.extraHeaders,
         );
     }
 

src/index.ts

@@ -16,7 +16,7 @@ export { MetadataService } from "./MetadataService";
 export * from "./OidcClient";
 export { OidcClientSettingsStore } from "./OidcClientSettings";
 export type { OidcClientSettings, SigningKey } from "./OidcClientSettings";
-export type { CustomHeader } from "./JsonService";
+export type { ExtraHeader } from "./JsonService";
 export type { OidcMetadata } from "./OidcMetadata";
 export { SessionMonitor } from "./SessionMonitor";
 export type { SessionStatus } from "./SessionStatus";