@abyss-project/tools 1.0.5 → 1.1.1

package/src/types/interface/api/requests/rcb.request.ts

@@ -1,267 +0,0 @@
-// ──────────────────────────────────────────────
-// RCB API requests.
-// ──────────────────────────────────────────────
-
-import {
-  RcbExtractionMode,
-  RcbFeedbackIssueType,
-  RcbFeedbackStatus,
-  RcbProcessingMode,
-  IRcbBankHint,
-} from '../../models/rcb.dto';
-
-// ─── EXTRACT ─────────────────────────────────
-
-export interface IExtractRcbBody {
-  /** Inline PDF buffer — multipart upload only. SDK helpers wrap this. */
-  pdf?: Buffer | Uint8Array;
-  storage_file_id?: string;
-  mode: RcbExtractionMode;
-  hint?: IRcbBankHint;
-  template_id?: string;
-  template?: Record<string, unknown>;
-  pdf_filename?: string;
-  user_external_id?: string;
-  user_metadata?: Record<string, unknown>;
-  archive?: boolean;
-  force?: boolean;
-  processing?: RcbProcessingMode;
-}
-
-export interface IExtractBulkRcbBody {
-  items: Array<{
-    storage_file_id?: string;
-    pdf_base64?: string;
-    mode: RcbExtractionMode;
-    hint?: IRcbBankHint;
-    template_id?: string;
-    template?: Record<string, unknown>;
-    pdf_filename?: string;
-    user_external_id?: string;
-    user_metadata?: Record<string, unknown>;
-    archive?: boolean;
-    force?: boolean;
-  }>;
-}
-
-// ─── DETECT ──────────────────────────────────
-
-export interface IDetectBulkRcbBody {
-  items: Array<{ pdf_base64: string; pdf_filename?: string }>;
-}
-
-// ─── FILES ───────────────────────────────────
-
-export interface IListFilesRcbQuery {
-  hash?: string;
-  external_id?: string;
-  application_file_id?: string;
-  bank?: string;
-  from?: string;
-  to?: string;
-  limit?: number;
-  offset?: number;
-}
-
-export interface IGetFileRcbParams {
-  fileId: string;
-}
-
-export interface IPatchFileRcbBody {
-  user_external_id?: string | null;
-  user_metadata?: Record<string, unknown> | null;
-}
-
-// ─── EXTRACTIONS ─────────────────────────────
-
-export interface IGetExtractionRcbParams {
-  extractionId: string;
-}
-
-export interface IPatchExtractionRcbBody {
-  tags?: string[] | null;
-  note?: string | null;
-}
-
-export interface ISearchExtractionRecordsRcbQuery {
-  q?: string;
-  amount_min?: number;
-  amount_max?: number;
-  sign?: 'debit' | 'credit';
-  date_from?: string;
-  date_to?: string;
-  sort?: 'date' | 'amount' | 'description';
-  sort_dir?: 'asc' | 'desc';
-  limit?: number;
-  offset?: number;
-}
-
-export interface IExportExtractionRcbQuery {
-  format: 'csv' | 'json';
-  delimiter?: ',' | ';' | '\t';
-}
-
-export interface IAsyncExportExtractionRcbBody {
-  format: 'csv' | 'json';
-  delimiter?: ',' | ';' | '\t';
-}
-
-// ─── TEMPLATES ───────────────────────────────
-
-export interface ICreateTemplateRcbBody {
-  name: string;
-  description?: string;
-  template_json: Record<string, unknown>;
-  comment?: string;
-}
-
-export interface IUpdateTemplateRcbBody {
-  template_json: Record<string, unknown>;
-  comment?: string;
-}
-
-export interface IPatchTemplateMetaRcbBody {
-  name?: string;
-  description?: string | null;
-  is_active?: boolean;
-}
-
-// ─── FEEDBACK ────────────────────────────────
-
-export interface ICreateFeedbackRcbBody {
-  extraction_id: string;
-  issue_type: RcbFeedbackIssueType;
-  description?: string;
-}
-
-export interface IPatchFeedbackRcbBody {
-  status: RcbFeedbackStatus;
-}
-
-export interface IListFeedbackRcbQuery {
-  extraction_id?: string;
-  status?: RcbFeedbackStatus;
-  issue_type?: RcbFeedbackIssueType;
-  limit?: number;
-  offset?: number;
-}
-
-// ─── USAGE ───────────────────────────────────
-
-export interface IListUsageRcbQuery {
-  application_id?: string;
-  event_type?: string;
-  from?: string;
-  to?: string;
-  limit?: number;
-  offset?: number;
-}
-
-export interface ISummaryUsageRcbQuery {
-  from?: string;
-  to?: string;
-}
-
-// ─── WEBHOOK DELIVERIES ─────────────────────
-
-export interface IListWebhookDeliveriesRcbQuery {
-  job_id?: string;
-  event?: string;
-  delivered?: boolean;
-  from?: string;
-  to?: string;
-  limit?: number;
-  offset?: number;
-}
-
-export interface IReplayWebhookDeliveryRcbBody {
-  url?: string;
-  secret?: string;
-}
-
-// ─── SHARE ───────────────────────────────────
-
-export interface IMintShareExtractionRcbBody {
-  expires_in_days?: number;
-}
-
-// ─── ADMIN: CATALOGUE ────────────────────────
-
-export interface IUpsertBankVersionAdminRcbBody {
-  bank: string;
-  version: string;
-  valid_from?: string | null;
-  valid_to?: string | null;
-  detector_json: Record<string, unknown>;
-  parser_kind: string;
-  config_json: Record<string, unknown>;
-  is_active?: boolean;
-}
-
-export interface IToggleBankVersionActiveAdminRcbBody {
-  is_active: boolean;
-}
-
-export interface IUpsertQuotaAdminRcbBody {
-  tier?: string;
-  monthly_extract_cap?: number | null;
-  monthly_extracted_cap?: number | null;
-  monthly_bytes_cap?: number | null;
-  queue_only_above_count?: number | null;
-}
-
-export interface IDetectorReplayAdminRcbBody {
-  detected_bank?: string;
-  from?: string;
-  to?: string;
-  limit?: number;
-}
-
-export interface IListRequestLogAdminRcbQuery {
-  since_ms?: number;
-  status_min?: number;
-  status_max?: number;
-  user_id?: string;
-  path_prefix?: string;
-  limit?: number;
-}
-
-// ─── WEBHOOK SUBSCRIPTIONS ──────────────────
-
-import type { RcbWebhookEvent } from '../../models/rcb.dto';
-
-export interface IRcbWebhookScopeQuery {
-  organization_id?: string;
-  project_id?: string;
-}
-
-export interface IPaginateRcbWebhookQuery extends IRcbWebhookScopeQuery {
-  name?: string;
-  event?: RcbWebhookEvent;
-  isEnabled?: boolean;
-  page?: number;
-  limit?: number;
-}
-
-export interface ICreateRcbWebhookBody {
-  webhookUrl: string;
-  name?: string;
-  description?: string;
-  isEnabled?: boolean;
-  scopes: RcbWebhookEvent[];
-}
-
-export interface IUpdateRcbWebhookBody {
-  webhookUrl?: string;
-  name?: string;
-  description?: string;
-  isEnabled?: boolean;
-  scopes?: RcbWebhookEvent[];
-}
-
-// ─── SHARED FILES (content_share-backed) ────
-
-export interface IListSharedFilesRcbQuery extends IRcbWebhookScopeQuery {
-  limit?: number;
-  offset?: number;
-}

