@digitaldefiance/express-suite-react-components 5.0.2 → 5.0.3

package/src/interfaces/ICategoryConfig.ts

@@ -1,41 +0,0 @@
-import { ReactElement, ReactNode } from 'react';
-
-/**
- * Configuration for a TopMenu category (mega-menu container).
- *
- * Categories let you group multiple icon dropdowns under a single AppBar
- * button. Menus opt into a category by setting `IMenuConfig.category` (or
- * `AdditionalDropdownMenu.category`) to this category's `id`. The TopMenu
- * renders one icon button per category that has at least one matching menu;
- * clicking it opens a popover containing the matching menus as icon tiles.
- *
- * Backwards compatibility: if `TopMenu` is not given a `categories` array,
- * or if a menu does not declare a `category`, it renders inline in the AppBar
- * exactly as before.
- */
-export interface ICategoryConfig {
-  /** Unique identifier referenced by `IMenuConfig.category`. */
-  id: string;
-  /** Icon shown on the AppBar trigger button. */
-  icon: ReactElement;
-  /**
-   * Optional accessible label / tooltip / panel header. Plain string for
-   * tooltip; render-prop or node for the panel header if `showHeader` is true.
-   */
-  label?: string;
-  /** Optional header content shown above the tile grid when `showHeader` is true. */
-  header?: ReactNode;
-  /** Show the `header` (or `label`) above the tile grid. Defaults to false. */
-  showHeader?: boolean;
-  /** Show the menu label under each tile inside the popover. Defaults to true. */
-  showLabels?: boolean;
-  /**
-   * Sort order for placement in the AppBar. Higher numbers render first
-   * (same convention as `IMenuConfig.priority`). Defaults to 0.
-   */
-  priority?: number;
-  /** Number of tile columns in the popover grid. Defaults to 3. */
-  columns?: number;
-  /** Hide the category trigger when it has no matching menus. Defaults to true. */
-  hideWhenEmpty?: boolean;
-}

package/src/interfaces/IMenuConfig.ts

@@ -1,28 +0,0 @@
-import { ReactElement } from 'react';
-import { IMenuOption } from './IMenuOption';
-import { createMenuType } from '../types';
-
-export interface IMenuConfig {
-  menuType: ReturnType<typeof createMenuType>;
-  menuIcon: ReactElement;
-  priority?: number;
-  options: IMenuOption[];
-  isUserMenu?: boolean;
-  /** Optional callback invoked when the icon button is clicked. */
-  action?: () => void;
-  /** When true, the menu icon is hidden if there are no sub-options. Defaults to false. */
-  hideWhenEmpty?: boolean;
-  /**
-   * Optional category identifier. When the TopMenu is configured with matching
-   * `categories`, this menu is rendered as a tile inside that category's
-   * mega-menu popover instead of inline in the AppBar. When omitted (or no
-   * matching category exists), the menu renders inline as a normal dropdown.
-   */
-  category?: string;
-  /**
-   * Optional human-readable label. When the menu is rendered as a tile inside
-   * a category popover with `showLabels` enabled, this is shown under the icon.
-   * Also used as the IconButton tooltip. Falls back to `menuType` when omitted.
-   */
-  label?: string;
-}

package/src/interfaces/IMenuOption.ts

