@abyss-project/tools 1.0.0 → 1.0.1

package/src/types/interface/api/responses/board-card.response.ts

@@ -1,55 +1,55 @@
-import { IResponse } from '../type-message/response';
-import { IBoardCard } from '../..';
-
-export interface IGetBoardCardData {
-  boardCard: IBoardCard;
-}
-export type IGetBoardCardResponse = IResponse<IGetBoardCardData>;
-
-export interface IUpdateBoardCardData {
-  boardCard: IBoardCard;
-}
-export type IUpdateBoardCardResponse = IResponse<IUpdateBoardCardData>;
-
-export interface IRestoreBoardCardData {
-  boardCard: IBoardCard;
-}
-export type IRestoreBoardCardResponse = IResponse<IRestoreBoardCardData>;
-
-export interface ICreateBoardCardData {
-  boardCard: IBoardCard;
-}
-export type ICreateBoardCardResponse = IResponse<ICreateBoardCardData>;
-
-export interface IDeleteBoardCardData {}
-export type IDeleteBoardCardResponse = IResponse<IDeleteBoardCardData>;
-
-export interface IAddMemberBoardCardData {}
-export type IAddMemberBoardCardResponse = IResponse<IAddMemberBoardCardData>;
-
-export interface IRemoveMemberBoardCardData {}
-export type IRemoveMemberBoardCardResponse = IResponse<IRemoveMemberBoardCardData>;
-
-export interface IGetAllBoardCardData {
-  boardCard: IBoardCard[];
-}
-export type IGetAllBoardCardResponse = IResponse<IGetAllBoardCardData>;
-
-export interface IMoveToBoardBoardCardData {
-  boardCard: IBoardCard;
-}
-export type IMoveToBoardBoardCardResponse = IResponse<IMoveToBoardBoardCardData>;
-
-export interface IBoardCardSearchResult {
-  boardCard: IBoardCard;
-  matchCount: number;
-  excerpt: string;
-}
-
-export interface ISearchBoardCardData {
-  results: IBoardCardSearchResult[];
-  total: number;
-  page: number;
-  limit: number;
-}
-export type ISearchBoardCardResponse = IResponse<ISearchBoardCardData>;
+import { IResponse } from '../type-message/response';
+import { IBoardCard } from '../..';
+
+export interface IGetBoardCardData {
+  boardCard: IBoardCard;
+}
+export type IGetBoardCardResponse = IResponse<IGetBoardCardData>;
+
+export interface IUpdateBoardCardData {
+  boardCard: IBoardCard;
+}
+export type IUpdateBoardCardResponse = IResponse<IUpdateBoardCardData>;
+
+export interface IRestoreBoardCardData {
+  boardCard: IBoardCard;
+}
+export type IRestoreBoardCardResponse = IResponse<IRestoreBoardCardData>;
+
+export interface ICreateBoardCardData {
+  boardCard: IBoardCard;
+}
+export type ICreateBoardCardResponse = IResponse<ICreateBoardCardData>;
+
+export interface IDeleteBoardCardData {}
+export type IDeleteBoardCardResponse = IResponse<IDeleteBoardCardData>;
+
+export interface IAddMemberBoardCardData {}
+export type IAddMemberBoardCardResponse = IResponse<IAddMemberBoardCardData>;
+
+export interface IRemoveMemberBoardCardData {}
+export type IRemoveMemberBoardCardResponse = IResponse<IRemoveMemberBoardCardData>;
+
+export interface IGetAllBoardCardData {
+  boardCard: IBoardCard[];
+}
+export type IGetAllBoardCardResponse = IResponse<IGetAllBoardCardData>;
+
+export interface IMoveToBoardBoardCardData {
+  boardCard: IBoardCard;
+}
+export type IMoveToBoardBoardCardResponse = IResponse<IMoveToBoardBoardCardData>;
+
+export interface IBoardCardSearchResult {
+  boardCard: IBoardCard;
+  matchCount: number;
+  excerpt: string;
+}
+
+export interface ISearchBoardCardData {
+  results: IBoardCardSearchResult[];
+  total: number;
+  page: number;
+  limit: number;
+}
+export type ISearchBoardCardResponse = IResponse<ISearchBoardCardData>;

package/src/types/interface/api/responses/board-column.response.ts

