@abyss-project/extract 0.0.0-stage → 1.0.0

package/dist/types/interface/api/responses/extraction.response.d.ts

@@ -0,0 +1,424 @@
+import { IResponse } from '../type-message/response';
+import type { IExtractionPlanPreset, IExtractModesData, IFieldValue } from '../../models/extraction-plan.dto';
+import { IExtractionBankVersion, IExtraction, IExtractionMetadata, IExtractionFeedback, IExtractionFile, IExtractionTemplate, IExtractionTemplateVersion, IExtractionTransaction, IExtractionWebhookDelivery, ExtractionMode } from '../../models/extraction.dto';
+export interface IExtractSyncData {
+    extraction_id: string;
+    file_id: string;
+    application_file_id: string | null;
+    cached: boolean;
+    records: IExtractionTransaction[];
+    metadata: IExtractionMetadata;
+    extraction: {
+        mode: ExtractionMode;
+        strategy_used: string | null;
+        confidence: number | null;
+        detected_bank: string | null;
+        detected_version: string | null;
+        balance_validated: boolean | null;
+        duration_ms: number | null;
+        warnings: string[];
+        alternatives: unknown[];
+        used_ocr: boolean;
+        ocr_page_count: number;
+    };
+    documentType: string | null;
+    documentTypeConfidence: number | null;
+    fields: Record<string, {
+        value: unknown;
+        confidence: number;
+    }> | null;
+}
+export type IExtractSyncResponse = IResponse<IExtractSyncData>;
+export interface IExtractQueueData {
+    job_id: string;
+    status: string;
+    queued_at: string;
+    poll_url: string;
+    documentType: string | null;
+    documentTypeConfidence: number | null;
+    fields: Record<string, {
+        value: unknown;
+        confidence: number;
+    }> | null;
+}
+export type IExtractQueueResponse = IResponse<IExtractQueueData>;
+export interface IExtractBulkData {
+    accepted: number;
+    rejected: number;
+    jobs: Array<{
+        index: number;
+        job_id: string;
+    }>;
+    errors: Array<{
+        index: number;
+        error: string;
+    }>;
+}
+export type IExtractBulkResponse = IResponse<IExtractBulkData>;
+export interface IDetectData {
+    pdfHash: string;
+    pageCount: number;
+    metadata: {
+        ibans: Array<{
+            iban: string;
+            bankCode: string;
+            countryCode: string;
+        }>;
+        bics: Array<{
+            bic: string;
+            bankCode: string;
+        }>;
+    };
+    candidates: Array<{
+        id: string;
+        bankName: string;
+        version: string;
+        score: number;
+        matchedSignals: string[];
+    }>;
+    durationMs: number;
+}
+export type IDetectResponse = IResponse<IDetectData>;
+export interface IDetectBulkData {
+    count: number;
+    results: Array<{
+        index: number;
+        result?: IDetectData;
+        error?: string;
+    }>;
+}
+export type IDetectBulkResponse = IResponse<IDetectBulkData>;
+export interface IListFilesData {
+    data: IExtractionFile[];
+    total?: number;
+}
+export type IListFilesResponse = IListFilesData;
+export type IGetFileResponse = IResponse<IExtractionFile>;
+export interface IListFileExtractionsData {
+    data: IExtraction[];
+    total?: number;
+}
+export type IListFileExtractionsResponse = IListFileExtractionsData;
+export interface IGetExtractionData extends IExtraction {
+    documentType: string | null;
+    documentTypeConfidence: number | null;
+    fields: Record<string, IFieldValue> | null;
+}
+export type IGetExtractionResponse = IResponse<IGetExtractionData>;
+export interface ISearchExtractionRecordsResponse {
+    data: IExtractionTransaction[];
+    matched: number;
+    total: number;
+}
+export interface IDiffExtractionsData {
+    left: {
+        id: string;
+        mode: ExtractionMode;
+        recordsCount: number | null;
+    };
+    right: {
+        id: string;
+        mode: ExtractionMode;
+        recordsCount: number | null;
+    };
+    same: number;
+    added: IExtractionTransaction[];
+    removed: IExtractionTransaction[];
+    changed: Array<{
+        before: IExtractionTransaction;
+        after: IExtractionTransaction;
+        fields: string[];
+    }>;
+    summary: {
+        leftCount: number;
+        rightCount: number;
+        sumDeltaCents: number;
+    };
+}
+export type IDiffExtractionsResponse = IResponse<IDiffExtractionsData>;
+export interface IAsyncExportData {
+    job_id: string;
+    status: string;
+    poll_url: string;
+}
+export type IAsyncExportResponse = IResponse<IAsyncExportData>;
+export interface IGetExportJobData {
+    id: string;
+    status: string;
+    progress: number | object | string | boolean;
+    result: {
+        applicationFileId: string;
+        filename: string;
+        contentType: string;
+        byteSize: number;
+    } | null;
+    error: string | null;
+}
+export type IGetExportJobResponse = IResponse<IGetExportJobData>;
+export interface ITemplateAndVersionData {
+    template: IExtractionTemplate;
+    version: IExtractionTemplateVersion;
+    warnings?: string[];
+}
+export type ICreateTemplateResponse = IResponse<ITemplateAndVersionData>;
+export type IUpdateTemplateResponse = IResponse<ITemplateAndVersionData>;
+export type IListTemplatesResponse = IResponse<IExtractionTemplate[]>;
+export interface IGetTemplateData {
+    template: IExtractionTemplate;
+    latest_version: IExtractionTemplateVersion | null;
+}
+export type IGetTemplateResponse = IResponse<IGetTemplateData>;
+export type IListTemplateVersionsResponse = IResponse<IExtractionTemplateVersion[]>;
+export interface IGetTemplateWitnessUrlData {
+    url: string;
+    filename: string | null;
+    size_bytes: number | null;
+}
+export type IGetTemplateWitnessUrlResponse = IResponse<IGetTemplateWitnessUrlData>;
+export interface IExtractionTemplateCollection {
+    $schema: 'abyss-rcb-template-collection/v1';
+    exported_at: string;
+    templates: Array<{
+        name: string;
+        description: string | null;
+        versions: Array<{
+            version: number;
+            comment: string | null;
+            template_json: Record<string, unknown>;
+        }>;
+    }>;
+}
+export interface IImportTemplateCollectionData {
+    imported: Array<{
+        originalName: string;
+        createdName: string;
+        templateId: string;
+        versions: number;
+    }>;
+    errors: Array<{
+        originalName: string;
+        error: string;
+    }>;
+}
+export type IImportTemplateCollectionResponse = IResponse<IImportTemplateCollectionData>;
+export interface IExtractionJob {
+    id: string;
+    status: 'waiting' | 'active' | 'completed' | 'failed' | 'delayed' | 'paused' | 'pending' | 'stuck';
+    progress: number | object | string | boolean;
+    result: {
+        extractionId: string;
+        fileId: string;
+        cached: boolean;
+        recordsCount: number;
+        strategyUsed: string | null;
+    } | null;
+    error: string | null;
+    createdAt: number;
+    processedOn: number | null;
+    finishedOn: number | null;
+    attemptsMade: number;
+}
+export type IGetJobResponse = IResponse<IExtractionJob>;
+export type ICreateFeedbackResponse = IResponse<IExtractionFeedback>;
+export interface IListFeedbackResponse {
+    data: IExtractionFeedback[];
+    total?: number;
+}
+export type IGetFeedbackResponse = IResponse<IExtractionFeedback>;
+export interface IExtractionHealth {
+    status: 'ok' | 'degraded' | 'down';
+    redis: 'ok' | 'down';
+    queue: 'ok' | 'down';
+    worker: 'ok' | 'down';
+    isShuttingDown: boolean;
+    rssMb: number;
+    heapUsedMb: number;
+    uptimeSec: number;
+}
+export type IHealthResponse = IResponse<IExtractionHealth>;
+export interface IExtractionStats {
+    waiting: number;
+    active: number;
+    completed: number;
+    failed: number;
+    delayed: number;
+    workerConcurrency: number;
+    isPaused: boolean;
+}
+export type IStatsResponse = IResponse<IExtractionStats>;
+export interface IExtractionUsageSummary {
+    totalEvents: number;
+    successCount: number;
+    failedCount: number;
+    cachedCount: number;
+    totalDurationMs: number;
+    totalRecordsExtracted: number;
+    totalBytesProcessed: number;
+    byEventType: Record<string, number>;
+    byBank: Record<string, number>;
+}
+export type ISummaryUsageResponse = IResponse<IExtractionUsageSummary>;
+export interface IUsageByConfigRow {
+    planPresetId: string;
+    providerId: string | null;
+    interpreterId: string | null;
+    count: number;
+    successCount: number;
+    successRate: number;
+    avgDurationMs: number;
+    avgRecords: number;
+    ocrPagesConsumed: number;
+}
+export interface IUsageByConfig {
+    rows: IUsageByConfigRow[];
+}
+export type IUsageByConfigResponse = IResponse<IUsageByConfig>;
+export interface IListWebhookDeliveriesResponse {
+    data: IExtractionWebhookDelivery[];
+    total?: number;
+}
+export type IGetWebhookDeliveryResponse = IResponse<IExtractionWebhookDelivery>;
+export interface IGetSharedExtractionData {
+    id: string;
+    mode: ExtractionMode;
+    strategy_used: string | null;
+    confidence: number | null;
+    records_count: number | null;
+    balance_validated: boolean | null;
+    records: IExtractionTransaction[];
+    metadata: IExtractionMetadata;
+    warnings: string[];
+    share_expires_at: string | null;
+    created_at: string;
+}
+export type IGetSharedExtractionResponse = IResponse<IGetSharedExtractionData>;
+export interface IMintShareExtractionData {
+    share_url: string;
+    share_token: string;
+    share_expires_at: string | null;
+}
+export type IMintShareExtractionResponse = IResponse<IMintShareExtractionData>;
+export interface IChangelogData {
+    current_version: string;
+    entries: Array<{
+        version: string;
+        date: string;
+        highlights: string[];
+    }>;
+}
+export type IChangelogResponse = IResponse<IChangelogData>;
+export interface IListBankVersionsAdminResponse {
+    data: IExtractionBankVersion[];
+    total?: number;
+}
+export type IGetBankVersionAdminResponse = IResponse<IExtractionBankVersion>;
+export type IUpsertBankVersionAdminResponse = IResponse<IExtractionBankVersion>;
+export interface IReloadBankVersionsAdminData {
+    loaded: number;
+    skipped: number;
+    total: number;
+}
+export type IReloadBankVersionsAdminResponse = IResponse<IReloadBankVersionsAdminData>;
+export interface IDetectorReplayAdminData {
+    scanned: number;
+    kept: number;
+    flipped: number;
+    newDetections: number;
+    skipped: number;
+    details: unknown[];
+    durationMs: number;
+}
+export type IDetectorReplayAdminResponse = IResponse<IDetectorReplayAdminData>;
+export interface IListRequestLogAdminData {
+    data: Array<{
+        ts: number;
+        method: string;
+        path: string;
+        status: number;
+        durationMs: number;
+        userId: string | null;
+        requestId: string | null;
+        rateLimitBucket: string | null;
+    }>;
+    meta: {
+        capacity: number;
+        used: number;
+        oldestTs: number | null;
+        newestTs: number | null;
+    };
+}
+export interface IExtractionPerBankMetric {
+    bank: string;
+    extractions: number;
+    avgConfidence: number;
+    avgRecords: number;
+    balanceValidatedRate: number;
+    avgDurationMs: number;
+    feedbackOpen: number;
+}
+export type IPerBankMetricsAdminResponse = IResponse<IExtractionPerBankMetric[]>;
+export interface IExtractionLatencyBucket {
+    bucket: string;
+    count: number;
+}
+export type ILatencyMetricsAdminResponse = IResponse<IExtractionLatencyBucket[]>;
+export interface IExtractionOverviewMetrics {
+    last24h: {
+        extractions: number;
+        failures: number;
+        avgLatencyMs: number;
+    };
+    last30d: {
+        extractions: number;
+        uniqueUsers: number;
+    };
+}
+export type IOverviewMetricsAdminResponse = IResponse<IExtractionOverviewMetrics>;
+import type { IExtractionWebhook } from '../../models/extraction.dto';
+export interface IPaginateExtractionWebhookData {
+    rows: IExtractionWebhook[];
+    total: number;
+}
+export type IPaginateExtractionWebhookResponse = IResponse<IPaginateExtractionWebhookData>;
+export type IGetExtractionWebhookResponse = IResponse<{
+    webhook: IExtractionWebhook;
+}>;
+export type ICreateExtractionWebhookResponse = IResponse<{
+    webhook: IExtractionWebhook;
+}>;
+export type IUpdateExtractionWebhookResponse = IResponse<{
+    webhook: IExtractionWebhook;
+}>;
+export type IDeleteExtractionWebhookResponse = IResponse<{
+    ok: true;
+}>;
+export type IResetSecretExtractionWebhookResponse = IResponse<{
+    webhook: IExtractionWebhook;
+}>;
+export interface IGetExtractionSettingsResponse {
+    data: {
+        improvement_default: boolean;
+    };
+}
+export type IUpsertExtractionSettingsResponse = IGetExtractionSettingsResponse;
+export interface IToggleExtractionTrainingResponse {
+    data: {
+        id: string;
+        usable_for_training: boolean;
+        training_file_id: string | null;
+    };
+}
+export interface IListModesResponse {
+    data: IExtractModesData;
+}
+export interface IListPlanPresetsResponse {
+    data: IExtractionPlanPreset[];
+}
+export interface IGetPlanPresetResponse {
+    data: IExtractionPlanPreset;
+}
+export interface IDeletePlanPresetResponse {
+    data: {
+        id: string;
+    };
+}