@@ -1,79 +0,0 @@
-import { ReactNode } from 'react';
-import { To } from 'react-router';
-import { MenuType } from '../types/MenuType';
-import { SxProps } from '@mui/system';
-import { Theme } from '@mui/material';
-
-export interface IMenuOption {
-  /**
-   * Unique identifier for the menu option
-   */
-  id: string;
-  /**
-   * Text to display for the menu option
-   */
-  label: string | ReactNode | Array<ReactNode>;
-  /**
-   * Where the menu option should be displayed
-   */
-  includeOnMenus: MenuType[];
-  /**
-   * Display order for the menu option. Lower numbers are displayed first.
-   */
-  index: number;
-  /**
-   * Whether the menu option is a divider
-   */
-  divider?: boolean;
-  /**
-   * Icon to display for the menu option
-   */
-  icon?: ReactNode;
-  /**
-   * Link to navigate to when the menu option is clicked
-   * Mutually exclusive with `action`
-   * Can be a string, a react-router To object, or an object with pathname and optional state
-   */
-  link?: To | { pathname: string; state?: unknown };
-  /**
-   * Function to execute when the menu option is clicked
-   * Mutually exclusive with `link`
-   * @returns void
-   */
-  action?: () => void;
-  /**
-   * Whether the menu option requires authentication
-   * true = requires authentication
-   * false = requires unauthenticated
-   * undefined = always show
-   */
-  requiresAuth: boolean | undefined;
-  /**
-   * Whether the menu option requires the user to be a global admin
-   * true = only show to global admins
-   * undefined/false = no admin requirement
-   */
-  requiresAdmin?: boolean;
-  /**
-   * Custom filter function to determine if the menu option should be displayed
-   * @param option - The menu option to filter
-   * @returns boolean
-   */
-  filter?: (option: IMenuOption) => boolean;
-  /**
-   * Additional CSS properties
-   */
-  additionalSx?: SxProps<Theme>;
-  /**
-   * Additional CSS properties for the side menu variant
-   */
-  sideSx?: SxProps<Theme>;
-  /**
-   * Additional CSS properties for the side menu variant Icon sub item
-   */
-  sideIconSx?: SxProps<Theme>;
-  /**
-   * Additional CSS properties for the side menu variant Text sub item
-   */
-  sideTextSx?: SxProps<Theme>;
-}

package/src/services/__mocks__/authService.ts

@@ -1,14 +0,0 @@
-import { jest } from '@jest/globals';
-
-export const mockAuthService = {
-  verifyToken: jest.fn(),
-  directLogin: jest.fn(),
-  emailChallengeLogin: jest.fn(),
-  refreshToken: jest.fn(),
-  register: jest.fn(),
-  requestEmailLogin: jest.fn(),
-  backupCodeLogin: jest.fn(),
-  changePassword: jest.fn(),
-};
-
-export const createAuthService = jest.fn(() => mockAuthService);

package/src/services/__tests__/authService.totp.property.spec.ts