@@ -1,20 +1,20 @@
-import { IResponse } from '../type-message/response';
-import { IBoardColumn } from '../..';
-
-export interface IGetBoardColumnData {
-  boardColumn: IBoardColumn;
-}
-export type IGetBoardColumnResponse = IResponse<IGetBoardColumnData>;
-
-export interface IUpdateBoardColumnData {
-  boardColumn: IBoardColumn;
-}
-export type IUpdateBoardColumnResponse = IResponse<IUpdateBoardColumnData>;
-
-export interface ICreateBoardColumnData {
-  boardColumn: IBoardColumn;
-}
-export type ICreateBoardColumnResponse = IResponse<ICreateBoardColumnData>;
-
-export interface IDeleteBoardColumnData {}
-export type IDeleteBoardColumnResponse = IResponse<IDeleteBoardColumnData>;
+import { IResponse } from '../type-message/response';
+import { IBoardColumn } from '../..';
+
+export interface IGetBoardColumnData {
+  boardColumn: IBoardColumn;
+}
+export type IGetBoardColumnResponse = IResponse<IGetBoardColumnData>;
+
+export interface IUpdateBoardColumnData {
+  boardColumn: IBoardColumn;
+}
+export type IUpdateBoardColumnResponse = IResponse<IUpdateBoardColumnData>;
+
+export interface ICreateBoardColumnData {
+  boardColumn: IBoardColumn;
+}
+export type ICreateBoardColumnResponse = IResponse<ICreateBoardColumnData>;
+
+export interface IDeleteBoardColumnData {}
+export type IDeleteBoardColumnResponse = IResponse<IDeleteBoardColumnData>;

package/src/types/interface/api/responses/board-label.response.ts

@@ -1,31 +1,31 @@
-import { IResponse } from '../type-message/response';
-import { IBoardLabel } from '../..';
-
-export interface IGetBoardLabelData {
-  boardLabel: IBoardLabel;
-}
-export type IGetBoardLabelResponse = IResponse<IGetBoardLabelData>;
-
-export interface IUpdateBoardLabelData {
-  boardLabel: IBoardLabel;
-}
-export type IUpdateBoardLabelResponse = IResponse<IUpdateBoardLabelData>;
-
-export interface ICreateBoardLabelData {
-  boardLabel: IBoardLabel;
-}
-export type ICreateBoardLabelResponse = IResponse<ICreateBoardLabelData>;
-
-export interface IDeleteBoardLabelData {}
-export type IDeleteBoardLabelResponse = IResponse<IDeleteBoardLabelData>;
-
-export interface IAddBoardLabelData {}
-export type IAddBoardLabelResponse = IResponse<IAddBoardLabelData>;
-
-export interface IRemoveBoardLabelData {}
-export type IRemoveBoardLabelResponse = IResponse<IRemoveBoardLabelData>;
-
-export interface IListBoardLabelData {
-  boardLabels: { boardLabel: IBoardLabel; count: number }[];
-}
-export type IListBoardLabelResponse = IResponse<IListBoardLabelData>;
+import { IResponse } from '../type-message/response';
+import { IBoardLabel } from '../..';
+
+export interface IGetBoardLabelData {
+  boardLabel: IBoardLabel;
+}
+export type IGetBoardLabelResponse = IResponse<IGetBoardLabelData>;
+
+export interface IUpdateBoardLabelData {
+  boardLabel: IBoardLabel;
+}
+export type IUpdateBoardLabelResponse = IResponse<IUpdateBoardLabelData>;
+
+export interface ICreateBoardLabelData {
+  boardLabel: IBoardLabel;
+}
+export type ICreateBoardLabelResponse = IResponse<ICreateBoardLabelData>;
+
+export interface IDeleteBoardLabelData {}
+export type IDeleteBoardLabelResponse = IResponse<IDeleteBoardLabelData>;
+
+export interface IAddBoardLabelData {}
+export type IAddBoardLabelResponse = IResponse<IAddBoardLabelData>;
+
+export interface IRemoveBoardLabelData {}
+export type IRemoveBoardLabelResponse = IResponse<IRemoveBoardLabelData>;
+
+export interface IListBoardLabelData {
+  boardLabels: { boardLabel: IBoardLabel; count: number }[];
+}
+export type IListBoardLabelResponse = IResponse<IListBoardLabelData>;

package/src/types/interface/api/responses/board.response.ts

