@tantainnovative/ndpr-toolkit 1.0.1 → 1.0.3

package/RELEASE-NOTES-v1.0.1.md

@@ -0,0 +1,69 @@
+# NDPR Toolkit v1.0.1 Release Notes
+
+**Release Date:** May 4, 2025  
+**Package:** [@tantainnovative/ndpr-toolkit](https://www.npmjs.com/package/@tantainnovative/ndpr-toolkit)  
+**Version:** 1.0.1
+
+## Overview
+
+This release adds React 19 compatibility to the NDPR Toolkit while maintaining support for React 18. The update ensures that the toolkit can be seamlessly integrated into projects using either React version.
+
+## What's New
+
+### React 19 Compatibility
+
+- Updated peer dependencies to support both React 18 and React 19
+- Added installation instructions for React 19 users
+- Maintained full functionality across all components with the newer React version
+
+### Installation Notes
+
+When using the toolkit with React 19, you may encounter peer dependency warnings with other packages in your project. To resolve these, you can use the `--legacy-peer-deps` flag:
+
+```bash
+npm install @tantainnovative/ndpr-toolkit --legacy-peer-deps
+```
+
+Alternatively, you can create a `.npmrc` file in your project root with the following content:
+
+```
+legacy-peer-deps=true
+```
+
+This will make npm ignore peer dependency conflicts during installation.
+
+## Technical Specifications
+
+- **Framework Compatibility**: React 18+ and React 19+
+- **TypeScript Support**: Full TypeScript definitions for all components and utilities
+- **Modular Architecture**: Use only what you need with tree-shakable imports
+- **Customization**: Extensive theming and styling options
+- **Accessibility**: WCAG 2.1 AA compliant components
+- **Performance**: Optimized bundle size with minimal dependencies
+
+## Bug Fixes
+
+- No bug fixes in this release; this is purely a compatibility update
+
+## Documentation Updates
+
+- Added React 19 compatibility notes to README.md
+- Updated installation instructions with guidance for handling peer dependency conflicts
+
+## Upgrading from v1.0.0
+
+This is a drop-in replacement for v1.0.0 with no breaking changes. To upgrade:
+
+```bash
+npm install @tantainnovative/ndpr-toolkit@1.0.1
+```
+
+Or with peer dependency resolution:
+
+```bash
+npm install @tantainnovative/ndpr-toolkit@1.0.1 --legacy-peer-deps
+```
+
+---
+
+© 2025 Tanta Innovative. All rights reserved.

package/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

package/commitlint.config.js

@@ -0,0 +1,36 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 100],
+    'subject-case': [
+      2,
+      'never',
+      ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+    ],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'ci',
+        'docs',
+        'feat',
+        'fix',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test',
+      ],
+    ],
+  },
+};

package/components.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "",
+    "css": "src/app/globals.css",
+    "baseColor": "gray",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  },
+  "iconLibrary": "lucide"
+}

package/eslint.config.mjs

@@ -0,0 +1,16 @@
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+const eslintConfig = [
+  ...compat.extends("next/core-web-vitals", "next/typescript"),
+];
+
+export default eslintConfig;

package/jest.config.js

@@ -0,0 +1,31 @@
+const nextJest = require('next/jest');
+
+const createJestConfig = nextJest({
+  // Provide the path to your Next.js app to load next.config.js and .env files in your test environment
+  dir: './',
+});
+
+// Add any custom config to be passed to Jest
+const customJestConfig = {
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+  testEnvironment: 'jest-environment-jsdom',
+  moduleNameMapper: {
+    // Handle module aliases (if you have them in tsconfig.json)
+    '^@/(.*)$': '<rootDir>/src/$1',
+  },
+  testPathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/.next/',
+    '<rootDir>/out/'
+  ],
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'src/**/*.{js,jsx,ts,tsx}',
+    '!src/**/*.d.ts',
+    '!src/**/_*.{js,jsx,ts,tsx}',
+    '!src/**/index.{js,jsx,ts,tsx}',
+  ],
+};
+
+// createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async
+module.exports = createJestConfig(customJestConfig);

package/jest.setup.js

@@ -0,0 +1,15 @@
+// Learn more: https://github.com/testing-library/jest-dom
+import '@testing-library/jest-dom';
+
+// Mock localStorage for tests
+if (typeof window !== 'undefined') {
+  Object.defineProperty(window, 'localStorage', {
+    value: {
+      getItem: jest.fn(),
+      setItem: jest.fn(),
+      removeItem: jest.fn(),
+      clear: jest.fn(),
+    },
+    writable: true
+  });
+}

package/next.config.js

@@ -0,0 +1,15 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  output: 'export',
+  basePath: '',
+  images: {
+    unoptimized: true,
+  },
+  eslint: {
+    // Warning: This allows production builds to successfully complete even if
+    // your project has ESLint errors.
+    ignoreDuringBuilds: true,
+  },
+}
+
+module.exports = nextConfig

package/next.config.ts

