@abyss-project/tools 1.0.3 → 1.1.1

package/src/types/enum/beam.enum.ts

@@ -0,0 +1,24 @@
+// AbyssBeam transfer visibility (design D7). PUBLIC = a contentShare LINK so the
+// /b/:slug link works for anyone until expiry; RESTRICTED = USER/ORG/TEAM/PROJECT
+// grants resolved via contentShare.resolveAccess (>= VIEW). Password is an
+// independent second factor, NOT a visibility level.
+export enum BeamVisibility {
+  PUBLIC = 'PUBLIC',
+  RESTRICTED = 'RESTRICTED',
+}
+
+// Machine-readable denial reason returned on the public serving discovery path
+// (GET /b/:slug) so the front renders the correct state from the reason code
+// rather than inferring it from the bare HTTP status (spec §17.1). Mirrors the
+// backend `BeamServeDenyReason`; only the non-password discovery denials are
+// surfaced here (PASSWORD_REQUIRED is not a VIEW denial — the metadata is still
+// returned with isLocked=true). Byte endpoints (/file, /raw, /thumb, /zip) stay
+// bare-status by design (CDN-visible), so this reason is a VIEW-only signal.
+export enum BeamServeDenyReasonCode {
+  NOT_FOUND = 'not_found',
+  EXPIRED = 'expired',
+  FORBIDDEN_VISIBILITY = 'forbidden_visibility',
+  MAX_DOWNLOADS = 'max_downloads',
+  SCAN_PENDING = 'scan_pending',
+  SCAN_INFECTED = 'scan_infected',
+}

package/src/types/enum/combine-strategy.enum.ts

@@ -0,0 +1,7 @@
+// Combine strategy enum — mirror apps/api plan.types.ts exactly.
+
+export enum CombineStrategy {
+  MAX_CONFIDENCE = 'maxConfidence',
+  FIRST_WINS = 'firstWins',
+  VOTE = 'vote',
+}

package/src/types/enum/content-share.enum.ts

@@ -1,36 +1,38 @@
-export enum ShareableContentType {
-  DRAW = 'draw',
-  BOARD = 'board',
-  MEMO = 'memo',
-  ATLAS = 'atlas',
-  RETROSPECTIVE = 'retrospective',
-  SHORT_LINK = 'short_link',
-  CLOUD_FILE = 'cloud_file',
-  CLOUD_FOLDER = 'cloud_folder',
-  CLOUD_GALLERY = 'cloud_gallery',
-  FORM = 'form',
-  SPOTLIGHT_PROJECT = 'spotlight_project',
-  EVENT = 'event',
-  REPORT = 'report',
-  PDF = 'pdf',
-}
-
-export enum ShareTargetType {
-  USER = 'USER',
-  TEAM = 'TEAM',
-  ORGANIZATION = 'ORGANIZATION',
-  LINK = 'LINK',
-}
-
-export enum SharePermission {
-  VIEW = 'VIEW',
-  EDIT = 'EDIT',
-  MANAGE = 'MANAGE',
-}
-
-export enum ContentShareScope {
-  ORGANIZATION = 'ORGANIZATION',
-  ORG_USER = 'ORG_USER',
-  ORG_TEAM = 'ORG_TEAM',
-  ORG_PROJECT = 'ORG_PROJECT',
-}
+export enum ShareableContentType {
+  DRAW = 'draw',
+  BOARD = 'board',
+  MEMO = 'memo',
+  ATLAS = 'atlas',
+  RETROSPECTIVE = 'retrospective',
+  SHORT_LINK = 'short_link',
+  CLOUD_FILE = 'cloud_file',
+  CLOUD_FOLDER = 'cloud_folder',
+  CLOUD_GALLERY = 'cloud_gallery',
+  FORM = 'form',
+  SPOTLIGHT_PROJECT = 'spotlight_project',
+  EVENT = 'event',
+  REPORT = 'report',
+  PDF = 'pdf',
+  BEAM = 'beam',
+}
+
+export enum ShareTargetType {
+  USER = 'USER',
+  TEAM = 'TEAM',
+  ORGANIZATION = 'ORGANIZATION',
+  PROJECT = 'PROJECT',
+  LINK = 'LINK',
+}
+
+export enum SharePermission {
+  VIEW = 'VIEW',
+  EDIT = 'EDIT',
+  MANAGE = 'MANAGE',
+}
+
+export enum ContentShareScope {
+  ORGANIZATION = 'ORGANIZATION',
+  ORG_USER = 'ORG_USER',
+  ORG_TEAM = 'ORG_TEAM',
+  ORG_PROJECT = 'ORG_PROJECT',
+}

