@abyss-project/tools 1.0.0 → 1.0.1

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

@@ -0,0 +1,54 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateTagBody = {
+  name: string;
+  color: string;
+  organizationId?: string;
+};
+
+export type IListTagQuery = {
+  organizationId?: string;
+};
+
+export type ITagStatsQuery = {
+  organizationId?: string;
+};
+
+export type IUpdateTagParams = {
+  tagId: string;
+};
+export type IUpdateTagBody = {
+  name?: string;
+  color?: string;
+};
+
+export type IGetTagParams = {
+  tagId: string;
+};
+
+export type IDeleteTagParams = {
+  tagId: string;
+};
+
+export type IPaginateTagQuery = {
+  name?: string;
+} & QueryPaginate;
+
+export type IAssignTagParams = {
+  entityType: string;
+  entityId: string;
+};
+export type IAssignTagBody = {
+  tagId: string;
+};
+
+export type IUnassignTagParams = {
+  entityType: string;
+  entityId: string;
+  tagId: string;
+};
+
+export type IGetEntityTagsParams = {
+  entityType: string;
+  entityId: string;
+};

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

@@ -0,0 +1,3 @@
+export interface ITransferContentBody {
+  newOwnerId: string;
+}

package/src/types/interface/api/responses/abyss.admin.response.ts

@@ -1,17 +1,28 @@
-import { IUser, IOrganization, IProject } from '../..';
-import { IResponse } from '../type-message/response';
-
-export interface IActivateUserServiceAbyssAdminData {
-  user: IUser;
-}
-export type IActivateUserServiceAbyssAdminResponse = IResponse<IActivateUserServiceAbyssAdminData>;
-
-export interface ISyncOrganizationAbyssAdminData {
-  organization: IOrganization;
-}
-export type ISyncOrganizationAbyssAdminResponse = IResponse<ISyncOrganizationAbyssAdminData>;
-
-export interface ISyncProjectAbyssAdminData {
-  project: IProject;
-}
-export type ISyncProjectAbyssAdminResponse = IResponse<ISyncProjectAbyssAdminData>;
+import { IUser, IOrganization, IProject } from '../..';
+import { IResponse } from '../type-message/response';
+
+export interface IActivateUserServiceAbyssAdminData {
+  user: IUser;
+}
+export type IActivateUserServiceAbyssAdminResponse = IResponse<IActivateUserServiceAbyssAdminData>;
+
+export interface ISyncOrganizationAbyssAdminData {
+  organization: IOrganization;
+}
+export type ISyncOrganizationAbyssAdminResponse = IResponse<ISyncOrganizationAbyssAdminData>;
+
+export interface ISyncProjectAbyssAdminData {
+  project: IProject;
+}
+export type ISyncProjectAbyssAdminResponse = IResponse<ISyncProjectAbyssAdminData>;
+
+export type IProjectContentSummaryData = {
+  draws: number;
+  boards: number;
+  memos: number;
+  retrospectives: number;
+  shortLinks: number;
+  atlas: number;
+};
+
+export type IGetProjectContentSummaryAdminResponse = IResponse<IProjectContentSummaryData>;

package/src/types/interface/api/responses/atlas-document.response.ts

@@ -1,24 +1,24 @@
-import { IResponse } from '../type-message/response';
-import { BasePaginate } from '../type-message/base-paginate';
-import { IAtlasDocument } from '../..';
-
-export interface IGetAtlasDocumentData {
-  atlasDocument: IAtlasDocument;
-}
-export type IGetAtlasDocumentResponse = IResponse<IGetAtlasDocumentData>;
-
-export interface IGetUploadPreSignedUrlAtlasDocumentData {
-  preSignedUrl: string;
-}
-export type IGetUploadPreSignedUrlAtlasDocumentResponse =
-  IResponse<IGetUploadPreSignedUrlAtlasDocumentData>;
-
-export interface IDeleteAtlasDocumentData {}
-export type IDeleteAtlasDocumentResponse = IResponse<IDeleteAtlasDocumentData>;
-
-export type IPaginateAtlasDocumentResponse = IResponse<BasePaginate<IAtlasDocument>>;
-
-export interface IListAtlasDocumentData {
-  atlasDocuments: IAtlasDocument[];
-}
-export type IListAtlasDocumentResponse = IResponse<IListAtlasDocumentData>;
+import { IResponse } from '../type-message/response';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IAtlasDocument } from '../..';
+
+export interface IGetAtlasDocumentData {
+  atlasDocument: IAtlasDocument;
+}
+export type IGetAtlasDocumentResponse = IResponse<IGetAtlasDocumentData>;
+
+export interface IGetUploadPreSignedUrlAtlasDocumentData {
+  preSignedUrl: string;
+}
+export type IGetUploadPreSignedUrlAtlasDocumentResponse =
+  IResponse<IGetUploadPreSignedUrlAtlasDocumentData>;
+
+export interface IDeleteAtlasDocumentData {}
+export type IDeleteAtlasDocumentResponse = IResponse<IDeleteAtlasDocumentData>;
+
+export type IPaginateAtlasDocumentResponse = IResponse<BasePaginate<IAtlasDocument>>;
+
+export interface IListAtlasDocumentData {
+  atlasDocuments: IAtlasDocument[];
+}
+export type IListAtlasDocumentResponse = IResponse<IListAtlasDocumentData>;

