Merge pull request #196 from yathindrakodithuwakku/remove-deprecated-fields

Remove deprecated fields in auth config

Author: thivi

lerna.json

@@ -9,5 +9,5 @@
         "samples/*"
     ],
     "npmClient": "yarn",
-    "version": "1.0.8"
+    "version": "2.0.2"
 }

lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@asgardeo/auth-js",
-    "version": "1.0.8",
+    "version": "2.0.2",
     "description": "Asgardeo Auth JS SDK to be used in JavaScript and TypeScript applications.",
     "keywords": [
         "Asgardeo",

lib/src/client.ts

@@ -96,7 +96,7 @@ export class AsgardeoAuthClient<T> {
      * const config = {
      *     signInRedirectURL: "http://localhost:3000/sign-in",
      *     clientID: "client ID",
-     *     serverOrigin: "https://localhost:9443"
+     *     baseUrl: "https://localhost:9443"
      * }
      *
      * await auth.initialize(config);
@@ -604,7 +604,7 @@ export class AsgardeoAuthClient<T> {
      * const config = {
      *     signInRedirectURL: "http://localhost:3000/sign-in",
      *     clientID: "client ID",
-     *     serverOrigin: "https://localhost:9443"
+     *     baseUrl: "https://localhost:9443"
      * }
      *
      * await auth.updateConfig(config);

lib/src/constants/oidc-endpoints.ts

@@ -26,13 +26,7 @@ export const SERVICE_RESOURCES: OIDCEndpoints  = {
     jwksUri: "/oauth2/jwks",
     revocationEndpoint: "/oauth2/revoke",
     tokenEndpoint: "/oauth2/token",
-    userinfoEndpoint: "/oauth2/userinfo",
-    /**
-     * The well known endpoint path.
-     * @deprecated This will be removed in the next version bump 2.0.0 
-     * as this is already defined in config.wellKnownEndpoint.
-     */
-    wellKnownEndpoint: "/oauth2/token/.well-known/openid-configuration"
+    userinfoEndpoint: "/oauth2/userinfo"
 };
 
 export const AUTHORIZATION_ENDPOINT = "authorization_endpoint";

lib/src/core/authentication-core.ts

@@ -438,8 +438,7 @@ export class AuthenticationCore<T> {
             return Promise.resolve();
         }
 
-        const wellKnownEndpoint = (configData as any).wellKnownEndpoint || 
-            configData?.endpoints?.wellKnownEndpoint;
+        const wellKnownEndpoint = (configData as any).wellKnownEndpoint;
 
         if (wellKnownEndpoint) {
 
@@ -464,7 +463,7 @@ export class AuthenticationCore<T> {
             await this._dataLayer.setTemporaryDataParameter(OP_CONFIG_INITIATED, true);
 
             return Promise.resolve();
-        } else if ((configData as any).baseUrl || (configData as any).serverOrigin) {
+        } else if ((configData as any).baseUrl) {
             try {
                 await this._dataLayer.setOIDCProviderMetaData(
                     await this._authenticationHelper.resolveEndpointsByBaseURL());
@@ -508,8 +507,7 @@ export class AuthenticationCore<T> {
             registrationEndpoint: oidcProviderMetaData.registration_endpoint ?? "",
             revocationEndpoint: oidcProviderMetaData.revocation_endpoint ?? "",
             tokenEndpoint: oidcProviderMetaData.token_endpoint ?? "",
-            userinfoEndpoint: oidcProviderMetaData.userinfo_endpoint ?? "",
-            wellKnownEndpoint: await this._authenticationHelper.resolveWellKnownEndpoint()
+            userinfoEndpoint: oidcProviderMetaData.userinfo_endpoint ?? ""
         };
     }
 
@@ -588,12 +586,6 @@ export class AuthenticationCore<T> {
 
     public async updateConfig(config: Partial<AuthClientConfig<T>>): Promise<void> {
         await this._dataLayer.setConfigData(config);
-
-        if ((config as any).overrideWellEndpointConfig) {
-            config?.endpoints &&
-                (await this._dataLayer.setOIDCProviderMetaData(await this._authenticationHelper.resolveEndpoints({})));
-        } else if (config?.endpoints) {
-            await this.getOIDCProviderMetaData(true);
-        }
+        await this.getOIDCProviderMetaData(true);
     }
 }

lib/src/helpers/authentication-helper.ts

@@ -64,34 +64,17 @@ export class AuthenticationHelper<T> {
         this._cryptoHelper = cryptoHelper;
     }
 
-    public async resolveWellKnownEndpoint(): Promise<string> {
-        const configData = await this._config();
-
-        const wellKnownEndpoint = (configData as any).wellKnownEndpoint || 
-            configData?.endpoints?.wellKnownEndpoint;
-
-        const baseUrl = (configData as any).baseUrl || (configData as any).serverOrigin;
-
-        if (wellKnownEndpoint) {
-            return wellKnownEndpoint;
-        } else {
-            return baseUrl + SERVICE_RESOURCES.wellKnownEndpoint;
-        }
-    }
-
     public async resolveEndpoints(response: OIDCProviderMetaData): Promise<OIDCProviderMetaData> {
         const oidcProviderMetaData = {};
         const configData = await this._config();
 
-        if (configData.overrideWellEndpointConfig) {
-            configData.endpoints &&
-                Object.keys(configData.endpoints).forEach((endpointName: string) => {
-                    const snakeCasedName = endpointName.replace(/[A-Z]/g, (letter) => `_${ letter.toLowerCase() }`);
-                    oidcProviderMetaData[ snakeCasedName ] = configData?.endpoints
-                        ? configData.endpoints[ endpointName ]
-                        : "";
-                });
-        }
+        configData.endpoints &&
+            Object.keys(configData.endpoints).forEach((endpointName: string) => {
+                const snakeCasedName = endpointName.replace(/[A-Z]/g, (letter) => `_${ letter.toLowerCase() }`);
+                oidcProviderMetaData[ snakeCasedName ] = configData?.endpoints
+                    ? configData.endpoints[ endpointName ]
+                    : "";
+            });
 
         return { ...response, ...oidcProviderMetaData };
     }
@@ -141,7 +124,7 @@ export class AuthenticationHelper<T> {
         const oidcProviderMetaData = {};
         const configData = await this._config();
 
-        const baseUrl = (configData as any).baseUrl || (configData as any).serverOrigin;
+        const baseUrl = (configData as any).baseUrl;
 
         if (!baseUrl) {
             throw new AsgardeoAuthException(

lib/src/models/client-config.ts

@@ -30,11 +30,6 @@ export interface DefaultAuthClientConfig {
   responseMode?: ResponseMode;
   scope?: string[];
   validateIDToken?: boolean;
-  /**
-   * The allow explicitly override oidc endpoints.
-   * @deprecated This will be removed in the next version bump 2.0.0.
-   */
-  overrideWellEndpointConfig?: boolean;
   /**
   * Allowed leeway for id_tokens (in seconds).
   */
@@ -52,15 +47,6 @@ export interface WellKnownAuthClientConfig extends DefaultAuthClientConfig {
   endpoints?: Partial<OIDCEndpoints>;
 }
 
-export interface ServerOriginAuthClientConfig extends DefaultAuthClientConfig {
-  /**
-  * The asgardeo root domain url with the organization.
-  * @deprecated Use `baseUrl` instead, this will be removed in the next version bump 2.0.0.
-  */
-  serverOrigin: string;
-  endpoints?: Partial<OIDCEndpoints>;
-}
-
 export interface BaseURLAuthClientConfig extends DefaultAuthClientConfig {
   baseUrl: string;
   endpoints?: Partial<OIDCEndpoints>;
@@ -72,7 +58,7 @@ export interface ExplicitAuthClientConfig extends DefaultAuthClientConfig {
 
 export type StrictAuthClientConfig =
   | WellKnownAuthClientConfig
-  | (ServerOriginAuthClientConfig | BaseURLAuthClientConfig)
+  | BaseURLAuthClientConfig
   | ExplicitAuthClientConfig;
 
 export type AuthClientConfig<T = unknown> = StrictAuthClientConfig & T;

lib/src/models/oidc-provider-meta-data.ts

@@ -269,10 +269,4 @@ export interface OIDCEndpoints {
     checkSessionIframe: string;
     endSessionEndpoint: string;
     issuer: string;
-    /**
-     * The well known endpoint path.
-     * @deprecated This will be removed in the next version bump 2.0.0 
-     * as this is already defined in config.wellKnownEndpoint.
-     */
-    wellKnownEndpoint?: string;
 }