@abyss-project/tools 2.4.0 → 2.5.0

package/dist/types/enum/file-scan-status.enum.d.ts

@@ -0,0 +1 @@
+export type FileScanStatus = 'pending_scan' | 'clean' | 'infected' | 'skipped' | 'error';

package/dist/types/enum/file-scan-status.enum.js

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

package/dist/types/enum/file-scan-status.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-scan-status.enum.js","sourceRoot":"","sources":["../../../src/types/enum/file-scan-status.enum.ts"],"names":[],"mappings":""}

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

@@ -12,3 +12,4 @@ export * from './provider-kind.enum';
 export * from './interpreter-kind.enum';
 export * from './combine-strategy.enum';
 export * from './probe-scan.enum';
+export * from './file-scan-status.enum';

package/dist/types/enum/index.js

@@ -28,4 +28,5 @@ __exportStar(require("./provider-kind.enum"), exports);
 __exportStar(require("./interpreter-kind.enum"), exports);
 __exportStar(require("./combine-strategy.enum"), exports);
 __exportStar(require("./probe-scan.enum"), exports);
+__exportStar(require("./file-scan-status.enum"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,kDAAgC;AAChC,4DAA0C;AAC1C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,kDAAgC;AAChC,4DAA0C;AAC1C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,oDAAkC;AAClC,0DAAwC"}

package/dist/types/interface/models/atlas-document.dto.d.ts

@@ -1,5 +1,6 @@
 import { IAtlasPage } from './atlas-page.dto';
 import { IAtlas } from './atlas.dto';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
 export interface IAtlasDocument {
     id: string;
     atlasPageId: string;
@@ -12,6 +13,7 @@ export interface IAtlasDocument {
     sizeOctet: number;
     mimeType: string;
     checksum: string;
+    scanStatus: FileScanStatus | null;
     createdAt?: Date;
     updatedAt?: Date;
     atlasPage?: IAtlasPage;

package/dist/types/interface/models/board-card-document.dto.d.ts

@@ -1,5 +1,6 @@
 import { IBoardCard } from './board-card.dto';
 import { IBoard } from './board.dto';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
 export interface IBoardCardDocument {
     id: string;
     boardCardId: string;
@@ -12,6 +13,7 @@ export interface IBoardCardDocument {
     checksum: string;
     mimeType: string;
     sizeOctet: number;
+    scanStatus: FileScanStatus | null;
     updatedAt?: Date;
     createdAt?: Date;
     boardCard: IBoardCard;

package/dist/types/interface/models/extraction.dto.d.ts

@@ -1,6 +1,7 @@
 import { ExtractionWarningCode } from '../../../types/enum/extraction-warning.enum';
 import { ExtractionFeedbackIssueType } from '../../../types/enum/extraction-feedback-issue-type.enum';
 import { DocumentType } from '../../../types/enum/document-type.enum';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
 import type { IFieldValue, IExecutionManifest, IGlobalConfidence } from './extraction-plan.dto';
 export { ExtractionFeedbackIssueType };
 export type ExtractionMode = 'auto' | 'hint' | 'template';
@@ -51,6 +52,7 @@ export interface IExtractionFile {
     detectedIban: string | null;
     detectedBic: string | null;
     detectedCurrency: string | null;
+    scanStatus: FileScanStatus | null;
     createdAt: string;
     updatedAt: string;
 }

package/dist/types/interface/models/extraction.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"extraction.dto.js","sourceRoot":"","sources":["../../../../src/types/interface/models/extraction.dto.ts"],"names":[],"mappings":";;;AAKA,yFAAoF;AA4E3E,sGA5EA,+CAAqB,OA4EA;AA3E9B,iHAAsG;AAK7F,4GALA,iEAA2B,OAKA;AAoQpC,IAAY,sBAYX;AAZD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,+DAAqC,CAAA;IACrC,+EAAqD,CAAA;IACrD,uEAA6C,CAAA;IAC7C,6DAAmC,CAAA;IACnC,2DAAiC,CAAA;IACjC,6DAAmC,CAAA;IACnC,uEAA6C,CAAA;IAC7C,uDAA6B,CAAA;IAC7B,mEAAyC,CAAA;IACzC,6DAAmC,CAAA;AACrC,CAAC,EAZW,sBAAsB,sCAAtB,sBAAsB,QAYjC;AAEY,QAAA,yBAAyB,GACpC,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAuCxC,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACrC,4CAAa,CAAA;IACb,0CAAW,CAAA;AACb,CAAC,EAHW,2BAA2B,2CAA3B,2BAA2B,QAGtC"}
+{"version":3,"file":"extraction.dto.js","sourceRoot":"","sources":["../../../../src/types/interface/models/extraction.dto.ts"],"names":[],"mappings":";;;AAKA,yFAAoF;AAwF3E,sGAxFA,+CAAqB,OAwFA;AAvF9B,iHAAsG;AAM7F,4GANA,iEAA2B,OAMA;AA+QpC,IAAY,sBAYX;AAZD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,+DAAqC,CAAA;IACrC,+EAAqD,CAAA;IACrD,uEAA6C,CAAA;IAC7C,6DAAmC,CAAA;IACnC,2DAAiC,CAAA;IACjC,6DAAmC,CAAA;IACnC,uEAA6C,CAAA;IAC7C,uDAA6B,CAAA;IAC7B,mEAAyC,CAAA;IACzC,6DAAmC,CAAA;AACrC,CAAC,EAZW,sBAAsB,sCAAtB,sBAAsB,QAYjC;AAEY,QAAA,yBAAyB,GACpC,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAuCxC,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACrC,4CAAa,CAAA;IACb,0CAAW,CAAA;AACb,CAAC,EAHW,2BAA2B,2CAA3B,2BAA2B,QAGtC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/tools",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Core package to interact with Abyss-Project Tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/types/enum/file-scan-status.enum.ts

@@ -0,0 +1,33 @@
+/**
+ * Antivirus scan verdict for a stored file, mirrored from AbyssStorage.
+ *
+ * Same vocabulary as `@abyss-project/storage`'s `FileScanStatus` enum
+ * (`application_files.scanStatus`): `pending_scan` | `clean` | `infected` |
+ * `skipped` | `error`. Intentionally re-declared here as a string union — NOT
+ * imported — because abyss-tools-core is standalone (does not depend on
+ * `@abyss-project/storage`), the same approach every other core package
+ * (abyss-main asset-core, abyss-banking-core, abyss-memories-core) takes for
+ * a mirrored external vocabulary. `BeamFileScanStatus` (beam.enum.ts) mirrors
+ * the SAME storage vocabulary as a real TS enum instead: that shape fits
+ * beam, which converts a single Map of live-read values at ONE serialization
+ * boundary (an explicit `Record<FileScanStatus, BeamFileScanStatus>`
+ * suffices there). This column is denormalized and WRITTEN from several call
+ * sites (webhook UPLOAD seed, webhook SCAN_RESULT update, cloud-import
+ * mirror, archive-upload seed) — a string union lets the backend assign a
+ * storage `FileScanStatus` enum value straight into it with no cast (a
+ * string-enum member is assignable to a matching string-literal union, but
+ * NOT to a distinct local enum with identical values), avoiding a repeated
+ * conversion Record at every one of those sites. Keep the members in sync
+ * with storage's enum.
+ *
+ * Storage-neutral posture (ADR-0038): this field is purely informational —
+ * exposed so the front can render an AbyssProbe indicator (clean / "en
+ * analyse" / infected). Nothing in abyss-tools purges an infected row,
+ * redacts a servable id, or blocks a read while pending; the front decides
+ * what to show (e.g. blurring a pending thumbnail).
+ *
+ * Used by BoardCardDocument, AtlasDocument and ExtractionFile (the last only
+ * for an archive-owned row — see ExtractionFile.scanStatus's own doc
+ * comment).
+ */
+export type FileScanStatus = 'pending_scan' | 'clean' | 'infected' | 'skipped' | 'error';

package/src/types/enum/index.ts

@@ -12,3 +12,4 @@ export * from './provider-kind.enum';
 export * from './interpreter-kind.enum';
 export * from './combine-strategy.enum';
 export * from './probe-scan.enum';
+export * from './file-scan-status.enum';

package/src/types/interface/models/atlas-document.dto.ts

@@ -1,5 +1,6 @@
 import { IAtlasPage } from './atlas-page.dto';
 import { IAtlas } from './atlas.dto';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
 
 export interface IAtlasDocument {
   id: string;
@@ -13,6 +14,15 @@ export interface IAtlasDocument {
   sizeOctet: number;
   mimeType: string;
   checksum: string;
+  /**
+   * Antivirus verdict mirrored from AbyssStorage (denormalized, seeded at the
+   * UPLOAD webhook and updated by the SCAN_RESULT webhook — see
+   * storage-webhook.service.ts#handleScanResult). Null for a document
+   * created before this column existed. Storage-neutral (ADR-0038): purely
+   * informational — never redacted, never gates a read. The front renders
+   * the AbyssProbe indicator (and blurs a pending thumbnail) from this field.
+   */
+  scanStatus: FileScanStatus | null;
   createdAt?: Date;
   updatedAt?: Date;
 

package/src/types/interface/models/board-card-document.dto.ts

@@ -1,5 +1,6 @@
 import { IBoardCard } from './board-card.dto';
 import { IBoard } from './board.dto';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
 
 export interface IBoardCardDocument {
   id: string;
@@ -13,6 +14,15 @@ export interface IBoardCardDocument {
   checksum: string;
   mimeType: string;
   sizeOctet: number;
+  /**
+   * Antivirus verdict mirrored from AbyssStorage (denormalized, seeded at the
+   * UPLOAD webhook and updated by the SCAN_RESULT webhook — see
+   * storage-webhook.service.ts#handleScanResult). Null for a document
+   * created before this column existed. Storage-neutral (ADR-0038): purely
+   * informational — never redacted, never gates a read. The front renders
+   * the AbyssProbe indicator (and blurs a pending thumbnail) from this field.
+   */
+  scanStatus: FileScanStatus | null;
   updatedAt?: Date;
   createdAt?: Date;
 

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

@@ -6,6 +6,7 @@
 import { ExtractionWarningCode } from '../../../types/enum/extraction-warning.enum';
 import { ExtractionFeedbackIssueType } from '../../../types/enum/extraction-feedback-issue-type.enum';
 import { DocumentType } from '../../../types/enum/document-type.enum';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
 import type { IFieldValue, IExecutionManifest, IGlobalConfidence } from './extraction-plan.dto';
 
 // Re-export so consumers can import ExtractionFeedbackIssueType from the DTO barrel.
@@ -74,6 +75,17 @@ export interface IExtractionFile {
   detectedIban: string | null;
   detectedBic: string | null;
   detectedCurrency: string | null;
+  /**
+   * Antivirus verdict mirrored from AbyssStorage for an ARCHIVE-OWNED file
+   * only (seeded at extractionFileService.upsert from the archive-upload
+   * response — see extraction-extract.service.ts#archivePdf — and updated by
+   * the SCAN_RESULT webhook, storage-webhook.service.ts#handleScanResult).
+   * Null for a by-reference file (AbyssExtract never requested that scan, so
+   * it never mirrors a verdict for it) and for rows created before this
+   * column existed. Storage-neutral (ADR-0038): purely informational — never
+   * redacted, never gates a read.
+   */
+  scanStatus: FileScanStatus | null;
   createdAt: string;
   updatedAt: string;
 }