@wral/studio.mods.auth 0.3.7 → 1.0.0

package/src/util.mjs

@@ -1,194 +0,0 @@
-/**
- * Module for authentication management using `@wral/sdk-auth` and session
- * storage. Provides functionalities to handle login, logout, token refresh,
- * and decode operations.
- * @module authTool
- */
-
-import { createClient } from '@wral/sdk-auth';
-import { html } from 'lit';
-import './components/mod-auth-login-form.mjs';
-
-/**
- * Retrieves a valid authentication token from session storage or initiates
- * a new token request.
- * 
- * @param {Object} params - The function parameters
- * @param {Object} params.studio - The studio context to raise or handle events
- * @returns {Promise<string>} promise that resolves with the token if successful
- * 
- * @example
- * // Request token within a studio context
- * getToken({ studio: myStudioContext })
- *   .then(token => console.log('Authentication Token:', token))
- *   .catch(error => console.error('Failed to retrieve token:', error));
- */
-export function getToken({ studio, config }) {
-	return new Promise((resolve, reject) => {
-		let token = window.sessionStorage.getItem(tokenStorageKey({ studio }));
-		if (token) {
-      // Token exists, make sure its fresh and resolve
-			if (shouldRefreshToken(token)) {
-				refreshToken({ studio, config, token }).then(resolve).catch((error) => {
-          // Log a token refresh failure
-          /* eslint-disable-next-line no-console */
-          console.error('Failed to refresh token:', error);
-          // Remove token if refresh fails
-          window.sessionStorage.removeItem(tokenStorageKey({ studio }));
-          getToken({ studio, config }).then(resolve).catch(reject);
-        });
-			} else {
-				resolve(token);
-			}
-      return;
-		}
-
-    const storeToken = (token) => {
-      window.sessionStorage.setItem(tokenStorageKey({ studio }), token);
-      return token;
-    };
-
-    let loginForm;
-
-    // Token doesn't exist, present the login form
-    const successfulLogin = (event) => {
-      const { token } = event.detail;
-      storeToken(token);
-      resolve(token);
-      studio.pub('system::workspace', 'dismiss', loginForm);
-    };
-
-    loginForm = html`<mod-auth-login-form
-      id="login"
-      apibaseurl=${config.apibaseurl}
-      @login-success=${successfulLogin}></mod-auth-login-form>`;
-
-    studio.pub('system::workspace', 'present', loginForm);
-	});
-}
-
-/**
- * Refreshes an expired authentication token.
- * 
- * @param {Object} params - The function parameters.
- * @param {Object} params.studio - The studio context.
- * @param {string} params.token - The expired token.
- * @returns {Promise<string>} A promise that resolves with the refreshed token.
- * 
- * @example
- * // Refresh an expired token
- * refreshToken({ studio: myStudioContext, token: 'expiredToken123' })
- *   .then(newToken => console.log('Token refreshed:', newToken))
- *   .catch(error => console.error('Failed to refresh token:', error));
- */
-export async function refreshToken({ studio, config, token }) {
-	const authApiUrl = config.apibaseurl;
-	const client = createClient({ baseUrl: authApiUrl });
-
-	const { token: newToken } = await client.refreshToken({ token });
-	window.sessionStorage.setItem(tokenStorageKey({ studio }), newToken);
-	return newToken;
-}
-
-/**
- * Logs out the current user by removing the authentication token from session
- * storage.
- * 
- * @param {Object} params - The function parameters.
- * @param {Object} params.studio - The studio context to raise or handle events.
- * 
- * @example
- * // Logout from the system
- * logout({ studio: myStudioContext });
- */
-export function logout({ studio }) {
-	window.sessionStorage.removeItem(tokenStorageKey({ studio }));
-}
-
-/**
- * Decodes a JWT (JSON Web Token) to extract its payload as an object.
- * 
- * @param {string} token - The JWT to decode.
- * @returns {Object} The decoded payload of the token.
- * 
- * @example
- * // Decode a sample JWT
- * const token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
- * + '.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2M'
- * + 'jM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
- * const payload = decodeToken(token);
- * console.log('Decoded Payload:', payload);
- */
-export function decodeToken(token) {
-	return JSON.parse(window.atob(token.split('.')[1].replace(/-/g, '+').replace(/_/g, '/')));
-}
-
-/**
- * Determines if the token needs to be refreshed based on its expiry time.
- * 
- * @param {string} token - The authentication token to check.
- * @param {number} [offset=300] - The offset in milliseconds to consider
- *                                for refreshing before actual expiry.
- * @param {number} [now=Date.now()] - The current timestamp, primarily used 
- *                                    for testing.
- * @returns {boolean} True if the token needs to be refreshed, false otherwise.
- * 
- * @example
- * // Check if token needs to be refreshed
- * const tokenNeedsRefresh = shouldRefreshToken('someToken', 300);
- * console.log('Token needs refresh:', tokenNeedsRefresh);
- */
-function shouldRefreshToken(token, offset = 300, now = Date.now()) {
-	const decoded = decodeToken(token);
-	return decoded.exp * 1000 - offset < now;
-}
-
-/**
- * Generates a unique key for storing the token in session storage.
- * 
- * @param {Object} params - The function parameters.
- * @param {Object} params.studio - The studio context.
- * @returns {string} The storage key for the token.
- * 
- * @example
- * // Get storage key
- * const key = tokenStorageKey({ studio: myStudioContext });
- * console.log('Storage Key:', key);
- */
-function tokenStorageKey () {
-	return `studio.wral::auth_token`;
-}
-
-/**
- * Converts an error object into a user-friendly message.
- *
- * @param {Error} error - The error object to convert.
- * @returns {string} The user-friendly message for the error.
- *
- * @example
- * // Convert an error object into a user-friendly message
- * const error = new Error('An error occurred');
- * const message = messageFromError(error);
- * console.log('Error Message:', message);
- */
-export function messageFromError (error) {
-	switch (error.status) {
-			// Let's make these messages _very_ user friendly.
-		case 401:
-			return 'The username or password provided is incorrect.';
-		case 403:
-			return 'You do not have permission to perform this action.';
-		case 404:
-			return 'The requested resource could not be found.';
-		case 500:
-			return 'An internal server error has occurred.';
-		case 503:
-			return 'The server is temporarily unavailable. Please try again later.';
-		case 504:
-			return 'The server took too long to respond. Please try again later.';
-		case 0:
-			return 'The server could not be reached. Please try again later.';
-		default:
-			return error.message || 'An unknown error has occurred.';
-	}
-}

