@abyss-project/tools 1.0.0

package/src/types/enum/board-activity.enum.ts

@@ -0,0 +1,189 @@
+export enum BoardActivityType {
+  CARD_CREATE = 'CARD_CREATE',
+  CARD_UPDATE = 'CARD_UPDATE',
+  CARD_ARCHIVE = 'CARD_ARCHIVE',
+  CARD_RESTORE = 'CARD_RESTORE',
+  CARD_MOVE_COLUMN = 'CARD_MOVE_COLUMN',
+  CARD_MOVE_BOARD = 'CARD_MOVE_BOARD',
+
+  COLUMN_CREATE = 'COLUMN_CREATE',
+  COLUMN_UPDATE = 'COLUMN_UPDATE',
+  COLUMN_DELETE = 'COLUMN_DELETE',
+
+  COMMENT_CREATE = 'COMMENT_CREATE',
+  COMMENT_UPDATE = 'COMMENT_UPDATE',
+  COMMENT_DELETE = 'COMMENT_DELETE',
+
+  LABEL_CREATE = 'LABEL_CREATE',
+  LABEL_DELETE = 'LABEL_DELETE',
+  LABEL_UPDATE = 'LABEL_UPDATE',
+  LABEL_ADD = 'LABEL_ADD',
+  LABEL_REMOVE = 'LABEL_REMOVE',
+
+  MEMBER_ADD = 'MEMBER_ADD',
+  MEMBER_REMOVE = 'MEMBER_REMOVE',
+
+  CHECKLIST_CREATE = 'CHECKLIST_CREATE',
+  CHECKLIST_UPDATE = 'CHECKLIST_UPDATE',
+  CHECKLIST_DELETE = 'CHECKLIST_DELETE',
+  CHECKLIST_ITEM_ADD = 'CHECKLIST_ITEM_ADD',
+  CHECKLIST_ITEM_UPDATE = 'CHECKLIST_ITEM_UPDATE',
+  CHECKLIST_ITEM_DELETE = 'CHECKLIST_ITEM_DELETE',
+
+  DOCUMENT_ADD = 'DOCUMENT_ADD',
+  DOCUMENT_REMOVE = 'DOCUMENT_REMOVE',
+}
+
+type ValueOf<T> = T[keyof T];
+
+export type BoardActivityDataContent = ValueOf<
+  {
+    [K in BoardActivityType]: {
+      type: K;
+      payload: BoardActivityData[K];
+    };
+  }
+>;
+
+export class BoardActivityData
+  implements Record<BoardActivityType, Record<string, string | number | Date | boolean>>
+{
+  [BoardActivityType.CARD_CREATE]!: {
+    boardCardName: string;
+    boardCardId: string;
+    boardColumnName: string;
+    boardColumnId: string;
+  };
+  [BoardActivityType.CARD_UPDATE]!: {
+    boardCardName: string;
+    boardCardId: string;
+  };
+  [BoardActivityType.CARD_ARCHIVE]!: {
+    boardCardId: string;
+  };
+  [BoardActivityType.CARD_RESTORE]!: {
+    boardCardId: string;
+  };
+  [BoardActivityType.CARD_MOVE_COLUMN]!: {
+    boardCardName: string;
+    boardCardId: string;
+    toBoardColumnId: string;
+    toBoardColumnName: string;
+  };
+  [BoardActivityType.CARD_MOVE_BOARD]!: {
+    boardCardName: string;
+    boardCardId: string;
+    toBoardColumnId: string;
+    toBoardColumnName: string;
+    toBoardId: string;
+    toBoardName: string;
+  };
+
+  [BoardActivityType.COLUMN_CREATE]!: {
+    boardColumnName: string;
+    boardColumnId: string;
+  };
+  [BoardActivityType.COLUMN_UPDATE]!: {
+    boardColumnName: string;
+    boardColumnId: string;
+  };
+  [BoardActivityType.COLUMN_DELETE]!: {
+    boardColumnId: string;
+  };
+
+  [BoardActivityType.COMMENT_CREATE]!: {
+    boardCardCommentId: string;
+    boardCardId: string;
+  };
+  [BoardActivityType.COMMENT_UPDATE]!: {
+    boardCardCommentId: string;
+    fromBoardCardCommentContent: string;
+    toBoardCardCommentContent: string;
+    boardCardId: string;
+  };
+  [BoardActivityType.COMMENT_DELETE]!: {
+    boardCardCommentId: string;
+    boardCardId: string;
+  };
+
+  [BoardActivityType.LABEL_CREATE]!: {
+    boardLabelId: string;
+    boardLabelName: string;
+    boardLabelColor: string;
+  };
+  [BoardActivityType.LABEL_DELETE]!: {
+    boardLabelId: string;
+  };
+  [BoardActivityType.LABEL_UPDATE]!: {
+    boardLabelId: string;
+    boardLabelName: string;
+    boardLabelColor: string;
+  };
+
+  [BoardActivityType.LABEL_ADD]!: {
+    boardLabelId: string;
+    boardCardId: string;
+    boardLabelName: string;
+  };
+  [BoardActivityType.LABEL_REMOVE]!: {
+    boardLabelId: string;
+    boardCardId: string;
+    boardLabelName: string;
+  };
+
+  [BoardActivityType.MEMBER_ADD]!: {
+    boardCardId: string;
+    userId: string;
+  };
+  [BoardActivityType.MEMBER_REMOVE]!: {
+    boardCardId: string;
+    userId: string;
+  };
+
+  [BoardActivityType.CHECKLIST_CREATE]!: {
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardCardChecklistName: string;
+  };
+  [BoardActivityType.CHECKLIST_UPDATE]!: {
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardCardChecklistName: string;
+  };
+  [BoardActivityType.CHECKLIST_DELETE]!: {
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardCardChecklistName: string;
+  };
+  [BoardActivityType.CHECKLIST_ITEM_ADD]!: {
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardCardChecklistItemId: string;
+    boardCardChecklistItemContent: string;
+    boardCardChecklistName: string;
+  };
+  [BoardActivityType.CHECKLIST_ITEM_UPDATE]!: {
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardCardChecklistItemId: string;
+    boardCardChecklistName: string;
+  };
+  [BoardActivityType.CHECKLIST_ITEM_DELETE]!: {
+    boardCardId: string;
+    boardCardChecklistId: string;
+    boardCardChecklistItemId: string;
+    boardCardChecklistName: string;
+    boardCardChecklistItemContent: string;
+  };
+
+  [BoardActivityType.DOCUMENT_ADD]!: {
+    boardCardId: string;
+    boardCardDocumentId: string;
+    boardCardDocumentName: string;
+  };
+  [BoardActivityType.DOCUMENT_REMOVE]!: {
+    boardCardId: string;
+    boardCardDocumentId: string;
+    boardCardDocumentName: string;
+  };
+}