package/src/types/interface/api/responses/rcb.response.ts

@@ -1,399 +0,0 @@
-// ──────────────────────────────────────────────
-// RCB API responses.
-// ──────────────────────────────────────────────
-
-import { IResponse } from '../type-message/response';
-import {
-  IRcbBankVersion,
-  IRcbExtraction,
-  IRcbExtractionMetadata,
-  IRcbFeedback,
-  IRcbFile,
-  IRcbQuota,
-  IRcbTemplate,
-  IRcbTemplateVersion,
-  IRcbTransaction,
-  IRcbWebhookDelivery,
-  RcbExtractionMode,
-} from '../../models/rcb.dto';
-
-// ─── EXTRACT ─────────────────────────────────
-
-export interface IExtractSyncRcbData {
-  extraction_id: string;
-  file_id: string;
-  application_file_id: string | null;
-  cached: boolean;
-  records: IRcbTransaction[];
-  metadata: IRcbExtractionMetadata;
-  extraction: {
-    mode: RcbExtractionMode;
-    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[];
-  };
-}
-export type IExtractSyncRcbResponse = IResponse<IExtractSyncRcbData>;
-
-export interface IExtractQueueRcbData {
-  job_id: string;
-  status: string;
-  queued_at: string;
-  poll_url: string;
-}
-export type IExtractQueueRcbResponse = IResponse<IExtractQueueRcbData>;
-
-export interface IExtractBulkRcbData {
-  accepted: number;
-  rejected: number;
-  jobs: Array<{ index: number; job_id: string }>;
-  errors: Array<{ index: number; error: string }>;
-}
-export type IExtractBulkRcbResponse = IResponse<IExtractBulkRcbData>;
-
-// ─── DETECT ──────────────────────────────────
-
-export interface IDetectRcbData {
-  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 IDetectRcbResponse = IResponse<IDetectRcbData>;
-
-export interface IDetectBulkRcbData {
-  count: number;
-  results: Array<{ index: number; result?: IDetectRcbData; error?: string }>;
-}
-export type IDetectBulkRcbResponse = IResponse<IDetectBulkRcbData>;
-
-// ─── FILES / EXTRACTIONS ─────────────────────
-
-export interface IListFilesRcbData {
-  data: IRcbFile[];
-  total?: number;
-}
-export type IListFilesRcbResponse = IListFilesRcbData;
-
-export type IGetFileRcbResponse = IResponse<IRcbFile>;
-
-export interface IListFileExtractionsRcbData {
-  data: IRcbExtraction[];
-  total?: number;
-}
-export type IListFileExtractionsRcbResponse = IListFileExtractionsRcbData;
-
-export type IGetExtractionRcbResponse = IResponse<IRcbExtraction>;
-
-export interface ISearchExtractionRecordsRcbResponse {
-  data: IRcbTransaction[];
-  matched: number;
-  total: number;
-}
-
-export interface IDiffExtractionsRcbData {
-  left: { id: string; mode: RcbExtractionMode; recordsCount: number | null };
-  right: { id: string; mode: RcbExtractionMode; recordsCount: number | null };
-  same: number;
-  added: IRcbTransaction[];
-  removed: IRcbTransaction[];
-  changed: Array<{ before: IRcbTransaction; after: IRcbTransaction; fields: string[] }>;
-  summary: { leftCount: number; rightCount: number; sumDeltaCents: number };
-}
-export type IDiffExtractionsRcbResponse = IResponse<IDiffExtractionsRcbData>;
-
-export interface IAsyncExportRcbData {
-  job_id: string;
-  status: string;
-  poll_url: string;
-}
-export type IAsyncExportRcbResponse = IResponse<IAsyncExportRcbData>;
-
-export interface IGetExportJobRcbData {
-  id: string;
-  status: string;
-  progress: number | object | string | boolean;
-  result: {
-    applicationFileId: string;
-    filename: string;
-    contentType: string;
-    byteSize: number;
-  } | null;
-  error: string | null;
-}
-export type IGetExportJobRcbResponse = IResponse<IGetExportJobRcbData>;
-
-// ─── TEMPLATES ───────────────────────────────
-
-export interface ITemplateAndVersionRcbData {
-  template: IRcbTemplate;
-  version: IRcbTemplateVersion;
-  warnings?: string[];
-}
-export type ICreateTemplateRcbResponse = IResponse<ITemplateAndVersionRcbData>;
-export type IUpdateTemplateRcbResponse = IResponse<ITemplateAndVersionRcbData>;
-
-export type IListTemplatesRcbResponse = IResponse<IRcbTemplate[]>;
-
-export interface IGetTemplateRcbData {
-  template: IRcbTemplate;
-  latest_version: IRcbTemplateVersion | null;
-}
-export type IGetTemplateRcbResponse = IResponse<IGetTemplateRcbData>;
-
-export type IListTemplateVersionsRcbResponse = IResponse<IRcbTemplateVersion[]>;
-
-export interface IRcbTemplateCollection {
-  $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 IImportTemplateCollectionRcbData {
-  imported: Array<{
-    originalName: string;
-    createdName: string;
-    templateId: string;
-    versions: number;
-  }>;
-  errors: Array<{ originalName: string; error: string }>;
-}
-export type IImportTemplateCollectionRcbResponse = IResponse<IImportTemplateCollectionRcbData>;
-
-// ─── JOBS ────────────────────────────────────
-
-export interface IRcbJob {
-  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 IGetJobRcbResponse = IResponse<IRcbJob>;
-
-// ─── FEEDBACK ────────────────────────────────
-
-export type ICreateFeedbackRcbResponse = IResponse<IRcbFeedback>;
-export interface IListFeedbackRcbResponse {
-  data: IRcbFeedback[];
-  total?: number;
-}
-export type IGetFeedbackRcbResponse = IResponse<IRcbFeedback>;
-
-// ─── HEALTH / STATS / QUOTA ─────────────────
-
-export interface IRcbHealth {
-  status: 'ok' | 'degraded' | 'down';
-  redis: 'ok' | 'down';
-  queue: 'ok' | 'down';
-  worker: 'ok' | 'down';
-  isShuttingDown: boolean;
-  rssMb: number;
-  heapUsedMb: number;
-  uptimeSec: number;
-}
-export type IHealthRcbResponse = IResponse<IRcbHealth>;
-
-export interface IRcbStats {
-  waiting: number;
-  active: number;
-  completed: number;
-  failed: number;
-  delayed: number;
-  workerConcurrency: number;
-  isPaused: boolean;
-}
-export type IStatsRcbResponse = IResponse<IRcbStats>;
-
-export interface IRcbUsageSummary {
-  totalEvents: number;
-  successCount: number;
-  failedCount: number;
-  cachedCount: number;
-  totalDurationMs: number;
-  totalRecordsExtracted: number;
-  totalBytesProcessed: number;
-  byEventType: Record<string, number>;
-  byBank: Record<string, number>;
-}
-export type ISummaryUsageRcbResponse = IResponse<IRcbUsageSummary>;
-
-export interface IRcbQuotaStatus {
-  tier: string;
-  used: { extractCalls: number; extractedRecords: number; bytesProcessed: number };
-  caps: {
-    monthlyExtractCap: number | null;
-    monthlyExtractedCap: number | null;
-    monthlyBytesCap: number | null;
-    queueOnlyAboveCount: number | null;
-  };
-  allowed: boolean;
-  force_queue: boolean;
-  reason: string | null;
-}
-export type IGetQuotaRcbResponse = IResponse<IRcbQuotaStatus>;
-
-// ─── WEBHOOK DELIVERIES ─────────────────────
-
-export interface IListWebhookDeliveriesRcbResponse {
-  data: IRcbWebhookDelivery[];
-  total?: number;
-}
-export type IGetWebhookDeliveryRcbResponse = IResponse<IRcbWebhookDelivery>;
-
-// ─── SHARE (public) ──────────────────────────
-
-export interface IGetSharedExtractionRcbData {
-  id: string;
-  mode: RcbExtractionMode;
-  strategy_used: string | null;
-  confidence: number | null;
-  records_count: number | null;
-  balance_validated: boolean | null;
-  records: IRcbTransaction[];
-  metadata: IRcbExtractionMetadata;
-  warnings: string[];
-  share_expires_at: string | null;
-  created_at: string;
-}
-export type IGetSharedExtractionRcbResponse = IResponse<IGetSharedExtractionRcbData>;
-
-export interface IMintShareExtractionRcbData {
-  share_url: string;
-  share_token: string;
-  share_expires_at: string | null;
-}
-export type IMintShareExtractionRcbResponse = IResponse<IMintShareExtractionRcbData>;
-
-// ─── CHANGELOG ──────────────────────────────
-
-export interface IChangelogRcbData {
-  current_version: string;
-  entries: Array<{ version: string; date: string; highlights: string[] }>;
-}
-export type IChangelogRcbResponse = IResponse<IChangelogRcbData>;
-
-// ─── ADMIN: CATALOGUE ────────────────────────
-
-export interface IListBankVersionsAdminRcbResponse {
-  data: IRcbBankVersion[];
-  total?: number;
-}
-export type IGetBankVersionAdminRcbResponse = IResponse<IRcbBankVersion>;
-export type IUpsertBankVersionAdminRcbResponse = IResponse<IRcbBankVersion>;
-
-export interface IReloadBankVersionsAdminRcbData {
-  loaded: number;
-  skipped: number;
-  total: number;
-}
-export type IReloadBankVersionsAdminRcbResponse = IResponse<IReloadBankVersionsAdminRcbData>;
-
-export type IGetQuotaAdminRcbResponse = IResponse<IRcbQuota | null>;
-export type IUpsertQuotaAdminRcbResponse = IResponse<IRcbQuota>;
-
-export interface IDetectorReplayAdminRcbData {
-  scanned: number;
-  kept: number;
-  flipped: number;
-  newDetections: number;
-  skipped: number;
-  details: unknown[];
-  durationMs: number;
-}
-export type IDetectorReplayAdminRcbResponse = IResponse<IDetectorReplayAdminRcbData>;
-
-export interface IListRequestLogAdminRcbData {
-  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 };
-}
-
-// ─── METRICS ────────────────────────────────
-
-export interface IRcbPerBankMetric {
-  bank: string;
-  extractions: number;
-  avgConfidence: number;
-  avgRecords: number;
-  balanceValidatedRate: number;
-  avgDurationMs: number;
-  feedbackOpen: number;
-}
-export type IPerBankMetricsAdminRcbResponse = IResponse<IRcbPerBankMetric[]>;
-
-export interface IRcbLatencyBucket {
-  bucket: string;
-  count: number;
-}
-export type ILatencyMetricsAdminRcbResponse = IResponse<IRcbLatencyBucket[]>;
-
-export interface IRcbOverviewMetrics {
-  last24h: { extractions: number; failures: number; avgLatencyMs: number };
-  last30d: { extractions: number; uniqueUsers: number };
-}
-export type IOverviewMetricsAdminRcbResponse = IResponse<IRcbOverviewMetrics>;
-
-// ─── WEBHOOK SUBSCRIPTIONS ──────────────────
-
-import type { IRcbWebhook } from '../../models/rcb.dto';
-
-export interface IPaginateRcbWebhookData {
-  rows: IRcbWebhook[];
-  total: number;
-}
-export type IPaginateRcbWebhookResponse = IResponse<IPaginateRcbWebhookData>;
-export type IGetRcbWebhookResponse = IResponse<{ webhook: IRcbWebhook }>;
-export type ICreateRcbWebhookResponse = IResponse<{ webhook: IRcbWebhook }>;
-export type IUpdateRcbWebhookResponse = IResponse<{ webhook: IRcbWebhook }>;
-export type IDeleteRcbWebhookResponse = IResponse<{ ok: true }>;
-export type IResetSecretRcbWebhookResponse = IResponse<{ webhook: IRcbWebhook }>;