@abyss-project/workspace 0.0.0-stage → 1.0.0

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

@@ -0,0 +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[];
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,32 @@
+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;
+  boardId: string;
+  name: string;
+  externalId: string;
+  publicAccessId: string;
+  thumbnailId: string | null;
+  thumbnailPublicAccessId: string | null;
+  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;
+
+  // Association
+  boardCard: IBoardCard;
+  board: IBoard;
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,51 @@
+import { BoardCardLinkTargetType } from '../../enum/board-card-link-target-type.enum';
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardCardLink {
+  id: string;
+  boardCardId: string;
+  boardId: string;
+  targetType: BoardCardLinkTargetType;
+  /** Polymorphic target id, no foreign key: the target table depends on `targetType`. */
+  targetId: string;
+  createdByUserId: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard?: IBoardCard;
+  board?: IBoard;
+}
+
+/**
+ * A link as read by a given user. The server resolves the reader's access to the target: a closed
+ * (or deleted) target is returned without type, title or target id, so nothing leaks.
+ */
+export type IResolvedBoardCardLink =
+  | {
+      id: string;
+      accessible: true;
+      targetType: BoardCardLinkTargetType;
+      targetId: string;
+      title: string;
+      /** Organization of the space holding the target (its atlas or board): routes into that space. */
+      organizationId: string | null;
+      /** Project of the space holding the target (its atlas or board). */
+      projectId: string | null;
+      /** Set for an Atlas page: builds the route to the page. */
+      atlasId?: string;
+      /** Set for a board card: builds the route to the card. */
+      boardId?: string;
+    }
+  | {
+      id: string;
+      accessible: false;
+    };
+
+export interface IBoardCardBacklink {
+  boardCardId: string;
+  boardCardTitle: string;
+  boardId: string;
+  boardTitle: string;
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,41 @@
+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 { IBoardCardLink } from './board-card-link.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;
+  /** Number of links of the card; set by the API on the detail and on the list. */
+  linkCount?: number;
+
+  // Association
+  board: IBoard;
+  boardColumn: IBoardColumn;
+  boardActivities: IBoardActivity[];
+  boardCardMembers: IBoardCardMember[];
+  boardCardDocuments: IBoardCardDocument[];
+  boardCardChecklists: IBoardCardChecklist[];
+  boardCardComments?: IBoardCardComment[];
+  boardCardLabels?: IBoardCardLabel[];
+  boardCardLinks?: IBoardCardLink[];
+  banner?: IBoardCardDocument | null;
+}

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

@@ -0,0 +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[];
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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[];
+}

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

@@ -0,0 +1,20 @@
+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-image.dto.ts

@@ -0,0 +1,15 @@
+/** An image stored with a draw; `id` is the `imageId` carried by the IMAGE shapes of the content. */
+export interface IDrawImage {
+  id: string;
+  drawId: string;
+  /** The file in AbyssStorage. */
+  externalId: string;
+  /** Permanent public access id of the file (no authentication, unguessable). */
+  publicAccessId: string;
+  sizeOctet: number;
+  mimeType: string;
+  /** Set when a save found the image no longer referenced; the file is purged 24 h later. */
+  unusedSince: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+}

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

@@ -0,0 +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[];
+}

package/src/types/interface/models/index.ts

@@ -0,0 +1,33 @@
+export * from './user.dto';
+export * from './organization.dto';
+export * from './project.dto';
+export * from './atlas.dto';
+export * from './atlas-document.dto';
+export * from './atlas-group.dto';
+export * from './atlas-page.dto';
+export * from './atlas-page-content.dto';
+export * from './draw.dto';
+export * from './draw-image.dto';
+export * from './retrospective.dto';
+export * from './retrospective-section.dto';
+export * from './retrospective-card.dto';
+export * from './retrospective-action.dto';
+export * from './retrospective-member.dto';
+export * from './short-link.dto';
+export * from './short-link-click.dto';
+export * from './board.dto';
+export * from './board-activity.dto';
+export * from './board-card.dto';
+export * from './board-card-checklist.dto';
+export * from './board-card-checklist-row.dto';
+export * from './board-card-comment.dto';
+export * from './board-card-document.dto';
+export * from './board-card-link.dto';
+export * from './board-card-label.dto';
+export * from './board-card-member.dto';
+export * from './board-column.dto';
+export * from './board-label.dto';
+export * from './team.dto';
+export * from './tag.dto';
+export * from './content-share.dto';
+export * from './upload-session.dto';

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

@@ -0,0 +1,21 @@
+import { IProject } from './project.dto';
+
+export interface IOrganization {
+  id?: string;
+  name: string;
+  slug: string;
+  // Mirror of abyss-main Organization.kind. Drives the family default-share
+  // permission (family → EDIT, else VIEW). Synced by organization.middleware.ts.
+  // Typed as a literal union that mirrors @abyss-project/main's OrganizationKind
+  // enum values 1:1 — this published SDK package intentionally does NOT depend on
+  // @abyss-project/main, so the enum is referenced by value (the api-side model
+  // and middleware narrow this to OrganizationKind, where main IS resolvable).
+  kind?: 'standard' | 'family';
+  // Last refresh of `kind` from abyss-main; drives the TTL (≤5min) sync gate.
+  kindSyncedAt?: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  projects?: IProject[];
+}

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