@@ -1,68 +1,81 @@
-import { IResponse } from '../type-message/response';
-import { IBoardCard } from '../../models/board-card.dto';
-import { IBoard } from '../../models/board.dto';
-
-export interface IGetBoardData {
-  board: IBoard;
-  metrics: {
-    cardMetrics: Record<
-      string,
-      {
-        documentCount: number;
-        commentCount: number;
-        memberCount: number;
-        todoCount: number;
-        completedTodoCount: number;
-        completedTodoPerDay: Record<string, number>;
-      }
-    >;
-  };
-}
-export type IGetBoardResponse = IResponse<IGetBoardData>;
-
-export interface IGetBySlugBoardData {
-  board: IBoard;
-  metrics: {
-    cardMetrics: Record<
-      string,
-      {
-        documentCount: number;
-        commentCount: number;
-        memberCount: number;
-        todoCount: number;
-        completedTodoCount: number;
-        completedTodoPerDay: Record<string, number>;
-      }
-    >;
-  };
-}
-export type IGetBySlugBoardResponse = IResponse<IGetBySlugBoardData>;
-
-export interface IUpdateBoardData {
-  board: IBoard;
-}
-export type IUpdateBoardResponse = IResponse<IUpdateBoardData>;
-
-export interface ICreateBoardData {
-  board: IBoard;
-}
-export type ICreateBoardResponse = IResponse<ICreateBoardData>;
-
-export interface IDeleteBoardData {}
-export type IDeleteBoardResponse = IResponse<IDeleteBoardData>;
-
-export interface IGetNextCardPreviewBoardData {
-  boardCard: IBoardCard[];
-}
-export type IGetNextCardPreviewBoardResponse = IResponse<IGetNextCardPreviewBoardData>;
-
-export interface IListBoardUserData {
-  boards: {
-    board: IBoard;
-    activityPerDay: Record<string, number>;
-    checklistRowPerDay: Record<string, { created: number; completed: number }>;
-    almostLateCard: string[];
-    lateCard: string[];
-  }[];
-}
-export type IListBoardUserResponse = IResponse<IListBoardUserData>;
+import { IResponse } from '../type-message/response';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IBoardCard } from '../../models/board-card.dto';
+import { IBoard } from '../../models/board.dto';
+import { SharePermission } from '../../../enum/content-share.enum';
+
+export interface IGetBoardData {
+  board: IBoard;
+  metrics: {
+    cardMetrics: Record<
+      string,
+      {
+        documentCount: number;
+        commentCount: number;
+        memberCount: number;
+        todoCount: number;
+        completedTodoCount: number;
+        completedTodoPerDay: Record<string, number>;
+      }
+    >;
+  };
+  sharePermission?: SharePermission | null;
+}
+export type IGetBoardResponse = IResponse<IGetBoardData>;
+
+export interface IGetBySlugBoardData {
+  board: IBoard;
+  metrics: {
+    cardMetrics: Record<
+      string,
+      {
+        documentCount: number;
+        commentCount: number;
+        memberCount: number;
+        todoCount: number;
+        completedTodoCount: number;
+        completedTodoPerDay: Record<string, number>;
+      }
+    >;
+  };
+  sharePermission?: SharePermission | null;
+}
+export type IGetBySlugBoardResponse = IResponse<IGetBySlugBoardData>;
+
+export interface IUpdateBoardData {
+  board: IBoard;
+}
+export type IUpdateBoardResponse = IResponse<IUpdateBoardData>;
+
+export interface ICreateBoardData {
+  board: IBoard;
+}
+export type ICreateBoardResponse = IResponse<ICreateBoardData>;
+
+export interface IDeleteBoardData {}
+export type IDeleteBoardResponse = IResponse<IDeleteBoardData>;
+
+export interface IGetNextCardPreviewBoardData {
+  boardCard: IBoardCard[];
+}
+export type IGetNextCardPreviewBoardResponse = IResponse<IGetNextCardPreviewBoardData>;
+
+export interface IListBoardUserData {
+  boards: {
+    board: IBoard;
+    activityPerDay: Record<string, number>;
+    checklistRowPerDay: Record<string, { created: number; completed: number }>;
+    almostLateCard: string[];
+    lateCard: string[];
+  }[];
+}
+export type IListBoardUserResponse = IResponse<IListBoardUserData>;
+
+export type IPaginateBoardResponse = IResponse<BasePaginate<IBoard>>;
+
+export interface ICountOrganizationBoardData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+export type ICountOrganizationBoardResponse = IResponse<ICountOrganizationBoardData>;

package/src/types/interface/api/responses/count.response.ts

@@ -0,0 +1,9 @@
+import { IResponse } from '../type-message/response';
+
+export interface ICountOrganizationData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+
+export type ICountOrganizationResponse = IResponse<ICountOrganizationData>;

package/src/types/interface/api/responses/draw.public.response.ts

