@abyss-project/tools 1.1.1 → 1.3.0

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/board-activity.dto.ts

@@ -1,20 +1,20 @@
-import { BoardActivityData, BoardActivityType } from '../../enum';
-import { IBoardCard } from './board-card.dto';
-import { IBoard } from './board.dto';
-import { IUser } from './user.dto';
-
-export type IBoardActivity = {
-  id: string;
-  type: BoardActivityType;
-  payload: BoardActivityData[keyof BoardActivityData];
-  userId: string | null;
-  boardCardId: string | null;
-  boardId: string;
-  createdAt?: Date;
-  updatedAt?: Date;
-
-  // Association
-  user?: IUser | null;
-  boardCard?: IBoardCard | null;
-  board?: IBoard;
-};
+import { BoardActivityData, BoardActivityType } from '../../enum';
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+import { IUser } from './user.dto';
+
+export type IBoardActivity = {
+  id: string;
+  type: BoardActivityType;
+  payload: BoardActivityData[keyof BoardActivityData];
+  userId: string | null;
+  boardCardId: string | null;
+  boardId: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  boardCard?: IBoardCard | null;
+  board?: IBoard;
+};

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

@@ -1,14 +1,14 @@
-import { IBoardCardChecklist } from './board-card-checklist.dto';
-
-export interface IBoardCardChecklistRow {
-  id: string;
-  boardCardChecklistId: string;
-  content: string;
-  completedAt: Date | null;
-  position: number;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardCardChecklist: IBoardCardChecklist;
-}
+import { IBoardCardChecklist } from './board-card-checklist.dto';
+
+export interface IBoardCardChecklistRow {
+  id: string;
+  boardCardChecklistId: string;
+  content: string;
+  completedAt: Date | null;
+  position: number;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCardChecklist: IBoardCardChecklist;
+}

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

@@ -1,16 +1,16 @@
-import { IBoardCardChecklistRow } from './board-card-checklist-row.dto';
-import { IBoardCard } from './board-card.dto';
-
-export interface IBoardCardChecklist {
-  id: string;
-  boardCardId: string;
-  title: string;
-  position: number;
-  maskCompletedRows: boolean;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardCard: IBoardCard;
-  boardCardChecklistRows: IBoardCardChecklistRow[];
-}
+import { IBoardCardChecklistRow } from './board-card-checklist-row.dto';
+import { IBoardCard } from './board-card.dto';
+
+export interface IBoardCardChecklist {
+  id: string;
+  boardCardId: string;
+  title: string;
+  position: number;
+  maskCompletedRows: boolean;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard: IBoardCard;
+  boardCardChecklistRows: IBoardCardChecklistRow[];
+}

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

@@ -1,15 +1,15 @@
-import { IBoardCard } from './board-card.dto';
-import { IUser } from './user.dto';
-
-export interface IBoardCardComment {
-  id: string;
-  boardCardId: string;
-  content: string;
-  userId: string | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardCard?: IBoardCard;
-  user?: IUser | null;
-}
+import { IBoardCard } from './board-card.dto';
+import { IUser } from './user.dto';
+
+export interface IBoardCardComment {
+  id: string;
+  boardCardId: string;
+  content: string;
+  userId: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard?: IBoardCard;
+  user?: IUser | null;
+}

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

@@ -1,22 +1,22 @@
-import { IBoardCard } from './board-card.dto';
-import { IBoard } from './board.dto';
-
-export interface IBoardCardDocument {
-  id: string;
-  boardCardId: string;
-  boardId: string;
-  name: string;
-  externalId: string;
-  publicAccessId: string;
-  thumbnailId: string | null;
-  thumbnailPublicAccessId: string | null;
-  checksum: string;
-  mimeType: string;
-  sizeOctet: number;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardCard: IBoardCard;
-  board: IBoard;
-}
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardCardDocument {
+  id: string;
+  boardCardId: string;
+  boardId: string;
+  name: string;
+  externalId: string;
+  publicAccessId: string;
+  thumbnailId: string | null;
+  thumbnailPublicAccessId: string | null;
+  checksum: string;
+  mimeType: string;
+  sizeOctet: number;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard: IBoardCard;
+  board: IBoard;
+}

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

