@abyss-project/tools 1.0.0

package/src/server-sent-events/protocols/board/board.sse-protocol.ts

@@ -0,0 +1,115 @@
+import { SystemSSEMessageContent } from '..';
+import {
+  IBoardCardChecklist,
+  IBoardCardComment,
+  IBoardCardDocument,
+  IBoardCardMember,
+  IGetBoardData,
+  IListBoardLabelData,
+  ValueOf,
+} from '../../../types';
+
+export enum BoardSSEEvent {
+  BOARD_UPDATE = 'BOARD_UPDATE',
+  BOARD_DELETE = 'BOARD_DELETE',
+
+  BOARD_LABELS = 'BOARD_LABELS',
+
+  BOARD_CARD_MEMBER_CREATE = 'BOARD_CARD_MEMBER_CREATE',
+  BOARD_CARD_MEMBER_DELETE = 'BOARD_CARD_MEMBER_DELETE',
+
+  BOARD_CARD_DOCUMENT_CREATE = 'BOARD_CARD_DOCUMENT_CREATE',
+  BOARD_CARD_DOCUMENT_DELETE = 'BOARD_CARD_DOCUMENT_DELETE',
+
+  BOARD_CARD_COMMENT_CREATE = 'BOARD_CARD_COMMENT_CREATE',
+  BOARD_CARD_COMMENT_DELETE = 'BOARD_CARD_COMMENT_DELETE',
+  BOARD_CARD_COMMENT_UPDATE = 'BOARD_CARD_COMMENT_UPDATE',
+
+  BOARD_CARD_CHECKLIST_CREATE = 'BOARD_CARD_CHECKLIST_CREATE',
+  BOARD_CARD_CHECKLIST_DELETE = 'BOARD_CARD_CHECKLIST_DELETE',
+  BOARD_CARD_CHECKLIST_UPDATE = 'BOARD_CARD_CHECKLIST_UPDATE',
+}
+
+export type BoardSSEMessageContent = ValueOf<
+  {
+    [K in BoardSSEEvent]: {
+      type: K;
+      payload: SourceBoardSSEEventPayload[K];
+    };
+  }
+>;
+
+export class SourceBoardSSEEventPayload implements Record<BoardSSEEvent, Record<string, any>> {
+  [BoardSSEEvent.BOARD_UPDATE]!: {
+    boardId: string;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_DELETE]!: {
+    boardId: string;
+  };
+
+  [BoardSSEEvent.BOARD_LABELS]!: {
+    boardId: string;
+    boardLabels: IListBoardLabelData['boardLabels'];
+  };
+
+  [BoardSSEEvent.BOARD_CARD_MEMBER_CREATE]!: {
+    boardId: string;
+    boardCardMember: IBoardCardMember;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_CARD_MEMBER_DELETE]!: {
+    boardId: string;
+    boardCardId: string;
+    userId: string;
+    boardData: IGetBoardData;
+  };
+
+  [BoardSSEEvent.BOARD_CARD_DOCUMENT_CREATE]!: {
+    boardId: string;
+    boardCardDocument: IBoardCardDocument;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_CARD_DOCUMENT_DELETE]!: {
+    boardId: string;
+    boardCardId: string;
+    boardCardDocumentId: string;
+    boardData: IGetBoardData;
+  };
+
+  [BoardSSEEvent.BOARD_CARD_COMMENT_CREATE]!: {
+    boardId: string;
+    boardCardComment: IBoardCardComment;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_CARD_COMMENT_DELETE]!: {
+    boardId: string;
+    boardCardId: string;
+    boardCardCommentId: string;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_CARD_COMMENT_UPDATE]!: {
+    boardId: string;
+    boardCardComment: IBoardCardComment;
+    boardData: IGetBoardData;
+  };
+
+  [BoardSSEEvent.BOARD_CARD_CHECKLIST_CREATE]!: {
+    boardId: string;
+    boardCardChecklist: IBoardCardChecklist;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_CARD_CHECKLIST_DELETE]!: {
+    boardId: string;
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardData: IGetBoardData;
+  };
+  [BoardSSEEvent.BOARD_CARD_CHECKLIST_UPDATE]!: {
+    boardId: string;
+    boardCardChecklist: IBoardCardChecklist;
+    boardData: IGetBoardData;
+  };
+}
+
+export type BoardSSEEventContent = BoardSSEMessageContent | SystemSSEMessageContent;

package/src/server-sent-events/protocols/board/index.ts

@@ -0,0 +1 @@
+export * from './board.sse-protocol';

package/src/server-sent-events/protocols/board-card/board-card.sse-protocol.ts

