@rjromeoent/ein-supabase 0.1.13 → 0.2.0

package/README.md

@@ -9,6 +9,7 @@ This package is the canonical home for:
 - Registered app slugs and the `x-ein-app` header helper.
 - Shared org-role helpers for `core.app_organization_memberships`.
 - Typed schema-client helpers.
+- Document-intake Edge Function names and request/response DTOs.
 
 Regenerate database types from the Event Intelligence Network repo root:
 
@@ -87,7 +88,7 @@ Then app repos should depend on the released version:
 ```json
 {
   "dependencies": {
-    "@rjromeoent/ein-supabase": "^0.1.11"
+    "@rjromeoent/ein-supabase": "^0.2.0"
   }
 }
 ```
@@ -226,6 +227,35 @@ different JSON parsing behavior.
 These helpers should stay small and dependency-free. App-specific parsers should
 compose them locally.
 
+#### Document Intake API Contracts
+
+Examples:
+
+- `DOCUMENT_INTAKE_EDGE_FUNCTIONS`
+- `DocumentIntakeCreateBatchRequest`
+- `DocumentIntakeGetBatchResponse`
+- `DocumentFindingAction`
+- `DocumentFindingStatus`
+- `DocumentReconciliationOperationDto`
+- `AiModelInvocationSummaryDto`
+- `AvailabilityReviewRowDto`
+- `AvailabilityBatchDetailsDto`
+
+Why:
+
+The document-intake review UI and the EIN Edge Functions need to agree on
+endpoint names, request bodies, response DTOs, finding actions, reconciliation
+operations, and AI invocation summaries. These contracts are app-facing even
+before all `document_intake` tables are available in generated database types.
+
+Keep UI-only state local to the app. Examples that should not move here:
+
+- upload progress state;
+- review mode or active tab;
+- row edit drafts;
+- matrix/table view models;
+- sidebar and filter state.
+
 #### Cross-App Backend Contracts
 
 Examples:

package/dist/document-intake.d.ts