@@ -1,14 +1,14 @@
-import { IBoardCard } from './board-card.dto';
-import { IBoardLabel } from './board-label.dto';
-
-export interface IBoardCardLabel {
-  id: string;
-  boardLabelId: string;
-  boardCardId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardLabel?: IBoardLabel;
-  boardCard?: IBoardCard;
-}
+import { IBoardCard } from './board-card.dto';
+import { IBoardLabel } from './board-label.dto';
+
+export interface IBoardCardLabel {
+  id: string;
+  boardLabelId: string;
+  boardCardId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardLabel?: IBoardLabel;
+  boardCard?: IBoardCard;
+}

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

@@ -1,14 +1,14 @@
-import { IBoardCard } from './board-card.dto';
-import { IUser } from './user.dto';
-
-export interface IBoardCardMember {
-  id: string;
-  boardCardId: string;
-  userId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardCard: IBoardCard;
-  user: IUser;
-}
+import { IBoardCard } from './board-card.dto';
+import { IUser } from './user.dto';
+
+export interface IBoardCardMember {
+  id: string;
+  boardCardId: string;
+  userId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard: IBoardCard;
+  user: IUser;
+}

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

@@ -1,37 +1,37 @@
-import { IBoardActivity } from './board-activity.dto';
-import { IBoardCardChecklist } from './board-card-checklist.dto';
-import { IBoardCardComment } from './board-card-comment.dto';
-import { IBoardCardDocument } from './board-card-document.dto';
-import { IBoardCardLabel } from './board-card-label.dto';
-import { IBoardCardMember } from './board-card-member.dto';
-import { IBoardColumn } from './board-column.dto';
-import { IBoard } from './board.dto';
-
-export interface IBoardCard {
-  id: string;
-  slug: string;
-  identifier: number;
-  boardColumnId: string | null;
-  boardId: string;
-  title: string;
-  description: string | null;
-  weight: number | null;
-  position: number;
-  startDate: Date | null;
-  endDate: Date | null;
-  bannerId: string | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-  deletedAt?: Date | null;
-
-  // Association
-  board: IBoard;
-  boardColumn: IBoardColumn;
-  boardActivities: IBoardActivity[];
-  boardCardMembers: IBoardCardMember[];
-  boardCardDocuments: IBoardCardDocument[];
-  boardCardChecklists: IBoardCardChecklist[];
-  boardCardComments?: IBoardCardComment[];
-  boardCardLabels?: IBoardCardLabel[];
-  banner?: IBoardCardDocument | null;
-}
+import { IBoardActivity } from './board-activity.dto';
+import { IBoardCardChecklist } from './board-card-checklist.dto';
+import { IBoardCardComment } from './board-card-comment.dto';
+import { IBoardCardDocument } from './board-card-document.dto';
+import { IBoardCardLabel } from './board-card-label.dto';
+import { IBoardCardMember } from './board-card-member.dto';
+import { IBoardColumn } from './board-column.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardCard {
+  id: string;
+  slug: string;
+  identifier: number;
+  boardColumnId: string | null;
+  boardId: string;
+  title: string;
+  description: string | null;
+  weight: number | null;
+  position: number;
+  startDate: Date | null;
+  endDate: Date | null;
+  bannerId: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+  deletedAt?: Date | null;
+
+  // Association
+  board: IBoard;
+  boardColumn: IBoardColumn;
+  boardActivities: IBoardActivity[];
+  boardCardMembers: IBoardCardMember[];
+  boardCardDocuments: IBoardCardDocument[];
+  boardCardChecklists: IBoardCardChecklist[];
+  boardCardComments?: IBoardCardComment[];
+  boardCardLabels?: IBoardCardLabel[];
+  banner?: IBoardCardDocument | null;
+}

package/src/types/interface/models/board-column.dto.ts

@@ -1,17 +1,17 @@
-import { BoardColumnType } from '../../enum';
-import { IBoardCard } from './board-card.dto';
-import { IBoard } from './board.dto';
-
-export interface IBoardColumn {
-  id: string;
-  title: string;
-  position: number;
-  boardId: string;
-  type: BoardColumnType;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  board: IBoard;
-  boardCards: IBoardCard[];
-}
+import { BoardColumnType } from '../../enum';
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardColumn {
+  id: string;
+  title: string;
+  position: number;
+  boardId: string;
+  type: BoardColumnType;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  board: IBoard;
+  boardCards: IBoardCard[];
+}

package/src/types/interface/models/board-label.dto.ts

