feat(sas-browser-auth): Add logout endpoint call for cookie based authentication (#53)

Author: ckedwards

sdk/sas-auth-browser/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.0 (Sep 26, 2023)
+
+- Add logout function
+
 ## 0.1.2 (May 16, 2023)
 
 - fix guest authentication

sdk/sas-auth-browser/README.md

@@ -80,6 +80,12 @@ Launches a popup window that navigates to the authentication endpoint and allows
 
 rejects: When login fails (for example: user closes the popup).
 
+##### `logout(): Promise<void>`
+
+Makes an endpoint call to the SAS Viya server that ends the cookie based browser session.
+
+rejects: When sign out fails.
+
 ##### `invalidateCache()`
 
 If `checkAuthenticated` has already been called, a cached value may be returned the next time. This is done to reduce the number of potential service calls needed when making multiple API calls. Calling `invalidateCache` will force `checkAuthenticated` to re-validate the next time it is called. **This is not needed for most use cases.**

sdk/sas-auth-browser/examples/basic-example.html

@@ -10,66 +10,74 @@
     <script src="https://cdn.developer.sas.com/packages/sas-auth-browser/latest/dist/index.js"></script>
     <script>
       (async () => {
-        const viyaUrl = "YOUR-VIYA-URL";
+        const content = document.getElementById('content');
+        const endpoint = 'YOUR-VIYA-URL';
+
+        function clearContent() {
+          for (const child of [...content.childNodes]) {
+            content.removeChild(child);
+          }
+        }
+        function createLoginButton() {
+          const btn = document.createElement('button');
+          btn.textContent = 'Logon...';
+          btn.onclick = async () => {
+            await instance.loginPopup();
+            fetchFolders();
+          };
+          content.appendChild(btn);
+        }
         async function fetchFolders() {
-          const content = document.getElementById("content");
-          content.innerText = "Fetching folders.";
+          content.innerText = 'Fetching folders.';
           let json;
           try {
             resp = await fetch(
-              `${viyaUrl}/folders/folders?limit=1000000&filter=and(isNull(parent),in(type,%27folder%27))`,
+              `${endpoint}/folders/folders?limit=1000000&filter=and(isNull(parent),%20in(type,%27folder%27))`,
               {
-                credentials: "include",
+                credentials: 'include',
                 // REST requests from browsers should include this header.
-                "X-Requested-With": "XMLHttpRequest",
+                'X-Requested-With': 'XMLHttpRequest',
               }
             );
             if (!resp.ok) {
-              throw new Error("Invalid response");
+              throw new Error('Invalid response');
             }
             json = await resp.json();
           } catch (e) {
-            content.innerText = "Unable to fetch folders.";
+            content.innerText = 'Unable to fetch folders.';
             throw e;
           }
 
-          content.innerHTML = "";
-          const title = document.createElement("h1");
-          title.innerText = "Folders";
+          clearContent();
+          const title = document.createElement('h1');
+          title.innerText = 'Folders';
           content.appendChild(title);
-          const ul = document.createElement("ul");
+          const ul = document.createElement('ul');
           content.appendChild(ul);
           for (const folder of json?.items || []) {
-            const li = document.createElement("li");
+            const li = document.createElement('li');
             li.innerText = folder.name;
             ul.appendChild(li);
           }
+          const button = document.createElement('button');
+          button.textContent = 'Logout';
+          button.addEventListener('click', async () => {
+            await instance.logout();
+            clearContent();
+            createLoginButton();
+          });
+          content.appendChild(button);
         }
 
         const instance = sasAuthBrowser.createCookieAuthenticationCredential({
-          url: viyaUrl,
+          url: endpoint,
         });
         try {
-          // Before calling any SAS Viya API endpoints, first ensure that a user is authenticated.
           await instance.checkAuthenticated();
-          // If a user is authenticated, it is safe to start making REST calls
           fetchFolders();
         } catch {
-          // When no user is authenticated, create a button to prompt the user to sign in.
-          // NOTE: A button is used so that the browser does not block the popup.
-          const btn = document.createElement("button");
-          btn.textContent = "Logon...";
-          btn.onclick = async () => {
-            // Open a popup and navigate to the logon endpoint.
-            // Once the user has logged in, the popup will automatically close.
-            await instance.loginPopup();
-            // After the user has successfully logged in and the popup has closed the promise
-            // will resolve and REST calls can now be made to SAS Viya endpoints.
-            fetchFolders();
-          };
-          const content = document.getElementById("content");
-          content.innerHTML = "";
-          content.appendChild(btn);
+          clearContent();
+          createLoginButton();
         }
       })();
     </script>