@tantainnovative/ndpr-toolkit 1.0.3 → 1.0.4

package/packages/ndpr-toolkit/package.json

@@ -1,71 +0,0 @@
-{
-  "name": "@tantainnovative/ndpr-toolkit",
-  "version": "1.0.2",
-  "description": "A comprehensive toolkit for implementing NDPR-compliant features in web applications",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "rollup -c",
-    "dev": "rollup -c -w",
-    "test": "jest",
-    "lint": "eslint src --ext .ts,.tsx",
-    "prepublishOnly": "npm run build"
-  },
-  "keywords": [
-    "ndpr",
-    "data-protection",
-    "privacy",
-    "compliance",
-    "nigeria",
-    "consent",
-    "dpia",
-    "data-subject-rights",
-    "breach-notification"
-  ],
-  "author": "Tanta Innovative",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/tantainnovative/ndpr-toolkit"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "peerDependencies": {
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^22.0.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@rollup/plugin-typescript": "^8.3.2",
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/react": "^13.4.0",
-    "@testing-library/react-hooks": "^8.0.1",
-    "@testing-library/user-event": "^14.6.1",
-    "@types/jest": "^28.1.6",
-    "@types/react": "^18.0.0",
-    "@types/react-dom": "^18.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.27.0",
-    "@typescript-eslint/parser": "^5.27.0",
-    "eslint": "^8.16.0",
-    "eslint-plugin-react": "^7.30.0",
-    "eslint-plugin-react-hooks": "^4.5.0",
-    "identity-obj-proxy": "^3.0.0",
-    "jest": "^28.1.0",
-    "jest-environment-jsdom": "^28.1.3",
-    "react-test-renderer": "^18.2.0",
-    "rollup": "^2.75.5",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-terser": "^7.0.2",
-    "ts-jest": "^28.0.8",
-    "typescript": "^4.7.2"
-  },
-  "dependencies": {
-    "tslib": "^2.4.0"
-  }
-}

package/packages/ndpr-toolkit/rollup.config.js

@@ -1,34 +0,0 @@
-import resolve from '@rollup/plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
-import typescript from '@rollup/plugin-typescript';
-import { terser } from 'rollup-plugin-terser';
-import peerDepsExternal from 'rollup-plugin-peer-deps-external';
-import pkg from './package.json';
-
-export default {
-  input: 'src/index.ts',
-  output: [
-    {
-      file: pkg.main,
-      format: 'cjs',
-      sourcemap: true,
-    },
-    {
-      file: pkg.module,
-      format: 'esm',
-      sourcemap: true,
-    },
-  ],
-  plugins: [
-    peerDepsExternal(),
-    resolve(),
-    commonjs(),
-    typescript({
-      tsconfig: './tsconfig.json',
-      declaration: true,
-      declarationDir: 'dist',
-    }),
-    terser(),
-  ],
-  external: ['react', 'react-dom'],
-};

package/packages/ndpr-toolkit/src/__tests__/components/consent/ConsentBanner.test.tsx

