@tantainnovative/ndpr-toolkit 1.0.0

package/dist/types/privacy.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Represents a section in a privacy policy
+ */
+export interface PolicySection {
+    /**
+     * Unique identifier for the section
+     */
+    id: string;
+    /**
+     * Title of the section
+     */
+    title: string;
+    /**
+     * Description of the section
+     */
+    description?: string;
+    /**
+     * Order of the section in the policy
+     */
+    order?: number;
+    /**
+     * Whether the section is required by NDPR
+     */
+    required: boolean;
+    /**
+     * Template text for the section
+     */
+    template: string;
+    /**
+     * Default content for the section (legacy field)
+     * @deprecated Use template instead
+     */
+    defaultContent?: string;
+    /**
+     * Custom content for the section (overrides default content)
+     * @deprecated Use template instead
+     */
+    customContent?: string;
+    /**
+     * Whether the section is included in the policy
+     */
+    included: boolean;
+    /**
+     * Variables that can be used in the section content
+     */
+    variables?: string[];
+}
+/**
+ * Represents a privacy policy template
+ */
+export interface PolicyTemplate {
+    /**
+     * Unique identifier for the template
+     */
+    id: string;
+    /**
+     * Name of the template
+     */
+    name: string;
+    /**
+     * Description of the template
+     */
+    description: string;
+    /**
+     * Type of organization the template is designed for
+     */
+    organizationType: 'business' | 'nonprofit' | 'government' | 'educational';
+    /**
+     * Sections included in the template
+     */
+    sections: PolicySection[];
+    /**
+     * Variables used across the template
+     */
+    variables: Record<string, {
+        name: string;
+        description: string;
+        required: boolean;
+        defaultValue?: string;
+    }>;
+    /**
+     * Version of the template
+     */
+    version: string;
+    /**
+     * Last updated date of the template
+     */
+    lastUpdated: number;
+}
+/**
+ * Represents organization information for a privacy policy
+ */
+export interface OrganizationInfo {
+    /**
+     * Name of the organization
+     */
+    name: string;
+    /**
+     * Website URL of the organization
+     */
+    website: string;
+    /**
+     * Contact email for privacy inquiries
+     */
+    privacyEmail: string;
+    /**
+     * Physical address of the organization
+     */
+    address?: string;
+    /**
+     * Phone number for privacy inquiries
+     */
+    privacyPhone?: string;
+    /**
+     * Name of the Data Protection Officer (if applicable)
+     */
+    dpoName?: string;
+    /**
+     * Email of the Data Protection Officer (if applicable)
+     */
+    dpoEmail?: string;
+    /**
+     * Industry or sector of the organization
+     */
+    industry?: string;
+}
+/**
+ * Represents a variable in a privacy policy
+ */
+export interface PolicyVariable {
+    /**
+     * Unique identifier for the variable
+     */
+    id: string;
+    /**
+     * Name of the variable as it appears in the template
+     */
+    name: string;
+    /**
+     * Description of the variable
+     */
+    description: string;
+    /**
+     * Default value for the variable
+     */
+    defaultValue?: string;
+    /**
+     * Current value of the variable
+     */
+    value: string;
+    /**
+     * Type of input for the variable
+     */
+    inputType: 'text' | 'textarea' | 'email' | 'url' | 'date' | 'select';
+    /**
+     * Options for select inputs
+     */
+    options?: string[];
+    /**
+     * Whether the variable is required
+     */
+    required: boolean;
+}
+/**
+ * Represents a generated privacy policy
+ */
+export interface PrivacyPolicy {
+    /**
+     * Unique identifier for the policy
+     */
+    id: string;
+    /**
+     * Title of the policy
+     */
+    title: string;
+    /**
+     * Template used to generate the policy
+     */
+    templateId: string;
+    /**
+     * Organization information
+     */
+    organizationInfo: OrganizationInfo;
+    /**
+     * Sections of the policy
+     */
+    sections: PolicySection[];
+    /**
+     * Values for the variables used in the policy
+     */
+    variableValues: Record<string, string>;
+    /**
+     * Effective date of the policy
+     */
+    effectiveDate: number;
+    /**
+     * Last updated date of the policy
+     */
+    lastUpdated: number;
+    /**
+     * Version of the policy
+     */
+    version: string;
+}

package/dist/utils/breach.d.ts

@@ -0,0 +1,14 @@
+import { BreachReport, RiskAssessment } from '../types/breach';
+/**
+ * Calculates the severity of a data breach based on various factors
+ * @param report The breach report
+ * @param assessment The risk assessment (if available)
+ * @returns The calculated severity and notification requirements
+ */
+export declare function calculateBreachSeverity(report: BreachReport, assessment?: RiskAssessment): {
+    severityLevel: 'low' | 'medium' | 'high' | 'critical';
+    notificationRequired: boolean;
+    urgentNotificationRequired: boolean;
+    timeframeHours: number;
+    justification: string;
+};

package/dist/utils/consent.d.ts

@@ -0,0 +1,10 @@
+import { ConsentSettings } from '../types/consent';
+/**
+ * Validates consent settings to ensure they meet NDPR requirements
+ * @param settings The consent settings to validate
+ * @returns An object containing validation result and any error messages
+ */
+export declare function validateConsent(settings: ConsentSettings): {
+    valid: boolean;
+    errors: string[];
+};

package/dist/utils/dpia.d.ts

@@ -0,0 +1,12 @@
+import { DPIAResult } from '../types/dpia';
+/**
+ * Assesses the risk level of a DPIA based on the identified risks
+ * @param dpiaResult The DPIA result containing risks to assess
+ * @returns Assessment result with overall risk level and recommendations
+ */
+export declare function assessDPIARisk(dpiaResult: DPIAResult): {
+    overallRiskLevel: 'low' | 'medium' | 'high' | 'critical';
+    requiresConsultation: boolean;
+    canProceed: boolean;
+    recommendations: string[];
+};

package/dist/utils/dsr.d.ts

@@ -0,0 +1,11 @@
+import { DSRRequest } from '../types/dsr';
+/**
+ * Formats a DSR request for display or submission
+ * @param request The DSR request to format
+ * @returns Formatted request data
+ */
+export declare function formatDSRRequest(request: DSRRequest): {
+    formattedRequest: Record<string, any>;
+    isValid: boolean;
+    validationErrors: string[];
+};

package/dist/utils/privacy.d.ts

@@ -0,0 +1,12 @@
+import { PolicySection, OrganizationInfo } from '../types/privacy';
+/**
+ * Generates policy text by replacing variables in a template with organization-specific values
+ * @param sectionsOrTemplate The policy sections or template string to generate text for
+ * @param organizationInfoOrVariables The organization information or variable map to use for replacement
+ * @returns The generated policy text or an object with the generated text and metadata
+ */
+export declare function generatePolicyText(sectionsOrTemplate: PolicySection[] | string, organizationInfoOrVariables: OrganizationInfo | Record<string, string>): string | {
+    fullText: string;
+    sectionTexts: Record<string, string>;
+    missingVariables: string[];
+};

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@tantainnovative/ndpr-toolkit",
+  "version": "1.0.0",
+  "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",
+    "react-dom": "^18.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"
+  }
+}