@verisoft/security-core 20.0.0 → 20.1.0

package/src/lib/services/auth-context.service.ts

@@ -0,0 +1,38 @@
+import { Injectable } from '@angular/core';
+import { Store } from '@ngrx/store';
+import { map, Observable } from 'rxjs';
+import { AuthenticatedUser } from '../models';
+import { hasRequiredPermission, hasRequiredRole } from '../models/functions';
+import { setUser } from '../state/actions';
+import { selectIsAuthenticated, selectUser } from '../state/selectors';
+
+@Injectable({
+  providedIn: 'root',
+})
+export class AuthContextService {
+  user$: Observable<AuthenticatedUser | undefined>;
+  isAuthenticated$: Observable<boolean>;
+
+  constructor(private store: Store) {
+    this.user$ = this.store.select(selectUser);
+    this.isAuthenticated$ = this.store.select(selectIsAuthenticated);
+  }
+
+  setUser(user: AuthenticatedUser | undefined): void {
+    this.store.dispatch(setUser({ user }));
+  }
+
+  hasRequiredPermission(
+    requiredPermissions: string | string[]
+  ): Observable<boolean> {
+    return this.user$.pipe(
+      map((user) => hasRequiredPermission(user, requiredPermissions))
+    );
+  }
+
+  hasRequiredRole(requiredPermissions: string | string[]): Observable<boolean> {
+    return this.user$.pipe(
+      map((user) => hasRequiredRole(user, requiredPermissions))
+    );
+  }
+}

package/src/lib/services/index.ts

@@ -0,0 +1,7 @@
+export * from './auth-context.service';
+export * from './local-storage-token-provider';
+export * from './security-initializer';
+export * from './session-token-provider';
+export * from './token-provider';
+export * from './login.service';
+export * from './logout.service';

package/src/lib/services/local-storage-token-provider.ts

@@ -0,0 +1,23 @@
+import { inject, Injectable } from '@angular/core';
+import { Observable, of } from 'rxjs';
+import { SecurityConfig } from '../models';
+import { SECURITY_CONFIG } from '../provider';
+import { TokenProvider } from './token-provider';
+
+@Injectable()
+export class LocalStorageTokenProvider implements TokenProvider {
+  private config = inject<SecurityConfig>(SECURITY_CONFIG);
+
+  getToken(): Observable<string | undefined> {
+    const token = localStorage.getItem(this.config.tokenStorageKey);
+    return of(token ?? undefined);
+  }
+
+  setToken(token: string): void {
+    localStorage.setItem(this.config.tokenStorageKey, token);
+  }
+
+  removeToken(): void {
+    localStorage.clear();
+  }
+}

package/src/lib/services/local-token-provider.ts

@@ -0,0 +1,15 @@
+import { inject, Injectable } from '@angular/core';
+import { Observable, of } from 'rxjs';
+import { SecurityConfig } from '../models';
+import { SECURITY_CONFIG } from '../provider';
+import { TokenProvider } from './token-provider';
+
+@Injectable()
+export class LocalStorageTokenProvider implements TokenProvider {
+  private config = inject<SecurityConfig>(SECURITY_CONFIG);
+
+  getToken(): Observable<string | undefined> {
+    const token = localStorage.getItem(this.config.tokenStorageKey);
+    return of(token ?? undefined);
+  }
+}

package/src/lib/services/login.service.ts

@@ -0,0 +1,23 @@
+import { inject, Injectable } from '@angular/core';
+import { Router } from '@angular/router';
+import { convertJWTToUser, SecurityConfig } from '../models';
+import { SECURITY_CONFIG, SECURITY_CONTEXT_TOKEN_PROVIDER } from '../provider';
+import { AuthContextService } from './auth-context.service';
+import { LocalStorageTokenProvider } from './local-storage-token-provider';
+
+@Injectable()
+export class LoginService {
+    private config = inject<SecurityConfig>(SECURITY_CONFIG);
+    private tokenProvider = inject<LocalStorageTokenProvider>(SECURITY_CONTEXT_TOKEN_PROVIDER);
+    private authService = inject(AuthContextService);
+    private router = inject(Router);
+
+    login(token?: string): void {
+        if (token) {
+            this.tokenProvider.setToken(token);
+            this.authService.setUser(convertJWTToUser(token));
+        } else {
+            this.router.navigate([this.config.loginPage]);
+        }
+    }
+}

package/src/lib/services/logout.service.ts

@@ -0,0 +1,15 @@
+import { inject, Injectable } from '@angular/core';
+import { SECURITY_CONTEXT_TOKEN_PROVIDER } from '../provider';
+import { AuthContextService } from './auth-context.service';
+import { LocalStorageTokenProvider } from './local-storage-token-provider';
+
+@Injectable()
+export class LogoutService {
+    private readonly tokenProvider = inject<LocalStorageTokenProvider>(SECURITY_CONTEXT_TOKEN_PROVIDER);
+    private readonly authService = inject(AuthContextService);
+
+    logout(): void {
+        this.tokenProvider.removeToken();
+        this.authService.setUser(undefined);
+    }
+}