@@ -1,119 +0,0 @@
-import React from 'react';
-import { render, screen, fireEvent } from '@testing-library/react';
-import { ConsentBanner } from '../../../components/consent/ConsentBanner';
-import { ConsentOption } from '../../../types/consent';
-
-describe('ConsentBanner', () => {
-  const mockOnSave = jest.fn();
-  
-  const consentOptions: ConsentOption[] = [
-    {
-      id: 'necessary',
-      label: 'Necessary Cookies',
-      description: 'Essential cookies for the website to function.',
-      required: true
-    },
-    {
-      id: 'analytics',
-      label: 'Analytics Cookies',
-      description: 'Cookies that help us understand how you use our website.',
-      required: false
-    },
-    {
-      id: 'marketing',
-      label: 'Marketing Cookies',
-      description: 'Cookies used for marketing purposes.',
-      required: false
-    }
-  ];
-
-  const renderComponent = (props = {}) => {
-    return render(
-      <ConsentBanner
-        options={consentOptions}
-        position="bottom"
-        onSave={mockOnSave}
-        show={true}
-        storageKey="test-consent"
-        {...props}
-      />
-    );
-  };
-
-  beforeEach(() => {
-    mockOnSave.mockClear();
-  });
-
-  it('renders the consent banner correctly', () => {
-    renderComponent();
-    
-    expect(screen.getByText(/We Value Your Privacy/i)).toBeInTheDocument();
-    expect(screen.getByRole('button', { name: /accept all/i })).toBeInTheDocument();
-    expect(screen.getByRole('button', { name: /reject all/i })).toBeInTheDocument();
-    expect(screen.getByRole('button', { name: /customize/i })).toBeInTheDocument();
-  });
-
-  it('calls onSave when "Accept All" is clicked', () => {
-    renderComponent();
-    
-    fireEvent.click(screen.getByRole('button', { name: /accept all/i }));
-    
-    expect(mockOnSave).toHaveBeenCalled();
-    const saveCall = mockOnSave.mock.calls[0][0];
-    expect(saveCall.consents.necessary).toBe(true);
-    expect(saveCall.consents.analytics).toBe(true);
-    expect(saveCall.consents.marketing).toBe(true);
-    expect(saveCall.timestamp).toBeDefined();
-    expect(saveCall.version).toBe('1.0');
-  });
-
-  it('shows preferences panel when "Customize" is clicked', () => {
-    renderComponent();
-    
-    fireEvent.click(screen.getByRole('button', { name: /customize/i }));
-    
-    expect(screen.getByText(/necessary cookies/i)).toBeInTheDocument();
-    expect(screen.getByText(/analytics cookies/i)).toBeInTheDocument();
-    expect(screen.getByText(/marketing cookies/i)).toBeInTheDocument();
-    expect(screen.getByRole('button', { name: /save preferences/i })).toBeInTheDocument();
-  });
-
-  it('disables required consent options', () => {
-    renderComponent();
-    
-    fireEvent.click(screen.getByRole('button', { name: /customize/i }));
-    
-    // The checkbox for necessary cookies should be disabled
-    const necessaryCheckbox = screen.getByLabelText(/necessary cookies/i);
-    expect(necessaryCheckbox).toBeDisabled();
-  });
-
-  it('allows toggling non-required consent options', () => {
-    renderComponent();
-    
-    fireEvent.click(screen.getByRole('button', { name: /customize/i }));
-    
-    // The checkbox for analytics cookies should be enabled
-    const analyticsCheckbox = screen.getByLabelText(/analytics cookies/i);
-    
-    // Toggle the checkbox
-    fireEvent.click(analyticsCheckbox);
-    
-    // Save preferences
-    fireEvent.click(screen.getByRole('button', { name: /save preferences/i }));
-    
-    expect(mockOnSave).toHaveBeenCalled();
-    const saveCall = mockOnSave.mock.calls[0][0];
-    expect(saveCall.consents.necessary).toBeDefined();
-    expect(saveCall.consents.analytics).toBeDefined();
-    expect(saveCall.method).toBe('customize');
-  });
-
-  it('renders with the correct position', () => {
-    renderComponent({ position: 'top' });
-    
-    const banner = screen.getByRole('dialog');
-    expect(banner).toHaveClass('top-0');
-    expect(banner).not.toHaveClass('bottom-0');
-  });
-});

package/packages/ndpr-toolkit/src/__tests__/components/consent/ConsentManager.test.tsx