package/src/types/enum/board-column-type.enum.ts

@@ -0,0 +1,6 @@
+export enum BoardColumnType {
+  CONCEPTION = 'CONCEPTION',
+  BACKLOG = 'BACKLOG',
+  DOING = 'DOING',
+  DONE = 'DONE',
+}

package/src/types/enum/index.ts

@@ -0,0 +1,3 @@
+export * from './api-error.enum';
+export * from './board-activity.enum';
+export * from './board-column-type.enum';

package/src/types/index.ts

@@ -0,0 +1,5 @@
+export * from './interface';
+export * from './enum';
+export * from './draw.type';
+
+export type ValueOf<T> = T[keyof T];

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

@@ -0,0 +1,5 @@
+export * from './requests';
+export * from './responses';
+export * from './type-message/response';
+export * from './type-message/api-error';
+export * from './type-message/base-paginate';

package/src/types/interface/api/requests/abyss.admin.request.ts

@@ -0,0 +1,16 @@
+export interface IActivateUserServiceAbyssAdminBody {
+  userId: string;
+}
+
+export interface ISyncOrganizationAbyssAdminBody {
+  id: string;
+  name: string;
+  slug: string;
+}
+
+export interface ISyncProjectAbyssAdminBody {
+  id: string;
+  name: string;
+  userId: string;
+  organizationId: string;
+}

package/src/types/interface/api/requests/atlas-document.request.ts

@@ -0,0 +1,32 @@
+import { QueryPaginate } from '..';
+
+export type IGetUploadPreSignedUrlAtlasDocumentParams = {
+  atlasId: string;
+  atlasPageId: string;
+};
+export type IGetUploadPreSignedUrlAtlasDocumentBody = {
+  name: string;
+};
+
+export type IGetAtlasDocumentParams = {
+  atlasId: string;
+  atlasDocumentId: string;
+};
+
+export type IDeleteAtlasDocumentParams = {
+  atlasId: string;
+  atlasDocumentId: string;
+};
+
+export type IPaginateAtlasDocumentParams = {
+  atlasId: string;
+};
+
+export type IPaginateAtlasDocumentQuery = QueryPaginate & {
+  atlasPageId?: string;
+};
+
+export type IListAtlasDocumentParams = {
+  atlasId: string;
+  atlasPageId: string;
+};

