@verisoft/security-core 18.5.0 → 18.6.0

package/src/lib/models/functions.ts

@@ -1,103 +0,0 @@
-import { AuthenticatedUser } from './authenticated-user.model';
-
-export function hasRequiredPermission(
-  user: AuthenticatedUser | undefined,
-  permission: string | string[]
-): boolean {
-  return hasItems(user?.permissions, permission);
-}
-
-export function hasRequiredRole(
-  user: AuthenticatedUser | undefined,
-  role: string | string[]
-): boolean {
-  return hasItems(user?.roles, role);
-}
-
-function hasItems(
-  userItems: string[] | undefined,
-  neededItems: string | string[]
-): boolean {
-  if (!neededItems || !neededItems.length) {
-    return true;
-  }
-
-  if (!userItems || !userItems.length) {
-    return false;
-  }
-
-  const userItemsSet = new Set(userItems);
-  if (Array.isArray(neededItems)) {
-    return neededItems.some((item) => hasItems(userItems, item));
-  }
-
-  if (neededItems.includes(',')) {
-    const splitItems = neededItems.split(',').map((i) => i.trim());
-    return splitItems.every((i) => userItemsSet.has(i));
-  }
-
-  return userItemsSet.has(neededItems);
-}
-
-export function convertJWTToUser(
-  base64Token?: string
-): AuthenticatedUser | undefined {
-  if (!base64Token) {
-    return undefined;
-  }
-
-  try {
-    const parts = base64Token.split('.');
-    if (parts.length < 2) {
-      return undefined;
-    }
-    const payload = decodeJwtPayload(parts[1]);
-
-    const userName = payload['unique_name'] ?? payload['nameid'];
-    if (!userName) {
-      return undefined;
-    }
-
-    const user: AuthenticatedUser = {
-      userName,
-      userId: payload['nameid'],
-      email: payload['email'],
-      displayName: payload['name'],
-      roles: convertToArray(payload, 'role'),
-      permissions: convertToArray(payload, 'permission'),
-    };
-
-    return user;
-  } catch (error) {
-    return undefined;
-  }
-}
-
-export function decodeJwtPayload(jwt: string): any {
-  const base64 = jwt.replace(/-/g, '+').replace(/_/g, '/');
-
-  const jsonPayload = decodeURIComponent(
-    atob(base64)
-      .split('')
-      .map(c => '%' + c.charCodeAt(0).toString(16).padStart(2, '0'))
-      .join('')
-  );
-
-  return JSON.parse(jsonPayload);
-}
-
-function convertToArray(
-  item: { [key: string]: string | string[] },
-  propertyName: string
-): string[] | undefined {
-  const rawValue = item[propertyName];
-  if (!rawValue) {
-    return undefined;
-  }
-
-  if (Array.isArray(rawValue)) {
-    return rawValue;
-  }
-
-  return [rawValue];
-}

package/src/lib/provider.ts

@@ -1,58 +0,0 @@
-import {
-  APP_INITIALIZER,
-  InjectionToken,
-  ModuleWithProviders,
-  NgModule,
-  Provider,
-} from '@angular/core';
-import { Router } from '@angular/router';
-import { StoreModule } from '@ngrx/store';
-import { AuthGuard } from './guards';
-import { SecurityConfig } from './models';
-import {
-  AuthContextService,
-  LocalStorageTokenProvider,
-  securityInitializerFactory,
-} from './services';
-import { SecurityFeature } from './state/feature';
-
-export function provideSecurity(
-  config: Partial<SecurityConfig> | undefined = undefined
-): Provider[] {
-  const securityConfig: SecurityConfig = {
-    tokenStorageKey: 'APP_TOKEN',
-    notAuthorizedPage: '/not-authorized',
-    ...(config ?? {}),
-  };
-  return [
-    AuthGuard,
-    SECURITY_INITIALIZER_PROVIDER,
-    { provide: SECURITY_CONTEXT_TOKEN_PROVIDER, useClass: LocalStorageTokenProvider },
-    { provide: SECURITY_CONFIG, useValue: securityConfig },
-  ];
-}
-
-@NgModule({
-  imports: [StoreModule.forFeature(SecurityFeature)],
-})
-export class SecurityModule {
-  static forRoot(
-    config?: Partial<SecurityConfig>
-  ): ModuleWithProviders<SecurityModule> {
-    return {
-      ngModule: SecurityModule,
-      providers: [...provideSecurity(config)],
-    };
-  }
-}
-
-export const SECURITY_CONTEXT_TOKEN_PROVIDER = new InjectionToken('SECURITY_CONTEXT_TOKEN_PROVIDER');
-
-export const SECURITY_CONFIG = new InjectionToken('SECURITY_CONFIG');
-
-export const SECURITY_INITIALIZER_PROVIDER: Provider = {
-  provide: APP_INITIALIZER,
-  useFactory: securityInitializerFactory,
-  deps: [SECURITY_CONTEXT_TOKEN_PROVIDER, AuthContextService, SECURITY_CONFIG, Router],
-  multi: true,
-};

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

@@ -1,38 +0,0 @@
-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/local-storage-token-provider.ts

@@ -1,23 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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/state/actions.ts

@@ -1,7 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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/reducers.ts

@@ -1,11 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

package/src/test-setup.ts

@@ -1,8 +0,0 @@
-// @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

@@ -1,30 +0,0 @@
-{
-  "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,
-    "compilationMode": "partial",
-    "enableIvy": true
-  }
-}

package/tsconfig.lib.json

@@ -1,17 +0,0 @@
-{
-  "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

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

package/tsconfig.spec.json

@@ -1,16 +0,0 @@
-{
-  "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"
-  ]
-}