@abyss-project/tools 1.0.0 → 1.0.1

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

@@ -1,23 +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',
-}
+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',
+}

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

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

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

package/src/types/enum/content-share.enum.ts

@@ -0,0 +1,36 @@
+export enum ShareableContentType {
+  DRAW = 'draw',
+  BOARD = 'board',
+  MEMO = 'memo',
+  ATLAS = 'atlas',
+  RETROSPECTIVE = 'retrospective',
+  SHORT_LINK = 'short_link',
+  CLOUD_FILE = 'cloud_file',
+  CLOUD_FOLDER = 'cloud_folder',
+  CLOUD_GALLERY = 'cloud_gallery',
+  FORM = 'form',
+  SPOTLIGHT_PROJECT = 'spotlight_project',
+  EVENT = 'event',
+  REPORT = 'report',
+  PDF = 'pdf',
+}
+
+export enum ShareTargetType {
+  USER = 'USER',
+  TEAM = 'TEAM',
+  ORGANIZATION = 'ORGANIZATION',
+  LINK = 'LINK',
+}
+
+export enum SharePermission {
+  VIEW = 'VIEW',
+  EDIT = 'EDIT',
+  MANAGE = 'MANAGE',
+}
+
+export enum ContentShareScope {
+  ORGANIZATION = 'ORGANIZATION',
+  ORG_USER = 'ORG_USER',
+  ORG_TEAM = 'ORG_TEAM',
+  ORG_PROJECT = 'ORG_PROJECT',
+}

package/src/types/enum/index.ts

@@ -1,3 +1,6 @@
-export * from './api-error.enum';
-export * from './board-activity.enum';
-export * from './board-column-type.enum';
+export * from './api-error.enum';
+export * from './board-activity.enum';
+export * from './board-column-type.enum';
+export * from './content-share.enum';
+export * from './pdf-operation.enum';
+export * from './rcb-bank.enum';

package/src/types/enum/pdf-operation.enum.ts

@@ -0,0 +1,98 @@
+export enum PdfOperationType {
+  ANNOTATE_TEXT = 'ANNOTATE_TEXT',
+  ANNOTATE_DRAW = 'ANNOTATE_DRAW',
+  ANNOTATE_IMAGE = 'ANNOTATE_IMAGE',
+  FILL_FIELD = 'FILL_FIELD',
+  PAGE_REORDER = 'PAGE_REORDER',
+  PAGE_DELETE = 'PAGE_DELETE',
+  PAGE_ROTATE = 'PAGE_ROTATE',
+  PAGE_INSERT_FROM_UPLOAD = 'PAGE_INSERT_FROM_UPLOAD',
+  FLATTEN = 'FLATTEN',
+}
+
+export interface IPdfOpAnnotateText {
+  opId: string;
+  type: PdfOperationType.ANNOTATE_TEXT;
+  pageIndex: number;
+  x: number;
+  y: number;
+  text: string;
+  fontSize: number;
+  color: string;
+}
+
+export interface IPdfOpAnnotateDraw {
+  opId: string;
+  type: PdfOperationType.ANNOTATE_DRAW;
+  pageIndex: number;
+  pathSvg: string;
+  color: string;
+  strokeWidth: number;
+}
+
+export type PdfImageSource =
+  | { kind: 'USER_ASSET'; assetId: string }
+  | { kind: 'INLINE'; storageKey: string };
+
+export interface IPdfOpAnnotateImage {
+  opId: string;
+  type: PdfOperationType.ANNOTATE_IMAGE;
+  pageIndex: number;
+  x: number;
+  y: number;
+  /** Width in PDF points (1/72 inch). Aligned with front-core PdfOperation. */
+  widthPt: number;
+  /** Height in PDF points (1/72 inch). Aligned with front-core PdfOperation. */
+  heightPt: number;
+  source: PdfImageSource;
+}
+
+export interface IPdfOpFillField {
+  opId: string;
+  type: PdfOperationType.FILL_FIELD;
+  fieldName: string;
+  value: string | boolean;
+}
+
+export interface IPdfOpPageReorder {
+  opId: string;
+  type: PdfOperationType.PAGE_REORDER;
+  order: number[];
+}
+
+export interface IPdfOpPageDelete {
+  opId: string;
+  type: PdfOperationType.PAGE_DELETE;
+  pageIndex: number;
+}
+
+export interface IPdfOpPageRotate {
+  opId: string;
+  type: PdfOperationType.PAGE_ROTATE;
+  pageIndex: number;
+  deg: 90 | 180 | 270;
+}
+
+export interface IPdfOpPageInsertFromUpload {
+  opId: string;
+  type: PdfOperationType.PAGE_INSERT_FROM_UPLOAD;
+  afterPageIndex: number;
+  uploadKey: string;
+  uploadPages: number[];
+}
+
+export interface IPdfOpFlatten {
+  opId: string;
+  type: PdfOperationType.FLATTEN;
+}
+
+export type PdfOperation =
+  | IPdfOpAnnotateText
+  | IPdfOpAnnotateDraw
+  | IPdfOpAnnotateImage
+  | IPdfOpFillField
+  | IPdfOpPageReorder
+  | IPdfOpPageDelete
+  | IPdfOpPageRotate
+  | IPdfOpPageInsertFromUpload
+  | IPdfOpFlatten;