package/src/types/interface/api/requests/atlas-group.request.ts

@@ -0,0 +1,45 @@
+export interface IGetAtlasGroupParams {
+  atlasId: string;
+  atlasGroupId: string;
+}
+
+export interface IPaginateAtlasGroupParams {
+  atlasId: string;
+}
+
+export interface IPaginateAtlasGroupQuery {
+  name?: string;
+  parentAtlasGroupId?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateAtlasGroupParams {
+  atlasId: string;
+}
+export interface ICreateAtlasGroupBody {
+  name: string;
+  description?: string | null;
+  icon?: string | null;
+  color?: string | null;
+  parentAtlasGroupId?: string | null;
+  position?: number;
+}
+
+export interface IUpdateAtlasGroupParams {
+  atlasId: string;
+  atlasGroupId: string;
+}
+export interface IUpdateAtlasGroupBody {
+  name?: string;
+  description?: string | null;
+  icon?: string | null;
+  color?: string | null;
+  parentAtlasGroupId?: string | null;
+  position?: number;
+}
+
+export interface IDeleteAtlasGroupParams {
+  atlasId: string;
+  atlasGroupId: string;
+}

package/src/types/interface/api/requests/atlas-page.request.ts

@@ -0,0 +1,84 @@
+export interface IGetAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+
+export interface IGetAtlasPageBySlugParams {
+  atlasId: string;
+  slug: string;
+}
+
+export interface IPaginateAtlasPageParams {
+  atlasId: string;
+}
+
+export interface IPaginateAtlasPageQuery {
+  title?: string;
+  slug?: string;
+  atlasGroupId?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateAtlasPageParams {
+  atlasId: string;
+}
+
+export interface ICreateAtlasPageBody {
+  title: string;
+  icon?: string | null;
+  color?: string | null;
+  atlasGroupId?: string | null;
+  position?: number;
+  content?: string;
+}
+
+export interface IUpdateAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+
+export interface IUpdateAtlasPageBody {
+  title?: string;
+  icon?: string | null;
+  color?: string | null;
+  atlasGroupId?: string | null;
+  position?: number;
+}
+
+export interface IDeleteAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+
+export interface IUpdateAtlasPageContentParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+export interface IUpdateAtlasPageContentBody {
+  diff: string;
+}
+
+export interface IGetAtlasPageContentHistoryParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+export interface IGetAtlasPageContentHistoryQuery {
+  page?: number;
+  limit?: number;
+}
+
+export interface IRestoreAtlasPageContentParams {
+  atlasId: string;
+  atlasPageId: string;
+  version: number;
+}
+
+export interface ISearchAtlasContentParams {
+  atlasId: string;
+}
+export interface ISearchAtlasContentQuery {
+  query: string;
+  page?: number;
+  limit?: number;
+}

package/src/types/interface/api/requests/atlas.public.request.ts

@@ -0,0 +1,21 @@
+export interface IGetAtlasPublicParams {
+  publicAccessToken: string;
+}
+
+export type ISSEAtlasPublicParams = {
+  publicAccessToken: string;
+};
+
+export interface IGetPageAtlasPublicParams {
+  publicAccessToken: string;
+  atlasPageId: string;
+}
+
+export interface ISearchContentAtlasPublicParams {
+  publicAccessToken: string;
+}
+export interface ISearchContentAtlasPublicQuery {
+  query: string;
+  page?: number;
+  limit?: number;
+}

package/src/types/interface/api/requests/atlas.request.ts

@@ -0,0 +1,40 @@
+export interface IGetAtlasParams {
+  atlasId: string;
+}
+
+export interface IPaginateProjectAtlasParams {
+  projectId: string;
+}
+
+export interface IPaginateAtlasQuery {
+  title?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateForProjectAtlasParams {
+  projectId: string;
+}
+
+export interface ICreateAtlasBody {
+  title: string;
+  description?: string | null;
+}
+
+export interface IUpdateAtlasParams {
+  atlasId: string;
+}
+export interface IUpdateAtlasBody {
+  title?: string;
+  description?: string | null;
+  enablePublicAccess?: boolean;
+  transferToProjectId?: string | null;
+}
+
+export interface IDeleteAtlasParams {
+  atlasId: string;
+}
+
+export type ISSEAtlasParams = {
+  atlasId: string;
+};

package/src/types/interface/api/requests/board-card-checklist.request.ts

@@ -0,0 +1,61 @@
+export type ICreateBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type ICreateBoardCardChecklistBody = {
+  title: string;
+  position: number;
+};
+
+export type IUpdateBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardChecklistId: string;
+};
+export type IUpdateBoardCardChecklistBody = {
+  title?: string;
+  position?: number;
+  maskCompletedRows?: boolean;
+};
+
+export type IGetBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardChecklistId: string;
+};
+
+export type IDeleteBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardChecklistId: string;
+};
+
+export type IAddRowBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardChecklistId: string;
+};
+export type IAddRowBoardCardChecklistBody = {
+  content: string;
+  position: number;
+};
+
+export type IRemoveRowBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardChecklistId: string;
+  boardCardChecklistRowId: string;
+};
+
+export type IUpdateRowBoardCardChecklistParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardChecklistId: string;
+  boardCardChecklistRowId: string;
+};
+export type IUpdateRowBoardCardChecklistBody = {
+  content?: string;
+  completed?: boolean;
+  position?: number;
+  boardCardChecklistId?: string;
+};