@@ -1,122 +0,0 @@
-import React from 'react';
-import { render, screen, fireEvent } from '@testing-library/react';
-import { ConsentManager } from '../../../components/consent/ConsentManager';
-import { ConsentOption, ConsentSettings } from '../../../types/consent';
-
-describe('ConsentManager', () => {
-  const mockOnSave = jest.fn();
-  
-  const consentOptions: ConsentOption[] = [
-    {
-      id: 'necessary',
-      label: 'Necessary Cookies',
-      description: 'Essential cookies for the website to function.',
-      required: true
-    },
-    {
-      id: 'analytics',
-      label: 'Analytics Cookies',
-      description: 'Cookies that help us understand how you use our website.',
-      required: false
-    }
-  ];
-  
-  beforeEach(() => {
-    mockOnSave.mockClear();
-  });
-
-  it('renders the consent manager correctly', () => {
-    render(
-      <ConsentManager
-        options={consentOptions}
-        onSave={mockOnSave}
-      />
-    );
-    
-    // Check that the title and description are rendered
-    expect(screen.getByText(/Manage Your Privacy Settings/i)).toBeInTheDocument();
-    expect(screen.getByText(/Update your consent preferences/i)).toBeInTheDocument();
-    
-    // Check that the consent options are rendered
-    expect(screen.getByText(/Necessary Cookies/i)).toBeInTheDocument();
-    expect(screen.getByText(/Analytics Cookies/i)).toBeInTheDocument();
-    
-    // Check that the buttons are rendered
-    expect(screen.getByRole('button', { name: /Save Preferences/i })).toBeInTheDocument();
-    expect(screen.getByRole('button', { name: /Reset to Defaults/i })).toBeInTheDocument();
-  });
-
-  it('calls onSave when Save Preferences is clicked', () => {
-    render(
-      <ConsentManager
-        options={consentOptions}
-        onSave={mockOnSave}
-      />
-    );
-    
-    // Click the save button
-    fireEvent.click(screen.getByRole('button', { name: /Save Preferences/i }));
-    
-    // Check that onSave was called with the correct settings
-    expect(mockOnSave).toHaveBeenCalled();
-    const saveCall = mockOnSave.mock.calls[0][0];
-    expect(saveCall.consents).toBeDefined();
-    expect(saveCall.timestamp).toBeDefined();
-    expect(saveCall.version).toBe('1.0');
-    expect(saveCall.method).toBe('manager');
-  });
-
-  it('handles empty options array', () => {
-    render(
-      <ConsentManager
-        options={[]}
-        onSave={mockOnSave}
-      />
-    );
-    
-    // Should still render the manager even with empty options
-    expect(screen.getByText(/Manage Your Privacy Settings/i)).toBeInTheDocument();
-  });
-
-  it('allows toggling non-required consent options', () => {
-    render(
-      <ConsentManager
-        options={consentOptions}
-        onSave={mockOnSave}
-      />
-    );
-    
-    // Find the analytics checkbox (non-required)
-    const analyticsCheckboxes = screen.getAllByRole('checkbox');
-    const analyticsCheckbox = analyticsCheckboxes.find(checkbox => !checkbox.hasAttribute('disabled'));
-    
-    // Toggle the checkbox
-    if (analyticsCheckbox) {
-      fireEvent.click(analyticsCheckbox);
-      
-      // Save preferences
-      fireEvent.click(screen.getByRole('button', { name: /Save Preferences/i }));
-      
-      // Check that onSave was called
-      expect(mockOnSave).toHaveBeenCalled();
-    }
-  });
-  
-  it('disables required consent options', () => {
-    render(
-      <ConsentManager
-        options={consentOptions}
-        onSave={mockOnSave}
-      />
-    );
-    
-    // Find all checkboxes
-    const checkboxes = screen.getAllByRole('checkbox');
-    
-    // Find the necessary checkbox (required)
-    const necessaryCheckbox = checkboxes.find(checkbox => checkbox.hasAttribute('disabled'));
-    
-    // Check thatit&apos;s disabled
-    expect(necessaryCheckbox).toBeDisabled();
-  });
-});

package/packages/ndpr-toolkit/src/__tests__/components/consent/ConsentStorage.test.tsx

