@abyss-project/workspace 0.0.0-stage → 1.0.0

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

@@ -0,0 +1,63 @@
+import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateForOrganizationDrawParams = {
+  organizationId: string;
+};
+export type ICreateDrawBody = {
+  title: string;
+  content: string;
+  /**
+   * Duplication: the draw the content was copied from. The caller needs access to it; its stored
+   * images are copied server side and the `imageId`/`src` of the content are rewritten to the copies.
+   * Without it, a content must not reference any `imageId`.
+   */
+  sourceDrawId?: string;
+};
+
+export type IUpdateDrawParams = {
+  drawId: string;
+};
+export type IUpdateDrawBody = {
+  title?: string;
+  archived?: boolean;
+  content?: string;
+};
+
+export type IGetDrawParams = {
+  drawId: string;
+};
+
+export type IDeleteDrawParams = {
+  drawId: string;
+};
+
+export type IPaginateDrawQuery = {
+  title?: string;
+  archived?: boolean;
+  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 type IPaginateProjectDrawParams = {
+  projectId: string;
+};
+
+export type IPaginateOrganizationDrawParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationDrawParams = {
+  organizationId: string;
+};

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

@@ -0,0 +1,29 @@
+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-card-link.request';
+export * from './board-column.request';
+export * from './board-label.request';
+export * from './draw.request';
+export * from './draw.public.request';
+export * from './draw-image.request';
+export * from './retrospective.request';
+export * from './retrospective.public.request';
+export * from './retrospective-card.request';
+export * from './retrospective-action.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 './tag.request';
+export * from './transfer.request';

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

@@ -0,0 +1,7 @@
+export interface IGetOrganizationWorkspaceMetricsParams {
+  organizationId: string;
+}
+
+export interface IGetProjectWorkspaceMetricsParams {
+  projectId: string;
+}

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

@@ -0,0 +1,38 @@
+import { RetrospectiveActionStatus } from '../../../enum/retrospective-action-status.enum';
+
+export interface ICreateRetrospectiveActionParams {
+  retrospectiveId: string;
+}
+
+export interface ICreateRetrospectiveActionBody {
+  /** 1 to 500 characters. */
+  content: string;
+  /** A member of the same retrospective. */
+  ownerMemberId?: string | null;
+  /** Calendar day, `YYYY-MM-DD`. */
+  dueDate?: string | null;
+  /** A card of the same retrospective. */
+  sourceCardId?: string | null;
+  /** Omitted: the action goes last. */
+  position?: number;
+}
+
+export interface IUpdateRetrospectiveActionParams {
+  retrospectiveId: string;
+  retrospectiveActionId: string;
+}
+
+/** At least one field. Only `status` may change once the retrospective is CLOSED. */
+export interface IUpdateRetrospectiveActionBody {
+  content?: string;
+  ownerMemberId?: string | null;
+  dueDate?: string | null;
+  sourceCardId?: string | null;
+  position?: number;
+  status?: RetrospectiveActionStatus;
+}
+
+export interface IDeleteRetrospectiveActionParams {
+  retrospectiveId: string;
+  retrospectiveActionId: string;
+}

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

@@ -0,0 +1,48 @@
+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;
+}
+
+export interface IAddRetrospectiveCardVoteParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}
+
+export interface IRemoveRetrospectiveCardVoteParams {
+  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,117 @@
+import {
+  ICreateRetrospectiveActionBody,
+  IUpdateRetrospectiveActionBody,
+} from './retrospective-action.request';
+
+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;
+}
+
+// Vote
+export interface IAddCardVoteRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveCardId: string;
+}
+
+export interface IRemoveCardVoteRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveCardId: string;
+}
+
+// Action
+export interface ICreateActionRetrospectivePublicParams {
+  accessToken: string;
+}
+export type ICreateActionRetrospectivePublicBody = ICreateRetrospectiveActionBody;
+
+export interface IUpdateActionRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveActionId: string;
+}
+export type IUpdateActionRetrospectivePublicBody = IUpdateRetrospectiveActionBody;
+
+export interface IDeleteActionRetrospectivePublicParams {
+  accessToken: string;
+  retrospectiveActionId: string;
+}

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

@@ -0,0 +1,84 @@
+import {
+  ContentShareScope,
+  RetrospectivePhase,
+  SortDirection,
+  ToolDocumentSortBy,
+} from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export interface IGetRetrospectiveParams {
+  retrospectiveId: string;
+}
+
+export interface IPaginateProjectRetrospectiveParams {
+  projectId: string;
+}
+
+export type IPaginateRetrospectiveQuery = {
+  title?: string;
+  archived?: boolean;
+  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 ICreateForOrganizationRetrospectiveParams {
+  organizationId: 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;
+}
+
+export interface IUpdateRetrospectivePhaseParams {
+  retrospectiveId: string;
+}
+
+export interface IUpdateRetrospectivePhaseBody {
+  phase: RetrospectivePhase;
+  /**
+   * Votes per member (1 to 10), accepted only with `phase: VOTE`. Omitted: the budget in place is
+   * kept. Lowering it never removes a vote already cast.
+   */
+  voteBudget?: number;
+}
+
+export interface IDeleteRetrospectiveParams {
+  retrospectiveId: string;
+}
+
+export type ISSERetrospectiveParams = {
+  retrospectiveId: string;
+};
+
+export type IPaginateOrganizationRetrospectiveParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationRetrospectiveParams = {
+  organizationId: string;
+};

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

@@ -0,0 +1,54 @@
+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;
+
+export type IGetCampaignStatsShortLinkAdminParams = {
+  shortLinkId: string;
+};
+export type IGetCampaignStatsShortLinkAdminQuery = {
+  /** Inclusive start of the period, ISO 8601. */
+  from: string;
+  /** Inclusive end of the period, ISO 8601. */
+  to: string;
+};
+
+export type ISetProtectionShortLinkAdminParams = {
+  shortLinkId: string;
+};
+export type ISetProtectionShortLinkAdminBody = {
+  isProtected: boolean;
+  /** The platform admin who sets or lifts the protection (the audit row is written by abyss-main). */
+  adminId: string;
+};

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,73 @@
+import { ContentShareScope } from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type IGetShortLinkParams = {
+  shortLinkId: string;
+};
+
+export type IPaginateShortLinkQuery = {
+  title?: string;
+  isActive?: boolean;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectShortLinkParams = {
+  projectId: string;
+};
+
+export type ICreateShortLinkBody = {
+  originalUrl: string;
+  title?: string;
+  description?: string;
+  expiresAt?: Date;
+  maxClicks?: number;
+  forwardCampaignParams?: boolean;
+};
+
+export type ICreateForOrganizationShortLinkParams = {
+  organizationId: string;
+};
+
+export type IUpdateShortLinkParams = {
+  shortLinkId: string;
+};
+
+export type IUpdateShortLinkBody = {
+  originalUrl?: string;
+  title?: string;
+  description?: string;
+  isActive?: boolean;
+  expiresAt?: Date | null;
+  maxClicks?: number | null;
+  forwardCampaignParams?: boolean;
+};
+
+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;
+
+export type IPaginateOrganizationShortLinkParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationShortLinkParams = {
+  organizationId: string;
+};

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;
+}