@indora-labs/redaction-react 0.1.0

package/README.md

@@ -0,0 +1,2 @@
+# indora-redaction-react
+A React component library for rendering and reviewing redactions in text, audio, and video files. Provides headless, prop-driven UI components designed to embed cleanly into regulated data workflows and custom applications.

package/dist/index.d.mts

@@ -0,0 +1,191 @@
+import React from 'react';
+
+type RedactionType = 'TEXT' | 'AUDIO' | 'VIDEO';
+
+type SpanAttribution = {
+    source: "policy" | "manual";
+    policyId: string | null;
+    ruleType: "REDACT" | "DETECT" | "EXCLUDE" | null;
+    sourceText: string | null;
+    target: string;
+};
+type Span = {
+    start: number;
+    end: number;
+    label: string;
+    attributions: SpanAttribution[];
+};
+type Rect = {
+    id: string;
+    page: number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    label: string;
+    type?: string;
+    reason?: string;
+};
+type OcrWordBox = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    str: string;
+    start: number;
+    end: number;
+};
+type DocumentPage = {
+    page: number;
+    /** Background surface. Keep it simple for portability. */
+    imageUrl: string;
+    /** Intrinsic size used to interpret x/y/w/h (your rect units). */
+    width: number;
+    height: number;
+};
+type DocumentRedactionViewerProps = {
+    pages: DocumentPage[];
+    /** Optional OCR word boxes to allow "text highlight" style selection. */
+    ocrByPage?: Record<number, OcrWordBox[]>;
+    /** Existing rects to render/edit. */
+    rects: Rect[];
+    /** Called whenever user creates/moves/resizes rects. */
+    onRectsChange: (next: Rect[]) => void;
+    /** Called when user selects a rect (optional). */
+    onRectSelect?: (rect: Rect | null) => void;
+    selectedRectId?: string | null;
+    /** Create rect label (optional). */
+    defaultRectLabel?: string;
+    /** If true, user can draw/create new rects. */
+    allowCreate?: boolean;
+    /** If true, user can move/resize rects. */
+    allowEdit?: boolean;
+    /** Viewer scale. (1 = native page units) */
+    zoom?: number;
+    /** Styling hooks */
+    className?: string;
+    style?: React.CSSProperties;
+    /** If provided, restrict selection to these pages. */
+    pageFilter?: (page: DocumentPage) => boolean;
+    /**
+     * If you want the selection behavior to create a rect even without OCR,
+     * set this true (will create a freeform drag-rectangle).
+     */
+    allowFreeformDragCreate?: boolean;
+};
+declare const DocumentRedactionViewer: React.FC<DocumentRedactionViewerProps>;
+
+type PolicyRuleInput = {
+    id: string;
+    org_id: string;
+    doc_id: string;
+    session_id: string;
+    type: 'REDACT' | 'DETECT' | 'EXCLUDE';
+    target: string;
+    source_text: string;
+    source_page: number;
+    offset_start: number;
+    offset_end: number;
+    created_at: string;
+};
+
+interface ViewerRedactionFlag {
+    id: string;
+    type: 'PII' | 'SSN' | 'Address' | 'Phone' | 'Face' | 'License Plate' | 'Custom';
+    reason: string;
+    approved: boolean;
+    timestamp?: number;
+    coordinates?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+declare enum ViewerIngestionMode {
+    Default = "default",
+    Policy = "policy"
+}
+type ViewerRedactionDecision = 'approved' | 'rejected';
+interface ViewerRedactionReview {
+    reviewerId: string;
+    reviewerEmail: string;
+    decision: ViewerRedactionDecision;
+    reviewedAt: string;
+    comment?: string;
+}
+declare const RedactionReviewStatus: {
+    readonly Pending: "pending";
+    readonly Approved: "approved";
+    readonly Rejected: "rejected";
+};
+type RedactionReviewStatus = typeof RedactionReviewStatus[keyof typeof RedactionReviewStatus];
+interface ViewerFileRecord {
+    id: string;
+    name: string;
+    size: number;
+    type: string;
+    uploadedAt: string;
+    department: string;
+    tags: string[];
+    relevancyScore: number;
+    reviewStatus: 'pending' | 'relevant' | 'irrelevant' | 'redacted';
+    redactionReviewStatus?: RedactionReviewStatus;
+    redactionReviews?: ViewerRedactionReview[];
+    redactionFlags: ViewerRedactionFlag[];
+    caseIds: string[];
+    pages?: number;
+    duration?: number;
+    ingestionMode?: ViewerIngestionMode;
+}
+interface DocumentViewerProps {
+    file: ViewerFileRecord;
+    documentUrl: string;
+    rects: Rect[];
+    rules: PolicyRuleInput[];
+    hideFileDetails: boolean;
+    hideAICaseFindings: boolean;
+    onRectsChange: (rects: Rect[]) => void;
+    onDeleteRedactionBox: (boxId: string) => void;
+    onClose: () => void;
+    onFinalizeRedaction: () => void;
+    onMarkRelevant?: (status: 'relevant' | 'irrelevant') => void;
+}
+declare const FileViewer: React.FC<DocumentViewerProps>;
+
+type PdfRedactionViewerProps = {
+    pdfUrl: string;
+    rects: Rect[];
+    onRectsChange: (r: Rect[]) => void;
+    defaultRectLabel?: string;
+    /** If true, user can draw/create new rects. */
+    allowCreate?: boolean;
+    /** If true, user can move/resize rects. */
+    allowEdit?: boolean;
+    /** Viewer scale. (1 = native page units) */
+    zoom?: number;
+    /** Styling hooks */
+    className?: string;
+    style?: React.CSSProperties;
+    /** If provided, restrict selection to these pages. */
+    pageFilter?: (page: DocumentPage) => boolean;
+    /** Called when user selects a rect (optional). */
+    onRectSelect?: (rect: Rect | null) => void;
+    selectedRectId?: string | null;
+    /**
+     * If you want the selection behavior to create a rect even without OCR,
+     * set this true (will create a freeform drag-rectangle).
+     */
+    allowFreeformDragCreate?: boolean;
+};
+declare const PdfRedactionViewer: React.FC<PdfRedactionViewerProps>;
+
+interface RedactionInspectorProps {
+    rect: Rect | null;
+    rules: PolicyRuleInput[];
+    onUpdate: (next: Rect) => void;
+    onDelete: (id: string) => void;
+}
+declare const RedactionInspector: React.FC<RedactionInspectorProps>;
+
+export { type DocumentPage, DocumentRedactionViewer, type DocumentRedactionViewerProps, FileViewer, type OcrWordBox, PdfRedactionViewer, type PdfRedactionViewerProps, type Rect, RedactionInspector, RedactionReviewStatus, type RedactionType, type Span, type SpanAttribution, type ViewerFileRecord, ViewerIngestionMode, type ViewerRedactionDecision, type ViewerRedactionFlag, type ViewerRedactionReview };

package/dist/index.d.ts

@@ -0,0 +1,191 @@
+import React from 'react';
+
+type RedactionType = 'TEXT' | 'AUDIO' | 'VIDEO';
+
+type SpanAttribution = {
+    source: "policy" | "manual";
+    policyId: string | null;
+    ruleType: "REDACT" | "DETECT" | "EXCLUDE" | null;
+    sourceText: string | null;
+    target: string;
+};
+type Span = {
+    start: number;
+    end: number;
+    label: string;
+    attributions: SpanAttribution[];
+};
+type Rect = {
+    id: string;
+    page: number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    label: string;
+    type?: string;
+    reason?: string;
+};
+type OcrWordBox = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    str: string;
+    start: number;
+    end: number;
+};
+type DocumentPage = {
+    page: number;
+    /** Background surface. Keep it simple for portability. */
+    imageUrl: string;
+    /** Intrinsic size used to interpret x/y/w/h (your rect units). */
+    width: number;
+    height: number;
+};
+type DocumentRedactionViewerProps = {
+    pages: DocumentPage[];
+    /** Optional OCR word boxes to allow "text highlight" style selection. */
+    ocrByPage?: Record<number, OcrWordBox[]>;
+    /** Existing rects to render/edit. */
+    rects: Rect[];
+    /** Called whenever user creates/moves/resizes rects. */
+    onRectsChange: (next: Rect[]) => void;
+    /** Called when user selects a rect (optional). */
+    onRectSelect?: (rect: Rect | null) => void;
+    selectedRectId?: string | null;
+    /** Create rect label (optional). */
+    defaultRectLabel?: string;
+    /** If true, user can draw/create new rects. */
+    allowCreate?: boolean;
+    /** If true, user can move/resize rects. */
+    allowEdit?: boolean;
+    /** Viewer scale. (1 = native page units) */
+    zoom?: number;
+    /** Styling hooks */
+    className?: string;
+    style?: React.CSSProperties;
+    /** If provided, restrict selection to these pages. */
+    pageFilter?: (page: DocumentPage) => boolean;
+    /**
+     * If you want the selection behavior to create a rect even without OCR,
+     * set this true (will create a freeform drag-rectangle).
+     */
+    allowFreeformDragCreate?: boolean;
+};
+declare const DocumentRedactionViewer: React.FC<DocumentRedactionViewerProps>;
+
+type PolicyRuleInput = {
+    id: string;
+    org_id: string;
+    doc_id: string;
+    session_id: string;
+    type: 'REDACT' | 'DETECT' | 'EXCLUDE';
+    target: string;
+    source_text: string;
+    source_page: number;
+    offset_start: number;
+    offset_end: number;
+    created_at: string;
+};
+
+interface ViewerRedactionFlag {
+    id: string;
+    type: 'PII' | 'SSN' | 'Address' | 'Phone' | 'Face' | 'License Plate' | 'Custom';
+    reason: string;
+    approved: boolean;
+    timestamp?: number;
+    coordinates?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+declare enum ViewerIngestionMode {
+    Default = "default",
+    Policy = "policy"
+}
+type ViewerRedactionDecision = 'approved' | 'rejected';
+interface ViewerRedactionReview {
+    reviewerId: string;
+    reviewerEmail: string;
+    decision: ViewerRedactionDecision;
+    reviewedAt: string;
+    comment?: string;
+}
+declare const RedactionReviewStatus: {
+    readonly Pending: "pending";
+    readonly Approved: "approved";
+    readonly Rejected: "rejected";
+};
+type RedactionReviewStatus = typeof RedactionReviewStatus[keyof typeof RedactionReviewStatus];
+interface ViewerFileRecord {
+    id: string;
+    name: string;
+    size: number;
+    type: string;
+    uploadedAt: string;
+    department: string;
+    tags: string[];
+    relevancyScore: number;
+    reviewStatus: 'pending' | 'relevant' | 'irrelevant' | 'redacted';
+    redactionReviewStatus?: RedactionReviewStatus;
+    redactionReviews?: ViewerRedactionReview[];
+    redactionFlags: ViewerRedactionFlag[];
+    caseIds: string[];
+    pages?: number;
+    duration?: number;
+    ingestionMode?: ViewerIngestionMode;
+}
+interface DocumentViewerProps {
+    file: ViewerFileRecord;
+    documentUrl: string;
+    rects: Rect[];
+    rules: PolicyRuleInput[];
+    hideFileDetails: boolean;
+    hideAICaseFindings: boolean;
+    onRectsChange: (rects: Rect[]) => void;
+    onDeleteRedactionBox: (boxId: string) => void;
+    onClose: () => void;
+    onFinalizeRedaction: () => void;
+    onMarkRelevant?: (status: 'relevant' | 'irrelevant') => void;
+}
+declare const FileViewer: React.FC<DocumentViewerProps>;
+
+type PdfRedactionViewerProps = {
+    pdfUrl: string;
+    rects: Rect[];
+    onRectsChange: (r: Rect[]) => void;
+    defaultRectLabel?: string;
+    /** If true, user can draw/create new rects. */
+    allowCreate?: boolean;
+    /** If true, user can move/resize rects. */
+    allowEdit?: boolean;
+    /** Viewer scale. (1 = native page units) */
+    zoom?: number;
+    /** Styling hooks */
+    className?: string;
+    style?: React.CSSProperties;
+    /** If provided, restrict selection to these pages. */
+    pageFilter?: (page: DocumentPage) => boolean;
+    /** Called when user selects a rect (optional). */
+    onRectSelect?: (rect: Rect | null) => void;
+    selectedRectId?: string | null;
+    /**
+     * If you want the selection behavior to create a rect even without OCR,
+     * set this true (will create a freeform drag-rectangle).
+     */
+    allowFreeformDragCreate?: boolean;
+};
+declare const PdfRedactionViewer: React.FC<PdfRedactionViewerProps>;
+
+interface RedactionInspectorProps {
+    rect: Rect | null;
+    rules: PolicyRuleInput[];
+    onUpdate: (next: Rect) => void;
+    onDelete: (id: string) => void;
+}
+declare const RedactionInspector: React.FC<RedactionInspectorProps>;
+
+export { type DocumentPage, DocumentRedactionViewer, type DocumentRedactionViewerProps, FileViewer, type OcrWordBox, PdfRedactionViewer, type PdfRedactionViewerProps, type Rect, RedactionInspector, RedactionReviewStatus, type RedactionType, type Span, type SpanAttribution, type ViewerFileRecord, ViewerIngestionMode, type ViewerRedactionDecision, type ViewerRedactionFlag, type ViewerRedactionReview };