package/src/util.test.mjs

@@ -1,171 +0,0 @@
-import { expect } from 'chai';
-import sinon from 'sinon';
-
-import { createClient } from '@wral/sdk-auth';
-
-
-import {
-	refreshToken,
-	logout,
-} from './util.mjs';
-
-describe('Authentication Functions', () => {
-	let sandbox, fakeStudio, clientStub//, sessionStore;
-
-	beforeEach(() => {
-		sandbox = sinon.createSandbox();
-		fakeStudio = {
-			pub: sandbox.stub(),
-			sub: sandbox.stub(),
-		};
-
-		// Mocking the client and sessionStorage
-		clientStub = {
-			mintToken: sandbox.stub(),
-			refreshToken: sandbox.stub(),
-		};
-		sandbox.stub(window, 'sessionStorage').value({
-			setItem: sandbox.stub(),
-			removeItem: sandbox.stub(),
-			getItem: sandbox.stub(),
-		});
-		sandbox.stub(createClient, 'call').returns(clientStub);
-	});
-
-	afterEach(() => {
-		sandbox.restore();
-	});
-
-	describe('refreshToken', () => {
-		it('should refresh the token and update session storage', async () => {
-			const originalToken = 'expiredToken123';
-			const newToken = 'newToken123';
-      const config = {
-        apibaseurl: 'https://api.example.com/auth',
-      };
-			clientStub.refreshToken.resolves({ token: newToken });
-
-			try {
-				const result = await refreshToken({
-          studio: fakeStudio, 
-          config,
-          token: originalToken,
-        });
-				expect(result).to.equal(newToken);
-			} catch(error) {
-				expect(error.message).to.equal('Failed to fetch');
-			}
-			/*
-       expect(window.sessionStorage.setItem).to.have.been
-         .calledWith(tokenStorageKey({ studio: fakeStudio }), newToken);
-       */
-		});
-	});
-
-	describe('logout', () => {
-		it('should remove the token from session storage', async () => {
-			await logout({ studio: fakeStudio });
-			/*
-      expect(window.sessionStorage.removeItem).to.have.been
-        .calledWith(tokenStorageKey({ studio: fakeStudio }));
-      */
-		});
-	});
-});
-
-
-
-import { decodeToken } from './util.mjs';
-describe('Token Functions', () => {
-
-	describe('decodeToken', () => {
-		let sandbox;
-
-		beforeEach(() => {
-			// Create a sandbox instance
-			sandbox = sinon.createSandbox();
-		});
-
-		afterEach(() => {
-			// Restore all stubs
-			sandbox.restore();
-		});
-
-		it('should decode a JWT token and return its payload', () => {
-			// Stub window.atob within the sandbox
-			sandbox.stub(window, 'atob')
-        .callsFake(() => '{"exp":2000000000,"sub":"1234567890"}');
-
-			const token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
-        + '.eyJleHAiOjIwMDAwMDAwMDAsInN1YiI6IjEyMzQ1Njc4OTAifQ'
-        + '.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
-			const payload = decodeToken(token);
-			expect(payload).to.deep.equal({ exp: 2000000000, sub: "1234567890" });
-		});
-	});
-
-});
-
-
-
-import { messageFromError } from './util.mjs';
-describe('messageFromError Function', () => {
-	it('should return a user-friendly message for 401 status', () => {
-		const error = new Error('Unauthorized');
-		error.status = 401;
-		expect(messageFromError(error)).to
-      .equal('The username or password provided is incorrect.');
-	});
-
-	it('should return a user-friendly message for 403 status', () => {
-		const error = new Error('Forbidden');
-		error.status = 403;
-		expect(messageFromError(error)).to
-      .equal('You do not have permission to perform this action.');
-	});
-
-	it('should return a user-friendly message for 404 status', () => {
-		const error = new Error('Not Found');
-		error.status = 404;
-		expect(messageFromError(error)).to
-      .equal('The requested resource could not be found.');
-	});
-
-	it('should return a user-friendly message for 500 status', () => {
-		const error = new Error('Server Error');
-		error.status = 500;
-		expect(messageFromError(error)).to
-      .equal('An internal server error has occurred.');
-	});
-
-	it('should return a user-friendly message for 503 status', () => {
-		const error = new Error('Service Unavailable');
-		error.status = 503;
-		expect(messageFromError(error)).to
-      .equal('The server is temporarily unavailable. Please try again later.');
-	});
-
-	it('should return a user-friendly message for 504 status', () => {
-		const error = new Error('Gateway Timeout');
-		error.status = 504;
-		expect(messageFromError(error)).to
-      .equal('The server took too long to respond. Please try again later.');
-	});
-
-	it('should return a user-friendly message for status 0 (network error)', () => {
-		const error = new Error('Network Error');
-		error.status = 0;
-		expect(messageFromError(error)).to
-      .equal('The server could not be reached. Please try again later.');
-	});
-
-	it('should return the default message if an unknown status is provided', () => {
-		const error = new Error('Unexpected Error');
-		expect(messageFromError(error)).to.equal('Unexpected Error');
-	});
-
-	it('should return "An unknown error has occurred." if no message is provided', () => {
-		const error = new Error();
-		expect(messageFromError(error)).to.equal('An unknown error has occurred.');
-	});
-});

