@tantainnovative/ndpr-toolkit 2.1.2 → 2.4.0

package/dist/policy-E0fXZkda.d.mts

@@ -0,0 +1,293 @@
+import React from 'react';
+import { P as PolicySection, b as PolicyVariable } from './privacy-Ca6te9Ir.mjs';
+import './useDefaultPrivacyPolicy-CUluF_ic.mjs';
+import './policy-templates-DMsPwOSZ.mjs';
+
+interface PolicyGeneratorClassNames {
+    /** Root container */
+    root?: string;
+    /** Header area containing title and description */
+    header?: string;
+    /** Title element */
+    title?: string;
+    /** Description element */
+    description?: string;
+    /** Section list container */
+    sectionList?: string;
+    /** Individual section item */
+    sectionItem?: string;
+    /** Variable form container */
+    form?: string;
+    /** Form input fields */
+    input?: string;
+    /** Generate button */
+    generateButton?: string;
+    /** Alias for generateButton */
+    primaryButton?: string;
+    /** NDPA compliance notice */
+    complianceNotice?: string;
+}
+interface PolicyGeneratorProps {
+    /**
+     * List of policy sections
+     * @default DEFAULT_POLICY_SECTIONS
+     */
+    sections?: PolicySection[];
+    /**
+     * List of policy variables
+     * @default DEFAULT_POLICY_VARIABLES
+     */
+    variables?: PolicyVariable[];
+    /**
+     * Callback function called when the policy is generated
+     */
+    onGenerate: (policy: {
+        sections: PolicySection[];
+        variables: PolicyVariable[];
+        content: string;
+    }) => void;
+    /**
+     * Title displayed on the generator
+     * @default "NDPA Privacy Policy Generator"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the generator
+     * @default "Generate an NDPA-compliant privacy policy for your organization in accordance with NDPA Section 24."
+     */
+    description?: string;
+    /**
+     * Custom CSS class for the generator
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Text for the generate button
+     * @default "Generate Policy"
+     */
+    generateButtonText?: string;
+    /**
+     * Whether to show a preview of the generated policy
+     * @default true
+     */
+    showPreview?: boolean;
+    /**
+     * Whether to allow editing the policy content
+     * @default true
+     */
+    allowEditing?: boolean;
+    /**
+     * Override class names for internal elements
+     */
+    classNames?: PolicyGeneratorClassNames;
+    /**
+     * If true, removes all default styles. Use with classNames to apply your own.
+     * @default false
+     */
+    unstyled?: boolean;
+}
+/**
+ * Privacy policy generator component. Implements NDPA Section 24 transparency requirements,
+ * helping organizations generate compliant privacy policies that disclose required information.
+ */
+declare const PolicyGenerator: React.FC<PolicyGeneratorProps>;
+
+interface PolicyPreviewClassNames {
+    /** Root container */
+    root?: string;
+    /** Header area containing title and description */
+    header?: string;
+    /** Title element */
+    title?: string;
+    /** Description element */
+    description?: string;
+    /** Content area wrapping the rendered policy */
+    content?: string;
+    /** Individual rendered section container */
+    section?: string;
+    /** Section title within rendered content */
+    sectionTitle?: string;
+    /** Section content within rendered content */
+    sectionContent?: string;
+    /** NDPA compliance notice */
+    complianceNotice?: string;
+}
+interface PolicyPreviewProps {
+    /**
+     * The policy content to preview
+     */
+    content: string;
+    /**
+     * The policy sections
+     */
+    sections?: PolicySection[];
+    /**
+     * The policy variables
+     */
+    variables?: PolicyVariable[];
+    /**
+     * Callback function called when the policy is exported
+     */
+    onExport?: (format: 'pdf' | 'html' | 'markdown' | 'docx') => void;
+    /**
+     * Callback function called when the policy is edited
+     */
+    onEdit?: () => void;
+    /**
+     * Title displayed on the preview
+     * @default "Privacy Policy Preview"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the preview
+     * @default "Preview your NDPA-compliant privacy policy before exporting."
+     */
+    description?: string;
+    /**
+     * Custom CSS class for the preview
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show the export options
+     * @default true
+     */
+    showExportOptions?: boolean;
+    /**
+     * Whether to show the edit button
+     * @default true
+     */
+    showEditButton?: boolean;
+    /**
+     * Whether to show the table of contents
+     * @default true
+     */
+    showTableOfContents?: boolean;
+    /**
+     * Whether to show the policy metadata
+     * @default true
+     */
+    showMetadata?: boolean;
+    /**
+     * The organization name to display in the policy
+     */
+    organizationName?: string;
+    /**
+     * The last updated date to display in the policy
+     */
+    lastUpdated?: Date;
+    /**
+     * Override class names for internal elements
+     */
+    classNames?: PolicyPreviewClassNames;
+    /**
+     * If true, removes all default styles. Use with classNames to apply your own.
+     * @default false
+     */
+    unstyled?: boolean;
+}
+declare const PolicyPreview: React.FC<PolicyPreviewProps>;
+
+interface PolicyExporterClassNames {
+    /** Root container */
+    root?: string;
+    /** Header area containing title and description */
+    header?: string;
+    /** Title element */
+    title?: string;
+    /** Description element */
+    description?: string;
+    /** Format selector container */
+    formatSelector?: string;
+    /** Individual format option */
+    formatOption?: string;
+    /** Export button */
+    exportButton?: string;
+    /** Alias for exportButton */
+    primaryButton?: string;
+    /** NDPA compliance / export tips notice */
+    complianceNotice?: string;
+    /** Preview / export history area */
+    preview?: string;
+}
+interface PolicyExporterProps {
+    /**
+     * The policy content to export
+     */
+    content: string;
+    /**
+     * The policy title
+     */
+    title?: string;
+    /**
+     * The organization name to include in the exported policy
+     */
+    organizationName?: string;
+    /**
+     * The last updated date to include in the exported policy
+     */
+    lastUpdated?: Date;
+    /**
+     * Callback function called when the export is complete
+     */
+    onExportComplete?: (format: string, url: string) => void;
+    /**
+     * Title displayed on the exporter
+     * @default "Export Privacy Policy"
+     */
+    componentTitle?: string;
+    /**
+     * Description text displayed on the exporter
+     * @default "Export your NDPA-compliant privacy policy in various formats."
+     */
+    description?: string;
+    /**
+     * Custom CSS class for the exporter
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show the export history
+     * @default true
+     */
+    showExportHistory?: boolean;
+    /**
+     * Whether to include the NDPA compliance notice in the exported policy
+     * @default true
+     */
+    includeComplianceNotice?: boolean;
+    /**
+     * Whether to include the organization logo in the exported policy
+     * @default false
+     */
+    includeLogo?: boolean;
+    /**
+     * URL of the organization logo
+     */
+    logoUrl?: string;
+    /**
+     * Custom CSS styles for the exported policy
+     */
+    customStyles?: string;
+    /**
+     * Override class names for internal elements
+     */
+    classNames?: PolicyExporterClassNames;
+    /**
+     * If true, removes all default styles. Use with classNames to apply your own.
+     * @default false
+     */
+    unstyled?: boolean;
+}
+declare const PolicyExporter: React.FC<PolicyExporterProps>;
+
+export { PolicyExporter as P, type PolicyExporterClassNames as a, PolicyGenerator as b, type PolicyGeneratorClassNames as c, PolicyPreview as d, type PolicyPreviewClassNames as e };

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