@@ -0,0 +1,26 @@
+import { SystemSSEMessageContent } from '..';
+import { IGetBoardCardData, ValueOf } from '../../../types';
+
+export enum BoardCardSSEEvent {
+  BOARD_CARD_UPDATE = 'BOARD_CARD_UPDATE',
+}
+
+export type BoardCardSSEMessageContent = ValueOf<
+  {
+    [K in BoardCardSSEEvent]: {
+      type: K;
+      payload: SourceBoardCardSSEEventPayload[K];
+    };
+  }
+>;
+
+export class SourceBoardCardSSEEventPayload
+  implements Record<BoardCardSSEEvent, Record<string, any>>
+{
+  [BoardCardSSEEvent.BOARD_CARD_UPDATE]!: {
+    boardCardId: string;
+    boardData: IGetBoardCardData;
+  };
+}
+
+export type BoardCardSSEEventContent = BoardCardSSEMessageContent | SystemSSEMessageContent;

package/src/server-sent-events/protocols/board-card/index.ts

@@ -0,0 +1 @@
+export * from './board-card.sse-protocol';

package/src/server-sent-events/protocols/index.ts

@@ -0,0 +1,26 @@
+import { ValueOf } from '../..';
+
+export * from './board';
+export * from './board-card';
+export * from './retrospective';
+export * from './atlas';
+
+export enum SYSTEM_PROTOCOL_EVENTS {
+  PING = 'PING',
+}
+
+export type SystemSSEMessageContent = ValueOf<
+  {
+    [K in SYSTEM_PROTOCOL_EVENTS]: {
+      type: K;
+      payload: SystemSSEEventPayload[K];
+    };
+  }
+>;
+
+export class SystemSSEEventPayload implements Record<SYSTEM_PROTOCOL_EVENTS, Record<string, any>> {
+  [SYSTEM_PROTOCOL_EVENTS.PING]!: {
+    openedAt: number;
+    timestamp: number;
+  };
+}

package/src/server-sent-events/protocols/retrospective/index.ts

@@ -0,0 +1 @@
+export * from './retrospective.sse-protocol';

package/src/server-sent-events/protocols/retrospective/retrospective.sse-protocol.ts

@@ -0,0 +1,92 @@
+import { SystemSSEMessageContent } from '..';
+import { ValueOf } from '../../../types';
+import {
+  IRetrospective,
+  IRetrospectiveCard,
+  IRetrospectiveSection,
+  IRetrospectiveMember,
+} from '../../../types/interface';
+
+export enum RetrospectiveSSEEvent {
+  RETROSPECTIVE_UPDATED = 'RETROSPECTIVE_UPDATED',
+  RETROSPECTIVE_DELETED = 'RETROSPECTIVE_DELETED',
+  CARD_CREATED = 'CARD_CREATED',
+  CARD_UPDATED = 'CARD_UPDATED',
+  CARD_DELETED = 'CARD_DELETED',
+  SECTION_CREATED = 'SECTION_CREATED',
+  SECTION_UPDATED = 'SECTION_UPDATED',
+  SECTION_DELETED = 'SECTION_DELETED',
+  MEMBER_JOINED = 'MEMBER_JOINED',
+  MEMBER_UPDATED = 'MEMBER_UPDATED',
+  MEMBER_LEFT = 'MEMBER_LEFT',
+}
+
+export type RetrospectiveSSEMessageContent = ValueOf<
+  {
+    [K in RetrospectiveSSEEvent]: {
+      type: K;
+      payload: SourceRetrospectiveSSEEventPayload[K];
+    };
+  }
+>;
+
+export class SourceRetrospectiveSSEEventPayload
+  implements Record<RetrospectiveSSEEvent, Record<string, any>>
+{
+  [RetrospectiveSSEEvent.RETROSPECTIVE_UPDATED]!: {
+    retrospectiveId: string;
+    retrospective: IRetrospective;
+  };
+
+  [RetrospectiveSSEEvent.RETROSPECTIVE_DELETED]!: {
+    retrospectiveId: string;
+    userId?: string;
+  };
+
+  [RetrospectiveSSEEvent.CARD_CREATED]!: {
+    retrospectiveId: string;
+    card: IRetrospectiveCard;
+  };
+
+  [RetrospectiveSSEEvent.CARD_UPDATED]!: {
+    retrospectiveId: string;
+    card: IRetrospectiveCard;
+  };
+
+  [RetrospectiveSSEEvent.CARD_DELETED]!: {
+    retrospectiveId: string;
+    cardId: string;
+  };
+
+  [RetrospectiveSSEEvent.SECTION_CREATED]!: {
+    retrospectiveId: string;
+    section: IRetrospectiveSection;
+  };
+
+  [RetrospectiveSSEEvent.SECTION_UPDATED]!: {
+    retrospectiveId: string;
+    section: IRetrospectiveSection;
+  };
+
+  [RetrospectiveSSEEvent.SECTION_DELETED]!: {
+    retrospectiveId: string;
+    sectionId: string;
+  };
+
+  [RetrospectiveSSEEvent.MEMBER_JOINED]!: {
+    retrospectiveId: string;
+    member: IRetrospectiveMember;
+  };
+
+  [RetrospectiveSSEEvent.MEMBER_UPDATED]!: {
+    retrospectiveId: string;
+    member: IRetrospectiveMember;
+  };
+
+  [RetrospectiveSSEEvent.MEMBER_LEFT]!: {
+    retrospectiveId: string;
+    memberId: string;
+  };
+}
+
+export type RetrospectiveSSEEventContent = RetrospectiveSSEMessageContent | SystemSSEMessageContent;