package/dist/types/interface/api/responses/extraction.response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=extraction.response.js.map

package/dist/types/interface/api/responses/extraction.response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/extraction.response.ts"],"names":[],"mappings":""}

package/dist/types/interface/api/responses/index.d.ts

@@ -0,0 +1 @@
+export * from './extraction.response';

package/dist/types/interface/api/responses/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./extraction.response"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/interface/api/responses/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC"}

package/dist/types/interface/api/type-message/api-error.d.ts

@@ -0,0 +1,6 @@
+import { Code, ErrorType } from '../../../enum';
+export interface IApiError {
+    code: Code;
+    type: ErrorType;
+    message?: string;
+}

package/dist/types/interface/api/type-message/api-error.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-error.js.map

package/dist/types/interface/api/type-message/api-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-error.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/type-message/api-error.ts"],"names":[],"mappings":""}

package/dist/types/interface/api/type-message/base-paginate.d.ts

@@ -0,0 +1,10 @@
+export interface BasePaginate<T> {
+    maxPages: number;
+    currentPage: number;
+    data: T[];
+    totalItems: number;
+}
+export interface QueryPaginate {
+    page?: number;
+    limit?: number;
+}

package/dist/types/interface/api/type-message/base-paginate.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=base-paginate.js.map

package/dist/types/interface/api/type-message/base-paginate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-paginate.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/type-message/base-paginate.ts"],"names":[],"mappings":""}

package/dist/types/interface/api/type-message/response.d.ts

@@ -0,0 +1,5 @@
+import { IApiError } from './api-error';
+export interface IResponse<T> {
+    data: T;
+    error?: IApiError | Error;
+}

package/dist/types/interface/api/type-message/response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=response.js.map

package/dist/types/interface/api/type-message/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/type-message/response.ts"],"names":[],"mappings":""}

package/dist/types/interface/index.d.ts

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './api';

package/dist/types/interface/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./models"), exports);
+__exportStar(require("./api"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/interface/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/interface/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,wCAAsB"}

package/dist/types/interface/models/extraction-fetched-provenance.dto.test.d.ts

@@ -0,0 +1 @@
+export {};