@tantainnovative/ndpr-toolkit 1.0.1 → 1.0.3

package/.claude/settings.local.json

@@ -0,0 +1,20 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(find:*)",
+      "Bash(grep:*)",
+      "Bash(git push:*)",
+      "Bash(npm run lint)",
+      "Bash(pnpm lint:*)",
+      "Bash(pnpm install:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(pnpm add:*)",
+      "Bash(pnpm build:*)",
+      "Bash(sed:*)",
+      "Bash(cat:*)",
+      "Bash(npm:*)"
+    ],
+    "deny": []
+  }
+}

package/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": "next/core-web-vitals",
+  "rules": {
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/no-empty-object-type": "off",
+    "react/no-unescaped-entities": "off",
+    "@typescript-eslint/no-explicit-any": "off"
+  },
+  "ignorePatterns": ["node_modules/**/*"]
+}

package/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [20.x]
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Lint
+        run: npm run lint
+      
+      - name: Type check
+        run: npx tsc --noEmit
+      
+      - name: Run tests
+        run: npm test

package/.github/workflows/nextjs.yml

@@ -0,0 +1,104 @@
+# Sample workflow for building and deploying a Next.js site to GitHub Pages
+#
+# To get started with Next.js see: https://nextjs.org/docs/getting-started
+#
+name: Deploy Next.js site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "${{ github.workspace }}/pnpm-lock.yaml" ]; then
+            echo "manager=pnpm" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=pnpm" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+      - name: Setup pnpm
+        if: steps.detect-package-manager.outputs.manager == 'pnpm'
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+        with:
+          # Automatically inject basePath in your Next.js configuration file and disable
+          # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
+          #
+          # You may remove this line if you want to manage the configuration yourself.
+          static_site_generator: next
+      - name: Restore cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            .next/cache
+          # Generate a new cache whenever packages or source files change.
+          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
+          # If source files changed but packages didn't, rebuild from a prior cache.
+          restore-keys: |
+            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
+      - name: Install dependencies
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+      - name: Build with Next.js
+        run: ${{ steps.detect-package-manager.outputs.runner }} next build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./out
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package/.lintstagedrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  '*.{js,jsx,ts,tsx}': ['eslint --fix', 'prettier --write'],
+  '*.{json,md}': ['prettier --write'],
+};

package/.nvmrc

@@ -0,0 +1 @@
+20

package/.versionrc

