@tantainnovative/ndpr-toolkit 3.4.0 → 3.5.0

package/dist/policy-engine-fYSqEqSW.d.mts

@@ -1,154 +0,0 @@
-import { O as OrganizationInfo } from './privacy-Ca6te9Ir.mjs';
-
-/**
- * Policy engine types for the adaptive privacy policy generator.
- * These types power the wizard-driven policy builder, compliance checker,
- * and export functionality — all aligned with the NDPA 2023.
- */
-
-/** Industry verticals with sector-specific compliance requirements. */
-type Industry = 'fintech' | 'healthcare' | 'ecommerce' | 'saas' | 'education' | 'government' | 'other';
-/** Organisation size tiers — affects complexity of generated language. */
-type OrgSize = 'startup' | 'midsize' | 'enterprise';
-/** Lawful processing purposes recognised under the NDPA. */
-type ProcessingPurpose = 'service_delivery' | 'marketing' | 'analytics' | 'research' | 'legal_compliance' | 'fraud_prevention';
-/** A logical category of personal data the organisation may collect. */
-interface DataCategory {
-    /** Machine-readable identifier. */
-    id: string;
-    /** Human-readable label shown in the wizard. */
-    label: string;
-    /** Grouping for display and compliance checks. */
-    group: 'identity' | 'financial' | 'behavioral' | 'sensitive' | 'children';
-    /** Specific data points within this category. */
-    dataPoints: string[];
-    /** Whether this category is currently selected by the user. */
-    selected: boolean;
-}
-/** A third-party entity that processes data on behalf of the organisation. */
-interface ThirdPartyProcessor {
-    /** Name of the third party. */
-    name: string;
-    /** Purpose of sharing data with this processor. */
-    purpose: string;
-    /** Country where the processor is located. */
-    country: string;
-}
-/** Full context used to generate an adaptive privacy policy. */
-interface TemplateContext {
-    /** Organisation details, extended with industry and size. */
-    org: OrganizationInfo & {
-        industry: Industry;
-        orgSize: OrgSize;
-        country: string;
-    };
-    /** Data categories the organisation collects. */
-    dataCategories: DataCategory[];
-    /** Processing purposes relevant to the organisation. */
-    purposes: ProcessingPurpose[];
-    /** Whether the organisation processes children's data. */
-    hasChildrenData: boolean;
-    /** Whether the organisation processes sensitive/special-category data. */
-    hasSensitiveData: boolean;
-    /** Whether the organisation processes financial data. */
-    hasFinancialData: boolean;
-    /** Whether data is transferred outside Nigeria. */
-    hasCrossBorderTransfer: boolean;
-    /** Whether automated decision-making or profiling is used. */
-    hasAutomatedDecisions: boolean;
-    /** Third-party processors that receive personal data. */
-    thirdPartyProcessors: ThirdPartyProcessor[];
-}
-/** A user-defined section added to the policy outside the generated ones. */
-interface CustomSection {
-    id: string;
-    title: string;
-    content: string;
-    order: number;
-    required: false;
-}
-/** Represents an in-progress policy being built in the wizard. */
-interface PolicyDraft {
-    /** Unique identifier for the draft. */
-    id: string;
-    /** The template context driving section generation. */
-    templateContext: TemplateContext;
-    /** Custom sections added by the user. */
-    customSections: CustomSection[];
-    /** Per-section content overrides keyed by section id. */
-    sectionOverrides: Record<string, string>;
-    /** Ordered list of section ids defining the final order. */
-    sectionOrder: string[];
-    /** Current wizard step (0-indexed). */
-    currentStep: number;
-    /** Timestamp of the last save. */
-    lastSavedAt: number;
-    /** The draft is always in "draft" status until finalised. */
-    status: 'draft';
-}
-/** A single gap found during NDPA compliance evaluation. */
-interface ComplianceGap {
-    /** Machine-readable requirement identifier. */
-    requirementId: string;
-    /** Human-readable name of the requirement. */
-    requirement: string;
-    /** Reference to the relevant NDPA section. */
-    ndpaSection: string;
-    /** How severe the gap is. */
-    severity: 'critical' | 'important' | 'recommended';
-    /** Explanation of what is missing. */
-    message: string;
-    /** Suggested fix type for the UI. */
-    fixType: 'add_section' | 'add_content' | 'fill_field';
-    /** Label for the fix action button. */
-    fixLabel: string;
-    /** Pre-written content the user can insert to close the gap. */
-    suggestedContent?: string;
-}
-/** Result of evaluating a policy against NDPA requirements. */
-interface ComplianceResult {
-    /** Points earned. */
-    score: number;
-    /** Maximum achievable points (115). */
-    maxScore: number;
-    /** Percentage score (0-100). */
-    percentage: number;
-    /** Overall compliance rating. */
-    rating: 'compliant' | 'nearly_compliant' | 'not_compliant';
-    /** List of identified compliance gaps. */
-    gaps: ComplianceGap[];
-    /** List of requirement ids that passed. */
-    passed: string[];
-}
-/** Options for PDF export of the finalised policy. */
-interface PDFExportOptions {
-    includeCoverPage?: boolean;
-    includeTOC?: boolean;
-    includeComplianceBadge?: boolean;
-    logoUrl?: string;
-    filename?: string;
-}
-/** Options for DOCX export of the finalised policy. */
-interface DOCXExportOptions {
-    includeTOC?: boolean;
-    filename?: string;
-}
-/** Options for HTML export of the finalised policy. */
-interface HTMLExportOptions {
-    includeStyles?: boolean;
-    includePrintCSS?: boolean;
-    customCSS?: string;
-}
-/**
- * Comprehensive set of 16 data categories spanning identity, financial,
- * behavioral, sensitive, and children groups. Used to populate the wizard
- * and drive adaptive section generation.
- */
-declare const DEFAULT_DATA_CATEGORIES: DataCategory[];
-/**
- * Creates a default TemplateContext with sensible empty/initial values.
- * Useful for initialising the wizard state before the user begins editing.
- */
-declare function createDefaultContext(): TemplateContext;
-
-export { type ComplianceGap as C, type DataCategory as D, type HTMLExportOptions as H, type Industry as I, type OrgSize as O, type PolicyDraft as P, type TemplateContext as T, type ComplianceResult as a, type CustomSection as b, type ThirdPartyProcessor as c, createDefaultContext as d, DEFAULT_DATA_CATEGORIES as e, type DOCXExportOptions as f, type PDFExportOptions as g, type ProcessingPurpose as h };

