@myxtra/authentication-green 2.15.0 → 2.17.0

package/README.md

@@ -108,13 +108,17 @@ The authentication package has the following configuration properties which are
 
 ```ts
 type Config = {
-  // The URL of the BFF the authentication component will redirect and do fetch requests to
-  apiUrl: string;
   // The environment on which the authentication component is running on
   environment: 'dev' | 'test' | 'syst' | 'prod';
+  // The URL of the BFF the authentication component will do fetch requests to
+  apiUrl: string;
+  // The URL of the BFF the authentication component will perform login, logout and redirect calls to
+  // ! Only necessary when different then apiUrl, because it defaults to the provided apiUrl.
+  authUrl?: string;
   // The redirect url the BFF should redirect to after the user has logged in. Defaults to window.location.href
   redirectUrl?: string;
   // The ID of the commerce/BOU for which the component will show the icon when the Terms & Condition dialog is shown.
+  // Defaults to 'xtra'
   commerceId?:
     | 'bioplanet'
     | 'collectgo'
@@ -134,6 +138,7 @@ type Config = {
     url: string; // URL of the custom page
     icon: string; // Icon to show in front of the text (see disclaimer below)
   }>;
+  country?: 'BE' | 'FR'; // Show options from specific country. Defaults to 'BE'
 };
 ```
 
@@ -212,11 +217,11 @@ const onMessage = (message: MessageEvent<XtraAuthenticationMessageEventData>) =>
   }
 
   if (!event.data.isAuthenticated) {
-    // TODO: add logic in case the user is not authenticated
+    // TO DO: add logic in case the user is not authenticated
     return;
   }
 
-  // TODO: add logic when the user is authenticated (window.xtra is set here)
+  // TO DO: add logic when the user is authenticated (window.xtra is set here)
 };
 
 window.addEventListener('message', onMessage);