package/src/types/enum/document-type.enum.ts

@@ -0,0 +1,10 @@
+// Document types supported by AbyssExtract. bank_statement is the legacy RCB profile.
+export enum DocumentType {
+  BANK_STATEMENT = 'bank_statement',
+  INVOICE = 'invoice',
+  RECEIPT = 'receipt',
+  ID_CARD = 'id_card',
+  RIB = 'rib',
+  FINANCIAL_STATEMENT = 'financial_statement',
+  GENERIC = 'generic',
+}

package/src/types/enum/extraction-feedback-issue-type.enum.ts

@@ -0,0 +1,10 @@
+// Global, document-type-agnostic feedback issue taxonomy for AbyssExtract.
+// fieldKey localizes the issue to a specific extracted field when relevant.
+export enum ExtractionFeedbackIssueType {
+  WRONG_VALUE = 'WRONG_VALUE',
+  MISSING_FIELD = 'MISSING_FIELD',
+  WRONG_DOCUMENT_TYPE = 'WRONG_DOCUMENT_TYPE',
+  EXTRA_RECORD = 'EXTRA_RECORD',
+  WRONG_RECORD = 'WRONG_RECORD',
+  OTHER = 'OTHER',
+}

package/src/types/enum/extraction-warning.enum.ts

@@ -0,0 +1,21 @@
+// ──────────────────────────────────────────────
+// ExtractionWarningCode — structured warning codes 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 ExtractionWarningCode {
+  NO_RECORDS = 'no_records',
+  NO_IBAN = 'no_iban',
+  NO_BALANCES = 'no_balances',
+  BALANCE_MISMATCH = 'balance_mismatch',
+  /**
+   * A coherence validation error produced by an adapter's `validate()` call.
+   * `data.type` carries the adapter-specific error/warning type (e.g.
+   * `ACTIF_PASSIF_MISMATCH`, `TOTAL_MISMATCH`, `MRZ_INVALID`) and
+   * `data.message` carries the human-readable explanation. This allows
+   * arbitrary adapter validation results to surface without extending the
+   * enum for each domain-specific rule.
+   */
+  ADAPTER_VALIDATION_ERROR = 'adapter_validation_error',
+}

package/src/types/enum/index.ts

@@ -1,6 +1,13 @@
-export * from './api-error.enum';
-export * from './board-activity.enum';
-export * from './board-column-type.enum';
-export * from './content-share.enum';
-export * from './pdf-operation.enum';
-export * from './rcb-bank.enum';
+export * from './api-error.enum';
+export * from './board-activity.enum';
+export * from './board-column-type.enum';
+export * from './content-share.enum';
+export * from './beam.enum';
+export * from './document-type.enum';
+export * from './pdf-operation.enum';
+export * from './rcb-bank.enum';
+export * from './extraction-warning.enum';
+export * from './extraction-feedback-issue-type.enum';
+export * from './provider-kind.enum';
+export * from './interpreter-kind.enum';
+export * from './combine-strategy.enum';

package/src/types/enum/interpreter-kind.enum.ts

@@ -0,0 +1,7 @@
+// Interpreter kind enum — mirror apps/api interpreter.interface.ts exactly.
+
+export enum InterpreterKind {
+  ALGORITHMIC = 'algorithmic',
+  TEMPLATE = 'template',
+  LLM = 'llm',
+}

package/src/types/enum/provider-kind.enum.ts

@@ -0,0 +1,13 @@
+// Provider kind and cost tier enums — mirror apps/api provider.interface.ts exactly.
+
+export enum ProviderKind {
+  TEXT = 'text',
+  OCR = 'ocr',
+  AI = 'ai',
+}
+
+export enum CostTier {
+  CHEAP = 'cheap',
+  MEDIUM = 'medium',
+  EXPENSIVE = 'expensive',
+}

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

