@abyss-project/workspace 0.0.0-stage → 1.0.0

package/src/api/short-link.admin.api.ts

@@ -0,0 +1,77 @@
+import { AbyssWorkspaceCore } from '..';
+import type {
+  IPaginateShortLinkAdminQuery,
+  IPaginateShortLinkAdminResponse,
+  IGetShortLinkAdminParams,
+  IGetShortLinkAdminResponse,
+  IUpdateShortLinkAdminParams,
+  IUpdateShortLinkAdminBody,
+  IUpdateShortLinkAdminResponse,
+  IDeleteShortLinkAdminParams,
+  IDeleteShortLinkAdminResponse,
+  IGetCampaignStatsShortLinkAdminParams,
+  IGetCampaignStatsShortLinkAdminQuery,
+  IGetCampaignStatsShortLinkAdminResponse,
+  ISetProtectionShortLinkAdminParams,
+  ISetProtectionShortLinkAdminBody,
+  ISetProtectionShortLinkAdminResponse,
+} from '../types';
+
+export const shortLinkAdminApi = {
+  paginate: async (
+    query: IPaginateShortLinkAdminQuery,
+  ): Promise<IPaginateShortLinkAdminResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IPaginateShortLinkAdminResponse>(
+      '/admin/short-link/paginate',
+      { params: query },
+    );
+    return response.data;
+  },
+
+  get: async (params: IGetShortLinkAdminParams): Promise<IGetShortLinkAdminResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}`,
+    );
+    return response.data;
+  },
+
+  getCampaignStats: async (
+    params: IGetCampaignStatsShortLinkAdminParams,
+    query: IGetCampaignStatsShortLinkAdminQuery,
+  ): Promise<IGetCampaignStatsShortLinkAdminResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetCampaignStatsShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}/campaign-stats`,
+      { params: query },
+    );
+    return response.data;
+  },
+
+  setProtection: async (
+    params: ISetProtectionShortLinkAdminParams,
+    body: ISetProtectionShortLinkAdminBody,
+  ): Promise<ISetProtectionShortLinkAdminResponse> => {
+    const response = await AbyssWorkspaceCore.axios.put<ISetProtectionShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}/protection`,
+      body,
+    );
+    return response.data;
+  },
+
+  update: async (
+    params: IUpdateShortLinkAdminParams,
+    body: IUpdateShortLinkAdminBody,
+  ): Promise<IUpdateShortLinkAdminResponse> => {
+    const response = await AbyssWorkspaceCore.axios.put<IUpdateShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}`,
+      body,
+    );
+    return response.data;
+  },
+
+  delete: async (params: IDeleteShortLinkAdminParams): Promise<IDeleteShortLinkAdminResponse> => {
+    const response = await AbyssWorkspaceCore.axios.delete<IDeleteShortLinkAdminResponse>(
+      `/admin/short-link/${params.shortLinkId}`,
+    );
+    return response.data;
+  },
+};

package/src/api/short-link.api.ts