@@ -0,0 +1,62 @@
+import type { NextConfig } from "next";
+
+// Check if we're in development mode
+const isDevelopment = process.env.NODE_ENV === 'development';
+
+// Repository name for GitHub Pages
+const REPO_NAME = 'ndpr-toolkit';
+
+const nextConfig: NextConfig = {
+  reactStrictMode: true,
+  
+  // These settings apply to all environments
+  poweredByHeader: false,
+  
+  // Fix for hydration errors
+  // This ensures consistent rendering between server and client
+  experimental: {
+    // Reduce hydration mismatches by making SSR output match client rendering
+    scrollRestoration: true,
+  },
+  
+  // Optimize fonts to reduce hydration mismatches
+  optimizeFonts: true,
+  
+  // Suppress hydration warnings in development
+  onDemandEntries: {
+    // Keep pages in memory for longer to avoid reloading
+    maxInactiveAge: 25 * 1000,
+    pagesBufferLength: 5,
+  },
+  
+  // Only use static export, basePath and assetPrefix in production
+  ...(isDevelopment 
+    ? {
+        // Development config - no basePath or static export
+      } 
+    : {
+        // Production config for GitHub Pages
+        output: 'export',  // Enable static HTML export
+        trailingSlash: true,  // Important for GitHub Pages to work correctly with routing
+        images: {
+          unoptimized: true,  // Required for static export
+        },
+        basePath: `/${REPO_NAME}`,
+        assetPrefix: `/${REPO_NAME}`,
+      }
+  ),
+};
+
+// Add a custom export script to generate a .nojekyll file
+// This prevents GitHub Pages from ignoring files that begin with an underscore
+if (process.env.NODE_ENV === 'production') {
+  const { execSync } = require('child_process');
+  try {
+    execSync('touch out/.nojekyll');
+    console.log('Created .nojekyll file');
+  } catch (error) {
+    console.error('Error creating .nojekyll file:', error);
+  }
+}
+
+export default nextConfig;

package/package.json

@@ -1,71 +1,89 @@
 {
   "name": "@tantainnovative/ndpr-toolkit",
-  "version": "1.0.1",
-  "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"
-  ],
+  "version": "1.0.3",
+  "private": false,
+  "description": "Nigerian Data Protection Compliance Toolkit for implementing NDPR and DPA compliant features",
   "scripts": {
-    "build": "rollup -c",
-    "dev": "rollup -c -w",
-    "test": "jest",
-    "lint": "eslint src --ext .ts,.tsx",
-    "prepublishOnly": "npm run build"
+    "dev": "next dev --turbopack",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "test": "jest --passWithNoTests",
+    "prepare": "husky install",
+    "export": "next export",
+    "build:static": "next build",
+    "deploy": "next build && touch out/.nojekyll && gh-pages -d out",
+    "release": "standard-version",
+    "release:minor": "standard-version --release-as minor",
+    "release:major": "standard-version --release-as major",
+    "release:patch": "standard-version --release-as patch"
   },
   "keywords": [
     "ndpr",
+    "dpa",
+    "nigeria",
     "data-protection",
-    "privacy",
     "compliance",
-    "nigeria",
-    "consent",
-    "dpia",
-    "data-subject-rights",
-    "breach-notification"
+    "privacy",
+    "gdpr"
   ],
   "author": "Tanta Innovative",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/tantainnovative/ndpr-toolkit"
+    "url": "git+https://github.com/tantainnovative/ndpr-toolkit.git"
   },
-  "publishConfig": {
-    "access": "public"
+  "bugs": {
+    "url": "https://github.com/tantainnovative/ndpr-toolkit/issues"
   },
-  "peerDependencies": {
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
+  "homepage": "https://github.com/tantainnovative/ndpr-toolkit#readme",
+  "dependencies": {
+    "@radix-ui/react-label": "^2.1.4",
+    "@radix-ui/react-slot": "^1.2.0",
+    "@radix-ui/react-switch": "^1.2.2",
+    "@radix-ui/react-tabs": "^1.1.9",
+    "@tantainnovative/ndpr-toolkit": "^1.0.1",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "docx": "^9.4.1",
+    "gray-matter": "^4.0.3",
+    "html-to-docx": "^1.8.0",
+    "jspdf": "^3.0.1",
+    "jspdf-autotable": "^5.0.2",
+    "lucide-react": "^0.507.0",
+    "next": "15.3.1",
+    "next-mdx-remote": "^5.0.0",
+    "nextra": "^4.2.17",
+    "nextra-theme-docs": "^4.2.17",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-markdown": "^10.1.0",
+    "tailwind-merge": "^2.6.0",
+    "uuid": "^11.1.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"
+    "@commitlint/cli": "^19.0.0",
+    "@commitlint/config-conventional": "^19.0.0",
+    "@eslint/eslintrc": "^3",
+    "@tailwindcss/postcss": "^4.1.5",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.3.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@types/uuid": "^9.0.0",
+    "autoprefixer": "^10.4.21",
+    "eslint": "^9",
+    "eslint-config-next": "15.3.1",
+    "gh-pages": "^6.3.0",
+    "husky": "^9.0.0",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "prettier": "^3.6.2",
+    "standard-version": "^9.5.0",
+    "tailwindcss": "^4",
+    "tw-animate-css": "^1.2.9",
+    "typescript": "^5"
   }
 }