@@ -0,0 +1,450 @@
+import type { JsonRecord } from "./json.js";
+export declare const DOCUMENT_INTAKE_EDGE_FUNCTIONS: {
+    readonly createBatch: "document-intake-create-batch";
+    readonly registerFiles: "document-intake-register-files";
+    readonly processFile: "document-intake-process-file";
+    readonly processFileWorker: "document-intake-process-file-worker";
+    readonly processingReaper: "document-intake-processing-reaper";
+    readonly getBatch: "document-intake-get-batch";
+    readonly listBatches: "document-intake-list-batches";
+    readonly updateRecord: "document-intake-update-record";
+    readonly updateFinding: "document-intake-update-finding";
+    readonly submitBatch: "document-intake-submit-batch";
+};
+export type DocumentIntakeEndpointKey = keyof typeof DOCUMENT_INTAKE_EDGE_FUNCTIONS;
+export type DocumentIntakeEdgeFunctionName = (typeof DOCUMENT_INTAKE_EDGE_FUNCTIONS)[DocumentIntakeEndpointKey];
+export type DocumentIntakeDomainKey = "availability" | string;
+export type DocumentIntakeBatchStatus = "draft" | "uploading" | "uploaded" | "processing" | "extracting" | "ready_for_review" | "submitting" | "submitted" | "normalizing" | "completed" | "completed_with_exceptions" | "failed" | "canceled";
+export type DocumentIntakeFileStatus = "pending_upload" | "uploaded" | "queued" | "processing" | "extracting" | "parsed" | "ready_for_review" | "failed" | "ignored" | "canceled";
+export type DocumentIntakeProcessingStatus = "queued" | "running" | "succeeded" | "failed" | "canceled";
+export type DocumentIntakeReviewStatus = "needs_review" | "accepted" | "rejected" | "submitted";
+export type DocumentFindingSeverity = "info" | "warning" | "error";
+export type DocumentFindingSource = "parser" | "validator" | "ai" | "reconciliation" | "system";
+export type DocumentFindingScope = "batch" | "file" | "chunk" | "record" | "record_group" | "entity" | "evidence";
+export type DocumentFindingAction = "resolve" | "dismiss" | "reopen" | "request_ai_verification" | "apply_reconciliation_operation" | "edit_record" | "map_entity" | "create_entity";
+export type DocumentFindingStatus = "open" | "resolved" | "dismissed" | "superseded";
+export type DocumentFindingStatusUpdate = Extract<DocumentFindingStatus, "open" | "resolved" | "dismissed">;
+export type DocumentFindingActionStatus = "applied" | "queued" | "rejected" | "failed";
+export type DocumentReconciliationOperationKind = "merge" | "split" | "flag" | "drop_exact_duplicate" | "normalize" | "link_entity" | "supersede";
+export type DocumentReconciliationDecision = "automatic" | "requires_human_approval" | "ai_suggested";
+export type DocumentReconciliationOperationStatus = "applied" | "proposed" | "skipped";
+export type AvailabilityDocumentFamily = "standard_availability_workbook" | "caa_matrix_workbook" | "caa_route_calendar_pdf" | "uta_buyer_copy_route_pdf" | "uta_casino_pdf" | "wasserman_route_pdf" | "wme_mtr_workbook" | "wme_route_book_pdf" | "generic_availability_document" | string;
+export type AvailabilityStorageBucket = "availability-uploads";
+export interface DocumentIntakeErrorResponse {
+    error: string;
+    details?: unknown;
+}
+export interface DocumentIntakeBatchDto<TDefaultContext extends JsonRecord = JsonRecord, TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    organization_id: string;
+    created_by_profile_id?: string | null;
+    domain_key?: DocumentIntakeDomainKey;
+    source_system?: string;
+    intake_channel?: string;
+    source_label?: string | null;
+    status: DocumentIntakeBatchStatus | string;
+    default_context?: TDefaultContext | null;
+    metadata?: TMetadata | null;
+    file_count?: number;
+    total_candidate_count?: number;
+    accepted_candidate_count?: number;
+    rejected_candidate_count?: number;
+    needs_review_candidate_count?: number;
+    submitted_candidate_count?: number;
+    open_finding_count?: number;
+    blocking_finding_count?: number;
+    error_code?: string | null;
+    error_message?: string | null;
+    created_at?: string;
+    updated_at?: string;
+    submitted_at?: string | null;
+    completed_at?: string | null;
+}
+export type DocumentIntakeBatchSummaryDto = DocumentIntakeBatchDto;
+export interface DocumentIntakeFileDto<TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    batch_id: string;
+    organization_id: string;
+    domain_key?: DocumentIntakeDomainKey;
+    storage_bucket?: string;
+    storage_path?: string;
+    original_file_name: string;
+    content_type?: string | null;
+    file_size_bytes?: number | null;
+    checksum_sha256?: string | null;
+    file_fingerprint_sha256?: string | null;
+    status: DocumentIntakeFileStatus | string;
+    document_family?: string | null;
+    layout_variant?: string | null;
+    route?: string | null;
+    strategy_key?: string | null;
+    matched_strategy_id?: string | null;
+    processor_key?: string | null;
+    processor_version?: string | null;
+    classification_source?: string | null;
+    classification_confidence?: number | null;
+    metadata?: TMetadata | null;
+    error_code?: string | null;
+    error_message: string | null;
+    created_at?: string;
+    updated_at?: string;
+    uploaded_at?: string | null;
+    completed_at?: string | null;
+}
+export interface AiModelInvocationSummaryDto<TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    organization_id?: string | null;
+    domain: string;
+    feature_key: string;
+    context_prompt_id?: string | null;
+    prompt_revision_id?: string | null;
+    model_provider: string;
+    model_name: string;
+    input_token_count: number | null;
+    output_token_count: number | null;
+    input_cost_estimate: number | string | null;
+    output_cost_estimate: number | string | null;
+    total_cost_estimate: number | string | null;
+    cost_currency: string | null;
+    cost_estimate_source: string | null;
+    status: string;
+    started_at: string | null;
+    completed_at: string | null;
+    latency_ms: number | null;
+    error_message: string | null;
+    metadata?: TMetadata | null;
+}
+export interface DocumentIntakeReviewFileDto<TMetadata extends JsonRecord = JsonRecord> extends DocumentIntakeFileDto<TMetadata> {
+    extraction_method: string | null;
+    parser_version: string | null;
+    ai_model_invocation?: AiModelInvocationSummaryDto | null;
+}
+export interface DocumentIntakeProcessingJobDto<TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    file_id: string;
+    batch_id?: string;
+    job_kind?: string | null;
+    route?: string | null;
+    strategy_key?: string | null;
+    processor_key?: string | null;
+    processor_version?: string | null;
+    status: DocumentIntakeProcessingStatus | string;
+    extraction_method: string | null;
+    parser_version: string | null;
+    model_invocation_id: string | null;
+    error_code: string | null;
+    error_message: string | null;
+    input_summary?: JsonRecord | null;
+    output_summary?: JsonRecord | null;
+    metadata?: TMetadata | null;
+    started_at: string | null;
+    completed_at: string | null;
+    created_at: string;
+    updated_at: string;
+    ai_model_invocation?: AiModelInvocationSummaryDto | null;
+}
+export interface DocumentIntakeProcessingChunkDto<TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    processing_job_id: string;
+    batch_id?: string;
+    file_id: string;
+    chunk_index: number;
+    chunk_key: string;
+    chunk_type: string;
+    status: DocumentIntakeProcessingStatus | string;
+    attempt_count: number | null;
+    expected_candidate_count?: number | null;
+    actual_candidate_count?: number | null;
+    expected_row_count?: number | null;
+    actual_row_count?: number | null;
+    model_invocation_id?: string | null;
+    input_summary?: JsonRecord | null;
+    output_summary?: JsonRecord | null;
+    metadata?: TMetadata | null;
+    error_message: string | null;
+    queued_at?: string | null;
+    started_at?: string | null;
+    completed_at?: string | null;
+    created_at: string;
+    updated_at: string;
+    ai_model_invocation?: AiModelInvocationSummaryDto | null;
+}
+export interface DocumentTargetRefDto<TMetadata extends JsonRecord = JsonRecord> extends JsonRecord {
+    schema: string;
+    table: string;
+    id: string;
+    role?: string | null;
+    label?: string | null;
+    metadata?: TMetadata;
+}
+export interface DocumentFindingDto<TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    organization_id: string | null;
+    domain_key: DocumentIntakeDomainKey;
+    feature_key: string | null;
+    source_label: string | null;
+    document_family: string | null;
+    layout_variant: string | null;
+    batch_id: string | null;
+    file_id: string | null;
+    processing_job_id: string | null;
+    processing_chunk_id: string | null;
+    candidate_record_id: string | null;
+    candidate_key: string | null;
+    candidate_index: number | null;
+    severity: DocumentFindingSeverity | string;
+    source: DocumentFindingSource | string;
+    scope: DocumentFindingScope | string;
+    finding_type: string;
+    message: string;
+    source_evidence: string | null;
+    recommendation: string | null;
+    allowed_actions: DocumentFindingAction[];
+    blocks_submit: boolean;
+    ai_verifiable: boolean;
+    evidence_refs?: JsonRecord[];
+    affected_record_refs?: JsonRecord[];
+    status: DocumentFindingStatus | string;
+    model_invocation_id: string | null;
+    context_prompt_id: string | null;
+    metadata?: TMetadata | null;
+    created_at: string;
+    updated_at: string;
+    resolved_at: string | null;
+    resolved_by_profile_id: string | null;
+    ai_model_invocation?: AiModelInvocationSummaryDto | null;
+}
+export interface DocumentFindingUpdateOptions<TMetadata extends JsonRecord = JsonRecord> {
+    action?: DocumentFindingAction;
+    metadata?: TMetadata;
+}
+export interface DocumentFindingActionEventDto<TMetadata extends JsonRecord = JsonRecord> {
+    id: string;
+    organization_id: string | null;
+    domain_key: DocumentIntakeDomainKey;
+    batch_id: string | null;
+    finding_id: string;
+    action: DocumentFindingAction | string;
+    action_status: DocumentFindingActionStatus | string;
+    previous_status: DocumentFindingStatus | string | null;
+    next_status: DocumentFindingStatus | string | null;
+    reviewer_profile_id: string | null;
+    model_invocation_id: string | null;
+    reconciliation_operation_id: string | null;
+    metadata?: TMetadata | null;
+    created_at: string;
+    ai_model_invocation?: AiModelInvocationSummaryDto | null;
+}
+export interface DocumentReconciliationOperationDto<TMetadata extends JsonRecord = JsonRecord> {
+    version: "document_reconciliation_operation_v1" | string;
+    operation_key: string;
+    operation_kind: DocumentReconciliationOperationKind | string;
+    decision: DocumentReconciliationDecision | string;
+    status: DocumentReconciliationOperationStatus | string;
+    group_key: string | null;
+    message: string;
+    input_record_refs: JsonRecord[];
+    output_record_refs: JsonRecord[];
+    evidence_refs: JsonRecord[];
+    metadata?: TMetadata | null;
+    batch_id?: string | null;
+    file_id?: string | null;
+    processing_job_id?: string | null;
+    source_record_type?: "file" | "job" | string;
+    source_record_id?: string | null;
+    linked_finding_ids?: string[];
+}
+export interface DocumentIntakeReviewPageDto {
+    offset: number;
+    limit: number | null;
+    count: number;
+    total: number | null;
+    fileId: string | null;
+    hasMore: boolean;
+}
+export interface AvailabilityReviewRowDto<TEvidenceRef extends JsonRecord = JsonRecord> {
+    id: string;
+    file_id?: string | null;
+    source_row_number: number | null;
+    source_record_key?: string | null;
+    artist_name: string | null;
+    agency_id: string | null;
+    agency_name: string | null;
+    availability_date: string | null;
+    availability_start_date: string | null;
+    availability_end_date: string | null;
+    status: string | null;
+    market_city: string | null;
+    market_state: string | null;
+    market_name: string | null;
+    venue_name: string | null;
+    venue_capacity: number | null;
+    quote_low: number | null;
+    quote_high: number | null;
+    currency: string | null;
+    confidence: number | null;
+    review_status: DocumentIntakeReviewStatus | string;
+    review_reason: string | null;
+    normalized_window_id?: string | null;
+    submitted_source_record_id?: string | null;
+    raw_source_excerpt?: string | null;
+    evidence_refs?: TEvidenceRef[];
+}
+export interface DocumentIntakeBatchDetailsDto<TRow = JsonRecord> {
+    batch: DocumentIntakeBatchDto;
+    files: DocumentIntakeReviewFileDto[];
+    jobs?: DocumentIntakeProcessingJobDto[];
+    chunks?: DocumentIntakeProcessingChunkDto[];
+    document_findings?: DocumentFindingDto[];
+    document_finding_action_events?: DocumentFindingActionEventDto[];
+    document_reconciliation_operations?: DocumentReconciliationOperationDto[];
+    model_invocations?: AiModelInvocationSummaryDto[];
+    rowPage?: DocumentIntakeReviewPageDto;
+    rows: TRow[];
+}
+export type AvailabilityBatchDetailsDto = DocumentIntakeBatchDetailsDto<AvailabilityReviewRowDto>;
+export interface DocumentIntakeCreateBatchRequest<TMetadata extends JsonRecord = JsonRecord> {
+    domainKey: DocumentIntakeDomainKey;
+    organizationId?: string;
+    sourceLabel?: string | null;
+    defaultAgencyId?: string | null;
+    defaultAgency?: string | null;
+    defaultYear?: number | null;
+    parseTypeHint?: string | null;
+    documentFamilyHint?: AvailabilityDocumentFamily | string | null;
+    layoutHint?: string | null;
+    layoutVariantHint?: string | null;
+    processorKeyHint?: string | null;
+    processorVersionHint?: string | null;
+    timezone?: string | null;
+    metadata?: TMetadata | null;
+}
+export interface DocumentIntakeCreateBatchResponse {
+    batch: DocumentIntakeBatchDto;
+}
+export interface DocumentIntakeUploadedFileRegistration {
+    id: string;
+    storageBucket: AvailabilityStorageBucket | string;
+    storagePath: string;
+    originalFileName: string;
+    contentType: string | null;
+    fileSizeBytes: number;
+    checksumSha256?: string | null;
+    lastModified: number | null;
+}
+export interface DocumentIntakeRegisteredFileDto {
+    id: string;
+    batch_id: string;
+    organization_id: string;
+    original_file_name: string;
+    [key: string]: unknown;
+}
+export interface DocumentIntakeRegisterFilesRequest {
+    domainKey: DocumentIntakeDomainKey;
+    batchId: string;
+    files: DocumentIntakeUploadedFileRegistration[];
+}
+export interface DocumentIntakeRegisterFilesResponse {
+    files: DocumentIntakeRegisteredFileDto[];
+    processingTriggered: number;
+    processingFunction: DocumentIntakeEdgeFunctionName | string;
+    processingDomainKey: DocumentIntakeDomainKey;
+    processingResults: Array<{
+        fileId: string;
+        queued: boolean;
+    }>;
+}
+export interface DocumentIntakeGetBatchRequest {
+    domainKey: DocumentIntakeDomainKey;
+    batchId: string;
+    includeRows?: boolean;
+    rowOffset?: number;
+    rowLimit?: number | null;
+    rowFileId?: string | null;
+}
+export type DocumentIntakeGetBatchResponse<TRow = JsonRecord> = DocumentIntakeBatchDetailsDto<TRow>;
+export interface DocumentIntakeListBatchesRequest {
+    domainKey: DocumentIntakeDomainKey;
+    limit?: number;
+    excludeSmoke?: boolean;
+}
+export interface DocumentIntakeListBatchesResponse {
+    batches: DocumentIntakeBatchSummaryDto[];
+}
+export interface DocumentIntakeUpdateRecordRequest<TValues extends JsonRecord = JsonRecord> {
+    domainKey: DocumentIntakeDomainKey;
+    rowId: string;
+    values?: TValues;
+    reviewStatus?: DocumentIntakeReviewStatus;
+}
+export interface DocumentIntakeUpdateRecordResponse<TRow extends JsonRecord = JsonRecord> {
+    row?: TRow;
+    record?: TRow;
+    error?: string;
+}
+export interface DocumentIntakeUpdateFindingRequest<TMetadata extends JsonRecord = JsonRecord> {
+    domainKey: DocumentIntakeDomainKey;
+    findingId: string;
+    status?: DocumentFindingStatusUpdate;
+    action?: DocumentFindingAction;
+    metadata?: TMetadata;
+}
+export interface DocumentIntakeUpdateFindingResponse {
+    finding: DocumentFindingDto;
+    finding_action_event: DocumentFindingActionEventDto;
+}
+export interface DocumentIntakeProcessFileRequest {
+    domainKey?: DocumentIntakeDomainKey;
+    fileId: string;
+}
+export interface DocumentIntakeProcessFileResponse {
+    fileId: string;
+    parsedRows: number;
+    processingJobId?: string;
+    queuedRows?: number;
+    totalChunks?: number;
+    expectedRowCount?: number;
+    pageCount?: number;
+    asyncWorkerFunction?: DocumentIntakeEdgeFunctionName | string;
+    documentProcessorFallbackUsed?: boolean;
+    counts?: JsonRecord;
+    error?: string;
+    [key: string]: unknown;
+}
+export interface DocumentIntakeProcessFileWorkerRequest {
+    domainKey?: DocumentIntakeDomainKey;
+    jobId: string;
+}
+export interface DocumentIntakeProcessFileWorkerResponse {
+    jobId: string;
+    status?: string;
+    skipped?: boolean;
+    completed?: boolean;
+    chunkId?: string;
+    chunkIndex?: number;
+    parsedRows?: number;
+    insertedRows?: number;
+    queuedRowChunks?: number;
+    hasMore?: boolean;
+    counts?: JsonRecord;
+    error?: string;
+    [key: string]: unknown;
+}
+export interface DocumentIntakeSubmitBatchRequest {
+    domainKey: DocumentIntakeDomainKey;
+    batchId: string;
+    normalize?: boolean;
+}
+export interface DocumentIntakeSubmitBatchResponse {
+    batchId: string;
+    submittedRows: number;
+    publishedRows: number;
+    normalizedWindowCount: number;
+    publishSourceSystem: "document_intake" | string;
+    sourceArtistCount: number;
+    sourceRecordCount: number;
+    normalized: boolean;
+    normalizationRequested: boolean;
+    normalizationError: string | null;
+    pipelineResults: unknown[];
+}