@@ -0,0 +1,152 @@
+import { ContentShareScope } from '../../../enum';
+import { ShareTargetType, SharePermission } from '../../../enum/content-share.enum';
+import { BeamVisibility } from '../../../enum/beam.enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type IGetBeamParams = {
+  beamId: string;
+};
+
+export type IGetBeamBySlugParams = {
+  slug: string;
+};
+
+export type IPaginateBeamQuery = {
+  title?: string;
+  isActive?: boolean;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectBeamParams = {
+  projectId: string;
+};
+
+export type IPaginateOrganizationBeamParams = {
+  organizationId: string;
+};
+
+// Draft-creation metadata bundle (design §4 step 1). Files are attached
+// afterwards (B2) and the transfer is sealed at finalize (B5).
+export type ICreateBeamBody = {
+  title?: string;
+  message?: string;
+  visibility?: BeamVisibility;
+  expiresInDays?: number;
+  password?: string;
+  maxDownloads?: number;
+  recipients?: { email: string; locale?: string }[];
+};
+
+// Anonymous draft creation (POST /beam/public). Same metadata as the owned
+// create minus expiresInDays — anonymous TTL is fixed at 7 days by createDraft.
+export type ICreateBeamPublicBody = {
+  title?: string;
+  message?: string;
+  visibility?: BeamVisibility;
+  password?: string;
+  maxDownloads?: number;
+  recipients?: { email: string; locale?: string }[];
+};
+
+export interface IAddBeamFilesParams {
+  beamId: string;
+}
+
+export interface IAddBeamFilesBody {
+  files: { storageFileId: string }[];
+}
+
+export interface IImportCloudBeamFilesParams {
+  beamId: string;
+}
+
+export interface IImportCloudBeamFilesBody {
+  cloudFileIds: string[];
+}
+
+export interface IFinalizeBeamParams {
+  beamId: string;
+}
+
+export type IFinalizeBeamBody = Record<string, never>;
+
+export type ICreateForOrganizationBeamParams = {
+  organizationId: string;
+};
+
+export type IUpdateBeamParams = {
+  beamId: string;
+};
+
+export type IUpdateBeamBody = {
+  title?: string;
+  message?: string;
+  visibility?: BeamVisibility;
+  isActive?: boolean;
+  expiresAt?: Date | null;
+  maxDownloads?: number | null;
+};
+
+export type IDeleteBeamParams = {
+  beamId: string;
+};
+
+// Public serving (B3): unlock a password-protected transfer to obtain a
+// short-lived unlock token used by the byte-serving endpoints.
+export interface IUnlockBeamPublicParams {
+  slug: string;
+}
+
+export interface IUnlockBeamPublicBody {
+  password: string;
+}
+
+// Management lifecycle (B4): renew/reactivate take only the transfer id. Both
+// push expiresAt forward and reactivate the transfer server-side.
+export interface IRenewBeamParams {
+  beamId: string;
+}
+
+export interface IReactivateBeamParams {
+  beamId: string;
+}
+
+// Sharing (B4): a MANAGE holder grants a content_share (BEAM content type) on the
+// transfer. targetId is null for a LINK share, otherwise the user/team/org/project id.
+export interface ICreateBeamShareParams {
+  beamId: string;
+}
+
+export interface ICreateBeamShareBody {
+  targetType: ShareTargetType;
+  targetId?: string | null;
+  permission: SharePermission;
+}
+
+export interface IListBeamSharesParams {
+  beamId: string;
+}
+
+export interface IRevokeBeamShareParams {
+  beamId: string;
+  shareId: string;
+}
+
+// Recipients (B5): add extra recipients to a transfer (explicit add path,
+// distinct from the recipients recorded at draft time). Capped at
+// MAX_BEAM_RECIPIENTS on the API side.
+export interface IAddRecipientsBeamParams {
+  beamId: string;
+}
+
+export interface IAddRecipientsBeamBody {
+  recipients: { email: string; locale?: string | null }[];
+}
+
+export interface IListRecipientsBeamParams {
+  beamId: string;
+}