package/src/server-sent-events/server-sent-events.manager.ts

@@ -0,0 +1,73 @@
+import { Request, Response } from 'express-serve-static-core';
+import { v4 as uuidv4 } from 'uuid';
+import { SYSTEM_PROTOCOL_EVENTS, SystemSSEMessageContent } from './protocols';
+
+export class ServerSentEventBaseContext {
+  id = uuidv4();
+  createdAt = new Date();
+
+  req!: Request;
+  res!: Response;
+}
+
+export type RedisSSEMessage = {
+  key: string;
+  data: any;
+};
+
+export class ServerSentEventsManager<
+  T extends ServerSentEventBaseContext,
+  P extends { type: string; payload: any },
+> {
+  private channel: string;
+  private contexts: Map<string, Set<T>>;
+
+  constructor(channelName: string) {
+    this.channel = channelName;
+    this.contexts = new Map();
+  }
+
+  add(key: string, context: T, onClose: () => void) {
+    context.res.setHeader('Content-Type', 'text/event-stream');
+    context.res.setHeader('Cache-Control', 'no-cache');
+    context.res.setHeader('Connection', 'keep-alive');
+    context.res.flushHeaders?.(); // Support Express
+
+    const row = this.contexts.get(key);
+    if (!row) {
+      this.contexts.set(key, new Set([context]));
+    } else {
+      row.add(context);
+    }
+
+    const pingTimeout = setInterval(() => {
+      const payload: SystemSSEMessageContent = {
+        type: SYSTEM_PROTOCOL_EVENTS.PING,
+        payload: {
+          openedAt: context.createdAt.getTime(),
+          timestamp: Date.now(),
+        },
+      };
+      context.res.write(`data: ${JSON.stringify(payload)}\n\n`);
+    }, 10_000);
+
+    context.res.on('close', () => {
+      clearInterval(pingTimeout);
+      onClose();
+      const row = this.contexts.get(key);
+      row?.delete(context);
+    });
+  }
+
+  sendToContext(key: string, data: P, { senderId }: { senderId?: string } = {}): void {
+    const payload = JSON.stringify({ ...data, date: new Date() });
+
+    const clients = this.contexts.get(key);
+    clients?.forEach((client) => {
+      if (client.id === senderId) {
+        return;
+      }
+      client.res.write(`data: ${payload}\n\n`);
+    });
+  }
+}

package/src/types/draw.type.ts

