@abyss-project/tools 1.1.1 → 1.2.0

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

@@ -1,115 +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;
+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

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

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

@@ -1,26 +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;
+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

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

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

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

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

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

@@ -1,92 +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;
+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

@@ -1,73 +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: unknown;
-};
-
-export class ServerSentEventsManager<
-  T extends ServerSentEventBaseContext,
-  P extends { type: string; payload: unknown },
-> {
-  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`);
-    });
-  }
-}
+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: unknown;
+};
+
+export class ServerSentEventsManager<
+  T extends ServerSentEventBaseContext,
+  P extends { type: string; payload: unknown },
+> {
+  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`);
+    });
+  }
+}