@tantainnovative/ndpr-toolkit 4.1.0 → 5.0.0

package/dist/index.d.mts

@@ -1329,39 +1329,16 @@ export declare interface CrossBorderTransferManagerProps {
      */
     transfers: CrossBorderTransfer[];
     /**
-     * Callback when a new transfer is added
-     * @deprecated Renamed to `onAdd` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onAddTransfer?: (transfer: Omit<CrossBorderTransfer, 'id' | 'createdAt' | 'updatedAt'>) => void;
-    /**
-     * Callback when a transfer is updated
-     * @deprecated Renamed to `onUpdate` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onUpdateTransfer?: (id: string, updates: Partial<CrossBorderTransfer>) => void;
-    /**
-     * Callback when a transfer is removed
-     * @deprecated Renamed to `onArchive` in 4.1 (NDPA prefers soft-delete
-     * over hard delete). The legacy name still fires for backward
-     * compatibility and will be removed in 5.0.
-     */
-    onRemoveTransfer?: (id: string) => void;
-    /**
-     * Callback when a new transfer is added (uniform 4.1+ name).
-     * Takes precedence over `onAddTransfer` when both are provided.
+     * Callback when a new transfer is added.
      */
     onAdd?: (transfer: Omit<CrossBorderTransfer, 'id' | 'createdAt' | 'updatedAt'>) => void;
     /**
-     * Callback when a transfer is updated (uniform 4.1+ name).
-     * Takes precedence over `onUpdateTransfer` when both are provided.
+     * Callback when a transfer is updated.
      */
     onUpdate?: (id: string, updates: Partial<CrossBorderTransfer>) => void;
     /**
-     * Callback when a transfer is archived (uniform 4.1+ name). NDPA
-     * preference is soft-delete over hard-delete; consumers should treat
-     * this as an archive signal. Takes precedence over `onRemoveTransfer`
-     * when both are provided.
+     * Callback when a transfer is archived. NDPA preference is soft-delete
+     * over hard-delete; consumers should treat this as an archive signal.
      */
     onArchive?: (id: string) => void;
     /**
@@ -2101,7 +2078,7 @@ export declare type DSRStatus = 'pending' | 'awaitingVerification' | 'inProgress
 /**
  * Validated DSR submission shape — matches what `<DSRRequestForm onSubmit>`
  * emits client-side. Use this as the typed parameter for your server-side
- * handler after `validateDsrSubmission` returns `valid: true`.
+ * handler after `validateDsrSubmissionStructured` returns `valid: true`.
  */
 export declare interface DsrSubmissionPayload {
     requestType: string;
@@ -2116,16 +2093,6 @@ export declare interface DsrSubmissionPayload {
     submittedAt: number;
 }
 
-/** Result of validating a raw DSR submission payload. */
-export declare interface DsrSubmissionValidationResult {
-    /** True when the payload conforms to the DSR submission contract. */
-    valid: boolean;
-    /** Field-keyed error messages. Empty when `valid` is true. */
-    errors: Record<string, string>;
-    /** The narrowed, typed payload — only populated when `valid` is true. */
-    data?: DsrSubmissionPayload;
-}
-
 /**
  * DSR tracking and analytics component. Supports compliance with NDPA Part IV,
  * providing summary statistics, deadline tracking, and compliance metrics for data subject requests.
@@ -2240,21 +2207,9 @@ export declare type EffortLevel = 'low' | 'medium' | 'high';
 export declare function exportROPAToCSV(ropa: RecordOfProcessingActivities): string;
 
 /**
- * Formats a DSR request for display or submission
- * @param request The DSR request to format
- * @returns Formatted request data
- * @deprecated Use `formatDSRRequestStructured()` for typed `{ field, code, message }[]` errors. The legacy string-returning shape will be removed in 5.0.
- */
-export declare function formatDSRRequest(request: DSRRequest): {
-    formattedRequest: Record<string, unknown>;
-    isValid: boolean;
-    validationErrors: string[];
-};
-
-/**
- * Structured-result variant of {@link formatDSRRequest}. Same formatting
- * output, but `validationErrors` is replaced with a typed `errors` array
- * of `{ field, code, message }`.
+ * Format a DSR request for display or submission. Returns the formatted
+ * payload plus a typed `errors` array of `{ field, code, message }` for any
+ * required fields missing from the source request.
  *
  * Codes emitted:
  * - `request_id_required`
@@ -2467,36 +2422,15 @@ export declare interface LawfulBasisTrackerProps {
      */
     activities: ProcessingActivity[];
     /**
-     * Callback when a new activity is created
-     * @deprecated Renamed to `onAdd` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onAddActivity?: (activity: Omit<ProcessingActivity, 'id' | 'createdAt' | 'updatedAt'>) => void;
-    /**
-     * Callback when an activity is updated
-     * @deprecated Renamed to `onUpdate` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onUpdateActivity?: (id: string, updates: Partial<ProcessingActivity>) => void;
-    /**
-     * Callback when an activity is archived
-     * @deprecated Renamed to `onArchive` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onArchiveActivity?: (id: string) => void;
-    /**
-     * Callback when a new activity is created (uniform 4.1+ name).
-     * Takes precedence over `onAddActivity` when both are provided.
+     * Callback when a new activity is created.
      */
     onAdd?: (activity: Omit<ProcessingActivity, 'id' | 'createdAt' | 'updatedAt'>) => void;
     /**
-     * Callback when an activity is updated (uniform 4.1+ name).
-     * Takes precedence over `onUpdateActivity` when both are provided.
+     * Callback when an activity is updated.
      */
     onUpdate?: (id: string, updates: Partial<ProcessingActivity>) => void;
     /**
-     * Callback when an activity is archived (uniform 4.1+ name).
-     * Takes precedence over `onArchiveActivity` when both are provided.
+     * Callback when an activity is archived.
      */
     onArchive?: (id: string) => void;
     /**
@@ -3995,36 +3929,15 @@ export declare interface ROPAManagerProps {
      */
     ropa: RecordOfProcessingActivities;
     /**
-     * Callback when a new record is added
-     * @deprecated Renamed to `onAdd` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onAddRecord?: (record: ProcessingRecord) => void;
-    /**
-     * Callback when a record is updated
-     * @deprecated Renamed to `onUpdate` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onUpdateRecord?: (id: string, updates: Partial<ProcessingRecord>) => void;
-    /**
-     * Callback when a record is archived
-     * @deprecated Renamed to `onArchive` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onArchiveRecord?: (id: string) => void;
-    /**
-     * Callback when a new record is added (uniform 4.1+ name).
-     * Takes precedence over `onAddRecord` when both are provided.
+     * Callback when a new record is added.
      */
     onAdd?: (record: ProcessingRecord) => void;
     /**
-     * Callback when a record is updated (uniform 4.1+ name).
-     * Takes precedence over `onUpdateRecord` when both are provided.
+     * Callback when a record is updated.
      */
     onUpdate?: (id: string, updates: Partial<ProcessingRecord>) => void;
     /**
-     * Callback when a record is archived (uniform 4.1+ name).
-     * Takes precedence over `onArchiveRecord` when both are provided.
+     * Callback when a record is archived.
      */
     onArchive?: (id: string) => void;
     /**
@@ -4660,9 +4573,10 @@ declare interface UseConsentReturn {
      */
     isValid: boolean;
     /**
-     * Validation errors (if any)
+     * Validation errors (if any). Each entry is a structured `{ field, code,
+     * message }` so consumers can switch on `code` across locales.
      */
-    validationErrors: string[];
+    validationErrors: StructuredValidationError[];
     /**
      * Reset consent settings (clear from storage)
      */
@@ -5337,7 +5251,7 @@ declare interface UsePrivacyPolicyReturn {
  * }
  * ```
  */
-export declare function useROPA({ initialData, adapter, onRecordAdd, onRecordUpdate, onRecordArchive, onAdd, onUpdate, onArchive, }: UseROPAOptions): UseROPAReturn;
+export declare function useROPA({ initialData, adapter, onAdd, onUpdate, onArchive, }: UseROPAOptions): UseROPAReturn;
 
 export declare interface UseROPAOptions {
     /**
@@ -5351,36 +5265,15 @@ export declare interface UseROPAOptions {
      */
     adapter?: StorageAdapter<RecordOfProcessingActivities>;
     /**
-     * Callback when a record is added
-     * @deprecated Renamed to `onAdd` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onRecordAdd?: (record: ProcessingRecord) => void;
-    /**
-     * Callback when a record is updated
-     * @deprecated Renamed to `onUpdate` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onRecordUpdate?: (id: string, updates: Partial<ProcessingRecord>) => void;
-    /**
-     * Callback when a record is archived
-     * @deprecated Renamed to `onArchive` in 4.1. The legacy name still fires
-     * for backward compatibility and will be removed in 5.0.
-     */
-    onRecordArchive?: (id: string) => void;
-    /**
-     * Callback when a record is added (uniform 4.1+ name).
-     * Takes precedence over `onRecordAdd` when both are provided.
+     * Callback when a record is added.
      */
     onAdd?: (record: ProcessingRecord) => void;
     /**
-     * Callback when a record is updated (uniform 4.1+ name).
-     * Takes precedence over `onRecordUpdate` when both are provided.
+     * Callback when a record is updated.
      */
     onUpdate?: (id: string, updates: Partial<ProcessingRecord>) => void;
     /**
-     * Callback when a record is archived (uniform 4.1+ name).
-     * Takes precedence over `onRecordArchive` when both are provided.
+     * Callback when a record is archived.
      */
     onArchive?: (id: string) => void;
 }
@@ -5446,34 +5339,10 @@ export declare interface UseROPAReturn {
 }
 
 /**
- * Validates consent settings to ensure they meet NDPA requirements
- * @param settings The consent settings to validate
- * @returns An object containing validation result and any error messages
- * @deprecated Use `validateConsentStructured()` for typed `{ field, code, message }[]` errors. The legacy string-returning shape will be removed in 5.0.
- */
-export declare function validateConsent(settings: ConsentSettings): {
-    valid: boolean;
-    errors: string[];
-};
-
-/**
- * Validates that consent options meet NDPA Section 26 requirements.
- * Each consent option must specify a purpose for which data will be processed,
- * as consent must be specific and informed per the Nigeria Data Protection Act.
- * @param options The consent options to validate
- * @returns An object containing validation result and any error messages
- * @deprecated Use `validateConsentOptionsStructured()` for typed `{ field, code, message }[]` errors. The legacy string-returning shape will be removed in 5.0.
- */
-export declare function validateConsentOptions(options: ConsentOption[]): {
-    valid: boolean;
-    errors: string[];
-};
-
-/**
- * Structured-result variant of {@link validateConsentOptions}. Each option
- * is checked for a non-empty `purpose` (NDPA Section 26). Failing options
- * are reported with `field: 'options[i].purpose'` so consumers can map
- * errors back to the originating option index.
+ * Validates consent options against NDPA Section 26 requirements. Each option
+ * is checked for a non-empty `purpose`. Failing options are reported with
+ * `field: 'options[i].purpose'` so consumers can map errors back to the
+ * originating option index.
  *
  * Codes emitted:
  * - `options_required` — empty / missing options array
@@ -5482,8 +5351,8 @@ export declare function validateConsentOptions(options: ConsentOption[]): {
 export declare function validateConsentOptionsStructured(options: ConsentOption[]): StructuredValidationResult<ConsentOption[]>;
 
 /**
- * Structured-result variant of {@link validateConsent}. Returns the same
- * checks as `{ field, code, message }[]` so consumers can switch on `code`
+ * Validates consent settings against NDPA requirements. Returns structured
+ * `{ field, code, message }[]` errors so consumers can switch on `code`
  * across locales without regex-matching English strings.
  *
  * Codes emitted:
@@ -5506,47 +5375,7 @@ export declare function validateConsentOptionsStructured(options: ConsentOption[
  */
 export declare function validateConsentStructured(settings: ConsentSettings): StructuredValidationResult<ConsentSettings>;
 
-/**
- * Validate a raw DSR submission payload against the same rules
- * `<DSRRequestForm />` enforces client-side. Designed to be called from a
- * server-side handler (Next.js Route Handler, NestJS controller, Express
- * middleware, Cloudflare Worker) so client and server stay in sync without
- * the consumer hand-rolling zod / class-validator schemas.
- *
- * Defensive — accepts `unknown` and narrows. Safe to call directly on
- * `await request.json()`.
- *
- * @example **Next.js Route Handler**
- * ```ts
- * // app/api/dsr/route.ts
- * import { validateDsrSubmission } from '@tantainnovative/ndpr-toolkit/server';
- *
- * export async function POST(req: Request) {
- *   const { valid, errors, data } = validateDsrSubmission(await req.json());
- *   if (!valid) return Response.json({ errors }, { status: 422 });
- *   // `data` is the typed DsrSubmissionPayload
- *   await dsrStore.create(data);
- *   return Response.json({ ok: true }, { status: 201 });
- * }
- * ```
- *
- * @example **Lock to specific request types**
- * ```ts
- * validateDsrSubmission(payload, {
- *   allowedRequestTypes: ['access', 'erasure', 'rectification'],
- * });
- * ```
- *
- * @example **Skip identity verification (e.g. authenticated session)**
- * ```ts
- * validateDsrSubmission(payload, { requireIdentityVerification: false });
- * ```
- *
- * @deprecated Use `validateDsrSubmissionStructured()` for typed `{ field, code, message }[]` errors. The legacy string-returning shape will be removed in 5.0.
- */
-export declare function validateDsrSubmission(payload: unknown, options?: ValidateDsrSubmissionOptions): DsrSubmissionValidationResult;
-
-/** Options for {@link validateDsrSubmission}. */
+/** Options for {@link validateDsrSubmissionStructured}. */
 export declare interface ValidateDsrSubmissionOptions {
     /**
      * Whether the data subject is required to provide an identifier
@@ -5564,9 +5393,15 @@ export declare interface ValidateDsrSubmissionOptions {
 }
 
 /**
- * Structured-result variant of {@link validateDsrSubmission}. Same rules,
- * but returns an array of `{ field, code, message }` so callers can switch
- * on `code` programmatically across locales.
+ * Validate a raw DSR submission payload against the same rules
+ * `<DSRRequestForm />` enforces client-side. Designed to be called from a
+ * server-side handler (Next.js Route Handler, NestJS controller, Express
+ * middleware, Cloudflare Worker) so client and server stay in sync without
+ * the consumer hand-rolling zod / class-validator schemas.
+ *
+ * Defensive — accepts `unknown` and narrows. Safe to call directly on
+ * `await request.json()`. Returns `{ field, code, message }[]` errors so
+ * callers can switch on `code` programmatically across locales.
  *
  * Codes emitted:
  * - `payload_not_object`