@@ -1,360 +0,0 @@
-/**
- * Property-Based Tests for AuthService TOTP Error Extraction
- *
- * Feature: totp-2fa, Property 11: AuthService Error Extraction
- *
- * For any TOTP-related AuthService method, when the backend returns a
- * non-2xx HTTP response, the method SHALL return an object with an `error`
- * string extracted via `extractErrorMessage` and SHALL NOT throw an
- * unhandled exception.
- *
- * **Validates: Requirements 11.5**
- *
- * Uses fast-check with ≥100 iterations.
- *
- * @module services/__tests__/authService.totp.property.spec
- */
-
-import { describe, it, expect, beforeEach, jest } from '@jest/globals';
-import * as fc from 'fast-check';
-import axios, { AxiosError, AxiosHeaders } from 'axios';
-
-// ─── Mocks ──────────────────────────────────────────────────────────────────
-
-// Mock the API client factories so we can control what the axios instances return
-const mockPost = jest.fn() as jest.MockedFunction<typeof axios.prototype.post>;
-const mockGet = jest.fn() as jest.MockedFunction<typeof axios.prototype.get>;
-
-const mockAxiosInstance = {
-  post: mockPost,
-  get: mockGet,
-  interceptors: {
-    request: { use: jest.fn() },
-    response: { use: jest.fn() },
-  },
-};
-
-jest.mock('../api', () => ({
-  createApiClient: jest.fn(() => mockAxiosInstance),
-}));
-
-jest.mock('../authenticatedApi', () => ({
-  createAuthenticatedApiClient: jest.fn(() => mockAxiosInstance),
-}));
-
-jest.mock('@digitaldefiance/ecies-lib', () => ({
-  EciesCryptoCore: jest.fn().mockImplementation(() => ({})),
-  ECIESService: jest.fn().mockImplementation(() => ({})),
-  hexToUint8Array: jest.fn(),
-  uint8ArrayToHex: jest.fn(),
-}));
-
-jest.mock('@digitaldefiance/suite-core-lib', () => ({
-  getSuiteCoreTranslation: jest.fn(
-    (key: string) => key,
-  ),
-  SuiteCoreStringKey: {
-    Common_UnexpectedError: 'common_unexpectedError',
-    Registration_Error: 'registration_error',
-    Registration_Success: 'registration_success',
-    Validation_UsernameOrEmailRequired: 'validation_usernameOrEmailRequired',
-    Validation_InvalidToken: 'validation_invalidToken',
-    Error_Login_DirectChallengeNotEnabled:
-      'error_login_directChallengeNotEnabled',
-    Error_Login_PasswordLoginNotEnabled: 'error_login_passwordLoginNotEnabled',
-  },
-  Constants: {},
-}));
-
-// Import AuthService after mocks are set up
-import { AuthService } from '../authService';
-
-// ─── Helpers ────────────────────────────────────────────────────────────────
-
-/**
- * Build a realistic AxiosError with the given status code and response data.
- */
-function buildAxiosError(
-  status: number,
-  data: Record<string, unknown>,
-): AxiosError {
-  const headers = new AxiosHeaders();
-  const config = { headers } as import('axios').InternalAxiosRequestConfig;
-  const response = {
-    data,
-    status,
-    statusText: 'Error',
-    headers: {},
-    config,
-  };
-
-  const error = new AxiosError(
-    `Request failed with status code ${status}`,
-    AxiosError.ERR_BAD_RESPONSE,
-    config,
-    undefined,
-    response,
-  );
-
-  return error;
-}
-
-// ─── Arbitraries ────────────────────────────────────────────────────────────
-
-/** Non-2xx HTTP status codes (client and server errors) */
-const nonSuccessStatus = fc.oneof(
-  fc.integer({ min: 400, max: 499 }),
-  fc.integer({ min: 500, max: 599 }),
-);
-
-/** Arbitrary non-empty error message strings */
-const errorMessage = fc.string({ minLength: 1, maxLength: 200 }).filter(
-  (s) => s.trim().length > 0,
-);
-
-/** 6-digit TOTP code string */
-const totpCode = fc
-  .array(fc.constantFrom(...'0123456789'.split('')), {
-    minLength: 6,
-    maxLength: 6,
-  })
-  .map((chars) => chars.join(''));
-
-/** Arbitrary non-empty token string */
-const tokenString = fc.string({ minLength: 10, maxLength: 100 }).filter(
-  (s) => s.trim().length > 0,
-);
-
-// ─── Tests ──────────────────────────────────────────────────────────────────
-
-describe('AuthService TOTP - Property Tests', () => {
-  let authService: AuthService;
-
-  beforeEach(() => {
-    mockPost.mockReset();
-    mockGet.mockReset();
-
-    const mockConstants = {} as import('@digitaldefiance/suite-core-lib').IConstants;
-    const mockEciesConfig = {} as import('@digitaldefiance/ecies-lib').IECIESConfig;
-
-    authService = new AuthService(
-      mockConstants,
-      'http://localhost:3000',
-      mockEciesConfig,
-      'test.example.com',
-    );
-  });
-
-  // ─── Property 11: AuthService Error Extraction ──────────────────────────
-
-  describe('Feature: totp-2fa, Property 11: AuthService Error Extraction', () => {
-    /**
-     * **Validates: Requirements 11.5**
-     *
-     * For any TOTP-related AuthService method, when the backend returns a
-     * non-2xx HTTP response, the method must return `{ error: string }` and
-     * must not throw.
-     */
-
-    describe('setupTotp returns { error } on non-2xx and never throws', () => {
-      it('extracts error from response.data.message', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            async (status, msg) => {
-              mockPost.mockRejectedValueOnce(
-                buildAxiosError(status, { message: msg }),
-              );
-
-              const result = await authService.setupTotp();
-
-              expect(result).toHaveProperty('error');
-              expect(typeof (result as { error: string }).error).toBe('string');
-              expect((result as { error: string }).error.length).toBeGreaterThan(0);
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-
-      it('extracts error from response.data.error (string)', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            async (status, msg) => {
-              mockPost.mockRejectedValueOnce(
-                buildAxiosError(status, { error: msg }),
-              );
-
-              const result = await authService.setupTotp();
-
-              expect(result).toHaveProperty('error');
-              expect(typeof (result as { error: string }).error).toBe('string');
-              expect((result as { error: string }).error.length).toBeGreaterThan(0);
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-    });
-
-    describe('confirmTotp returns { error } on non-2xx and never throws', () => {
-      it('extracts error for any status code and error message', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            totpCode,
-            async (status, msg, code) => {
-              mockPost.mockRejectedValueOnce(
-                buildAxiosError(status, { message: msg }),
-              );
-
-              const result = await authService.confirmTotp(code);
-
-              expect(result).toHaveProperty('error');
-              expect(typeof (result as { error: string }).error).toBe('string');
-              expect((result as { error: string }).error.length).toBeGreaterThan(0);
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-    });
-
-    describe('disableTotp returns { error } on non-2xx and never throws', () => {
-      it('extracts error for any status code and error message', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            totpCode,
-            async (status, msg, code) => {
-              mockPost.mockRejectedValueOnce(
-                buildAxiosError(status, { message: msg }),
-              );
-
-              const result = await authService.disableTotp(code);
-
-              expect(result).toHaveProperty('error');
-              expect(typeof (result as { error: string }).error).toBe('string');
-              expect((result as { error: string }).error.length).toBeGreaterThan(0);
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-    });
-
-    describe('resetTotp returns { error } on non-2xx and never throws', () => {
-      it('extracts error for any status code and error message', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            totpCode,
-            async (status, msg, code) => {
-              mockPost.mockRejectedValueOnce(
-                buildAxiosError(status, { message: msg }),
-              );
-
-              const result = await authService.resetTotp(code);
-
-              expect(result).toHaveProperty('error');
-              expect(typeof (result as { error: string }).error).toBe('string');
-              expect((result as { error: string }).error.length).toBeGreaterThan(0);
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-    });
-
-    describe('verifyTotpLogin returns { error } on non-2xx and never throws', () => {
-      it('extracts error for any status code, error message, and token', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            totpCode,
-            tokenString,
-            async (status, msg, code, token) => {
-              mockPost.mockRejectedValueOnce(
-                buildAxiosError(status, { message: msg }),
-              );
-
-              const result = await authService.verifyTotpLogin(token, code);
-
-              expect(result).toHaveProperty('error');
-              expect(typeof (result as { error: string }).error).toBe('string');
-              expect((result as { error: string }).error.length).toBeGreaterThan(0);
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-    });
-
-    describe('error extraction handles object-shaped errors', () => {
-      it('extracts error.message from response.data.error object for all methods', async () => {
-        await fc.assert(
-          fc.asyncProperty(
-            nonSuccessStatus,
-            errorMessage,
-            totpCode,
-            tokenString,
-            async (status, msg, code, token) => {
-              const errorData = {
-                error: { message: msg, statusCode: status },
-              };
-
-              // Test all five methods with object-shaped error
-              const methods = [
-                () => {
-                  mockPost.mockRejectedValueOnce(
-                    buildAxiosError(status, errorData),
-                  );
-                  return authService.setupTotp();
-                },
-                () => {
-                  mockPost.mockRejectedValueOnce(
-                    buildAxiosError(status, errorData),
-                  );
-                  return authService.confirmTotp(code);
-                },
-                () => {
-                  mockPost.mockRejectedValueOnce(
-                    buildAxiosError(status, errorData),
-                  );
-                  return authService.disableTotp(code);
-                },
-                () => {
-                  mockPost.mockRejectedValueOnce(
-                    buildAxiosError(status, errorData),
-                  );
-                  return authService.resetTotp(code);
-                },
-                () => {
-                  mockPost.mockRejectedValueOnce(
-                    buildAxiosError(status, errorData),
-                  );
-                  return authService.verifyTotpLogin(token, code);
-                },
-              ];
-
-              for (const method of methods) {
-                const result = await method();
-                expect(result).toHaveProperty('error');
-                expect(typeof (result as { error: string }).error).toBe('string');
-                expect((result as { error: string }).error.length).toBeGreaterThan(0);
-              }
-            },
-          ),
-          { numRuns: 100 },
-        );
-      });
-    });
-  });
-});