package/src/types/interface/api/responses/atlas-group.response.ts

@@ -1,23 +1,23 @@
-import { IResponse } from '../type-message/response';
-import { BasePaginate } from '../type-message/base-paginate';
-import { IAtlasGroup } from '../..';
-
-export interface IGetAtlasGroupData {
-  atlasGroup: IAtlasGroup;
-}
-export type IGetAtlasGroupResponse = IResponse<IGetAtlasGroupData>;
-
-export type IPaginateAtlasGroupResponse = IResponse<BasePaginate<IAtlasGroup>>;
-
-export interface ICreateAtlasGroupData {
-  atlasGroup: IAtlasGroup;
-}
-export type ICreateAtlasGroupResponse = IResponse<ICreateAtlasGroupData>;
-
-export interface IUpdateAtlasGroupData {
-  atlasGroup: IAtlasGroup;
-}
-export type IUpdateAtlasGroupResponse = IResponse<IUpdateAtlasGroupData>;
-
-export interface IDeleteAtlasGroupData {}
-export type IDeleteAtlasGroupResponse = IResponse<IDeleteAtlasGroupData>;
+import { IResponse } from '../type-message/response';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IAtlasGroup } from '../..';
+
+export interface IGetAtlasGroupData {
+  atlasGroup: IAtlasGroup;
+}
+export type IGetAtlasGroupResponse = IResponse<IGetAtlasGroupData>;
+
+export type IPaginateAtlasGroupResponse = IResponse<BasePaginate<IAtlasGroup>>;
+
+export interface ICreateAtlasGroupData {
+  atlasGroup: IAtlasGroup;
+}
+export type ICreateAtlasGroupResponse = IResponse<ICreateAtlasGroupData>;
+
+export interface IUpdateAtlasGroupData {
+  atlasGroup: IAtlasGroup;
+}
+export type IUpdateAtlasGroupResponse = IResponse<IUpdateAtlasGroupData>;
+
+export interface IDeleteAtlasGroupData {}
+export type IDeleteAtlasGroupResponse = IResponse<IDeleteAtlasGroupData>;

package/src/types/interface/api/responses/atlas-page.response.ts