@@ -0,0 +1,173 @@
+import { Endpoint, ICON_LIBRARY, CurvePoint } from '../utils';
+
+export type DrawData = {
+  drawId: string | null;
+  shapes: DrawShapeToJsonResult[];
+  stagePos: Point;
+  stageScale: number;
+  showGrid: boolean;
+  timestamp: number;
+  version: number;
+  sections?: Section[];
+  activeSections?: string[];
+  sectionDisplayMode?: 'hidden' | 'opacity';
+};
+
+export type Section = {
+  id: string;
+  name: string;
+  color: string;
+};
+
+export interface Point {
+  x: number;
+  y: number;
+}
+
+export interface BoundingBox {
+  x1: number;
+  y1: number;
+  x2: number;
+  y2: number;
+}
+
+export interface DrawSize {
+  width: number;
+  height: number;
+}
+
+export interface DrawStyle {
+  fillColor: string;
+  strokeColor: string;
+  strokeWidth: number;
+  opacity: number;
+  lineDash: number[];
+  cornerRadius: number;
+  fontSize: number;
+  fontFamily: string;
+  fontWeight?: number;
+  preserveAspectRatio: boolean;
+  rotation: number; // in degrees
+  textAlign?: 'left' | 'center' | 'right';
+  textVerticalPosition?: 'top' | 'center' | 'bottom';
+  textHorizontalPosition?: 'left' | 'center' | 'right';
+}
+
+export interface ShapeProperties {
+  id?: string;
+  position: Point;
+  zIndex?: number;
+  size: DrawSize;
+  style?: Partial<DrawStyle>;
+}
+
+export enum DrawShapeType {
+  RECTANGLE = 'RECTANGLE',
+  DIAMOND = 'DIAMOND',
+  ELLIPSE = 'ELLIPSE',
+  TEXT = 'TEXT',
+  ICON = 'ICON',
+  IMAGE = 'IMAGE',
+  COMMENT = 'COMMENT',
+  ARROW = 'ARROW',
+  PENCIL = 'PENCIL',
+}
+export type ResizeShape = {
+  corner: 'se' | 'sw' | 'ne' | 'nw' | 'e' | 'w' | 'n' | 's';
+  startPos: Point;
+  originalSize: DrawSize;
+  originalPosition: Point;
+};
+
+export type RotationData = {
+  startAngle: number;
+  originalRotation: number;
+  center: Point;
+};
+
+export type Id = string;
+
+export type PortId =
+  | 'top'
+  | 'right'
+  | 'bottom'
+  | 'left'
+  | 'center'
+  | 'top-left'
+  | 'top-right'
+  | 'bottom-left'
+  | 'bottom-right';
+
+export type TextAnchor = {
+  shapeId: string;
+  relativeX: number; // 0-1: position relative to shape width (0 = left edge, 0.5 = center, 1 = right edge)
+  relativeY: number; // 0-1: position relative to shape height (0 = top edge, 0.5 = center, 1 = bottom edge)
+};
+
+export type DrawShapeToJsonBaseResult = {
+  id: string;
+  type: DrawShapeType;
+  position: Point;
+  size: DrawSize;
+  style: DrawStyle;
+  zIndex: number;
+  sectionIds?: string[];
+};
+
+export type DrawShapeArrowToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.ARROW;
+  startEndpoint: Endpoint;
+  endEndpoint: Endpoint;
+  curvePoints?: CurvePoint[];
+};
+
+export type DrawShapeIconToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.ICON;
+  iconType: keyof typeof ICON_LIBRARY;
+};
+
+export type DrawShapeTextToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.TEXT;
+  text: string;
+  anchor?: TextAnchor;
+};
+
+export type DrawShapeRectangleToJsonResult = {
+  type: DrawShapeType.RECTANGLE;
+} & DrawShapeToJsonBaseResult;
+
+export type DrawShapeDiamondToJsonResult = {
+  type: DrawShapeType.DIAMOND;
+} & DrawShapeToJsonBaseResult;
+
+export type DrawShapeImageToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.IMAGE;
+  src: string;
+  base64: string;
+};
+
+export type DrawShapeEllipseToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.ELLIPSE;
+};
+
+export type DrawShapeCommentToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.COMMENT;
+  text: string;
+  date: string;
+};
+
+export type DrawShapePencilToJsonResult = DrawShapeToJsonBaseResult & {
+  type: DrawShapeType.PENCIL;
+  points: number[];
+};
+
+export type DrawShapeToJsonResult =
+  | DrawShapeArrowToJsonResult
+  | DrawShapeIconToJsonResult
+  | DrawShapeTextToJsonResult
+  | DrawShapeRectangleToJsonResult
+  | DrawShapeDiamondToJsonResult
+  | DrawShapeImageToJsonResult
+  | DrawShapeCommentToJsonResult
+  | DrawShapeEllipseToJsonResult
+  | DrawShapePencilToJsonResult;

package/src/types/enum/api-error.enum.ts

@@ -0,0 +1,23 @@
+export enum ErrorType {
+  apiError = 'api_error',
+  authError = 'authentication_error',
+  resourceError = 'resource_error',
+}
+
+export enum Code {
+  // HTTP Error
+  tokenFailure = 'token_authentication_failure',
+  authenticationFailure = 'authentication_credentials_failure',
+  accessNotAllowed = 'access_not_allowed',
+  notFound = 'not_found',
+  validationError = 'resource_validation_error',
+  constraintError = 'resource_constraint_error',
+  internalServerError = 'internal_server_error',
+  serviceUnavailable = 'service_unavailable',
+  invalidData = 'invalid_data',
+  notImplemented = 'not_implemented',
+  retrospectiveCannotBeModifiedWhenCompleted = 'retrospective_cannot_be_modified_when_completed',
+  atlasDocumentLimitReached = 'atlas_document_limit_reached',
+  boardCardDocumentLimitReached = 'board_card_document_limit_reached',
+  boardCardMoveInvalidDestination = 'board_card_move_invalid_destination',
+}