@abyss-project/tools 1.0.0

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

@@ -0,0 +1,90 @@
+import { AbyssToolsCore } from '..';
+import type {
+  IGetShortLinkParams,
+  IGetShortLinkResponse,
+  IPaginateShortLinkQuery,
+  IPaginateShortLinkResponse,
+  IPaginateProjectShortLinkParams,
+  ICreateShortLinkBody,
+  ICreateShortLinkResponse,
+  ICreateForProjectShortLinkParams,
+  IUpdateShortLinkParams,
+  IUpdateShortLinkBody,
+  IUpdateShortLinkResponse,
+  IDeleteShortLinkParams,
+  IDeleteShortLinkResponse,
+  IGetStatsShortLinkParams,
+  IGetStatsShortLinkQuery,
+  IGetStatsShortLinkResponse,
+  IGetClicksShortLinkParams,
+  IGetClicksShortLinkQuery,
+  IGetClicksShortLinkResponse,
+} from '../types';
+
+export const shortLinkApi = {
+  get: async (params: IGetShortLinkParams): Promise<IGetShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.get<IGetShortLinkResponse>(`/short-link/${params.shortLinkId}`);
+    return response.data;
+  },
+
+  paginate: async (query: IPaginateShortLinkQuery): Promise<IPaginateShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkResponse>('/short-link/paginate', { params: query });
+    return response.data;
+  },
+
+  paginateProject: async (
+    params: IPaginateProjectShortLinkParams,
+    query: IPaginateShortLinkQuery,
+  ): Promise<IPaginateShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.get<IPaginateShortLinkResponse>(`/short-link/project/${params.projectId}/paginate`, {
+      params: query,
+    });
+    return response.data;
+  },
+
+  create: async (body: ICreateShortLinkBody): Promise<ICreateShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.post<ICreateShortLinkResponse>('/short-link', body);
+    return response.data;
+  },
+
+  createForProject: async (
+    params: ICreateForProjectShortLinkParams,
+    body: ICreateShortLinkBody,
+  ): Promise<ICreateShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.post<ICreateShortLinkResponse>(`/short-link/project/${params.projectId}`, body);
+    return response.data;
+  },
+
+  update: async (
+    params: IUpdateShortLinkParams,
+    body: IUpdateShortLinkBody,
+  ): Promise<IUpdateShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.put<IUpdateShortLinkResponse>(`/short-link/${params.shortLinkId}`, body);
+    return response.data;
+  },
+
+  delete: async (params: IDeleteShortLinkParams): Promise<IDeleteShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.delete<IDeleteShortLinkResponse>(`/short-link/${params.shortLinkId}`);
+    return response.data;
+  },
+
+  getStats: async (
+    params: IGetStatsShortLinkParams,
+    query?: IGetStatsShortLinkQuery,
+  ): Promise<IGetStatsShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.get<IGetStatsShortLinkResponse>(`/short-link/${params.shortLinkId}/stats`, {
+      params: query,
+    });
+    return response.data;
+  },
+
+  getClicks: async (
+    params: IGetClicksShortLinkParams,
+    query?: IGetClicksShortLinkQuery,
+  ): Promise<IGetClicksShortLinkResponse> => {
+    const response = await AbyssToolsCore.axios.get<IGetClicksShortLinkResponse>(`/short-link/${params.shortLinkId}/clicks`, {
+      params: query,
+    });
+    return response.data;
+  },
+};

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

@@ -0,0 +1,60 @@
+import { AbyssToolsCore } 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 AbyssToolsCore.axios.post<ICreateShortLinkPublicResponse>('/short-link/public', body);
+    return response.data;
+  },
+
+  redirect: async (
+    params: IRedirectShortLinkPublicParams,
+    query?: IRedirectShortLinkPublicQuery,
+  ): Promise<IRedirectShortLinkPublicResponse> => {
+    const response = await AbyssToolsCore.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 AbyssToolsCore.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 AbyssToolsCore.axios.get<IGetClicksShortLinkPublicResponse>(`/short-link/public/${params.shortLinkId}/clicks`, {
+      params: query,
+    });
+    return response.data;
+  },
+
+  renew: async (params: IRenewShortLinkPublicParams): Promise<IRenewShortLinkPublicResponse> => {
+    const response = await AbyssToolsCore.axios.post<IRenewShortLinkPublicResponse>(`/short-link/public/${params.shortLinkId}/renew`);
+    return response.data;
+  },
+};