package/vite.config.js

@@ -1,12 +0,0 @@
-export default {
-  build: {
-    lib: {
-      entry: {
-        'auth': 'src/auth.mjs',
-        'lib': 'src/lib.mjs',
-      },
-      formats: ['es', 'cjs'],
-      fileName: (format) => `[name].${format}.js`,
-    },
-  },
-}

package/web-test-runner.config.mjs

@@ -1,28 +0,0 @@
-import { playwrightLauncher } from '@web/test-runner-playwright';
-
-export default {
-  files: 'src/**/*.test.mjs',  // Path to your test files
-  browsers: [
-    playwrightLauncher({ product: 'chromium' }),  // You can add 'firefox' and 'webkit'
-  ],
-	nodeResolve: {
-		exportConditions: ['production'],
-	},
-  coverage: true,
-  coverageConfig: {
-    include: ['src/**/*.mjs'],  // Specify which files to include in coverage
-    // Exclude test files and node_modules
-    exclude: ['**/*.test.mjs', '**/node_modules/**'],  
-    threshold: {
-      global: {
-        statements: 70,
-        branches: 70,
-        functions: 70,
-        lines: 70,
-      },
-    },
-    report: true,
-    reportDir: '.coverage',  // Directory where coverage reports will be placed
-    reporter: ['text', 'html'],  // Coverage reporters to use
-  },
-};