@techextensor/tab-sdk 0.0.0

package/projects/tab-sdk/src/lib/store/store.service.ts

@@ -0,0 +1,831 @@
+import { inject, Injectable } from '@angular/core';
+import { LocalStorageService, SessionStorageService, StorageConstants } from '@techextensor/tab-core-utility';
+import { StorageType } from '../enum/store.enum';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class StoreService {
+    private readonly _localStorageService: LocalStorageService = inject(LocalStorageService);
+    private readonly _sessionStorageService: SessionStorageService = inject(SessionStorageService);
+
+    /**
+     * Retrieves the tenant ID from the local storage.
+     */
+    get tenantId(): string | null {
+        return this.getOrgInfo()?.Id || null;
+    }
+
+    /**
+     * Sets the tenant ID in the organization info.
+     * 
+     * @param value - The tenant ID to set.
+     */
+    set tenantId(value: string | null) {
+        // Retrieve the existing organization info or initialize a new object
+        const orgInfo = this.getOrgInfo() || {};
+
+        // Update the tenant ID value
+        orgInfo.Id = value;
+
+        // Save the updated organization info back to storage
+        this.setOrgInfo(orgInfo);
+    }
+
+    /**
+     * Retrieves the tenant name from the organization info.
+     */
+    get tenantName(): string | null {
+        // Retrieve the organization info from storage
+        const orgInfo = this.getOrgInfo();
+
+        // Return the tenant name if it exists, otherwise return null
+        return orgInfo?.OrganizationName || null;
+    }
+
+    /**
+     * Sets the tenant name in the organization info.
+     * 
+     * @param value - The tenant name to set.
+     */
+    set tenantName(value: string | null) {
+        // Retrieve the existing organization info or initialize a new object
+        const orgInfo = this.getOrgInfo() || {};
+
+        // Update the organization name value
+        orgInfo.OrganizationName = value;
+
+        // Save the updated organization info back to storage
+        this.setOrgInfo(orgInfo);
+    }
+
+    /**
+     * Retrieves the subdomain from the organization info.
+     * 
+     * @returns The subdomain if it exists, otherwise `null`.
+     */
+    get subdomain(): string | null {
+        // Retrieve the organization info from storage
+        const orgInfo = this.getOrgInfo();
+
+        // Return the subdomain if it exists, otherwise return null
+        return orgInfo?.Subdomain || null;
+    }
+
+    /**
+     * Sets the subdomain in the organization info.
+     * 
+     * @param value - The subdomain to set.
+     */
+    set subdomain(value: string | null) {
+        // Retrieve the existing organization info or initialize a new object
+        const orgInfo = this.getOrgInfo() || {};
+
+        // Update the subdomain value
+        orgInfo.Subdomain = value;
+
+        // Save the updated organization info back to storage
+        this.setOrgInfo(orgInfo);
+    }
+
+    /**
+     * Retrieves the locale settings from the organization info.
+     * 
+     * @returns The locale settings if they exist, otherwise `null`.
+     */
+    get orgLocaleSettings(): any {
+        // Retrieve the locale settings from the organization info
+        let localSettings = this.getOrgInfo()?.LocaleSettings;
+
+        // If the locale settings are a string, parse them as JSON
+        if(typeof localSettings === 'string') {
+            localSettings = JSON.parse(localSettings);
+        }
+
+        // Return the locale settings
+        return localSettings;
+    }
+
+    /**
+     * Sets the locale settings in the organization info.
+     * 
+     * @param value - The locale settings to set.
+     */
+    set orgLocaleSettings(value: any) {
+        // Retrieve the existing organization info or initialize a new object
+        const orgInfo = this.getOrgInfo() || {};
+
+        // Update the locale settings value
+        orgInfo.LocaleSettings = value;
+
+        // Save the updated organization info back to storage
+        this.setOrgInfo(orgInfo);
+    }
+
+    /**
+     * Retrieves the app ID from the app info.
+     * 
+     * @returns The app ID if it exists, otherwise `null`.
+     */
+    get appId(): string | null {
+        return this.getAppInfo()?.Id || null;
+    }
+
+    /**
+     * Sets the app ID in the app info.
+     * 
+     * @param value - The app ID to set.
+     */
+    set appId(value: string | null) {
+        // Retrieve the existing app info or initialize a new object
+        const appInfo = this.getAppInfo() || {};
+
+        // Update the app ID value
+        appInfo.Id = value;
+
+        // Save the updated app info back to storage
+        this.setAppInfo(appInfo);
+    }
+
+    /**
+     * Retrieves the app name from the app info.
+     * 
+     * @returns The app name if it exists, otherwise `null`.
+     */
+    get appName(): string | null {
+        // Retrieve and return the app name from the app info, or return null if it doesn't exist
+        return this.getAppInfo()?.AppName || null;
+    }
+
+    /**
+     * Sets the app name in the app info.
+     * 
+     * @param value - The app name to set.
+     */
+    set appName(value: string | null) {
+        // Retrieve the existing app info or initialize a new object
+        const appInfo = this.getAppInfo() || {};
+
+        // Update the app name value
+        appInfo.AppName = value;
+
+        // Save the updated app info back to storage
+        this.setAppInfo(appInfo);
+    }
+
+    /**
+     * Retrieves the environment ID from the environment info.
+     * 
+     * @returns The environment ID if it exists, otherwise `null`.
+     */
+    get environmentId(): string | null {
+        // Retrieve and return the environment ID from the environment info, or return null if it doesn't exist
+        return this.getEnvironmentInfo()?.Id || null;
+    }
+
+    /**
+     * Sets the environment ID in the environment info.
+     * 
+     * @param value - The environment ID to set.
+     */
+    set environmentId(value: string | null) {
+        // Retrieve the existing environment info or initialize a new object
+        const environmentInfo = this.getEnvironmentInfo() || {};
+
+        // Update the environment ID value
+        environmentInfo.Id = value;
+
+        // Save the updated environment info back to storage
+        this.setEnvironmentInfo(environmentInfo);
+    }
+
+    /**
+     * Retrieves the environment name from the environment info.
+     * 
+     * @returns The environment name if it exists, otherwise `null`.
+     */
+    get environmentName(): string | null {
+        // Retrieve and return the environment name from the environment info, or return null if it doesn't exist
+        return this.getEnvironmentInfo()?.Name || null;
+    }
+
+    /**
+     * Sets the environment name in the environment info.
+     * 
+     * @param value - The environment name to set.
+     */
+    set environmentName(value: string | null) {
+        // Retrieve the existing environment info or initialize a new object
+        const environmentInfo = this.getEnvironmentInfo() || {};
+
+        // Update the environment name value
+        environmentInfo.Name = value;
+
+        // Save the updated environment info back to storage
+        this.setEnvironmentInfo(environmentInfo);
+    }
+
+    /**
+     * Retrieves the token from the token info.
+     * 
+     * @returns The token if it exists, otherwise `null`.
+     */
+    get token(): string | null {
+        // Retrieve and return the token from the token info, or return null if it doesn't exist
+        return this.getTokenInfo()?.token || null;
+    }
+
+    /**
+     * Sets the token in the token info.
+     * 
+     * @param value - The token to set.
+     */
+    set token(value: string | null) {
+        // Retrieve the existing token info or initialize a new object
+        const tokenInfo = this.getTokenInfo() || {};
+
+        // Update the token value
+        tokenInfo.token = value;
+
+        // Save the updated token info back to storage
+        this.setTokenInfo(tokenInfo);
+    }
+
+    /**
+     * Retrieves the refresh token from the token info.
+     * 
+     * @returns The refresh token if it exists, otherwise `null`.
+     */
+    get refreshToken(): string | null {
+        // Retrieve and return the refresh token from the token info, or return null if it doesn't exist
+        return this.getTokenInfo()?.refreshToken || null;
+    }
+
+    /**
+     * Sets the refresh token in the token info.
+     * 
+     * @param value - The refresh token to set.
+     */
+    set refreshToken(value: string | null) {
+        // Retrieve the existing token info or initialize a new object
+        const tokenInfo = this.getTokenInfo() || {};
+
+        // Update the refresh token value
+        tokenInfo.refreshToken = value;
+
+        // Save the updated token info back to storage
+        this.setTokenInfo(tokenInfo);
+    }
+
+    /**
+     * Retrieves the refresh token expiry time from the token info.
+     * 
+     * @returns The refresh token expiry time if it exists, otherwise `null`.
+     */
+    get refreshTokenExpiry(): string | null {
+        // Retrieve and return the refresh token expiry time from the token info,
+        // or return null if it doesn't exist
+        return this.getTokenInfo()?.refreshTokenExpiry || null;
+    }
+
+    /**
+     * Sets the refresh token expiry time in the token info.
+     * 
+     * @param value - The refresh token expiry time to set.
+     */
+    set refreshTokenExpiry(value: string | null) {
+        // Retrieve the existing token info or initialize a new object
+        const tokenInfo = this.getTokenInfo() || {};
+
+        // Update the refresh token expiry time
+        tokenInfo.refreshTokenExpiry = value;
+
+        // Save the updated token info back to storage
+        this.setTokenInfo(tokenInfo);
+    }
+
+    /**
+     * Retrieves the static token from the token info.
+     * 
+     * @returns The static token if it exists, otherwise `null`.
+     */
+    get staticToken(): string | null {
+        // Retrieve and return the static token from the token info,
+        // or return null if it doesn't exist
+        return this.getTokenInfo()?.staticToken || null;
+    }
+
+    /**
+     * Sets the static token in the token info.
+     * 
+     * @param value - The static token to set.
+     */
+    set staticToken(value: string | null) {
+        // Retrieve the existing token info or initialize a new object
+        const tokenInfo = this.getTokenInfo() || {};
+
+        // Update the static token value
+        tokenInfo.staticToken = value;
+
+        // Save the updated token info back to storage
+        this.setTokenInfo(tokenInfo);
+    }
+
+    /**
+     * Retrieves the user ID from the user info.
+     * 
+     * @returns The user ID if it exists, otherwise `null`.
+     */
+    get userId(): string | null {
+        // Retrieve and return the user ID from the user info, or return null if it doesn't exist
+        return this.getUserInfo()?.user?.Id || null;
+    }
+
+    /**
+     * Retrieves the user's roles from the user information.
+     * 
+     * @returns An array of user roles if they exist, otherwise `null`.
+     */
+    get userRoles(): any[] | null {
+        // Retrieve and return the user roles from the user info, or return null if they don't exist
+        return this.getUserInfo()?.user?.Roles || null;
+    }
+
+    /**
+     * Retrieves the user's teams from the user information.
+     * 
+     * @returns An array of user teams if they exist, otherwise `null`.
+     */
+    get userTeams(): any[] | null {
+        // Retrieve and return the user teams from the user info, or return null if they don't exist
+        return this.getUserInfo()?.user?.Teams || null;
+    }
+
+    /**
+     * Removes the tenant ID from the organization information.
+     */
+    removeTenantId(): void {
+        this.removeFromOrgInfo('Id');
+    }
+
+    /**
+     * Removes the tenant name from the organization information.
+     */
+    removeTenantName(): void {
+        // Remove the tenant name from the organization information
+        this.removeFromOrgInfo('OrganizationName');
+    }
+
+    /**
+     * Removes the subdomain from the organization information.
+     * 
+     * This removes the subdomain property from the organization information
+     * stored in local storage.
+     */
+    removeSubdomain(): void {
+        // Remove the subdomain from the organization information
+        this.removeFromOrgInfo('Subdomain');
+    }
+
+    /**
+     * Removes the app ID from the app information.
+     * 
+     * This removes the app ID property from the app information stored in local storage.
+     */
+    removeAppId(): void {
+        this.removeFromAppInfo('Id');
+    }
+
+    /**
+     * Removes the app name from the app information.
+     * 
+     * This removes the app name property from the app information stored in local storage.
+     */
+    removeAppName(): void {
+        this.removeFromAppInfo('AppName');
+    }
+
+    /**
+     * Removes the environment ID from the environment information.
+     * 
+     * This removes the ID property from the environment information
+     * stored in local storage.
+     */
+    removeEnvironmentId(): void {
+        // Remove the environment ID from the environment information
+        this.removeFromEnvironmentInfo('Id');
+    }
+
+    /**
+     * Removes the environment name from the environment information.
+     * 
+     * This removes the Name property from the environment information
+     * stored in local storage.
+     */
+    removeEnvironmentName(): void {
+        // Remove the environment name from the environment information
+        this.removeFromEnvironmentInfo('Name');
+    }
+
+    /**
+     * Removes the token from the token info.
+     * 
+     * This removes the token property from the token information stored in session
+     * storage.
+     */
+    removeToken(): void {
+        // Remove the token from the token info
+        this.removeFromTokenInfo('token');
+    }
+
+    /**
+     * Removes the refresh token from the token information.
+     * 
+     * This removes the refresh token property from the token information stored in session
+     * storage.
+     */
+    removeRefreshToken(): void {
+        this.removeFromTokenInfo('refreshToken');
+    }
+
+    /**
+     * Removes the refresh token expiry time from the token information.
+     * 
+     * This removes the refresh token expiry time property from the token information stored in session
+     * storage.
+     */
+    removeRefreshTokenExpiry(): void {
+        // Remove the refresh token expiry from the token info
+        this.removeFromTokenInfo('refreshTokenExpiry');
+    }
+
+    /**
+     * Removes the static token from the token information.
+     * 
+     * This removes the static token property from the token information stored in session
+     * storage.
+     */
+    removeStaticToken(): void {
+        // Remove the static token from the token info
+        this.removeFromTokenInfo('staticToken');
+    }
+
+    /**
+     * Removes the specified key from the organization information.
+     * 
+     * This removes the specified key from the organization information stored in local storage.
+     * 
+     * @param key The key to remove from the organization information.
+     */
+    private removeFromOrgInfo(key: string): void {
+        const orgInfo = this.getOrgInfo();
+        if (orgInfo) {
+            // Remove the key from the organization information
+            delete orgInfo[key];
+            // Save the updated organization information back to local storage
+            this.setOrgInfo(orgInfo);
+        }
+    }
+
+    /**
+     * Removes the specified key from the app information.
+     * 
+     * This removes the specified key from the app information stored in session
+     * storage.
+     * 
+     * @param key The key to remove from the app information.
+     */
+    private removeFromAppInfo(key: string): void {
+        const appInfo = this.getAppInfo();
+        if (appInfo) {
+            // Remove the key from the app information
+            delete appInfo[key];
+            // Save the updated app information back to session storage
+            this.setAppInfo(appInfo);
+        }
+    }
+
+    /**
+     * Removes the specified key from the environment information.
+     * 
+     * This removes the specified key from the environment information stored in session
+     * storage.
+     * 
+     * @param key The key to remove from the environment information.
+     */
+    private removeFromEnvironmentInfo(key: string): void {
+        const environmentInfo = this.getEnvironmentInfo();
+        if (environmentInfo) {
+            // Remove the key from the environment information
+            delete environmentInfo[key];
+            // Save the updated environment information back to session storage
+            this.setEnvironmentInfo(environmentInfo);
+        }
+    }
+
+    /**
+     * Removes the specified key from the token information.
+     * 
+     * This removes the specified key from the token information stored in session
+     * storage.
+     * 
+     * @param key The key to remove from the token information.
+     */
+    private removeFromTokenInfo(key: string): void {
+        const tokenInfo = this.getTokenInfo();
+        if (tokenInfo) {
+            // Remove the key from the token information
+            delete tokenInfo[key];
+            // Save the updated token information back to session storage
+            this.setTokenInfo(tokenInfo);
+        }
+    }
+
+    /**
+     * Retrieves the organization information from local storage.
+     * 
+     * @returns The organization information object or null if it doesn't exist.
+     */
+    getOrgInfo(): any {
+        return this.getFromStorage(StorageType.Local, StorageConstants.orgInfo);
+    }
+
+    /**
+     * Saves the organization information to local storage.
+     * 
+     * @param orgInfo - The organization information to store.
+     */
+    setOrgInfo(orgInfo: any): void {
+        // temp once remove from dropdown, we can remove this
+        if (orgInfo.Id) {
+            this.setSession(StorageConstants.TenantId, orgInfo.Id);
+        } else {
+            this.removeSession(StorageConstants.TenantId);
+        }
+
+        // Save the organization info to local storage
+        this.setToStorage(StorageType.Local, StorageConstants.orgInfo, orgInfo);
+    }
+
+    /**
+     * Retrieves the app information from session storage.
+     * 
+     * @returns The app information object or null if it doesn't exist.
+     */
+    getAppInfo(): any {
+        return this.getFromStorage(StorageType.Session, StorageConstants.appInfo);
+    }
+
+    /**
+     * Saves the app information to session storage.
+     * 
+     * @param appInfo - The app information to store.
+     */
+    setAppInfo(appInfo: any): void {
+        // temp once remove from dropdown, we can remove this
+        if (appInfo?.Id) {
+            this.setSession(StorageConstants.AppId, appInfo.Id);
+        } else {
+            this.removeSession(StorageConstants.AppId);
+        }
+
+        if (appInfo?.AppName) {
+            this.setSession(StorageConstants.applicationCode, appInfo.AppName);
+        } else {
+            this.removeSession(StorageConstants.applicationCode);
+        }
+
+        // Save the app info to session storage
+        this.setToStorage(StorageType.Session, StorageConstants.appInfo, appInfo);
+    }
+
+    /**
+     * Retrieves the environment information from session storage.
+     * 
+     * @returns The environment information object or null if it doesn't exist.
+     */
+    getEnvironmentInfo(): any {
+        return this.getFromStorage(StorageType.Session, StorageConstants.environmentInfo);
+    }
+
+    /**
+     * Saves the environment information to session storage.
+     * 
+     * @param envInfo - The environment information to store.
+     */
+    setEnvironmentInfo(envInfo: any): void {
+        // Save the environment info to session storage
+        this.setToStorage(StorageType.Session, StorageConstants.environmentInfo, envInfo);
+    }
+
+    /**
+     * Retrieves the token information from session storage.
+     * 
+     * @returns The token information object or null if it doesn't exist.
+     */
+    getTokenInfo(): any {
+        return this.getFromStorage(StorageType.Session, StorageConstants.tokenInfo);
+    }
+
+    /**
+     * Saves the token information to session storage.
+     * 
+     * @param tokenInfo - The token information to store.
+     */
+    setTokenInfo(tokenInfo: any): void {
+        // temp once remove from dropdown, we can remove this
+        if (tokenInfo?.token) {
+            this.setSession(StorageConstants.token, tokenInfo?.token);
+        } else {
+            this.removeSession(StorageConstants.token);
+        }
+
+        // Save the token info to session storage
+        this.setToStorage(StorageType.Session, StorageConstants.tokenInfo, tokenInfo);
+    }
+
+    /**
+     * Retrieves the user information from local storage.
+     * 
+     * @returns The user information object or null if it doesn't exist.
+     */
+    getUserInfo(): any {
+        return this.getFromStorage(StorageType.Local, StorageConstants.userInfo);
+    }
+
+    /**
+     * Sets the user information in local storage.
+     * 
+     * @param userInfo The user information to store.
+     */
+    setUserInfo(userInfo: any): void {
+        // Save the user info to local storage
+        this.setToStorage(StorageType.Local, StorageConstants.userInfo, userInfo);
+    }
+
+    /**
+     * Sets a key-value pair in local storage.
+     * 
+     * @param key The key to store the value under.
+     * @param data The value to store.
+     */
+    setLocal(key: string, data: any): void {
+        this.setToStorage(StorageType.Local, key, data);
+    }
+
+    /**
+     * Retrieves a value from local storage by key.
+     * 
+     * @param key The key associated with the value to retrieve.
+     * @returns The value stored in local storage, or null if it doesn't exist.
+     */
+    getLocal(key: string): any {
+        return this.getFromStorage(StorageType.Local, key);
+    }
+
+    /**
+     * Removes a key-value pair from local storage.
+     * 
+     * @param key The key associated with the value to remove.
+     */
+    removeLocal(key: string): void {
+        // Remove the key from local storage
+        this.removeFromStorage(StorageType.Local, key);
+    }
+
+    /**
+     * Clears all local storage data.
+     */
+    clearLocal(): void {
+        this.clearStorage(StorageType.Local);
+    }
+
+    /**
+     * Sets a key-value pair in session storage.
+     * 
+     * @param key The key to store the value under.
+     * @param data The value to store.
+     */
+    setSession(key: string, data: any): void {
+        // Save data to session storage under the specified key
+        this.setToStorage(StorageType.Session, key, data);
+    }
+
+    /**
+     * Retrieves a value from session storage by key.
+     * 
+     * @param key The key associated with the value to retrieve.
+     * @returns The value stored in session storage, or null if it doesn't exist.
+     */
+    getSession(key: string): any {
+        // Retrieve the value from session storage
+        return this.getFromStorage(StorageType.Session, key);
+    }
+
+    /**
+     * Removes a key-value pair from session storage.
+     * 
+     * @param key The key associated with the value to remove.
+     */
+    removeSession(key: string): void {
+        // Remove the key from session storage
+        this.removeFromStorage(StorageType.Session, key);
+    }
+
+    /**
+     * Clears all session storage data.
+     */
+    clearSession(): void {
+        // Remove all key-value pairs from session storage
+        this.clearStorage(StorageType.Session);
+    }
+
+    /**
+     * Clears all authentication-related data from local and session storage.
+     * 
+     * This method is typically used after a user logs out.
+     */
+    clearAuth(): void {
+        // Remove user info from local storage
+        this.removeFromStorage(StorageType.Local, StorageConstants.userInfo);
+        // Remove token info from session storage
+        this.removeFromStorage(StorageType.Session, StorageConstants.tokenInfo);
+    }
+
+    /**
+     * Generic getter method for retrieving data from either local or session storage.
+     * 
+     * @param storage The type of storage to retrieve from.
+     * @param key The key associated with the data to retrieve.
+     * @returns The retrieved data, deserialized from JSON if it was stored as a string.
+     */
+    private getFromStorage(storage: StorageType, key: string): any {
+        // Retrieve the data from the specified storage
+        const data = storage === StorageType.Local
+            ? this._localStorageService.getLocalStorage(key)
+            : this._sessionStorageService.getSessionStorage(key);
+
+        try {
+            // Attempt to parse the data as JSON
+            return typeof data === 'string' ? JSON.parse(data) : data;
+        } catch (e) {
+            // If the data cannot be parsed, return it as is
+            return data;
+        }
+    }
+
+    /**
+     * Sets a key-value pair in the specified storage type.
+     * 
+     * @param storage The type of storage to use (local or session).
+     * @param key The key under which the data should be stored.
+     * @param data The data to store.
+     */
+    private setToStorage(storage: StorageType, key: string, data: any): void {
+        // Check if the storage type is local
+        if (storage === StorageType.Local) {
+            // Set the data in local storage
+            this._localStorageService.setLocalStorage(key, data);
+        } else {
+            // Otherwise, set the data in session storage
+            this._sessionStorageService.setSessionStorage(key, data);
+        }
+    }
+
+    /**
+     * Removes a key-value pair from the specified storage type.
+     * 
+     * This method removes the given key from either local or session storage 
+     * based on the specified storage type.
+     * 
+     * @param storage The type of storage to remove from (local or session).
+     * @param key The key associated with the value to remove.
+     */
+    private removeFromStorage(storage: StorageType, key: string): void {
+        if (storage === StorageType.Local) {
+            // Remove the key from local storage
+            this._localStorageService.removeLocalStorage(key);
+        } else {
+            // Remove the key from session storage
+            this._sessionStorageService.removeSessionStorage(key);
+        }
+    }
+
+    /**
+     * Clears all key-value pairs from the specified storage type.
+     * 
+     * This method clears all key-value pairs from either local or session storage
+     * based on the specified storage type.
+     * 
+     * @param storage The type of storage to clear (local or session).
+     */
+    private clearStorage(storage: StorageType): void {
+        if (storage === StorageType.Local) {
+            // Clear local storage
+            this._localStorageService.clearLocalStorage();
+        } else {
+            // Clear session storage
+            this._sessionStorageService.clearSessionStorage();
+        }
+    }
+}