@@ -0,0 +1,17 @@
+{
+  "types": [
+    {"type": "feat", "section": "Features"},
+    {"type": "fix", "section": "Bug Fixes"},
+    {"type": "chore", "hidden": true},
+    {"type": "docs", "section": "Documentation"},
+    {"type": "style", "hidden": true},
+    {"type": "refactor", "section": "Code Refactoring"},
+    {"type": "perf", "section": "Performance Improvements"},
+    {"type": "test", "hidden": true},
+    {"type": "build", "hidden": true},
+    {"type": "ci", "hidden": true}
+  ],
+  "commitUrlFormat": "https://github.com/tantainnovative/ndpr-toolkit/commit/{{hash}}",
+  "compareUrlFormat": "https://github.com/tantainnovative/ndpr-toolkit/compare/{{previousTag}}...{{currentTag}}",
+  "releaseCommitMessageFormat": "chore(release): {{currentTag}}"
+}

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## 1.0.0 (2025-05-02)
+
+
+### Features
+
+* initial implementation of NDPR-Toolkit with all key components ([b41aeef](https://github.com/tantainnovative/ndpr-toolkit/commit/b41aeefe3184ce69ed09f3d8c0fdacb860a98427))
+
+
+### Bug Fixes
+
+* resolve ESLint errors for successful build ([3f78939](https://github.com/tantainnovative/ndpr-toolkit/commit/3f7893902cc7ec67913a7e19f6a804d01e69896e))
+* resolve type errors for successful build ([b827186](https://github.com/tantainnovative/ndpr-toolkit/commit/b8271865a77b097f0ce839ad13555b4bfe12fe2e))

package/CLAUDE.md

@@ -0,0 +1,90 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+The Nigerian Data Protection Compliance Toolkit (NDPR-Toolkit) is a Next.js application that helps developers implement NDPR and DPA compliant features. It's deployed as a static site to GitHub Pages.
+
+## Development Commands
+
+### Package Manager
+Always use `pnpm` for all package management operations.
+
+### Core Commands
+- **Development server**: `pnpm dev` (uses Turbopack)
+- **Build**: `pnpm build`
+- **Production server**: `pnpm start`
+- **Static export**: `pnpm export` or `pnpm build:static`
+- **Deploy to GitHub Pages**: `pnpm deploy`
+
+### Testing
+- **Run tests**: `pnpm test`
+- **Run specific test**: `pnpm test -- path/to/test.spec.ts`
+- **Tests use**: Jest with React Testing Library and jest-environment-jsdom
+
+### Code Quality
+- **Lint**: `pnpm lint`
+- **Git hooks**: Pre-commit runs lint-staged, commit-msg runs commitlint
+- **Commit format**: Use conventional commits (feat, fix, docs, style, refactor, test, chore)
+
+### Release Management
+- **Standard release**: `pnpm release`
+- **Version bumps**: `pnpm release:patch`, `pnpm release:minor`, `pnpm release:major`
+
+## Architecture
+
+### Tech Stack
+- **Next.js 15.3.1** with App Router
+- **React 19** with TypeScript
+- **Tailwind CSS v4** with custom theme configuration
+- **Radix UI** for accessible components
+- **Nextra** for documentation pages
+
+### Project Structure
+```
+src/
+├── app/                    # Next.js pages (App Router)
+│   ├── docs/              # Documentation pages
+│   ├── ndpr-demos/        # Interactive NDPR compliance demos
+│   └── page.tsx           # Homepage
+├── components/            # Feature-based component organization
+│   ├── breach-notification/
+│   ├── consent/
+│   ├── data-subject-rights/
+│   ├── dpia/
+│   ├── privacy-policy/
+│   └── ui/               # Base UI components
+├── hooks/                 # Custom React hooks
+├── lib/                   # Services and utilities
+│   ├── consentService.ts
+│   ├── requestService.ts  # LocalStorage-based state management
+│   └── utils.ts
+└── types/                 # TypeScript type definitions
+```
+
+### Key Patterns
+
+1. **State Management**: Demo data persists in localStorage via service layer (e.g., `requestService.ts`)
+2. **Component Architecture**: Feature-based organization with modular, reusable components
+3. **Static Site**: Configured for GitHub Pages with basePath and assetPrefix in `next.config.ts`
+4. **Type Safety**: Comprehensive TypeScript types in `types/` directory
+5. **Styling**: Tailwind CSS with CSS variables for theming
+
+### NDPR Compliance Features
+
+When working on NDPR features, understand these core modules:
+
+1. **Consent Management** (`components/consent/`): Multi-purpose consent with granular controls
+2. **Data Subject Rights** (`components/data-subject-rights/`): Request portal for access, deletion, etc.
+3. **Privacy Policy Generator** (`components/privacy-policy/`): Step-by-step wizard
+4. **DPIA Tool** (`components/dpia/`): Data Protection Impact Assessment questionnaire
+5. **Breach Notification** (`components/breach-notification/`): Incident reporting system
+
+### Important Notes
+
+- All data in demos uses localStorage - no backend required
+- Components are designed for NDPR/DPA compliance out of the box
+- The project auto-deploys to GitHub Pages on main branch pushes
+- TypeScript strict mode is enabled - maintain type safety
+- Follow existing component patterns when adding new features

package/CNAME

@@ -0,0 +1 @@
+ndprtoolkit.com.ng

package/CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to NDPR-Toolkit
+
+Thank you for considering contributing to the Nigerian Data Protection Compliance Toolkit! This document outlines the process for contributing to this project.
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create an issue in the GitHub repository with the following information:
+
+1. A clear, descriptive title
+2. Steps to reproduce the bug
+3. Expected behavior
+4. Actual behavior
+5. Screenshots (if applicable)
+6. Environment information (browser, OS, etc.)
+
+### Suggesting Features
+
+We welcome feature suggestions! Please create an issue with:
+
+1. A clear, descriptive title
+2. Detailed description of the proposed feature
+3. Any relevant examples or mockups
+4. Explanation of why this feature would be useful to the project
+
+### Pull Requests
+
+We follow a standard GitHub workflow:
+
+1. Fork the repository
+2. Create a new branch for your feature or bug fix
+3. Make your changes
+4. Write or update tests as needed
+5. Ensure all tests pass
+6. Commit your changes using conventional commit messages
+7. Push to your fork
+8. Submit a pull request
+
+### Commit Message Convention
+
+We use conventional commits to automate versioning and changelog generation. Please format your commit messages as follows:
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types include:
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code changes that neither fix bugs nor add features
+- `perf`: Performance improvements
+- `test`: Adding or updating tests
+- `chore`: Changes to the build process or auxiliary tools
+
+Example:
+```
+feat(consent): add ability to customize consent banner colors
+```
+
+## Development Setup
+
+1. Clone your fork of the repository
+2. Install dependencies: `npm install`
+3. Start the development server: `npm run dev`
+4. Make your changes
+5. Run tests: `npm test`
+
+## Release Process
+
+Releases are managed by the maintainers using semantic versioning. The process is automated through GitHub Actions.
+
+## Questions?
+
+If you have any questions about contributing, please open an issue with your question.
+
+Thank you for contributing to the NDPR-Toolkit!