package/src/api/user-tag.api.ts

@@ -0,0 +1,70 @@
+import { AbyssToolsCore } from '..';
+import {
+  ICreateUserTagBody,
+  ICreateUserTagResponse,
+  IUpdateUserTagParams,
+  IUpdateUserTagBody,
+  IUpdateUserTagResponse,
+  IDeleteUserTagParams,
+  IDeleteUserTagResponse,
+  IListUserTagResponse,
+  IAssignUserTagParams,
+  IAssignUserTagBody,
+  IAssignUserTagResponse,
+  IUnassignUserTagParams,
+  IUnassignUserTagResponse,
+  IUserTagStatsResponse,
+  IGetEntityTagsParams,
+  IGetEntityTagsResponse,
+} from '../types';
+
+export const listUserTag = async (): Promise<IListUserTagResponse> => {
+  return (await AbyssToolsCore.axios.get<IListUserTagResponse>(`user-tag`)).data;
+};
+
+export const createUserTag = async (body: ICreateUserTagBody): Promise<ICreateUserTagResponse> => {
+  return (await AbyssToolsCore.axios.post<ICreateUserTagResponse>(`user-tag`, body)).data;
+};
+
+export const updateUserTag = async (
+  params: IUpdateUserTagParams,
+  body: IUpdateUserTagBody,
+): Promise<IUpdateUserTagResponse> => {
+  return (await AbyssToolsCore.axios.put<IUpdateUserTagResponse>(`user-tag/${params.userTagId}`, body)).data;
+};
+
+export const deleteUserTag = async (params: IDeleteUserTagParams): Promise<IDeleteUserTagResponse> => {
+  return (await AbyssToolsCore.axios.delete<IDeleteUserTagResponse>(`user-tag/${params.userTagId}`)).data;
+};
+
+export const assignTag = async (
+  params: IAssignUserTagParams,
+  body: IAssignUserTagBody,
+): Promise<IAssignUserTagResponse> => {
+  return (
+    await AbyssToolsCore.axios.post<IAssignUserTagResponse>(
+      `${params.entityType}/${params.entityId}/tags`,
+      body,
+    )
+  ).data;
+};
+
+export const unassignTag = async (params: IUnassignUserTagParams): Promise<IUnassignUserTagResponse> => {
+  return (
+    await AbyssToolsCore.axios.delete<IUnassignUserTagResponse>(
+      `${params.entityType}/${params.entityId}/tags/${params.userTagId}`,
+    )
+  ).data;
+};
+
+export const getUserTagStats = async (): Promise<IUserTagStatsResponse> => {
+  return (await AbyssToolsCore.axios.get<IUserTagStatsResponse>('user-tag/stats')).data;
+};
+
+export const getEntityTags = async (params: IGetEntityTagsParams): Promise<IGetEntityTagsResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetEntityTagsResponse>(
+      `${params.entityType}/${params.entityId}/tags`,
+    )
+  ).data;
+};

package/src/constants/atlas.constants.ts

@@ -0,0 +1,2 @@
+export const MAX_DOCUMENTS_PER_ATLAS_PAGE = 20;
+export const MAX_ATLAS_DOCUMENT_SIZE_OCTET = 20 * 1024 * 1024; // 20 MB

package/src/constants/board.constants.ts

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

package/src/constants/index.ts

@@ -0,0 +1,5 @@
+export * from './memo.constants';
+export * from './atlas.constants';
+export * from './board.constants';
+export * from './short-link.constants';
+export * from './user-tag.constants';

package/src/constants/memo.constants.ts

@@ -0,0 +1,3 @@
+export const MIN_MEMO_TITLE_LENGTH = 3;
+export const MAX_MEMO_TITLE_LENGTH = 100;
+export const MAX_MEMO_CONTENT_LENGTH = 10000;

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/user-tag.constants.ts

@@ -0,0 +1,3 @@
+export const MIN_USER_TAG_NAME_LENGTH = 1;
+export const MAX_USER_TAG_NAME_LENGTH = 50;
+export const MAX_USER_TAG_COLOR_LENGTH = 7;