package/src/lib/services/security-initializer.ts

@@ -0,0 +1,26 @@
+import { Router } from '@angular/router';
+import { firstValueFrom, from, of, switchMap } from 'rxjs';
+import { convertJWTToUser, SecurityConfig } from '../models';
+import { AuthContextService } from './auth-context.service';
+import { TokenProvider } from './token-provider';
+
+export function securityInitializerFactory(
+  tokenProvider: TokenProvider,
+  authService: AuthContextService,
+  config: SecurityConfig,
+  router: Router
+): () => Promise<unknown> {
+  const initializationFn = tokenProvider.getToken().pipe(
+    switchMap((token) => {
+      const user = convertJWTToUser(token);
+      if (config.loginPage && !user) {
+        return from(router.navigate([config.loginPage]));
+      }
+
+      authService.setUser(user);
+      return of({});
+    })
+  );
+
+  return () => firstValueFrom(initializationFn)
+}

package/src/lib/services/session-token-provider.ts

@@ -0,0 +1,15 @@
+import { inject, Injectable } from '@angular/core';
+import { Observable, of } from 'rxjs';
+import { SecurityConfig } from '../models';
+import { SECURITY_CONFIG } from '../provider';
+import { TokenProvider } from './token-provider';
+
+@Injectable()
+export class SessionStorageTokenProvider implements TokenProvider {
+  private config = inject<SecurityConfig>(SECURITY_CONFIG);
+
+  getToken(): Observable<string | undefined> {
+    const token = sessionStorage.getItem(this.config.tokenStorageKey);
+    return of(token ?? undefined);
+  }
+}

package/src/lib/services/token-provider.ts

@@ -0,0 +1,5 @@
+import { Observable } from "rxjs";
+
+export interface TokenProvider {
+  getToken(): Observable<string | undefined>;
+}

package/src/lib/state/actions.ts

@@ -0,0 +1,7 @@
+import { createAction, props } from '@ngrx/store';
+import { AuthenticatedUser } from '../models';
+
+export const setUser = createAction(
+  '[Auth] Set User',
+  props<{ user: AuthenticatedUser | undefined }>()
+);

package/src/lib/state/feature.ts

@@ -0,0 +1,10 @@
+import { createFeature } from "@ngrx/store"
+import { authReducer } from "./reducers"
+
+export const SECURITY_FEATURE_NAME = 'SECURITY';
+
+export const SecurityFeature = createFeature({
+    name: SECURITY_FEATURE_NAME,
+    reducer: authReducer
+});
+

package/src/lib/state/index.ts

@@ -0,0 +1,4 @@
+export * from './actions';
+export * from './state';
+export * from './reducers';
+export * from './selectors';

package/src/lib/state/reducers.ts

@@ -0,0 +1,11 @@
+import { createReducer, on } from '@ngrx/store';
+import { setUser } from './actions';
+import { initialState } from './state';
+
+export const authReducer = createReducer(
+  initialState,
+  on(setUser, (state, action) => ({
+    ...state,
+    user: action.user
+  }))
+);

package/src/lib/state/selectors.ts

@@ -0,0 +1,9 @@
+import { createSelector } from '@ngrx/store';
+import { SecurityFeature } from './feature';
+
+export const selectIsAuthenticated = createSelector(
+  SecurityFeature.selectUser,
+  (user) => !!user
+);
+
+export const selectUser = SecurityFeature.selectUser;

package/src/lib/state/state.ts

@@ -0,0 +1,9 @@
+import { AuthenticatedUser } from '../models';
+
+export interface AuthState {
+  user: AuthenticatedUser | undefined;
+}
+
+export const initialState: AuthState = {
+  user: undefined,
+};

package/src/test-setup.ts

@@ -0,0 +1,8 @@
+// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
+globalThis.ngJest = {
+  testEnvironmentOptions: {
+    errorOnUnknownElements: true,
+    errorOnUnknownProperties: true,
+  },
+};
+import 'jest-preset-angular/setup-jest';

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../../../tsconfig.base.json",
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  }
+}

package/tsconfig.lib.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../../dist/out-tsc",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "src/**/*.spec.ts",
+    "src/test-setup.ts",
+    "jest.config.ts",
+    "src/**/*.test.ts"
+  ],
+  "include": ["src/**/*.ts"]
+}

package/tsconfig.lib.prod.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  }
+}

package/tsconfig.spec.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../../dist/out-tsc",
+    "module": "commonjs",
+    "target": "es2016",
+    "types": ["jest", "node"]
+  },
+  "files": ["src/test-setup.ts"],
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}