package/dist/policy-sections-BYx6fEFk.d.ts

@@ -1,56 +0,0 @@
-import { c as PrivacyPolicy, P as PolicySection } from './privacy-Ca6te9Ir.js';
-import { T as TemplateContext, a as ComplianceResult } from './policy-engine-CCUCud2T.js';
-
-/**
- * NDPA policy compliance checker.
- *
- * Evaluates a {@link PrivacyPolicy} against 15 requirements drawn from
- * the Nigeria Data Protection Act (NDPA) 2023, producing a scored
- * {@link ComplianceResult} with actionable gaps.
- *
- * Scoring:
- *   6 critical  @ 10 pts = 60
- *   5 important @  7 pts = 35
- *   4 recommended @ 5 pts = 20
- *   Total max = 115
- *
- * Rating thresholds:
- *   >= 100 → compliant
- *   >=  80 → nearly_compliant
- *   <   80 → not_compliant
- */
-
-/**
- * Evaluates a privacy policy against 15 NDPA 2023 requirements and
- * returns a scored compliance result with actionable gap information.
- *
- * @param policy  - The privacy policy to evaluate.
- * @param context - The template context that was used to generate the policy.
- * @returns A {@link ComplianceResult} with score, rating, gaps, and passed ids.
- */
-declare function evaluatePolicyCompliance(policy: PrivacyPolicy, context: TemplateContext): ComplianceResult;
-
-/**
- * Adaptive privacy policy section generators.
- *
- * Builds NDPA 2023-compliant policy sections based on the organisation's
- * template context (industry, data categories, purposes, flags, etc.).
- *
- * Every section produces a {@link PolicySection} matching the existing
- * interface from `types/privacy.ts`.
- */
-
-declare const UNFILLED_PREFIX = "\u00ABTODO: ";
-declare const UNFILLED_SUFFIX = "\u00BB";
-/**
- * Assembles an ordered array of privacy policy sections based on the
- * provided template context. Core sections are always included; conditional
- * sections are added based on context flags (children, sensitive data,
- * cross-border transfers, automated decisions).
- *
- * @param context - The template context describing the organisation and its data practices.
- * @returns An array of {@link PolicySection} objects, ordered and ready for rendering.
- */
-declare function assemblePolicy(context: TemplateContext): PolicySection[];
-
-export { UNFILLED_PREFIX as U, assemblePolicy as a, UNFILLED_SUFFIX as b, evaluatePolicyCompliance as e };