@@ -0,0 +1,150 @@
+import { AbyssWorkspaceCore } from '..';
+import type {
+  IGetShortLinkParams,
+  IGetShortLinkResponse,
+  IPaginateShortLinkQuery,
+  IPaginateShortLinkResponse,
+  IPaginateProjectShortLinkParams,
+  ICreateShortLinkBody,
+  ICreateShortLinkResponse,
+  ICreateForOrganizationShortLinkParams,
+  IUpdateShortLinkParams,
+  IUpdateShortLinkBody,
+  IUpdateShortLinkResponse,
+  IDeleteShortLinkParams,
+  IDeleteShortLinkResponse,
+  IGetStatsShortLinkParams,
+  IGetStatsShortLinkQuery,
+  IGetStatsShortLinkResponse,
+  IGetClicksShortLinkParams,
+  IGetClicksShortLinkQuery,
+  IGetClicksShortLinkResponse,
+  IPaginateOrganizationShortLinkParams,
+  ITransferContentBody,
+  ITransferShortLinkResponse,
+  ICountOrganizationResponse,
+} from '../types';
+
+export const shortLinkApi = {
+  get: async (params: IGetShortLinkParams): Promise<IGetShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetShortLinkResponse>(
+      `/short-link/${params.shortLinkId}`,
+    );
+    return response.data;
+  },
+
+  paginate: async (query: IPaginateShortLinkQuery): Promise<IPaginateShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IPaginateShortLinkResponse>(
+      '/short-link/paginate',
+      { params: query },
+    );
+    return response.data;
+  },
+
+  paginateProject: async (
+    params: IPaginateProjectShortLinkParams,
+    query: IPaginateShortLinkQuery,
+  ): Promise<IPaginateShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IPaginateShortLinkResponse>(
+      `/short-link/project/${params.projectId}/paginate`,
+      {
+        params: query,
+      },
+    );
+    return response.data;
+  },
+
+  create: async (body: ICreateShortLinkBody): Promise<ICreateShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.post<ICreateShortLinkResponse>(
+      '/short-link',
+      body,
+    );
+    return response.data;
+  },
+
+  createForOrganization: async (
+    params: ICreateForOrganizationShortLinkParams,
+    body: ICreateShortLinkBody,
+  ): Promise<ICreateShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.post<ICreateShortLinkResponse>(
+      `/short-link/organization/${params.organizationId}`,
+      body,
+    );
+    return response.data;
+  },
+
+  update: async (
+    params: IUpdateShortLinkParams,
+    body: IUpdateShortLinkBody,
+  ): Promise<IUpdateShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.put<IUpdateShortLinkResponse>(
+      `/short-link/${params.shortLinkId}`,
+      body,
+    );
+    return response.data;
+  },
+
+  delete: async (params: IDeleteShortLinkParams): Promise<IDeleteShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.delete<IDeleteShortLinkResponse>(
+      `/short-link/${params.shortLinkId}`,
+    );
+    return response.data;
+  },
+
+  getStats: async (
+    params: IGetStatsShortLinkParams,
+    query?: IGetStatsShortLinkQuery,
+  ): Promise<IGetStatsShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetStatsShortLinkResponse>(
+      `/short-link/${params.shortLinkId}/stats`,
+      {
+        params: query,
+      },
+    );
+    return response.data;
+  },
+
+  getClicks: async (
+    params: IGetClicksShortLinkParams,
+    query?: IGetClicksShortLinkQuery,
+  ): Promise<IGetClicksShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetClicksShortLinkResponse>(
+      `/short-link/${params.shortLinkId}/clicks`,
+      {
+        params: query,
+      },
+    );
+    return response.data;
+  },
+
+  paginateOrganization: async (
+    params: IPaginateOrganizationShortLinkParams,
+    query: IPaginateShortLinkQuery,
+  ): Promise<IPaginateShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IPaginateShortLinkResponse>(
+      `/short-link/organization/${params.organizationId}/paginate`,
+      { params: query },
+    );
+    return response.data;
+  },
+
+  transfer: async (
+    params: { shortLinkId: string },
+    body: ITransferContentBody,
+  ): Promise<ITransferShortLinkResponse> => {
+    const response = await AbyssWorkspaceCore.axios.post<ITransferShortLinkResponse>(
+      `/short-link/${params.shortLinkId}/transfer`,
+      body,
+    );
+    return response.data;
+  },
+
+  countOrganization: async (params: {
+    organizationId: string;
+  }): Promise<ICountOrganizationResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<ICountOrganizationResponse>(
+      `/short-link/organization/${params.organizationId}/count`,
+    );
+    return response.data;
+  },
+};

package/src/api/short-link.public.api.ts