@@ -1,53 +1,53 @@
-import { IResponse } from '../type-message/response';
-import { BasePaginate } from '../type-message/base-paginate';
-import { IAtlasPage, IAtlasPageContent } from '../..';
-
-export interface IGetAtlasPageData {
-  atlasPage: IAtlasPage;
-}
-export type IGetAtlasPageResponse = IResponse<IGetAtlasPageData>;
-
-export type IPaginateAtlasPageResponse = IResponse<BasePaginate<IAtlasPage>>;
-
-export interface ICreateAtlasPageData {
-  atlasPage: IAtlasPage;
-  content?: IAtlasPageContent | null;
-}
-export type ICreateAtlasPageResponse = IResponse<ICreateAtlasPageData>;
-
-export interface IUpdateAtlasPageData {
-  atlasPage: IAtlasPage;
-}
-export type IUpdateAtlasPageResponse = IResponse<IUpdateAtlasPageData>;
-
-export interface IDeleteAtlasPageData {}
-export type IDeleteAtlasPageResponse = IResponse<IDeleteAtlasPageData>;
-
-export interface IUpdateAtlasPageContentData {
-  content: IAtlasPageContent;
-  atlasPage: IAtlasPage;
-}
-export type IUpdateAtlasPageContentResponse = IResponse<IUpdateAtlasPageContentData>;
-
-export type IGetAtlasPageContentHistoryResponse = IResponse<BasePaginate<IAtlasPageContent>>;
-
-export interface IRestoreAtlasPageContentData {
-  content: IAtlasPageContent;
-  atlasPage: IAtlasPage;
-}
-export type IRestoreAtlasPageContentResponse = IResponse<IRestoreAtlasPageContentData>;
-
-export interface IAtlasSearchResult {
-  page: IAtlasPage;
-  content: string;
-  matchCount: number;
-  excerpt: string;
-}
-
-export interface ISearchAtlasContentData {
-  results: IAtlasSearchResult[];
-  total: number;
-  page: number;
-  limit: number;
-}
-export type ISearchAtlasContentResponse = IResponse<ISearchAtlasContentData>;
+import { IResponse } from '../type-message/response';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IAtlasPage, IAtlasPageContent } from '../..';
+
+export interface IGetAtlasPageData {
+  atlasPage: IAtlasPage;
+}
+export type IGetAtlasPageResponse = IResponse<IGetAtlasPageData>;
+
+export type IPaginateAtlasPageResponse = IResponse<BasePaginate<IAtlasPage>>;
+
+export interface ICreateAtlasPageData {
+  atlasPage: IAtlasPage;
+  content?: IAtlasPageContent | null;
+}
+export type ICreateAtlasPageResponse = IResponse<ICreateAtlasPageData>;
+
+export interface IUpdateAtlasPageData {
+  atlasPage: IAtlasPage;
+}
+export type IUpdateAtlasPageResponse = IResponse<IUpdateAtlasPageData>;
+
+export interface IDeleteAtlasPageData {}
+export type IDeleteAtlasPageResponse = IResponse<IDeleteAtlasPageData>;
+
+export interface IUpdateAtlasPageContentData {
+  content: IAtlasPageContent;
+  atlasPage: IAtlasPage;
+}
+export type IUpdateAtlasPageContentResponse = IResponse<IUpdateAtlasPageContentData>;
+
+export type IGetAtlasPageContentHistoryResponse = IResponse<BasePaginate<IAtlasPageContent>>;
+
+export interface IRestoreAtlasPageContentData {
+  content: IAtlasPageContent;
+  atlasPage: IAtlasPage;
+}
+export type IRestoreAtlasPageContentResponse = IResponse<IRestoreAtlasPageContentData>;
+
+export interface IAtlasSearchResult {
+  page: IAtlasPage;
+  content: string;
+  matchCount: number;
+  excerpt: string;
+}
+
+export interface ISearchAtlasContentData {
+  results: IAtlasSearchResult[];
+  total: number;
+  page: number;
+  limit: number;
+}
+export type ISearchAtlasContentResponse = IResponse<ISearchAtlasContentData>;

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

@@ -1,21 +1,21 @@
-import { IResponse } from '../type-message/response';
-import { IAtlas, IAtlasPage } from '../..';
-import { IAtlasSearchResult } from './atlas-page.response';
-
-export interface IGetAtlasPublicData {
-  atlas: IAtlas;
-}
-export type IGetAtlasPublicResponse = IResponse<IGetAtlasPublicData>;
-
-export interface IGetPageAtlasPublicData {
-  atlasPage: IAtlasPage;
-}
-export type IGetPageAtlasPublicResponse = IResponse<IGetPageAtlasPublicData>;
-
-export interface ISearchContentAtlasPublicData {
-  results: IAtlasSearchResult[];
-  total: number;
-  page: number;
-  limit: number;
-}
-export type ISearchContentAtlasPublicResponse = IResponse<ISearchContentAtlasPublicData>;
+import { IResponse } from '../type-message/response';
+import { IAtlas, IAtlasPage } from '../..';
+import { IAtlasSearchResult } from './atlas-page.response';
+
+export interface IGetAtlasPublicData {
+  atlas: IAtlas;
+}
+export type IGetAtlasPublicResponse = IResponse<IGetAtlasPublicData>;
+
+export interface IGetPageAtlasPublicData {
+  atlasPage: IAtlasPage;
+}
+export type IGetPageAtlasPublicResponse = IResponse<IGetPageAtlasPublicData>;
+
+export interface ISearchContentAtlasPublicData {
+  results: IAtlasSearchResult[];
+  total: number;
+  page: number;
+  limit: number;
+}
+export type ISearchContentAtlasPublicResponse = IResponse<ISearchContentAtlasPublicData>;

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

