@abyss-project/workspace 0.0.0-stage → 1.0.0

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

@@ -0,0 +1,46 @@
+import { QueryPaginate } from '..';
+
+export type IGetUploadPreSignedUrlAtlasDocumentParams = {
+  atlasId: string;
+  atlasPageId: string;
+};
+export type IGetUploadPreSignedUrlAtlasDocumentBody = {
+  name: string;
+  // SP3 — transparent multipart: the DECLARED size (the front hasn't
+  // necessarily read the file into memory yet, only `file.size`), needed by
+  // `initiateUpload` to pick single-shot vs multipart and to seed the storage
+  // cap check.
+  sizeOctet: number;
+};
+
+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;
+};
+
+// IDOR fix — resolves an AtlasDocument's storage `publicAccessId` server-side
+// (scoped to the caller's AtlasMiddleware-verified atlasId), so the front
+// never needs an unscoped `applicationFile.get` call against storage.
+export type IGetPublicAccessIdAtlasDocumentParams = {
+  atlasId: string;
+  atlasPageId: string;
+  storageFileId: 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,93 @@
+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 IDuplicateAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+export interface IDuplicateAtlasPageBody {
+  /** Title of the copy, chosen by the caller (the front appends its localized "copy" suffix). */
+  title: 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,60 @@
+import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export interface IGetAtlasParams {
+  atlasId: string;
+}
+
+export interface IPaginateProjectAtlasParams {
+  projectId: string;
+}
+
+export type IPaginateAtlasQuery = {
+  title?: string;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+  sortBy?: ToolDocumentSortBy;
+  sortDirection?: SortDirection;
+  /** Keeps the documents carrying at least one of these tags. */
+  tagIds?: string[];
+  /** Inclusive lower bound on the creation date. */
+  createdAfter?: Date;
+  /** Inclusive upper bound on the creation date. */
+  createdBefore?: Date;
+} & QueryPaginate;
+
+export interface ICreateForOrganizationAtlasParams {
+  organizationId: string;
+}
+
+export interface ICreateAtlasBody {
+  title: string;
+  description?: string | null;
+}
+
+export interface IUpdateAtlasParams {
+  atlasId: string;
+}
+export interface IUpdateAtlasBody {
+  title?: string;
+  description?: string | null;
+}
+
+export interface IDeleteAtlasParams {
+  atlasId: string;
+}
+
+export type ISSEAtlasParams = {
+  atlasId: string;
+};
+
+export type IPaginateOrganizationAtlasParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationAtlasParams = {
+  organizationId: 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,34 @@
+export type IGetUploadPreSignedUrlBoardCardDocumentParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type IGetUploadPreSignedUrlBoardCardDocumentBody = {
+  name: string;
+  // SP3 — transparent multipart: the DECLARED size (the front hasn't
+  // necessarily read the file into memory yet, only `file.size`), needed by
+  // `initiateUpload` to pick single-shot vs multipart and to seed the storage
+  // cap check.
+  sizeOctet: number;
+};
+
+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-link.request.ts

@@ -0,0 +1,26 @@
+import { BoardCardLinkTargetType } from '../../../enum/board-card-link-target-type.enum';
+
+export type ICreateBoardCardLinkParams = {
+  boardId: string;
+  boardCardId: string;
+};
+export type ICreateBoardCardLinkBody = {
+  targetType: BoardCardLinkTargetType;
+  targetId: string;
+};
+
+export type IDeleteBoardCardLinkParams = {
+  boardId: string;
+  boardCardId: string;
+  boardCardLinkId: string;
+};
+
+export type IListBoardCardLinkParams = {
+  boardId: string;
+  boardCardId: string;
+};
+
+export type IBacklinksBoardCardLinkQuery = {
+  targetType: BoardCardLinkTargetType;
+  targetId: 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;
+};

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,63 @@
+import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateForOrganizationBoardParams = {
+  organizationId: 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;
+};
+
+export type IListOrganizationBoardParams = {
+  organizationId: string;
+};
+
+export type IListOrganizationBoardQuery = {
+  projectId?: string;
+  scope?: ContentShareScope;
+  adminView?: boolean;
+};
+
+export type IPaginateBoardQuery = {
+  title?: string;
+  archived?: boolean;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+  sortBy?: ToolDocumentSortBy;
+  sortDirection?: SortDirection;
+} & QueryPaginate;
+
+export type IPaginateOrganizationBoardParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationBoardParams = {
+  organizationId: string;
+};

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

@@ -0,0 +1,26 @@
+import { DrawImageMimeType } from '../../../../constants/draw.constants';
+
+export type IGetUploadSessionDrawImageParams = {
+  drawId: string;
+};
+export type IGetUploadSessionDrawImageBody = {
+  name: string;
+  /** Declared size of the file to send, at most MAX_DRAW_IMAGE_SIZE_OCTET. */
+  sizeOctet: number;
+  mimeType: DrawImageMimeType;
+};
+
+export type IGetUploadSessionDrawImagePublicParams = {
+  publicAccessToken: string;
+};
+export type IGetUploadSessionDrawImagePublicBody = IGetUploadSessionDrawImageBody;
+
+export type IGetDrawImageParams = {
+  drawId: string;
+  imageId: string;
+};
+
+export type IGetDrawImagePublicParams = {
+  publicAccessToken: string;
+  imageId: 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;
+};