package/dist/policy-sections-Dm97Nq8m.d.mts

@@ -1,56 +0,0 @@
-import { c as PrivacyPolicy, P as PolicySection } from './privacy-Ca6te9Ir.mjs';
-import { T as TemplateContext, a as ComplianceResult } from './policy-engine-fYSqEqSW.mjs';
-
-/**
- * NDPA policy compliance checker.
- *
- * Evaluates a {@link PrivacyPolicy} against 15 requirements drawn from
- * the Nigeria Data Protection Act (NDPA) 2023, producing a scored
- * {@link ComplianceResult} with actionable gaps.
- *
- * Scoring:
- *   6 critical  @ 10 pts = 60
- *   5 important @  7 pts = 35
- *   4 recommended @ 5 pts = 20
- *   Total max = 115
- *
- * Rating thresholds:
- *   >= 100 → compliant
- *   >=  80 → nearly_compliant
- *   <   80 → not_compliant
- */
-
-/**
- * Evaluates a privacy policy against 15 NDPA 2023 requirements and
- * returns a scored compliance result with actionable gap information.
- *
- * @param policy  - The privacy policy to evaluate.
- * @param context - The template context that was used to generate the policy.
- * @returns A {@link ComplianceResult} with score, rating, gaps, and passed ids.
- */
-declare function evaluatePolicyCompliance(policy: PrivacyPolicy, context: TemplateContext): ComplianceResult;
-
-/**
- * Adaptive privacy policy section generators.
- *
- * Builds NDPA 2023-compliant policy sections based on the organisation's
- * template context (industry, data categories, purposes, flags, etc.).
- *
- * Every section produces a {@link PolicySection} matching the existing
- * interface from `types/privacy.ts`.
- */
-
-declare const UNFILLED_PREFIX = "\u00ABTODO: ";
-declare const UNFILLED_SUFFIX = "\u00BB";
-/**
- * Assembles an ordered array of privacy policy sections based on the
- * provided template context. Core sections are always included; conditional
- * sections are added based on context flags (children, sensitive data,
- * cross-border transfers, automated decisions).
- *
- * @param context - The template context describing the organisation and its data practices.
- * @returns An array of {@link PolicySection} objects, ordered and ready for rendering.
- */
-declare function assemblePolicy(context: TemplateContext): PolicySection[];
-
-export { UNFILLED_PREFIX as U, assemblePolicy as a, UNFILLED_SUFFIX as b, evaluatePolicyCompliance as e };

package/dist/policy-templates-DhLwq4R-.d.ts

@@ -1,43 +0,0 @@
-import { P as PolicySection, O as OrganizationInfo, b as PolicyVariable } from './privacy-Ca6te9Ir.js';
-
-/**
- * Scans rendered policy text for unfilled tokens. Returns the list of field
- * names that were left unfilled (deduplicated). Use in CI to assert a
- * canonical org-info fixture renders cleanly, or at runtime to surface
- * "policy is missing X" errors before publishing.
- */
-declare function findUnfilledTokens(rendered: string): string[];
-/**
- * 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
- */
-declare function generatePolicyText(sectionsOrTemplate: PolicySection[] | string, organizationInfoOrVariables: OrganizationInfo | Record<string, string>): string | {
-    fullText: string;
-    sectionTexts: Record<string, string>;
-    missingVariables: string[];
-};
-
-/**
- * Default NDPA-compliant privacy policy sections.
- * Each section uses {{variable}} placeholders that are resolved at generation time.
- */
-declare const DEFAULT_POLICY_SECTIONS: PolicySection[];
-/**
- * Default policy variables for NDPA-compliant privacy policies.
- * These map to the {{variable}} placeholders used in DEFAULT_POLICY_SECTIONS.
- */
-declare const DEFAULT_POLICY_VARIABLES: PolicyVariable[];
-/**
- * Creates a complete business privacy policy template with default
- * NDPA-compliant sections and variables.
- *
- * @returns An object containing the default sections and variables.
- */
-declare function createBusinessPolicyTemplate(): {
-    sections: PolicySection[];
-    variables: PolicyVariable[];
-};
-
-export { DEFAULT_POLICY_SECTIONS as D, DEFAULT_POLICY_VARIABLES as a, createBusinessPolicyTemplate as c, findUnfilledTokens as f, generatePolicyText as g };