@@ -1,23 +1,32 @@
-import { IResponse } from '../type-message/response';
-import { BasePaginate } from '../type-message/base-paginate';
-import { IAtlas } from '../..';
-
-export interface IGetAtlasData {
-  atlas: IAtlas;
-}
-export type IGetAtlasResponse = IResponse<IGetAtlasData>;
-
-export type IPaginateAtlasResponse = IResponse<BasePaginate<IAtlas>>;
-
-export interface ICreateAtlasData {
-  atlas: IAtlas;
-}
-export type ICreateAtlasResponse = IResponse<ICreateAtlasData>;
-
-export interface IUpdateAtlasData {
-  atlas: IAtlas;
-}
-export type IUpdateAtlasResponse = IResponse<IUpdateAtlasData>;
-
-export interface IDeleteAtlasData {}
-export type IDeleteAtlasResponse = IResponse<IDeleteAtlasData>;
+import { IResponse } from '../type-message/response';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IAtlas } from '../..';
+import { SharePermission } from '../../../enum/content-share.enum';
+
+export interface IGetAtlasData {
+  atlas: IAtlas;
+  sharePermission?: SharePermission | null;
+}
+export type IGetAtlasResponse = IResponse<IGetAtlasData>;
+
+export type IPaginateAtlasResponse = IResponse<BasePaginate<IAtlas>>;
+
+export interface ICreateAtlasData {
+  atlas: IAtlas;
+}
+export type ICreateAtlasResponse = IResponse<ICreateAtlasData>;
+
+export interface IUpdateAtlasData {
+  atlas: IAtlas;
+}
+export type IUpdateAtlasResponse = IResponse<IUpdateAtlasData>;
+
+export interface IDeleteAtlasData {}
+export type IDeleteAtlasResponse = IResponse<IDeleteAtlasData>;
+
+export interface ICountOrganizationAtlasData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+export type ICountOrganizationAtlasResponse = IResponse<ICountOrganizationAtlasData>;

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

@@ -1,31 +1,31 @@
-import { IResponse } from '../type-message/response';
-import { IBoardCardChecklist, IBoardCardChecklistRow } from '../..';
-
-export interface IGetBoardCardChecklistData {
-  boardCardChecklist: IBoardCardChecklist;
-}
-export type IGetBoardCardChecklistResponse = IResponse<IGetBoardCardChecklistData>;
-
-export interface IUpdateBoardCardChecklistData {
-  boardCardChecklist: IBoardCardChecklist;
-}
-export type IUpdateBoardCardChecklistResponse = IResponse<IUpdateBoardCardChecklistData>;
-
-export interface ICreateBoardCardChecklistData {
-  boardCardChecklist: IBoardCardChecklist;
-}
-export type ICreateBoardCardChecklistResponse = IResponse<ICreateBoardCardChecklistData>;
-
-export interface IDeleteBoardCardChecklistData {}
-export type IDeleteBoardCardChecklistResponse = IResponse<IDeleteBoardCardChecklistData>;
-
-export interface IAddRowBoardCardChecklistData {
-  boardCardChecklistRow: IBoardCardChecklistRow;
-}
-export type IAddRowBoardCardChecklistResponse = IResponse<IAddRowBoardCardChecklistData>;
-
-export interface IRemoveRowBoardCardChecklistData {}
-export type IRemoveRowBoardCardChecklistResponse = IResponse<IRemoveRowBoardCardChecklistData>;
-
-export interface IUpdateRowBoardCardChecklistData {}
-export type IUpdateRowBoardCardChecklistResponse = IResponse<IUpdateRowBoardCardChecklistData>;
+import { IResponse } from '../type-message/response';
+import { IBoardCardChecklist, IBoardCardChecklistRow } from '../..';
+
+export interface IGetBoardCardChecklistData {
+  boardCardChecklist: IBoardCardChecklist;
+}
+export type IGetBoardCardChecklistResponse = IResponse<IGetBoardCardChecklistData>;
+
+export interface IUpdateBoardCardChecklistData {
+  boardCardChecklist: IBoardCardChecklist;
+}
+export type IUpdateBoardCardChecklistResponse = IResponse<IUpdateBoardCardChecklistData>;
+
+export interface ICreateBoardCardChecklistData {
+  boardCardChecklist: IBoardCardChecklist;
+}
+export type ICreateBoardCardChecklistResponse = IResponse<ICreateBoardCardChecklistData>;
+
+export interface IDeleteBoardCardChecklistData {}
+export type IDeleteBoardCardChecklistResponse = IResponse<IDeleteBoardCardChecklistData>;
+
+export interface IAddRowBoardCardChecklistData {
+  boardCardChecklistRow: IBoardCardChecklistRow;
+}
+export type IAddRowBoardCardChecklistResponse = IResponse<IAddRowBoardCardChecklistData>;
+
+export interface IRemoveRowBoardCardChecklistData {}
+export type IRemoveRowBoardCardChecklistResponse = IResponse<IRemoveRowBoardCardChecklistData>;
+
+export interface IUpdateRowBoardCardChecklistData {}
+export type IUpdateRowBoardCardChecklistResponse = IResponse<IUpdateRowBoardCardChecklistData>;

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