@@ -0,0 +1,24 @@
+import { IAtlas } from './atlas.dto';
+import { IDraw } from './draw.dto';
+import { IOrganization } from './organization.dto';
+import { IRetrospective } from './retrospective.dto';
+import { IShortLink } from './short-link.dto';
+import { IUser } from './user.dto';
+
+export interface IProject {
+  id?: string;
+  name: string;
+  // Historical creator of the project, null once their account is deleted. NOT used for access control.
+  createdByUserId: string | null;
+  organizationId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  organization?: IOrganization;
+  user?: IUser;
+  draws?: IDraw[];
+  retrospectives?: IRetrospective[];
+  atlases?: IAtlas[];
+  shortLinks?: IShortLink[];
+}

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

@@ -0,0 +1,26 @@
+import { RetrospectiveActionStatus } from '../../enum/retrospective-action-status.enum';
+
+/**
+ * A follow-up action of a retrospective, as a given reader may see it. The owner is shown under
+ * the stable pseudonym of the member until that member reveals their name; the creator is never
+ * exposed.
+ */
+export interface IRetrospectiveAction {
+  id: string;
+  retrospectiveId: string;
+  content: string;
+  /** Stable per retrospective and per member; `null` for an action without owner. */
+  ownerPseudonym: string | null;
+  /** The owner's member id: the reader's own, or an owner who revealed their name; else `null`. */
+  ownerMemberId: string | null;
+  /** True when the reader is the owner of the action. */
+  isMine: boolean;
+  /** Calendar day, `YYYY-MM-DD`. */
+  dueDate: string | null;
+  status: RetrospectiveActionStatus;
+  /** The card the action comes from; `null` when it has none or the card was deleted. */
+  sourceCardId: string | null;
+  position: number;
+  updatedAt?: Date;
+  createdAt?: Date;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * A card as a given reader may see it: the server projects every card per reader
+ * (see the retrospective domain doc), so the author is never exposed beyond these fields.
+ */
+export interface IRetrospectiveCard {
+  id: string;
+  /** `null` when the reader may not read it (someone else's card during the WRITE phase). */
+  content: string | null;
+  positionX: number;
+  positionY: number;
+  retrospectiveId: string;
+  /** The author's member id: the reader's own, or an author who revealed their name; else `null`. */
+  retrospectiveMemberId: string | null;
+  /** Stable per retrospective and per author; `null` during WRITE and for a card without author. */
+  authorPseudonym: string | null;
+  /** True when the reader is the author of the card. */
+  isMine: boolean;
+  /** How many votes the reader put on this card, in every phase. */
+  myVoteCount: number;
+  /**
+   * The total of votes on this card. `null` until the DISCUSS phase (blind vote): from then on a
+   * number, whoever the reader is. Who voted is never sent.
+   */
+  voteCount: number | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+}

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

@@ -0,0 +1,41 @@
+import { IRetrospective } from './retrospective.dto';
+
+/** The stored member of a retrospective. Only its own reader ever receives it whole. */
+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;
+}
+
+/** The reader's own member, complete, with the pseudonym the others see him under. */
+export interface IRetrospectiveViewerMember extends IRetrospectiveMember {
+  pseudonym: string;
+  /** How many votes of the budget (`IRetrospective.voteBudget`) this member has spent. */
+  votesUsed: number;
+}
+
+/** Another member of the retrospective, as a reader may see it. */
+export interface IRetrospectiveParticipant {
+  id: string;
+  retrospectiveId: string;
+  /** Stable per retrospective and per member, unrelated to the account. */
+  pseudonym: string;
+  /** True for the reader's own member. */
+  isMe: boolean;
+  /**
+   * True once the participant chose to reveal his name AND the retrospective reached the REVEAL
+   * phase. `alias` and `userId` are `null` until then (except for the reader's own member).
+   */
+  isNameRevealed: boolean;
+  alias: string | null;
+  userId: string | null;
+  createdAt?: Date;
+}

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

@@ -0,0 +1,11 @@
+export interface IRetrospectiveSection {
+  id: string;
+  title: string;
+  description: string;
+  color: string;
+  positionX: number;
+  positionY: number;
+  retrospectiveId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+}

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

@@ -0,0 +1,45 @@
+import { RetrospectivePhase } from '../../enum/retrospective-phase.enum';
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IRetrospectiveAction } from './retrospective-action.dto';
+import { IRetrospectiveCard } from './retrospective-card.dto';
+import { IRetrospectiveParticipant } 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;
+  phase: RetrospectivePhase;
+  phaseChangedAt: Date | null;
+  /** Votes each member may spend during the VOTE phase (1 to 10). */
+  voteBudget: number;
+  /** Non null if and only if the phase is CLOSED. */
+  completedAt: Date | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  archivedAt: Date | null;
+  /** Present on paginated lists, which carry neither the cards nor the members. */
+  cardCount?: number;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  retrospectiveSections?: IRetrospectiveSection[];
+  /** Only on the GET of one retrospective, projected for its reader. */
+  retrospectiveCards?: IRetrospectiveCard[];
+  /** Only on the GET of one retrospective, projected for its reader. */
+  retrospectiveMembers?: IRetrospectiveParticipant[];
+  /** Only on the GET of one retrospective, projected for its reader. */
+  retrospectiveActions?: IRetrospectiveAction[];
+  entityTags?: IEntityTag[];
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,55 @@
+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;
+  forwardCampaignParams: boolean;
+  isProtected: boolean;
+  protectedAt: Date | null;
+  protectedByAdminId: 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 }[];
+    clicksByUtmMedium: { utmMedium: string; clicks: number }[];
+    clicksByUtmCampaign: { utmCampaign: string; clicks: number }[];
+    clicksByLanguage: { language: string; clicks: number }[];
+    clicksByRefererDomain: { refererDomain: string; clicks: number }[];
+    clicksLast24h: number;
+    returningVisitorsCount: number;
+    botClicksCount: number;
+  };
+}