@@ -0,0 +1,74 @@
+import { AbyssWorkspaceCore } from '..';
+import type {
+  ICreateAnonymousShortLinkPublicBody,
+  ICreateShortLinkPublicResponse,
+  IGetStatsShortLinkPublicParams,
+  IGetStatsShortLinkPublicQuery,
+  IGetStatsShortLinkPublicResponse,
+  IGetClicksShortLinkPublicParams,
+  IGetClicksShortLinkPublicQuery,
+  IGetClicksShortLinkPublicResponse,
+  IRenewShortLinkPublicParams,
+  IRenewShortLinkPublicResponse,
+  IRedirectShortLinkPublicParams,
+  IRedirectShortLinkPublicQuery,
+  IRedirectShortLinkPublicResponse,
+} from '../types';
+
+export const shortLinkPublicApi = {
+  createAnonymous: async (
+    body: ICreateAnonymousShortLinkPublicBody,
+  ): Promise<ICreateShortLinkPublicResponse> => {
+    const response = await AbyssWorkspaceCore.axios.post<ICreateShortLinkPublicResponse>(
+      '/short-link/public',
+      body,
+    );
+    return response.data;
+  },
+
+  redirect: async (
+    params: IRedirectShortLinkPublicParams,
+    query?: IRedirectShortLinkPublicQuery,
+  ): Promise<IRedirectShortLinkPublicResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IRedirectShortLinkPublicResponse>(
+      `/short-link/public/redirect/${params.slug}`,
+      {
+        params: query,
+      },
+    );
+    return response.data;
+  },
+
+  getStats: async (
+    params: IGetStatsShortLinkPublicParams,
+    query?: IGetStatsShortLinkPublicQuery,
+  ): Promise<IGetStatsShortLinkPublicResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetStatsShortLinkPublicResponse>(
+      `/short-link/public/${params.shortLinkId}/stats`,
+      {
+        params: query,
+      },
+    );
+    return response.data;
+  },
+
+  getClicks: async (
+    params: IGetClicksShortLinkPublicParams,
+    query?: IGetClicksShortLinkPublicQuery,
+  ): Promise<IGetClicksShortLinkPublicResponse> => {
+    const response = await AbyssWorkspaceCore.axios.get<IGetClicksShortLinkPublicResponse>(
+      `/short-link/public/${params.shortLinkId}/clicks`,
+      {
+        params: query,
+      },
+    );
+    return response.data;
+  },
+
+  renew: async (params: IRenewShortLinkPublicParams): Promise<IRenewShortLinkPublicResponse> => {
+    const response = await AbyssWorkspaceCore.axios.post<IRenewShortLinkPublicResponse>(
+      `/short-link/public/${params.shortLinkId}/renew`,
+    );
+    return response.data;
+  },
+};

package/src/api/tag.api.ts

@@ -0,0 +1,75 @@
+import { AbyssWorkspaceCore } from '..';
+import {
+  ICreateTagBody,
+  ICreateTagResponse,
+  IUpdateTagParams,
+  IUpdateTagBody,
+  IUpdateTagResponse,
+  IDeleteTagParams,
+  IDeleteTagResponse,
+  IListTagQuery,
+  IListTagResponse,
+  IAssignTagParams,
+  IAssignTagBody,
+  IAssignTagResponse,
+  IUnassignTagParams,
+  IUnassignTagResponse,
+  ITagStatsQuery,
+  ITagStatsResponse,
+  IGetEntityTagsParams,
+  IGetEntityTagsResponse,
+} from '../types';
+
+export const listTag = async (query?: IListTagQuery): Promise<IListTagResponse> => {
+  return (await AbyssWorkspaceCore.axios.get<IListTagResponse>(`tag`, { params: query })).data;
+};
+
+export const createTag = async (body: ICreateTagBody): Promise<ICreateTagResponse> => {
+  return (await AbyssWorkspaceCore.axios.post<ICreateTagResponse>(`tag`, body)).data;
+};
+
+export const updateTag = async (
+  params: IUpdateTagParams,
+  body: IUpdateTagBody,
+): Promise<IUpdateTagResponse> => {
+  return (await AbyssWorkspaceCore.axios.put<IUpdateTagResponse>(`tag/${params.tagId}`, body)).data;
+};
+
+export const deleteTag = async (params: IDeleteTagParams): Promise<IDeleteTagResponse> => {
+  return (await AbyssWorkspaceCore.axios.delete<IDeleteTagResponse>(`tag/${params.tagId}`)).data;
+};
+
+export const assignTag = async (
+  params: IAssignTagParams,
+  body: IAssignTagBody,
+): Promise<IAssignTagResponse> => {
+  return (
+    await AbyssWorkspaceCore.axios.post<IAssignTagResponse>(
+      `${params.entityType}/${params.entityId}/tags`,
+      body,
+    )
+  ).data;
+};
+
+export const unassignTag = async (params: IUnassignTagParams): Promise<IUnassignTagResponse> => {
+  return (
+    await AbyssWorkspaceCore.axios.delete<IUnassignTagResponse>(
+      `${params.entityType}/${params.entityId}/tags/${params.tagId}`,
+    )
+  ).data;
+};
+
+export const getTagStats = async (query?: ITagStatsQuery): Promise<ITagStatsResponse> => {
+  return (await AbyssWorkspaceCore.axios.get<ITagStatsResponse>('tag/stats', { params: query }))
+    .data;
+};
+
+export const getEntityTags = async (
+  params: IGetEntityTagsParams,
+): Promise<IGetEntityTagsResponse> => {
+  return (
+    await AbyssWorkspaceCore.axios.get<IGetEntityTagsResponse>(
+      `${params.entityType}/${params.entityId}/tags`,
+    )
+  ).data;
+};