@@ -1,20 +1,20 @@
-import { IResponse } from '../type-message/response';
-import { IBoardCardComment } from '../..';
-
-export interface IGetBoardCardCommentData {
-  boardCardComment: IBoardCardComment;
-}
-export type IGetBoardCardCommentResponse = IResponse<IGetBoardCardCommentData>;
-
-export interface IUpdateBoardCardCommentData {
-  boardCardComment: IBoardCardComment;
-}
-export type IUpdateBoardCardCommentResponse = IResponse<IUpdateBoardCardCommentData>;
-
-export interface ICreateBoardCardCommentData {
-  boardCardComment: IBoardCardComment;
-}
-export type ICreateBoardCardCommentResponse = IResponse<ICreateBoardCardCommentData>;
-
-export interface IDeleteBoardCardCommentData {}
-export type IDeleteBoardCardCommentResponse = IResponse<IDeleteBoardCardCommentData>;
+import { IResponse } from '../type-message/response';
+import { IBoardCardComment } from '../..';
+
+export interface IGetBoardCardCommentData {
+  boardCardComment: IBoardCardComment;
+}
+export type IGetBoardCardCommentResponse = IResponse<IGetBoardCardCommentData>;
+
+export interface IUpdateBoardCardCommentData {
+  boardCardComment: IBoardCardComment;
+}
+export type IUpdateBoardCardCommentResponse = IResponse<IUpdateBoardCardCommentData>;
+
+export interface ICreateBoardCardCommentData {
+  boardCardComment: IBoardCardComment;
+}
+export type ICreateBoardCardCommentResponse = IResponse<ICreateBoardCardCommentData>;
+
+export interface IDeleteBoardCardCommentData {}
+export type IDeleteBoardCardCommentResponse = IResponse<IDeleteBoardCardCommentData>;

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

@@ -1,21 +1,21 @@
-import { IResponse } from '../type-message/response';
-import { IBoardCardDocument } from '../..';
-
-export interface IGetBoardCardDocumentData {
-  boardCardDocument: IBoardCardDocument;
-}
-export type IGetBoardCardDocumentResponse = IResponse<IGetBoardCardDocumentData>;
-
-export interface IGetUploadPreSignedUrlBoardCardDocumentData {
-  preSignedUrl: string;
-}
-export type IGetUploadPreSignedUrlBoardCardDocumentResponse =
-  IResponse<IGetUploadPreSignedUrlBoardCardDocumentData>;
-
-export interface IDeleteBoardCardDocumentData {}
-export type IDeleteBoardCardDocumentResponse = IResponse<IDeleteBoardCardDocumentData>;
-
-export interface ICloudImportBoardCardDocumentData {
-  errors: { fileId: string; code: string }[];
-}
-export type ICloudImportBoardCardDocumentResponse = IResponse<ICloudImportBoardCardDocumentData>;
+import { IResponse } from '../type-message/response';
+import { IBoardCardDocument } from '../..';
+
+export interface IGetBoardCardDocumentData {
+  boardCardDocument: IBoardCardDocument;
+}
+export type IGetBoardCardDocumentResponse = IResponse<IGetBoardCardDocumentData>;
+
+export interface IGetUploadPreSignedUrlBoardCardDocumentData {
+  preSignedUrl: string;
+}
+export type IGetUploadPreSignedUrlBoardCardDocumentResponse =
+  IResponse<IGetUploadPreSignedUrlBoardCardDocumentData>;
+
+export interface IDeleteBoardCardDocumentData {}
+export type IDeleteBoardCardDocumentResponse = IResponse<IDeleteBoardCardDocumentData>;
+
+export interface ICloudImportBoardCardDocumentData {
+  errors: { fileId: string; code: string }[];
+}
+export type ICloudImportBoardCardDocumentResponse = IResponse<ICloudImportBoardCardDocumentData>;