@@ -0,0 +1,36 @@
+import { P as PolicySection, O as OrganizationInfo, b as PolicyVariable } from './privacy-Ca6te9Ir.js';
+
+/**
+ * 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, generatePolicyText as g };

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

@@ -0,0 +1,36 @@
+import { P as PolicySection, O as OrganizationInfo, b as PolicyVariable } from './privacy-Ca6te9Ir.mjs';
+
+/**
+ * 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, generatePolicyText as g };

package/dist/policy.d.mts

@@ -1,195 +1,5 @@
-import React from 'react';
-import { P as PolicySection, b as PolicyVariable } from './privacy-Ca6te9Ir.mjs';
-export { O as OrganizationInfo, a as PolicyTemplate, c as PrivacyPolicy } from './privacy-Ca6te9Ir.mjs';
-export { u as usePrivacyPolicy } from './usePrivacyPolicy-Dit2sFuV.mjs';
-export { g as generatePolicyText } from './privacy-9FcJceMr.mjs';
-
-interface PolicyGeneratorProps {
-    /**
-     * List of policy sections
-     */
-    sections: PolicySection[];
-    /**
-     * List of policy variables
-     */
-    variables: PolicyVariable[];
-    /**
-     * Callback function called when the policy is generated
-     */
-    onGenerate: (policy: {
-        sections: PolicySection[];
-        variables: PolicyVariable[];
-        content: string;
-    }) => void;
-    /**
-     * Title displayed on the generator
-     * @default "NDPA Privacy Policy Generator"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the generator
-     * @default "Generate an NDPA-compliant privacy policy for your organization."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the generator
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Text for the generate button
-     * @default "Generate Policy"
-     */
-    generateButtonText?: string;
-    /**
-     * Whether to show a preview of the generated policy
-     * @default true
-     */
-    showPreview?: boolean;
-    /**
-     * Whether to allow editing the policy content
-     * @default true
-     */
-    allowEditing?: boolean;
-}
-declare const PolicyGenerator: React.FC<PolicyGeneratorProps>;
-
-interface PolicyPreviewProps {
-    /**
-     * The policy content to preview
-     */
-    content: string;
-    /**
-     * The policy sections
-     */
-    sections?: PolicySection[];
-    /**
-     * The policy variables
-     */
-    variables?: PolicyVariable[];
-    /**
-     * Callback function called when the policy is exported
-     */
-    onExport?: (format: 'pdf' | 'html' | 'markdown' | 'docx') => void;
-    /**
-     * Callback function called when the policy is edited
-     */
-    onEdit?: () => void;
-    /**
-     * Title displayed on the preview
-     * @default "Privacy Policy Preview"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the preview
-     * @default "Preview your NDPA-compliant privacy policy before exporting."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the preview
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Whether to show the export options
-     * @default true
-     */
-    showExportOptions?: boolean;
-    /**
-     * Whether to show the edit button
-     * @default true
-     */
-    showEditButton?: boolean;
-    /**
-     * Whether to show the table of contents
-     * @default true
-     */
-    showTableOfContents?: boolean;
-    /**
-     * Whether to show the policy metadata
-     * @default true
-     */
-    showMetadata?: boolean;
-    /**
-     * The organization name to display in the policy
-     */
-    organizationName?: string;
-    /**
-     * The last updated date to display in the policy
-     */
-    lastUpdated?: Date;
-}
-declare const PolicyPreview: React.FC<PolicyPreviewProps>;
-
-interface PolicyExporterProps {
-    /**
-     * The policy content to export
-     */
-    content: string;
-    /**
-     * The policy title
-     */
-    title?: string;
-    /**
-     * The organization name to include in the exported policy
-     */
-    organizationName?: string;
-    /**
-     * The last updated date to include in the exported policy
-     */
-    lastUpdated?: Date;
-    /**
-     * Callback function called when the export is complete
-     */
-    onExportComplete?: (format: string, url: string) => void;
-    /**
-     * Title displayed on the exporter
-     * @default "Export Privacy Policy"
-     */
-    componentTitle?: string;
-    /**
-     * Description text displayed on the exporter
-     * @default "Export your NDPA-compliant privacy policy in various formats."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the exporter
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Whether to show the export history
-     * @default true
-     */
-    showExportHistory?: boolean;
-    /**
-     * Whether to include the NDPA compliance notice in the exported policy
-     * @default true
-     */
-    includeComplianceNotice?: boolean;
-    /**
-     * Whether to include the organization logo in the exported policy
-     * @default false
-     */
-    includeLogo?: boolean;
-    /**
-     * URL of the organization logo
-     */
-    logoUrl?: string;
-    /**
-     * Custom CSS styles for the exported policy
-     */
-    customStyles?: string;
-}
-declare const PolicyExporter: React.FC<PolicyExporterProps>;
-
-export { PolicyExporter, PolicyGenerator, PolicyPreview, PolicySection, PolicyVariable };
+export { P as PolicyExporter, b as PolicyGenerator, d as PolicyPreview } from './policy-E0fXZkda.mjs';
+export { u as useDefaultPrivacyPolicy, a as usePrivacyPolicy } from './useDefaultPrivacyPolicy-CUluF_ic.mjs';
+export { D as DEFAULT_POLICY_SECTIONS, a as DEFAULT_POLICY_VARIABLES, c as createBusinessPolicyTemplate, g as generatePolicyText } from './policy-templates-DMsPwOSZ.mjs';
+export { O as OrganizationInfo, P as PolicySection, a as PolicyTemplate, b as PolicyVariable, c as PrivacyPolicy } from './privacy-Ca6te9Ir.mjs';
+import 'react';