@@ -1,20 +1,22 @@
-import { IResponse } from '../type-message/response';
-import { IDraw } from '../../models/draw.dto';
-
-export interface IGetDrawPublicData {
-  draw: IDraw;
-}
-export type IGetDrawPublicResponse = IResponse<IGetDrawPublicData>;
-
-export interface IUpdateDrawPublicData {
-  draw: IDraw;
-}
-export type IUpdateDrawPublicResponse = IResponse<IUpdateDrawPublicData>;
-
-export interface ICreateDrawPublicData {
-  draw: IDraw;
-}
-export type ICreateDrawPublicResponse = IResponse<ICreateDrawPublicData>;
-
-export interface IDeleteDrawPublicData {}
-export type IDeleteDrawPublicResponse = IResponse<IDeleteDrawPublicData>;
+import { IResponse } from '../type-message/response';
+import { IDraw } from '../../models/draw.dto';
+
+export interface IGetDrawPublicData {
+  draw: IDraw;
+}
+export type IGetDrawPublicResponse = IResponse<IGetDrawPublicData>;
+
+export interface IUpdateDrawPublicData {
+  draw: IDraw;
+}
+export type IUpdateDrawPublicResponse = IResponse<IUpdateDrawPublicData>;
+
+export interface ICreateDrawPublicData {
+  draw: IDraw;
+  viewToken: string | null;
+  editToken: string | null;
+}
+export type ICreateDrawPublicResponse = IResponse<ICreateDrawPublicData>;
+
+export interface IDeleteDrawPublicData {}
+export type IDeleteDrawPublicResponse = IResponse<IDeleteDrawPublicData>;

package/src/types/interface/api/responses/draw.response.ts

@@ -1,23 +1,32 @@
-import { BasePaginate } from '../type-message/base-paginate';
-import { IResponse } from '../type-message/response';
-import { IDraw } from '../../models/draw.dto';
-
-export interface IGetDrawData {
-  draw: IDraw;
-}
-export type IGetDrawResponse = IResponse<IGetDrawData>;
-
-export interface IUpdateDrawData {
-  draw: IDraw;
-}
-export type IUpdateDrawResponse = IResponse<IUpdateDrawData>;
-
-export interface ICreateDrawData {
-  draw: IDraw;
-}
-export type ICreateDrawResponse = IResponse<ICreateDrawData>;
-
-export interface IDeleteDrawData {}
-export type IDeleteDrawResponse = IResponse<IDeleteDrawData>;
-
-export type IPaginateDrawResponse = IResponse<BasePaginate<IDraw>>;
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+import { IDraw } from '../../models/draw.dto';
+import { SharePermission } from '../../../enum/content-share.enum';
+
+export interface IGetDrawData {
+  draw: IDraw;
+  sharePermission?: SharePermission | null;
+}
+export type IGetDrawResponse = IResponse<IGetDrawData>;
+
+export interface IUpdateDrawData {
+  draw: IDraw;
+}
+export type IUpdateDrawResponse = IResponse<IUpdateDrawData>;
+
+export interface ICreateDrawData {
+  draw: IDraw;
+}
+export type ICreateDrawResponse = IResponse<ICreateDrawData>;
+
+export interface IDeleteDrawData {}
+export type IDeleteDrawResponse = IResponse<IDeleteDrawData>;
+
+export type IPaginateDrawResponse = IResponse<BasePaginate<IDraw>>;
+
+export interface ICountOrganizationDrawData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+export type ICountOrganizationDrawResponse = IResponse<ICountOrganizationDrawData>;

package/src/types/interface/api/responses/enriched-paginate.response.ts

@@ -0,0 +1,11 @@
+import { IContentShare } from '../../models/content-share.dto';
+import { SharePermission } from '../../../enum/content-share.enum';
+import { BasePaginate } from '../type-message/base-paginate';
+
+export interface IEnrichedContentItem<T> {
+  item: T;
+  shares: IContentShare[];
+  permission: SharePermission;
+}
+
+export type EnrichedPaginate<T> = BasePaginate<IEnrichedContentItem<T>>;

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