package/dist/document-intake.js

@@ -0,0 +1,12 @@
+export const DOCUMENT_INTAKE_EDGE_FUNCTIONS = {
+    createBatch: "document-intake-create-batch",
+    registerFiles: "document-intake-register-files",
+    processFile: "document-intake-process-file",
+    processFileWorker: "document-intake-process-file-worker",
+    processingReaper: "document-intake-processing-reaper",
+    getBatch: "document-intake-get-batch",
+    listBatches: "document-intake-list-batches",
+    updateRecord: "document-intake-update-record",
+    updateFinding: "document-intake-update-finding",
+    submitBatch: "document-intake-submit-batch",
+};

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./app-context.js";
 export * from "./auth.js";
 export type * from "./db-enums.js";
+export * from "./document-intake.js";
 export * from "./json.js";
 export * from "./rad-rpc.js";
 export * from "./schema-client.js";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./app-context.js";
 export * from "./auth.js";
+export * from "./document-intake.js";
 export * from "./json.js";
 export * from "./rad-rpc.js";
 export * from "./schema-client.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjromeoent/ein-supabase",
-  "version": "0.1.13",
+  "version": "0.2.0",
   "description": "Shared Supabase types, app context, and contract helpers for EIN-connected apps.",
   "type": "module",
   "sideEffects": false,
@@ -24,6 +24,10 @@
       "types": "./dist/db-enums.d.ts",
       "import": "./dist/db-enums.js"
     },
+    "./document-intake": {
+      "types": "./dist/document-intake.d.ts",
+      "import": "./dist/document-intake.js"
+    },
     "./generated/database.types": {
       "types": "./dist/generated/database.types.d.ts",
       "import": "./dist/generated/database.types.js"