@@ -1,13 +1,13 @@
-import { IBoard } from './board.dto';
-
-export interface IBoardLabel {
-  id: string;
-  name: string;
-  color: string;
-  boardId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  board: IBoard;
-}
+import { IBoard } from './board.dto';
+
+export interface IBoardLabel {
+  id: string;
+  name: string;
+  color: string;
+  boardId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  board: IBoard;
+}

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

@@ -1,33 +1,33 @@
-import { IBoardActivity } from './board-activity.dto';
-import { IBoardCardDocument } from './board-card-document.dto';
-import { IBoardCard } from './board-card.dto';
-import { IBoardColumn } from './board-column.dto';
-import { IBoardLabel } from './board-label.dto';
-import { IOrganization } from './organization.dto';
-import { IProject } from './project.dto';
-import { IEntityTag } from './tag.dto';
-import { IUser } from './user.dto';
-
-export interface IBoard {
-  id: string;
-  slug: string;
-  title: string;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  createdByUserId: string | null;
-  archivedAt: Date | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  boardColumns?: IBoardColumn[];
-  boardActivities?: IBoardActivity[];
-  boardCards?: IBoardCard[];
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  boardLabels?: IBoardLabel[];
-  boardCardDocuments?: IBoardCardDocument[];
-  entityTags?: IEntityTag[];
-}
+import { IBoardActivity } from './board-activity.dto';
+import { IBoardCardDocument } from './board-card-document.dto';
+import { IBoardCard } from './board-card.dto';
+import { IBoardColumn } from './board-column.dto';
+import { IBoardLabel } from './board-label.dto';
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityTag } from './tag.dto';
+import { IUser } from './user.dto';
+
+export interface IBoard {
+  id: string;
+  slug: string;
+  title: string;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  archivedAt: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardColumns?: IBoardColumn[];
+  boardActivities?: IBoardActivity[];
+  boardCards?: IBoardCard[];
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  boardLabels?: IBoardLabel[];
+  boardCardDocuments?: IBoardCardDocument[];
+  entityTags?: IEntityTag[];
+}

package/src/types/interface/models/content-share.dto.ts

@@ -1,16 +1,16 @@
-import { ShareableContentType, SharePermission, ShareTargetType } from '../../enum/content-share.enum';
-
-export interface IContentShare {
-  id: string;
-  contentType: ShareableContentType;
-  contentId: string;
-  organizationId: string | null;
-  targetType: ShareTargetType;
-  targetId: string | null;
-  permission: SharePermission;
-  publicToken: string | null;
-  expiresAt: string | null;
-  createdByUserId: string;
-  createdAt: string;
-  updatedAt: string;
-}
+import { ShareableContentType, SharePermission, ShareTargetType } from '../../enum/content-share.enum';
+
+export interface IContentShare {
+  id: string;
+  contentType: ShareableContentType;
+  contentId: string;
+  organizationId: string | null;
+  targetType: ShareTargetType;
+  targetId: string | null;
+  permission: SharePermission;
+  publicToken: string | null;
+  expiresAt: string | null;
+  createdByUserId: string;
+  createdAt: string;
+  updatedAt: string;
+}

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

@@ -1,30 +1,30 @@
-import { IOrganization } from './organization.dto';
-import { IProject } from './project.dto';
-import { IEntityTag } from './tag.dto';
-import { IUser } from './user.dto';
-
-export interface IDraw {
-  id: string;
-  title: string;
-  content: string;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  createdByUserId: string | null;
-  fileId: string | null;
-  filePublicAccessId: string | null;
-  thumbnailId: string | null;
-  thumbnailPublicAccessId: string | null;
-  sizeOctet: number;
-  mimeType: string;
-  checksum: string;
-  archivedAt?: Date | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  entityTags?: IEntityTag[];
-}
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityTag } from './tag.dto';
+import { IUser } from './user.dto';
+
+export interface IDraw {
+  id: string;
+  title: string;
+  content: string;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  fileId: string | null;
+  filePublicAccessId: string | null;
+  thumbnailId: string | null;
+  thumbnailPublicAccessId: string | null;
+  sizeOctet: number;
+  mimeType: string;
+  checksum: string;
+  archivedAt?: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  entityTags?: IEntityTag[];
+}

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

@@ -5,11 +5,7 @@
 
 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 type { IFieldValue, IExecutionManifest, IGlobalConfidence } from './extraction-plan.dto';
 
 // Re-export so consumers can import ExtractionFeedbackIssueType from the DTO barrel.
 export { ExtractionFeedbackIssueType };
@@ -159,10 +155,22 @@ 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;
   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 +214,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;
 }