@@ -1,26 +1,31 @@
-export * from './abyss.admin.response';
-export * from './atlas.response';
-export * from './atlas.public.response';
-export * from './atlas-document.response';
-export * from './atlas-group.response';
-export * from './atlas-page.response';
-export * from './board.response';
-export * from './board-card.response';
-export * from './board-card-checklist.response';
-export * from './board-card-comment.response';
-export * from './board-card-document.response';
-export * from './board-column.response';
-export * from './board-label.response';
-export * from './draw.response';
-export * from './draw.public.response';
-export * from './memo.response';
-export * from './retrospective.response';
-export * from './retrospective.public.response';
-export * from './retrospective-card.response';
-export * from './retrospective-member.response';
-export * from './retrospective-section.response';
-export * from './short-link.response';
-export * from './short-link.public.response';
-export * from './short-link.admin.response';
-export * from './metrics.response';
-export * from './user-tag.response';
+export * from './abyss.admin.response';
+export * from './atlas.response';
+export * from './atlas.public.response';
+export * from './atlas-document.response';
+export * from './atlas-group.response';
+export * from './atlas-page.response';
+export * from './board.response';
+export * from './board-card.response';
+export * from './board-card-checklist.response';
+export * from './board-card-comment.response';
+export * from './board-card-document.response';
+export * from './board-column.response';
+export * from './board-label.response';
+export * from './draw.response';
+export * from './draw.public.response';
+export * from './memo.response';
+export * from './retrospective.response';
+export * from './retrospective.public.response';
+export * from './retrospective-card.response';
+export * from './retrospective-member.response';
+export * from './retrospective-section.response';
+export * from './short-link.response';
+export * from './short-link.public.response';
+export * from './short-link.admin.response';
+export * from './metrics.response';
+export * from './tag.response';
+export * from './enriched-paginate.response';
+export * from './count.response';
+export * from './recent.response';
+export * from './transfer.response';
+export * from './rcb.response';

package/src/types/interface/api/responses/memo.response.ts

@@ -1,23 +1,32 @@
-import { BasePaginate } from '../type-message/base-paginate';
-import { IResponse } from '../type-message/response';
-import { IMemo } from '../../models/memo.dto';
-
-export interface IGetMemoData {
-  memo: IMemo;
-}
-export type IGetMemoResponse = IResponse<IGetMemoData>;
-
-export interface IUpdateMemoData {
-  memo: IMemo;
-}
-export type IUpdateMemoResponse = IResponse<IUpdateMemoData>;
-
-export interface ICreateMemoData {
-  memo: IMemo;
-}
-export type ICreateMemoResponse = IResponse<ICreateMemoData>;
-
-export interface IDeleteMemoData {}
-export type IDeleteMemoResponse = IResponse<IDeleteMemoData>;
-
-export type IPaginateMemoResponse = IResponse<BasePaginate<IMemo>>;
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+import { IMemo } from '../../models/memo.dto';
+import { SharePermission } from '../../../enum/content-share.enum';
+
+export interface IGetMemoData {
+  memo: IMemo;
+  sharePermission?: SharePermission | null;
+}
+export type IGetMemoResponse = IResponse<IGetMemoData>;
+
+export interface IUpdateMemoData {
+  memo: IMemo;
+}
+export type IUpdateMemoResponse = IResponse<IUpdateMemoData>;
+
+export interface ICreateMemoData {
+  memo: IMemo;
+}
+export type ICreateMemoResponse = IResponse<ICreateMemoData>;
+
+export interface IDeleteMemoData {}
+export type IDeleteMemoResponse = IResponse<IDeleteMemoData>;
+
+export type IPaginateMemoResponse = IResponse<BasePaginate<IMemo>>;
+
+export interface ICountOrganizationMemoData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+export type ICountOrganizationMemoResponse = IResponse<ICountOrganizationMemoData>;

package/src/types/interface/api/responses/metrics.response.ts

@@ -1,16 +1,22 @@
-import { IResponse } from '../type-message/response';
-
-export interface IToolsMetrics {
-  boardCount: number;
-  drawCount: number;
-  memoCount: number;
-  atlasCount: number;
-  retrospectiveCount: number;
-  shortLinkCount: number;
-}
-
-export interface IGetOrganizationToolsMetricsData {
-  metrics: IToolsMetrics;
-}
-
-export type IGetOrganizationToolsMetricsResponse = IResponse<IGetOrganizationToolsMetricsData>;
+import { IResponse } from '../type-message/response';
+
+export interface IToolsMetrics {
+  boardCount: number;
+  drawCount: number;
+  memoCount: number;
+  atlasCount: number;
+  retrospectiveCount: number;
+  shortLinkCount: number;
+}
+
+export interface IGetOrganizationToolsMetricsData {
+  metrics: IToolsMetrics;
+}
+
+export type IGetOrganizationToolsMetricsResponse = IResponse<IGetOrganizationToolsMetricsData>;
+
+export interface IGetProjectToolsMetricsData {
+  metrics: IToolsMetrics;
+}
+
+export type IGetProjectToolsMetricsResponse = IResponse<IGetProjectToolsMetricsData>;