@abyss-project/tools 1.0.0 → 1.0.3

package/src/types/interface/models/rcb.dto.ts

@@ -0,0 +1,267 @@
+// ──────────────────────────────────────────────
+// RCB (Relevé de Compte Bancaire) DTOs.
+// Mirror server-side Sequelize models, dates serialized as ISO strings.
+// ──────────────────────────────────────────────
+
+export type RcbExtractionMode = 'auto' | 'hint' | 'template';
+export type RcbProcessingMode = 'sync' | 'queue';
+export type RcbExtractionStatus = 'pending' | 'completed' | 'failed' | 'cached';
+
+export type RcbFeedbackIssueType =
+  | 'missing_record'
+  | 'wrong_sign'
+  | 'wrong_amount'
+  | 'wrong_date'
+  | 'wrong_description'
+  | 'duplicate'
+  | 'other';
+
+export type RcbFeedbackStatus = 'open' | 'triaged' | 'fixed' | 'closed';
+
+export type RcbUsageEventType =
+  | 'extract.sync.success'
+  | 'extract.sync.cached'
+  | 'extract.sync.failed'
+  | 'extract.queue.enqueued'
+  | 'extract.queue.success'
+  | 'extract.queue.cached'
+  | 'extract.queue.failed'
+  | 'template.run.success'
+  | 'template.run.failed';
+
+export interface IRcbBankHint {
+  bank: string;
+  version?: string;
+}
+
+export interface IRcbTransaction {
+  date?: string;
+  description?: string;
+  amount?: number;
+  balance?: number;
+  valueDate?: string;
+  bookingDate?: string;
+  reference?: string;
+  [k: string]: unknown;
+}
+
+export interface IRcbExtractionMetadata {
+  iban?: string;
+  bic?: string;
+  bank?: string;
+  accountHolder?: string;
+  periodStart?: string;
+  periodEnd?: string;
+  openingBalance?: number;
+  closingBalance?: number;
+  currency?: string;
+  [k: string]: unknown;
+}
+
+export interface IRcbFile {
+  id: string;
+  userId: string;
+  applicationId: string | null;
+  pdfHash: string;
+  pdfSizeBytes: number;
+  pdfMimeType: string;
+  pdfPageCount: number | null;
+  pdfFilename: string | null;
+  applicationFileId: string | null;
+  userExternalId: string | null;
+  userMetadata: Record<string, unknown> | null;
+  detectedBank: string | null;
+  detectedVersion: string | null;
+  detectedIban: string | null;
+  detectedBic: string | null;
+  detectedCurrency: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+// Structured warning emitted by the extraction orchestrator. The `code`
+// is the i18n key suffix, `data` carries numeric/string values the UI
+// formats locally (currencies, dates, etc.).
+export enum RcbWarningCode {
+  NO_RECORDS = 'no_records',
+  NO_IBAN = 'no_iban',
+  NO_BALANCES = 'no_balances',
+  BALANCE_MISMATCH = 'balance_mismatch',
+}
+
+export interface IRcbWarning {
+  code: RcbWarningCode;
+  data?: {
+    actualCents?: number;
+    expectedCents?: number;
+    currency?: string;
+  };
+}
+
+export interface IRcbExtraction {
+  id: string;
+  fileId: string;
+  mode: RcbExtractionMode;
+  hintBank: string | null;
+  hintVersion: string | null;
+  templateId: string | null;
+  templateVersion: number | null;
+  status: RcbExtractionStatus;
+  strategyUsed: string | null;
+  confidence: number | null;
+  recordsCount: number | null;
+  balanceValidated: boolean | null;
+  durationMs: number | null;
+  error: string | null;
+  recordsJson: IRcbTransaction[] | null;
+  metadataJson: IRcbExtractionMetadata | null;
+  warningsJson: IRcbWarning[] | null;
+  tags: string[] | null;
+  note: string | null;
+  shareToken: string | null;
+  shareExpiresAt: string | null;
+  createdAt: string;
+}
+
+export interface IRcbTemplate {
+  id: string;
+  userId: string;
+  name: string;
+  description: string | null;
+  isActive: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+/**
+ * Spatial zone on a PDF page (PDF coords: origin bottom-left, points).
+ * Restricts regex matching to a specific rectangle.
+ */
+export interface IRcbTemplateZone {
+  name: string;
+  page: number; // 1-indexed
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+}
+
+/**
+ * Typed shape of the template DSL JSON stored in `templateJson`. Mirrors
+ * `TemplateDSL` server-side. UI editors should narrow `templateJson` to this
+ * shape via `templateJson as IRcbTemplateDsl`.
+ */
+export interface IRcbTemplateDsl {
+  regex_iban?: string;
+  regex_bic?: string;
+  period?: { regex: string };
+  balance?: { opening_regex?: string; closing_regex?: string };
+  transactions?: {
+    row_pattern: string;
+    date_format?: string;
+    amount_locale?: 'fr' | 'en';
+    sign_rule?: 'explicit' | 'keyword';
+  };
+  skip_patterns?: string[];
+  zones?: IRcbTemplateZone[];
+}
+
+export interface IRcbTemplateVersion {
+  id: string;
+  templateId: string;
+  version: number;
+  templateJson: Record<string, unknown>;
+  comment: string | null;
+  createdAt: string;
+}
+
+export interface IRcbFeedback {
+  id: string;
+  extractionId: string;
+  userId: string;
+  issueType: RcbFeedbackIssueType;
+  description: string | null;
+  status: RcbFeedbackStatus;
+  createdAt: string;
+}
+
+export interface IRcbWebhookDelivery {
+  id: string;
+  userId: string | null;
+  organizationId: string | null;
+  projectId: string | null;
+  createdByUserId: string | null;
+  webhookId: string | null;
+  jobId: string | null;
+  event: string;
+  url: string;
+  payloadJson: Record<string, unknown>;
+  attempts: number;
+  lastStatus: number | null;
+  lastError: string | null;
+  deliveredAt: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+// Webhook event identifier. Values mirror AbyssApplicationEvent's RCB_*
+// entries so a logger.log(applicationEvent: ...) and a webhook delivery
+// can never drift.
+export enum RcbWebhookEvent {
+  EXTRACT_COMPLETED = 'rcb.extract.completed',
+  EXTRACT_FAILED = 'rcb.extract.failed',
+  EXTRACT_LOW_CONFIDENCE = 'rcb.extract.low-confidence',
+  EXTRACT_BALANCE_KO = 'rcb.extract.balance-ko',
+  FILE_ARCHIVED = 'rcb.file.archived',
+  SHARE_MINTED = 'rcb.share.minted',
+  SHARE_REVOKED = 'rcb.share.revoked',
+  FEEDBACK_SUBMITTED = 'rcb.feedback.submitted',
+  JOB_FAILED = 'rcb.job.failed',
+  EXPORT_COMPLETED = 'rcb.export.completed',
+  EXPORT_FAILED = 'rcb.export.failed',
+}
+
+export const RCB_WEBHOOK_EVENTS: RcbWebhookEvent[] =
+  Object.values(RcbWebhookEvent);
+
+export interface IRcbWebhook {
+  id: string;
+  userId: string | null;
+  organizationId: string | null;
+  projectId: string | null;
+  createdByUserId: string | null;
+  webhookUrl: string;
+  webhookSecret: string;
+  isEnabled: boolean;
+  name: string;
+  description: string;
+  scopes: RcbWebhookEvent[];
+  consecutiveFailures: number;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface IRcbQuota {
+  userId: string;
+  tier: string;
+  monthlyExtractCap: number | null;
+  monthlyExtractedCap: number | null;
+  monthlyBytesCap: number | null;
+  queueOnlyAboveCount: number | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface IRcbBankVersion {
+  id: string;
+  bank: string;
+  version: string;
+  validFrom: string | null;
+  validTo: string | null;
+  detectorJson: Record<string, unknown>;
+  parserKind: string;
+  configJson: Record<string, unknown>;
+  isActive: boolean;
+  createdAt: string;
+  updatedAt: string;
+}

package/src/types/interface/models/retrospective-card.dto.ts

@@ -1,17 +1,17 @@
-import { IRetrospectiveMember } from './retrospective-member.dto';
-import { IRetrospective } from './retrospective.dto';
-
-export interface IRetrospectiveCard {
-  id: string;
-  content: string;
-  positionX: number;
-  positionY: number;
-  retrospectiveId: string;
-  retrospectiveMemberId?: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  retrospective?: IRetrospective;
-  retrospectiveMember?: IRetrospectiveMember;
-}
+import { IRetrospectiveMember } from './retrospective-member.dto';
+import { IRetrospective } from './retrospective.dto';
+
+export interface IRetrospectiveCard {
+  id: string;
+  content: string;
+  positionX: number;
+  positionY: number;
+  retrospectiveId: string;
+  retrospectiveMemberId?: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  retrospective?: IRetrospective;
+  retrospectiveMember?: IRetrospectiveMember;
+}

package/src/types/interface/models/retrospective-member.dto.ts

@@ -1,15 +1,15 @@
-import { IRetrospective } from './retrospective.dto';
-
-export interface IRetrospectiveMember {
-  id: string;
-  alias: string | null;
-  userId: string | null;
-  externalUserId: string | null;
-  unmaskedAt: Date | null;
-  retrospectiveId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  retrospective?: IRetrospective;
-}
+import { IRetrospective } from './retrospective.dto';
+
+export interface IRetrospectiveMember {
+  id: string;
+  alias: string | null;
+  userId: string | null;
+  externalUserId: string | null;
+  unmaskedAt: Date | null;
+  retrospectiveId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  retrospective?: IRetrospective;
+}

package/src/types/interface/models/retrospective-section.dto.ts

@@ -1,16 +1,16 @@
-import { IRetrospective } from './retrospective.dto';
-
-export interface IRetrospectiveSection {
-  id: string;
-  title: string;
-  description: string;
-  color: string;
-  positionX: number;
-  positionY: number;
-  retrospectiveId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  retrospective?: IRetrospective;
-}
+import { IRetrospective } from './retrospective.dto';
+
+export interface IRetrospectiveSection {
+  id: string;
+  title: string;
+  description: string;
+  color: string;
+  positionX: number;
+  positionY: number;
+  retrospectiveId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  retrospective?: IRetrospective;
+}

package/src/types/interface/models/retrospective.dto.ts

@@ -1,32 +1,32 @@
-import { IOrganization } from './organization.dto';
-import { IProject } from './project.dto';
-import { IRetrospectiveCard } from './retrospective-card.dto';
-import { IRetrospectiveMember } from './retrospective-member.dto';
-import { IRetrospectiveSection } from './retrospective-section.dto';
-import { IEntityUserTag } from './user-tag.dto';
-import { IUser } from './user.dto';
-
-export interface IRetrospective {
-  id: string;
-  title: string;
-  description: string;
-  startDate: Date | null;
-  endDate: Date | null;
-  completedAt: Date | null;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  archivedAt: Date | null;
-  publicAccessToken: string | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  retrospectiveSections?: IRetrospectiveSection[];
-  retrospectiveCards?: IRetrospectiveCard[];
-  retrospectiveMembers?: IRetrospectiveMember[];
-  entityUserTags?: IEntityUserTag[];
-}
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IRetrospectiveCard } from './retrospective-card.dto';
+import { IRetrospectiveMember } from './retrospective-member.dto';
+import { IRetrospectiveSection } from './retrospective-section.dto';
+import { IEntityTag } from './tag.dto';
+import { IUser } from './user.dto';
+
+export interface IRetrospective {
+  id: string;
+  title: string;
+  description: string;
+  startDate: Date | null;
+  endDate: Date | null;
+  completedAt: Date | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  archivedAt: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  retrospectiveSections?: IRetrospectiveSection[];
+  retrospectiveCards?: IRetrospectiveCard[];
+  retrospectiveMembers?: IRetrospectiveMember[];
+  entityTags?: IEntityTag[];
+}

package/src/types/interface/models/short-link-click.dto.ts

@@ -1,33 +1,33 @@
-import { IShortLink } from './short-link.dto';
-
-export interface IShortLinkClick {
-  id: string;
-  shortLinkId: string;
-  ipAddress: string | null;
-  ipHash: string;
-  userAgent: string | null;
-  referer: string | null;
-  refererDomain: string | null;
-  /** Code pays ISO-3 (ex: "FRA", "USA", "DEU") */
-  countryCodeIso: string | null;
-  countryCode: string | null;
-  countryName: string | null;
-  continentCode: string | null;
-  city: string | null;
-  device: string | null;
-  browser: string | null;
-  os: string | null;
-  language: string | null;
-  utmSource: string | null;
-  utmMedium: string | null;
-  utmCampaign: string | null;
-  utmTerm: string | null;
-  utmContent: string | null;
-  isBotLikely: boolean;
-  isReturningVisitor: boolean;
-  clickedAt: Date;
-  createdAt?: Date;
-  updatedAt?: Date;
-
-  shortLink?: IShortLink;
-}
+import { IShortLink } from './short-link.dto';
+
+export interface IShortLinkClick {
+  id: string;
+  shortLinkId: string;
+  ipAddress: string | null;
+  ipHash: string;
+  userAgent: string | null;
+  referer: string | null;
+  refererDomain: string | null;
+  /** Code pays ISO-3 (ex: "FRA", "USA", "DEU") */
+  countryCodeIso: string | null;
+  countryCode: string | null;
+  countryName: string | null;
+  continentCode: string | null;
+  city: string | null;
+  device: string | null;
+  browser: string | null;
+  os: string | null;
+  language: string | null;
+  utmSource: string | null;
+  utmMedium: string | null;
+  utmCampaign: string | null;
+  utmTerm: string | null;
+  utmContent: string | null;
+  isBotLikely: boolean;
+  isReturningVisitor: boolean;
+  clickedAt: Date;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  shortLink?: IShortLink;
+}

package/src/types/interface/models/short-link.dto.ts

@@ -1,48 +1,49 @@
-import { IOrganization } from './organization.dto';
-import { IUser } from './user.dto';
-import { IProject } from './project.dto';
-import { IShortLinkClick } from './short-link-click.dto';
-import { IEntityUserTag } from './user-tag.dto';
-
-export interface IShortLink {
-  id: string;
-  slug: string;
-  originalUrl: string;
-  title: string | null;
-  description: string | null;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  isActive: boolean;
-  clickCount: number;
-  uniqueClickCount: number;
-  lastClickedAt: Date | null;
-  expiresAt: Date | null;
-  maxClicks: number | null;
-  password: string | null;
-  createdAt?: Date;
-  updatedAt?: Date;
-  deletedAt?: Date | null;
-
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  shortLinkClicks?: IShortLinkClick[];
-  entityUserTags?: IEntityUserTag[];
-}
-
-export interface IShortLinkWithStats extends IShortLink {
-  stats?: {
-    clicksByDay: { date: string; clicks: number; uniqueClicks: number }[];
-    clicksByCountry: { country: string; clicks: number; countryName: string }[];
-    clicksByDevice: { device: string; clicks: number }[];
-    clicksByBrowser: { browser: string; clicks: number }[];
-    clicksByReferer: { referer: string; clicks: number }[];
-    clicksByUtmSource: { utmSource: string; clicks: number }[];
-    clicksByLanguage: { language: string; clicks: number }[];
-    clicksByRefererDomain: { refererDomain: string; clicks: number }[];
-    clicksLast24h: number;
-    returningVisitorsCount: number;
-    botClicksCount: number;
-  };
-}
+import { IOrganization } from './organization.dto';
+import { IUser } from './user.dto';
+import { IProject } from './project.dto';
+import { IShortLinkClick } from './short-link-click.dto';
+import { IEntityTag } from './tag.dto';
+
+export interface IShortLink {
+  id: string;
+  slug: string;
+  originalUrl: string;
+  title: string | null;
+  description: string | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  isActive: boolean;
+  clickCount: number;
+  uniqueClickCount: number;
+  lastClickedAt: Date | null;
+  expiresAt: Date | null;
+  maxClicks: number | null;
+  password: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date | null;
+
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  shortLinkClicks?: IShortLinkClick[];
+  entityTags?: IEntityTag[];
+}
+
+export interface IShortLinkWithStats extends IShortLink {
+  stats?: {
+    clicksByDay: { date: string; clicks: number; uniqueClicks: number }[];
+    clicksByCountry: { country: string; clicks: number; countryName: string }[];
+    clicksByDevice: { device: string; clicks: number }[];
+    clicksByBrowser: { browser: string; clicks: number }[];
+    clicksByReferer: { referer: string; clicks: number }[];
+    clicksByUtmSource: { utmSource: string; clicks: number }[];
+    clicksByLanguage: { language: string; clicks: number }[];
+    clicksByRefererDomain: { refererDomain: string; clicks: number }[];
+    clicksLast24h: number;
+    returningVisitorsCount: number;
+    botClicksCount: number;
+  };
+}

package/src/types/interface/models/{user-tag.dto.ts → tag.dto.ts}

@@ -1,26 +1,26 @@
-export interface IUserTag {
-  id: string;
-  name: string;
-  color: string;
-  userId: string;
-  organizationId: string | null;
-  createdAt?: Date;
-  updatedAt?: Date;
-}
-
-// Junction type for entity-tag relationships
-export interface IEntityUserTag {
-  id: string;
-  entityId: string;
-  entityType: string;
-  userTagId: string;
-  createdAt?: Date;
-  userTag?: IUserTag | null;
-}
-
-// Stats entry for tag usage counts
-export interface IUserTagStatEntry {
-  userTagId: string;
-  entityType: string;
-  count: number;
-}
+export interface ITag {
+  id: string;
+  name: string;
+  color: string;
+  userId: string;
+  organizationId: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+// Junction type for entity-tag relationships
+export interface IEntityTag {
+  id: string;
+  entityId: string;
+  entityType: string;
+  tagId: string;
+  createdAt?: Date;
+  tag?: ITag | null;
+}
+
+// Stats entry for tag usage counts
+export interface ITagStatEntry {
+  tagId: string;
+  entityType: string;
+  count: number;
+}

package/src/types/interface/models/team.dto.ts

@@ -0,0 +1,12 @@
+import { IOrganization } from './organization.dto';
+
+export interface ITeam {
+  id?: string;
+  organizationId: string;
+  name: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  organization?: IOrganization;
+}