package/dist/policy-templates-DwYl2329.d.mts

@@ -1,43 +0,0 @@
-import { P as PolicySection, O as OrganizationInfo, b as PolicyVariable } from './privacy-Ca6te9Ir.mjs';
-
-/**
- * Scans rendered policy text for unfilled tokens. Returns the list of field
- * names that were left unfilled (deduplicated). Use in CI to assert a
- * canonical org-info fixture renders cleanly, or at runtime to surface
- * "policy is missing X" errors before publishing.
- */
-declare function findUnfilledTokens(rendered: string): string[];
-/**
- * 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
- */
-declare function generatePolicyText(sectionsOrTemplate: PolicySection[] | string, organizationInfoOrVariables: OrganizationInfo | Record<string, string>): string | {
-    fullText: string;
-    sectionTexts: Record<string, string>;
-    missingVariables: string[];
-};
-
-/**
- * Default NDPA-compliant privacy policy sections.
- * Each section uses {{variable}} placeholders that are resolved at generation time.
- */
-declare const DEFAULT_POLICY_SECTIONS: PolicySection[];
-/**
- * Default policy variables for NDPA-compliant privacy policies.
- * These map to the {{variable}} placeholders used in DEFAULT_POLICY_SECTIONS.
- */
-declare const DEFAULT_POLICY_VARIABLES: PolicyVariable[];
-/**
- * Creates a complete business privacy policy template with default
- * NDPA-compliant sections and variables.
- *
- * @returns An object containing the default sections and variables.
- */
-declare function createBusinessPolicyTemplate(): {
-    sections: PolicySection[];
-    variables: PolicyVariable[];
-};
-
-export { DEFAULT_POLICY_SECTIONS as D, DEFAULT_POLICY_VARIABLES as a, createBusinessPolicyTemplate as c, findUnfilledTokens as f, generatePolicyText as g };

package/dist/privacy-Ca6te9Ir.d.mts

@@ -1,138 +0,0 @@
-/**
- * Privacy policy types aligned with NDPA 2023
- * Privacy policies must clearly inform data subjects of their rights under the NDPA
- */
-/**
- * Represents a section in a privacy policy
- */
-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 NDPA */
-    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
- */
-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;
-    /**
-     * Whether this template is NDPA 2023 compliant
-     */
-    ndpaCompliant: boolean;
-}
-/**
- * Represents organization information for a privacy policy
- */
-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 */
-    dpoName?: string;
-    /** Email of the Data Protection Officer */
-    dpoEmail?: string;
-    /** Industry or sector of the organization */
-    industry?: string;
-    /** NDPC registration number (if registered) */
-    ndpcRegistrationNumber?: string;
-}
-/**
- * Represents a variable in a privacy policy
- */
-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
- */
-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;
-    /**
-     * Applicable legal frameworks
-     */
-    applicableFrameworks?: ('ndpa' | 'ndpr' | 'gdpr' | 'ccpa')[];
-}
-
-export type { OrganizationInfo as O, PolicySection as P, PolicyTemplate as a, PolicyVariable as b, PrivacyPolicy as c };

package/dist/privacy-Ca6te9Ir.d.ts

@@ -1,138 +0,0 @@
-/**
- * Privacy policy types aligned with NDPA 2023
- * Privacy policies must clearly inform data subjects of their rights under the NDPA
- */
-/**
- * Represents a section in a privacy policy
- */
-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 NDPA */
-    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
- */
-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;
-    /**
-     * Whether this template is NDPA 2023 compliant
-     */
-    ndpaCompliant: boolean;
-}
-/**
- * Represents organization information for a privacy policy
- */
-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 */
-    dpoName?: string;
-    /** Email of the Data Protection Officer */
-    dpoEmail?: string;
-    /** Industry or sector of the organization */
-    industry?: string;
-    /** NDPC registration number (if registered) */
-    ndpcRegistrationNumber?: string;
-}
-/**
- * Represents a variable in a privacy policy
- */
-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
- */
-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;
-    /**
-     * Applicable legal frameworks
-     */
-    applicableFrameworks?: ('ndpa' | 'ndpr' | 'gdpr' | 'ccpa')[];
-}
-
-export type { OrganizationInfo as O, PolicySection as P, PolicyTemplate as a, PolicyVariable as b, PrivacyPolicy as c };