@abyss-project/tools 1.0.0

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

@@ -0,0 +1,42 @@
+export type ICreateBoardLabelParams = {
+  boardId: string;
+};
+export type ICreateBoardLabelBody = {
+  name: string;
+  color: string;
+};
+
+export type IUpdateBoardLabelParams = {
+  boardId: string;
+  boardLabelId: string;
+};
+export type IUpdateBoardLabelBody = {
+  name?: string;
+  color?: string;
+};
+
+export type IGetBoardLabelParams = {
+  boardId: string;
+  boardLabelId: string;
+};
+
+export type IDeleteBoardLabelParams = {
+  boardId: string;
+  boardLabelId: string;
+};
+
+export type IAddBoardLabelParams = {
+  boardId: string;
+  boardCardId: string;
+  boardLabelId: string;
+};
+
+export type IRemoveBoardLabelParams = {
+  boardId: string;
+  boardCardId: string;
+  boardLabelId: string;
+};
+
+export type IListBoardLabelParams = {
+  boardId: string;
+};

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

@@ -0,0 +1,30 @@
+export type ICreateForProjectBoardParams = {
+  projectId: string;
+};
+export type ICreateBoardBody = {
+  title: string;
+};
+
+export type IUpdateBoardParams = {
+  boardId: string;
+};
+export type IUpdateBoardBody = {
+  title?: string;
+  archived?: boolean;
+};
+
+export type IGetBoardParams = {
+  boardId: string;
+};
+
+export type ISSEBoardParams = {
+  boardId: string;
+};
+
+export type IGetBySlugBoardParams = {
+  slug: string;
+};
+
+export type IDeleteBoardParams = {
+  boardId: string;
+};

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

@@ -0,0 +1,20 @@
+export type ICreateDrawPublicBody = {
+  title: string;
+  content: string;
+};
+
+export type IUpdateDrawPublicParams = {
+  publicAccessToken: string;
+};
+export type IUpdateDrawPublicBody = {
+  title?: string;
+  content?: string;
+};
+
+export type IGetDrawPublicParams = {
+  publicAccessToken: string;
+};
+
+export type IDeleteDrawPublicParams = {
+  publicAccessToken: string;
+};

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

@@ -0,0 +1,37 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateForProjectDrawParams = {
+  projectId: string;
+};
+export type ICreateDrawBody = {
+  title: string;
+  content: string;
+};
+
+export type IUpdateDrawParams = {
+  drawId: string;
+};
+export type IUpdateDrawBody = {
+  title?: string;
+  archived?: boolean;
+  content?: string;
+  enablePublicReadAccess?: boolean;
+  enablePublicWriteAccess?: boolean;
+};
+
+export type IGetDrawParams = {
+  drawId: string;
+};
+
+export type IDeleteDrawParams = {
+  drawId: string;
+};
+
+export type IPaginateDrawQuery = {
+  title?: string;
+  archived?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectDrawParams = {
+  projectId: string;
+};

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

@@ -0,0 +1,26 @@
+export * from './abyss.admin.request';
+export * from './atlas.request';
+export * from './atlas.public.request';
+export * from './atlas-document.request';
+export * from './atlas-group.request';
+export * from './atlas-page.request';
+export * from './board.request';
+export * from './board-card.request';
+export * from './board-card-checklist.request';
+export * from './board-card-comment.request';
+export * from './board-card-document.request';
+export * from './board-column.request';
+export * from './board-label.request';
+export * from './draw.request';
+export * from './draw.public.request';
+export * from './memo.request';
+export * from './retrospective.request';
+export * from './retrospective.public.request';
+export * from './retrospective-card.request';
+export * from './retrospective-member.request';
+export * from './retrospective-section.request';
+export * from './short-link.request';
+export * from './short-link.public.request';
+export * from './short-link.admin.request';
+export * from './metrics.request';
+export * from './user-tag.request';

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

@@ -0,0 +1,35 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateForProjectMemoParams = {
+  projectId: string;
+};
+export type ICreateMemoBody = {
+  title: string;
+  content: string;
+};
+
+export type IUpdateMemoParams = {
+  memoId: string;
+};
+export type IUpdateMemoBody = {
+  title?: string;
+  content?: string;
+  archived?: boolean;
+};
+
+export type IGetMemoParams = {
+  memoId: string;
+};
+
+export type IDeleteMemoParams = {
+  memoId: string;
+};
+
+export type IPaginateMemoQuery = {
+  title?: string;
+  archived?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectMemoParams = {
+  projectId: string;
+};

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

@@ -0,0 +1,3 @@
+export interface IGetOrganizationToolsMetricsParams {
+  organizationId: string;
+}

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

@@ -0,0 +1,38 @@
+export interface IGetRetrospectiveCardParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}
+
+export interface IPaginateRetrospectiveCardParams {
+  retrospectiveId: string;
+}
+export interface IPaginateRetrospectiveCardQuery {
+  page?: number;
+  limit?: number;
+}
+
+export type ICreateRetrospectiveCardParams = {
+  retrospectiveId: string;
+};
+
+export interface ICreateRetrospectiveCardBody {
+  content: string;
+  positionX: number;
+  positionY: number;
+}
+
+export interface IUpdateRetrospectiveCardParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}
+
+export interface IUpdateRetrospectiveCardBody {
+  content?: string;
+  positionX?: number;
+  positionY?: number;
+}
+
+export interface IDeleteRetrospectiveCardParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}

