@abyss-project/tools 1.0.5 → 1.2.0

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

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

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

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

@@ -1,52 +1,52 @@
-import { ContentShareScope } 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;
-} & 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;
-};
+import { ContentShareScope } 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;
+} & 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/beam.request.ts

@@ -0,0 +1,152 @@
+import { ContentShareScope } from '../../../enum';
+import { ShareTargetType, SharePermission } from '../../../enum/content-share.enum';
+import { BeamVisibility } from '../../../enum/beam.enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type IGetBeamParams = {
+  beamId: string;
+};
+
+export type IGetBeamBySlugParams = {
+  slug: string;
+};
+
+export type IPaginateBeamQuery = {
+  title?: string;
+  isActive?: boolean;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectBeamParams = {
+  projectId: string;
+};
+
+export type IPaginateOrganizationBeamParams = {
+  organizationId: string;
+};
+
+// Draft-creation metadata bundle (design §4 step 1). Files are attached
+// afterwards (B2) and the transfer is sealed at finalize (B5).
+export type ICreateBeamBody = {
+  title?: string;
+  message?: string;
+  visibility?: BeamVisibility;
+  expiresInDays?: number;
+  password?: string;
+  maxDownloads?: number;
+  recipients?: { email: string; locale?: string }[];
+};
+
+// Anonymous draft creation (POST /beam/public). Same metadata as the owned
+// create minus expiresInDays — anonymous TTL is fixed at 7 days by createDraft.
+export type ICreateBeamPublicBody = {
+  title?: string;
+  message?: string;
+  visibility?: BeamVisibility;
+  password?: string;
+  maxDownloads?: number;
+  recipients?: { email: string; locale?: string }[];
+};
+
+export interface IAddBeamFilesParams {
+  beamId: string;
+}
+
+export interface IAddBeamFilesBody {
+  files: { storageFileId: string }[];
+}
+
+export interface IImportCloudBeamFilesParams {
+  beamId: string;
+}
+
+export interface IImportCloudBeamFilesBody {
+  cloudFileIds: string[];
+}
+
+export interface IFinalizeBeamParams {
+  beamId: string;
+}
+
+export type IFinalizeBeamBody = Record<string, never>;
+
+export type ICreateForOrganizationBeamParams = {
+  organizationId: string;
+};
+
+export type IUpdateBeamParams = {
+  beamId: string;
+};
+
+export type IUpdateBeamBody = {
+  title?: string;
+  message?: string;
+  visibility?: BeamVisibility;
+  isActive?: boolean;
+  expiresAt?: Date | null;
+  maxDownloads?: number | null;
+};
+
+export type IDeleteBeamParams = {
+  beamId: string;
+};
+
+// Public serving (B3): unlock a password-protected transfer to obtain a
+// short-lived unlock token used by the byte-serving endpoints.
+export interface IUnlockBeamPublicParams {
+  slug: string;
+}
+
+export interface IUnlockBeamPublicBody {
+  password: string;
+}
+
+// Management lifecycle (B4): renew/reactivate take only the transfer id. Both
+// push expiresAt forward and reactivate the transfer server-side.
+export interface IRenewBeamParams {
+  beamId: string;
+}
+
+export interface IReactivateBeamParams {
+  beamId: string;
+}
+
+// Sharing (B4): a MANAGE holder grants a content_share (BEAM content type) on the
+// transfer. targetId is null for a LINK share, otherwise the user/team/org/project id.
+export interface ICreateBeamShareParams {
+  beamId: string;
+}
+
+export interface ICreateBeamShareBody {
+  targetType: ShareTargetType;
+  targetId?: string | null;
+  permission: SharePermission;
+}
+
+export interface IListBeamSharesParams {
+  beamId: string;
+}
+
+export interface IRevokeBeamShareParams {
+  beamId: string;
+  shareId: string;
+}
+
+// Recipients (B5): add extra recipients to a transfer (explicit add path,
+// distinct from the recipients recorded at draft time). Capped at
+// MAX_BEAM_RECIPIENTS on the API side.
+export interface IAddRecipientsBeamParams {
+  beamId: string;
+}
+
+export interface IAddRecipientsBeamBody {
+  recipients: { email: string; locale?: string | null }[];
+}
+
+export interface IListRecipientsBeamParams {
+  beamId: string;
+}

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

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