@@ -1,270 +0,0 @@
-import React from 'react';
-import { render, screen } from '@testing-library/react';
-import { ConsentStorage } from '../../../components/consent/ConsentStorage';
-import { ConsentSettings } from '../../../types/consent';
-
-// Mock localStorage
-const mockLocalStorage = (() => {
-  let store: Record<string, string> = {};
-  return {
-    getItem: jest.fn((key: string) => store[key] || null),
-    setItem: jest.fn((key: string, value: string) => {
-      store[key] = value.toString();
-    }),
-    removeItem: jest.fn((key: string) => {
-      delete store[key];
-    }),
-    clear: jest.fn(() => {
-      store = {};
-    }),
-  };
-})();
-
-Object.defineProperty(window, 'localStorage', {
-  value: mockLocalStorage,
-});
-
-// Mock sessionStorage
-const mockSessionStorage = (() => {
-  let store: Record<string, string> = {};
-  return {
-    getItem: jest.fn((key: string) => store[key] || null),
-    setItem: jest.fn((key: string, value: string) => {
-      store[key] = value.toString();
-    }),
-    removeItem: jest.fn((key: string) => {
-      delete store[key];
-    }),
-    clear: jest.fn(() => {
-      store = {};
-    }),
-  };
-})();
-
-Object.defineProperty(window, 'sessionStorage', {
-  value: mockSessionStorage,
-});
-
-// Mock document.cookie
-Object.defineProperty(document, 'cookie', {
-  writable: true,
-  value: '',
-});
-
-describe('ConsentStorage', () => {
-  const testConsents: ConsentSettings = {
-    consents: {
-      necessary: true,
-      analytics: false,
-      marketing: true
-    },
-    timestamp: Date.now(),
-    version: '1.0',
-    method: 'test',
-    hasInteracted: true
-  };
-
-  beforeEach(() => {
-    mockLocalStorage.clear();
-    mockSessionStorage.clear();
-    document.cookie = '';
-    jest.clearAllMocks();
-  });
-
-  it('saves and loads consent settings from localStorage', () => {
-    const onLoad = jest.fn();
-
-    render(
-      <ConsentStorage
-        settings={testConsents}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "localStorage"
-        }}
-        onLoad={onLoad}
-        onSave={jest.fn()}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // Check that it saved to localStorage
-    expect(mockLocalStorage.setItem).toHaveBeenCalledWith(
-      'test-consent',
-      JSON.stringify(testConsents)
-    );
-
-    // Mock localStorage returning data
-    mockLocalStorage.getItem.mockReturnValueOnce(JSON.stringify(testConsents));
-
-    // Render again to test loading
-    render(
-      <ConsentStorage
-        settings={{
-          consents: {},
-          timestamp: Date.now(),
-          version: '1.0',
-          method: 'test',
-          hasInteracted: false
-        }}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "localStorage"
-        }}
-        onLoad={onLoad}
-        onSave={jest.fn()}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // Check that it loaded from localStorage
-    expect(mockLocalStorage.getItem).toHaveBeenCalledWith('test-consent');
-    expect(onLoad).toHaveBeenCalledWith(testConsents);
-  });
-
-  it('saves and loads consent settings from sessionStorage', () => {
-    const onLoad = jest.fn();
-
-    render(
-      <ConsentStorage
-        settings={testConsents}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "sessionStorage"
-        }}
-        onLoad={onLoad}
-        onSave={jest.fn()}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // Check that it saved to sessionStorage
-    expect(mockSessionStorage.setItem).toHaveBeenCalledWith(
-      'test-consent',
-      JSON.stringify(testConsents)
-    );
-
-    // Mock sessionStorage returning data
-    mockSessionStorage.getItem.mockReturnValueOnce(JSON.stringify(testConsents));
-
-    // Render again to test loading
-    render(
-      <ConsentStorage
-        settings={{
-          consents: {},
-          timestamp: Date.now(),
-          version: '1.0',
-          method: 'test',
-          hasInteracted: false
-        }}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "sessionStorage"
-        }}
-        onLoad={onLoad}
-        onSave={jest.fn()}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // Check that it loaded from sessionStorage
-    expect(mockSessionStorage.getItem).toHaveBeenCalledWith('test-consent');
-    expect(onLoad).toHaveBeenCalledWith(testConsents);
-  });
-
-  it('saves and loads consent settings from cookies', () => {
-    const onLoad = jest.fn();
-    const onSave = jest.fn();
-
-    // Skip this test since we can't properly mock document.cookie
-    // in the test environment without causing errors
-    
-    // Just make a simple assertion to pass the test
-    expect(true).toBe(true);
-  });
-
-  it('handles invalid stored data gracefully', () => {
-    // Mock console.error to prevent test output pollution
-    const originalConsoleError = console.error;
-    console.error = jest.fn();
-    
-    // Set invalid JSON in localStorage
-    mockLocalStorage.getItem.mockReturnValueOnce('invalid-json');
-
-    // We're just testing that the component doesn&apos;t crash with invalid data
-    // The component will log an error but should continue to function
-    render(
-      <ConsentStorage
-        settings={{
-          consents: {},
-          timestamp: Date.now(),
-          version: '1.0',
-          method: 'test',
-          hasInteracted: false
-        }}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "localStorage"
-        }}
-        onLoad={jest.fn()}
-        onSave={jest.fn()}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // Verify that console.error was called (indicating the error was handled)
-    expect(console.error).toHaveBeenCalled();
-    
-    // Restore console.error
-    console.error = originalConsoleError;
-  });
-
-  it('renders nothing to the DOM', () => {
-    const { container } = render(
-      <ConsentStorage
-        settings={testConsents}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "localStorage"
-        }}
-        onLoad={jest.fn()}
-        onSave={jest.fn()}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // The component should not render anything visible
-    expect(container.firstChild).toBeNull();
-  });
-
-  it('respects autoSave and autoLoad props', () => {
-    const onLoad = jest.fn();
-
-    // With autoSave=false, it should not save
-    render(
-      <ConsentStorage
-        settings={testConsents}
-        storageOptions={{
-          storageKey: "test-consent",
-          storageType: "localStorage"
-        }}
-        onLoad={onLoad}
-        onSave={jest.fn()}
-        autoSave={false}
-        autoLoad={false}
-      >
-        {null}
-      </ConsentStorage>
-    );
-
-    // Should not have saved or loaded
-    expect(mockLocalStorage.setItem).not.toHaveBeenCalled();
-    expect(mockLocalStorage.getItem).not.toHaveBeenCalled();
-    expect(onLoad).not.toHaveBeenCalled();
-  });
-});