package/src/types/interface/api/requests/retrospective-member.request.ts

@@ -0,0 +1,20 @@
+export interface IGetRetrospectiveMemberParams {
+  retrospectiveId: string;
+  retrospectiveMemberId: string;
+}
+
+export interface IListRetrospectiveMemberParams {
+  retrospectiveId: string;
+}
+
+export type IJoinRetrospectiveMemberParams = {
+  retrospectiveId: string;
+};
+
+export type IUpdateRetrospectiveMemberParams = {
+  retrospectiveId: string;
+};
+export interface IUpdateRetrospectiveMemberBody {
+  alias?: string;
+  unmasked?: boolean;
+}

package/src/types/interface/api/requests/retrospective-section.request.ts

@@ -0,0 +1,43 @@
+export interface IGetRetrospectiveSectionParams {
+  retrospectiveId: string;
+  retrospectiveSectionId: string;
+}
+
+export interface IPaginateRetrospectiveSectionParams {
+  retrospectiveId: string;
+}
+
+export interface IPaginateRetrospectiveSectionQuery {
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateRetrospectiveSectionParams {
+  retrospectiveId: string;
+}
+
+export interface ICreateRetrospectiveSectionBody {
+  title: string;
+  description: string;
+  color: string;
+  positionX: number;
+  positionY: number;
+}
+
+export interface IUpdateRetrospectiveSectionParams {
+  retrospectiveId: string;
+  retrospectiveSectionId: string;
+}
+
+export interface IUpdateRetrospectiveSectionBody {
+  title?: string;
+  description?: string;
+  color?: string;
+  positionX?: number;
+  positionY?: number;
+}
+
+export interface IDeleteRetrospectiveSectionParams {
+  retrospectiveId: string;
+  retrospectiveSectionId: string;
+}

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

@@ -0,0 +1,84 @@
+export interface IGetRetrospectivePublicParams {
+  accessToken: string;
+}
+
+export interface IUpdateRetrospectivePublicParams {
+  accessToken: string;
+}
+export interface IUpdateRetrospectivePublicBody {
+  title?: string;
+  description?: string;
+  startDate?: Date | null;
+  endDate?: Date | null;
+}
+
+export type ISSERetrospectivePublicParams = {
+  accessToken: string;
+};
+
+// Section
+export interface ICreateSectionRetrospectivePublicParams {
+  accessToken: string;
+}
+export interface ICreateSectionRetrospectivePublicBody {
+  title: string;
+  description: string;
+  color: string;
+  positionX: number;
+  positionY: number;
+}
+
+export interface IUpdateSectionRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveSectionId: string;
+}
+export interface IUpdateSectionRetrospectivePublicBody {
+  title?: string;
+  description?: string;
+  color?: string;
+  positionX?: number;
+  positionY?: number;
+}
+
+export interface IDeleteSectionRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveSectionId: string;
+}
+
+// Member
+export type IJoinMemberRetrospectivePublicParams = {
+  accessToken: string;
+};
+
+export type IUpdateMemberRetrospectivePublicParams = {
+  accessToken: string;
+};
+export interface IUpdateMemberRetrospectivePublicBody {
+  alias?: string;
+  unmasked?: boolean;
+}
+
+// Card
+export interface ICreateCardRetrospectivePublicParams {
+  accessToken: string;
+}
+export interface ICreateCardRetrospectivePublicBody {
+  content: string;
+  positionX: number;
+  positionY: number;
+}
+
+export interface IUpdateCardRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveCardId: string;
+}
+export interface IUpdateCardRetrospectivePublicBody {
+  content?: string;
+  positionX?: number;
+  positionY?: number;
+}
+
+export interface IDeleteCardRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveCardId: string;
+}

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