package/src/constants/atlas.constants.ts

@@ -0,0 +1,9 @@
+export const MAX_DOCUMENTS_PER_ATLAS_PAGE = 20;
+export const MAX_ATLAS_DOCUMENT_SIZE_OCTET = 100 * 1024 * 1024; // 100 MB
+
+/** Opens a passage found in `IAtlasSearchResult.excerpt` (Unicode private use, never in user text). */
+export const ATLAS_SEARCH_HIGHLIGHT_START = '\uE000';
+/** Closes a passage found in `IAtlasSearchResult.excerpt`. */
+export const ATLAS_SEARCH_HIGHLIGHT_END = '\uE001';
+/** Between two passages of `IAtlasSearchResult.excerpt`. */
+export const ATLAS_SEARCH_EXCERPT_SEPARATOR = ' … ';

package/src/constants/board.constants.ts

@@ -0,0 +1,9 @@
+import { BoardColumnType } from '../types';
+
+export const MAX_BOARD_LABEL_LENGTH = 50;
+
+export const PENDING_OR_DOING_BOARD_COLUMN_TYPES = [BoardColumnType.BACKLOG, BoardColumnType.DOING];
+export const MAX_DOCUMENTS_PER_BOARD_CARD = 10;
+export const MAX_BOARD_DOCUMENT_SIZE_OCTET = 100 * 1024 * 1024; // 100 Mo
+/** Cap on the links of one card: bounds the access resolutions made when its modal opens. */
+export const MAX_LINKS_PER_BOARD_CARD = 20;

package/src/constants/draw.constants.ts

@@ -0,0 +1,12 @@
+/** Size cap of one image stored with a draw. */
+export const MAX_DRAW_IMAGE_SIZE_OCTET = 10 * 1024 * 1024; // 10 MiB
+/** Cap on the images stored with one draw. */
+export const MAX_IMAGES_PER_DRAW = 100;
+/** Media types a draw image may have (the front resizes to WebP before sending). */
+export const DRAW_IMAGE_MIME_TYPES = [
+  'image/webp',
+  'image/png',
+  'image/jpeg',
+  'image/gif',
+] as const;
+export type DrawImageMimeType = typeof DRAW_IMAGE_MIME_TYPES[number];

package/src/constants/index.ts

@@ -0,0 +1,6 @@
+export * from './atlas.constants';
+export * from './draw.constants';
+export * from './board.constants';
+export * from './short-link.constants';
+export * from './tag.constants';
+export * from './retrospective.constants';

package/src/constants/retrospective.constants.ts

@@ -0,0 +1,11 @@
+/** Votes each member may spend during the VOTE phase: bounds of the budget and its default. */
+export const RETROSPECTIVE_VOTE_BUDGET_MIN = 1;
+export const RETROSPECTIVE_VOTE_BUDGET_MAX = 10;
+export const RETROSPECTIVE_VOTE_BUDGET_DEFAULT = 3;
+
+/** Length bounds of the text of a follow-up action. */
+export const RETROSPECTIVE_ACTION_CONTENT_MIN_LENGTH = 1;
+export const RETROSPECTIVE_ACTION_CONTENT_MAX_LENGTH = 500;
+
+/** Cap on the follow-up actions of one retrospective. */
+export const MAX_ACTIONS_PER_RETROSPECTIVE = 100;

package/src/constants/short-link.constants.ts

@@ -0,0 +1,11 @@
+export const MIN_SHORT_LINK_PAGE = 1;
+export const MIN_SHORT_LINK_LIMIT = 1;
+export const MAX_SHORT_LINK_LIMIT = 500;
+
+export const MAX_SHORT_LINK_TITLE_LENGTH = 255;
+export const MAX_SHORT_LINK_DESCRIPTION_LENGTH = 1000;
+
+export const MIN_SHORT_LINK_MAX_CLICKS = 1;
+
+export const MIN_SHORT_LINK_SLUG_LENGTH = 3;
+export const MAX_SHORT_LINK_SLUG_LENGTH = 50;

package/src/constants/tag.constants.ts

@@ -0,0 +1,3 @@
+export const MIN_TAG_NAME_LENGTH = 1;
+export const MAX_TAG_NAME_LENGTH = 50;
+export const MAX_TAG_COLOR_LENGTH = 7;