@abyss-project/tools 1.2.0 → 1.4.0

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

@@ -3,7 +3,11 @@
 // ──────────────────────────────────────────────
 
 import { IResponse } from '../type-message/response';
-import type { IExtractionPlanPreset, IExtractModesData, IFieldValue } from '../../models/extraction-plan.dto';
+import type {
+  IExtractionPlanPreset,
+  IExtractModesData,
+  IFieldValue,
+} from '../../models/extraction-plan.dto';
 import {
   IExtractionBankVersion,
   IExtraction,
@@ -134,7 +138,11 @@ export interface IDiffExtractionsData {
   same: number;
   added: IExtractionTransaction[];
   removed: IExtractionTransaction[];
-  changed: Array<{ before: IExtractionTransaction; after: IExtractionTransaction; fields: string[] }>;
+  changed: Array<{
+    before: IExtractionTransaction;
+    after: IExtractionTransaction;
+    fields: string[];
+  }>;
   summary: { leftCount: number; rightCount: number; sumDeltaCents: number };
 }
 export type IDiffExtractionsResponse = IResponse<IDiffExtractionsData>;
@@ -180,6 +188,15 @@ export type IGetTemplateResponse = IResponse<IGetTemplateData>;
 
 export type IListTemplateVersionsResponse = IResponse<IExtractionTemplateVersion[]>;
 
+/** Presigned download reference for a version's witness PDF. */
+export interface IGetTemplateWitnessUrlData {
+  /** Presigned DOWNLOAD URL (time-limited). */
+  url: string;
+  filename: string | null;
+  size_bytes: number | null;
+}
+export type IGetTemplateWitnessUrlResponse = IResponse<IGetTemplateWitnessUrlData>;
+
 // Deferred wire-schema rename — must match server SCHEMA constant in
 // extraction-template-portability.service.ts; rename together in the server/main batch.
 export interface IExtractionTemplateCollection {

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

@@ -1,7 +1,7 @@
 import { IOrganization } from './organization.dto';
 import { IUser } from './user.dto';
 import { IProject } from './project.dto';
-import { BeamVisibility } from '../../enum/beam.enum';
+import { BeamVisibility, BeamDownloadKind } from '../../enum/beam.enum';
 
 export interface IBeamTransfer {
   id: string;
@@ -65,3 +65,22 @@ export interface IBeamRecipient {
 
   transfer?: IBeamTransfer;
 }
+
+// One download-history event (B-phase download history). Written on the counted
+// download paths only (/file + /zip); fileId is null for a zip and after the
+// downloaded file was deleted (FK SET NULL). ipHash is the sha256 of the client
+// IP — the raw IP is never stored. userId is the optionally-resolved bearer of
+// the public serve request (null for anonymous downloads).
+export interface IBeamDownloadEvent {
+  id: string;
+  transferId: string;
+  fileId: string | null;
+  kind: BeamDownloadKind;
+  ipHash: string;
+  userId: string | null;
+  downloadedAt: Date;
+  createdAt?: Date;
+
+  transfer?: IBeamTransfer;
+  file?: IBeamFile | null;
+}

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

@@ -5,11 +5,8 @@
 
 import { ExtractionWarningCode } from '../../../types/enum/extraction-warning.enum';
 import { ExtractionFeedbackIssueType } from '../../../types/enum/extraction-feedback-issue-type.enum';
-import type {
-  IFieldValue,
-  IExecutionManifest,
-  IGlobalConfidence,
-} from './extraction-plan.dto';
+import { DocumentType } from '../../../types/enum/document-type.enum';
+import type { IFieldValue, IExecutionManifest, IGlobalConfidence } from './extraction-plan.dto';
 
 // Re-export so consumers can import ExtractionFeedbackIssueType from the DTO barrel.
 export { ExtractionFeedbackIssueType };
@@ -159,10 +156,28 @@ export interface IExtraction {
 
 export interface IExtractionTemplate {
   id: string;
-  userId: string;
+  /** Personal scope owner — null when the template is org/project-scoped. */
+  userId: string | null;
+  /** Owning organization — null for personal templates. */
+  organizationId: string | null;
+  /** Owning project — null for personal and org-wide templates. */
+  projectId: string | null;
+  /** Author inside an org/project scope — null for personal templates. */
+  createdByUserId: string | null;
   name: string;
   description: string | null;
+  /**
+   * Kind of document the template targets (DocumentType). Null when the
+   * template declares no type. Authoritative — spatial templates also embed
+   * `templateJson.documentType`, but this column is the source of truth.
+   */
+  documentType: DocumentType | null;
   isActive: boolean;
+  /**
+   * Stamped (fire-and-forget) whenever an extraction run resolves the
+   * template. Null until first use.
+   */
+  lastUsedAt: string | null;
   createdAt: string;
   updatedAt: string;
 }
@@ -206,6 +221,16 @@ export interface IExtractionTemplateVersion {
   version: number;
   templateJson: Record<string, unknown>;
   comment: string | null;
+  /**
+   * Witness (sample) PDF reference in the dedicated /rcb-witness bucket.
+   * Null when the version carries no witness. Retrieve a download URL via
+   * `sdk.extract.templates.getWitnessUrl`.
+   */
+  witnessFileId: string | null;
+  /** Witness byte size (billed to the owner's storage pool). */
+  witnessSizeBytes: number | null;
+  /** Original witness filename. */
+  witnessFilename: string | null;
   createdAt: string;
 }