@@ -0,0 +1,46 @@
+export interface IGetRetrospectiveParams {
+  retrospectiveId: string;
+}
+
+export interface IPaginateProjectRetrospectiveParams {
+  projectId: string;
+}
+
+export interface IPaginateRetrospectiveQuery {
+  title?: string;
+  archived?: boolean;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateForProjectRetrospectiveParams {
+  projectId: string;
+}
+export interface ICreateRetrospectiveBody {
+  title: string;
+  description: string;
+  startDate: Date | null;
+  endDate: Date | null;
+}
+
+export interface IUpdateRetrospectiveParams {
+  retrospectiveId: string;
+}
+
+export interface IUpdateRetrospectiveBody {
+  title?: string;
+  description?: string;
+  startDate?: Date | null;
+  endDate?: Date | null;
+  archived?: boolean;
+  completed?: boolean;
+  enablePublicAccess?: boolean;
+}
+
+export interface IDeleteRetrospectiveParams {
+  retrospectiveId: string;
+}
+
+export type ISSERetrospectiveParams = {
+  retrospectiveId: string;
+};

package/src/types/interface/api/requests/short-link.admin.request.ts

@@ -0,0 +1,35 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type IPaginateShortLinkAdminQuery = {
+  title?: string;
+  userId?: string;
+  projectId?: string;
+  isActive?: boolean;
+} & QueryPaginate;
+
+export type IGetShortLinkAdminParams = {
+  shortLinkId: string;
+};
+
+export type IDeleteShortLinkAdminParams = {
+  shortLinkId: string;
+};
+
+export type IUpdateShortLinkAdminParams = {
+  shortLinkId: string;
+};
+
+export type IUpdateShortLinkAdminBody = {
+  originalUrl?: string;
+  slug?: string;
+  title?: string;
+  description?: string;
+  isActive?: boolean;
+  expiresAt?: Date | null;
+  maxClicks?: number | null;
+};
+
+export type IGetClicksShortLinkAdminParams = {
+  shortLinkId: string;
+};
+export type IGetClicksShortLinkAdminQuery = QueryPaginate;

package/src/types/interface/api/requests/short-link.public.request.ts

@@ -0,0 +1,40 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateAnonymousShortLinkPublicBody = {
+  originalUrl: string;
+  title?: string;
+  description?: string;
+};
+
+export type IRedirectShortLinkPublicParams = {
+  slug: string;
+};
+
+export type IRedirectShortLinkPublicQuery = {
+  ref?: string;
+  lang?: string;
+  utmSource?: string;
+  utmMedium?: string;
+  utmCampaign?: string;
+  utmTerm?: string;
+  utmContent?: string;
+};
+
+export type IGetStatsShortLinkPublicParams = {
+  shortLinkId: string;
+};
+
+export type IGetStatsShortLinkPublicQuery = {
+  startDate?: Date;
+  endDate?: Date;
+  groupBy?: 'day' | 'week' | 'month';
+};
+
+export type IGetClicksShortLinkPublicParams = {
+  shortLinkId: string;
+};
+export type IGetClicksShortLinkPublicQuery = QueryPaginate;
+
+export type IRenewShortLinkPublicParams = {
+  shortLinkId: string;
+};

package/src/types/interface/api/requests/short-link.request.ts

@@ -0,0 +1,57 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type IGetShortLinkParams = {
+  shortLinkId: string;
+};
+
+export type IPaginateShortLinkQuery = {
+  title?: string;
+  isActive?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectShortLinkParams = {
+  projectId: string;
+};
+
+export type ICreateShortLinkBody = {
+  originalUrl: string;
+  title?: string;
+  description?: string;
+  expiresAt?: Date;
+  maxClicks?: number;
+};
+
+export type ICreateForProjectShortLinkParams = {
+  projectId: string;
+};
+
+export type IUpdateShortLinkParams = {
+  shortLinkId: string;
+};
+
+export type IUpdateShortLinkBody = {
+  originalUrl?: string;
+  title?: string;
+  description?: string;
+  isActive?: boolean;
+  expiresAt?: Date | null;
+  maxClicks?: number | null;
+};
+
+export type IDeleteShortLinkParams = {
+  shortLinkId: string;
+};
+
+export type IGetStatsShortLinkParams = {
+  shortLinkId: string;
+};
+export type IGetStatsShortLinkQuery = {
+  startDate?: Date;
+  endDate?: Date;
+  groupBy?: 'day' | 'week' | 'month';
+};
+
+export type IGetClicksShortLinkParams = {
+  shortLinkId: string;
+};
+export type IGetClicksShortLinkQuery = QueryPaginate;

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

@@ -0,0 +1,45 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateUserTagBody = {
+  name: string;
+  color: string;
+};
+
+export type IUpdateUserTagParams = {
+  userTagId: string;
+};
+export type IUpdateUserTagBody = {
+  name?: string;
+  color?: string;
+};
+
+export type IGetUserTagParams = {
+  userTagId: string;
+};
+
+export type IDeleteUserTagParams = {
+  userTagId: string;
+};
+
+export type IPaginateUserTagQuery = {
+  name?: string;
+} & QueryPaginate;
+
+export type IAssignUserTagParams = {
+  entityType: string;
+  entityId: string;
+};
+export type IAssignUserTagBody = {
+  userTagId: string;
+};
+
+export type IUnassignUserTagParams = {
+  entityType: string;
+  entityId: string;
+  userTagId: string;
+};
+
+export type IGetEntityTagsParams = {
+  entityType: string;
+  entityId: string;
+};

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

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

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

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

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

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