package/src/types/interface/api/requests/board-card-comment.request.ts

@@ -0,0 +1,28 @@
+export type ICreateBoardCardCommentParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type ICreateBoardCardCommentBody = {
+  content: string;
+};
+
+export type IUpdateBoardCardCommentParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardCommentId: string;
+};
+export type IUpdateBoardCardCommentBody = {
+  content?: string;
+};
+
+export type IGetBoardCardCommentParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardCommentId: string;
+};
+
+export type IDeleteBoardCardCommentParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardCommentId: string;
+};

package/src/types/interface/api/requests/board-card-document.request.ts

@@ -0,0 +1,29 @@
+export type IGetUploadPreSignedUrlBoardCardDocumentParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type IGetUploadPreSignedUrlBoardCardDocumentBody = {
+  name: string;
+};
+
+export type IGetBoardCardDocumentParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardDocumentId: string;
+};
+
+export type IDeleteBoardCardDocumentParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardDocumentId: string;
+};
+
+export type ICloudImportBoardCardDocumentParams = {
+  boardId: string;
+  boardCardId: string;
+};
+
+export type ICloudImportBoardCardDocumentBody = {
+  cloudId: string;
+  fileId: string[];
+};

package/src/types/interface/api/requests/board-card.request.ts

@@ -0,0 +1,86 @@
+export type ICreateBoardCardParams = {
+  boardId: string;
+  boardColumnId: string;
+};
+export type ICreateBoardCardBody = {
+  title: string;
+  position: number;
+  description?: string | null;
+  weight?: number;
+  startDate?: Date;
+  endDate?: Date;
+};
+
+export type IUpdateBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type IUpdateBoardCardBody = {
+  title?: string;
+  description?: string | null;
+  position?: number;
+  boardColumnId?: string;
+  weight?: number;
+  startDate?: Date | null;
+  endDate?: Date | null;
+  bannerId?: string | null;
+};
+
+export type IGetBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+};
+
+export type ISSEBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+};
+
+export type IDeleteBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+};
+
+export type IRestoreBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type IRestoreBoardCardBody = {
+  boardColumnId: string;
+};
+
+export type IAddMemberBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+  userId: string;
+};
+export type IRemoveMemberBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+  userId: string;
+};
+
+export type IGetAllBoardCardParams = {
+  boardId: string;
+};
+export type IGetAllBoardCardQuery = {
+  archived?: boolean;
+};
+
+export type IMoveToBoardBoardCardParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type IMoveToBoardBoardCardBody = {
+  boardColumnId: string;
+  boardId: string;
+};
+
+export type ISearchBoardCardParams = {
+  boardId: string;
+};
+export type ISearchBoardCardQuery = {
+  query?: string;
+  page?: number;
+  limit?: number;
+};

package/src/types/interface/api/requests/board-column.request.ts

@@ -0,0 +1,30 @@
+import { BoardColumnType } from '../../../enum';
+
+export type ICreateBoardColumnParams = {
+  boardId: string;
+};
+export type ICreateBoardColumnBody = {
+  title: string;
+  position: number;
+  type?: BoardColumnType;
+};
+
+export type IUpdateBoardColumnParams = {
+  boardId: string;
+  boardColumnId: string;
+};
+export type IUpdateBoardColumnBody = {
+  title?: string;
+  position?: number;
+  type?: BoardColumnType;
+};
+
+export type IGetBoardColumnParams = {
+  boardId: string;
+  boardColumnId: string;
+};
+
+export type IDeleteBoardColumnParams = {
+  boardId: string;
+  boardColumnId: string;
+};