@abyss-project/tools 1.1.1 → 1.2.0

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

@@ -1,60 +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;
-  },
-};
+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/tag.api.ts

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

@@ -1,2 +1,2 @@
-export const MAX_DOCUMENTS_PER_ATLAS_PAGE = 20;
-export const MAX_ATLAS_DOCUMENT_SIZE_OCTET = 20 * 1024 * 1024; // 20 MB
+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

@@ -1,7 +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
+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/memo.constants.ts

@@ -1,3 +1,3 @@
-export const MIN_MEMO_TITLE_LENGTH = 3;
-export const MAX_MEMO_TITLE_LENGTH = 100;
-export const MAX_MEMO_CONTENT_LENGTH = 10000;
+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

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

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

package/src/index.ts

@@ -41,7 +41,7 @@ export * from './server-sent-events';
 
 const DEFAULT_BASE_URL = 'https://tools-api.abyss-project.fr/api/';
 
-export const API_KEY_HEADER = 'abyss-tools-api-key';
+export const API_KEY_HEADER = 'abyss-api-key';
 export const ADMIN_TOKEN_HEADER = 'abyss-admin-token';
 
 const NUMBER_RETRY_API = 10;

package/src/server-sent-events/index.ts

@@ -1,13 +1,13 @@
-export * from './server-sent-events.manager';
-export * from './protocols';
-
-export enum SSEChannels {
-  BOARD = 'sse:board',
-  BOARD_CARD = 'sse:board-card',
-  USER_NOTIFICATION = 'sse:user-notification',
-  RETROSPECTIVE = 'sse:retrospective',
-  ATLAS = 'sse:atlas',
-
-  // AbyssCloud
-  CLOUD = 'sse:cloud',
-}
+export * from './server-sent-events.manager';
+export * from './protocols';
+
+export enum SSEChannels {
+  BOARD = 'sse:board',
+  BOARD_CARD = 'sse:board-card',
+  USER_NOTIFICATION = 'sse:user-notification',
+  RETROSPECTIVE = 'sse:retrospective',
+  ATLAS = 'sse:atlas',
+
+  // AbyssCloud
+  CLOUD = 'sse:cloud',
+}

package/src/server-sent-events/protocols/atlas/atlas.sse-protocol.ts

@@ -1,90 +1,90 @@
-import { SystemSSEMessageContent } from '..';
-import { ValueOf } from '../../../types';
-import { IAtlas, IAtlasGroup, IAtlasPage, IAtlasDocument } from '../../../types/interface';
-
-export enum AtlasSSEEvent {
-  ATLAS_UPDATED = 'ATLAS_UPDATED',
-  ATLAS_DELETED = 'ATLAS_DELETED',
-  GROUP_CREATED = 'GROUP_CREATED',
-  GROUP_UPDATED = 'GROUP_UPDATED',
-  GROUP_DELETED = 'GROUP_DELETED',
-  PAGE_CREATED = 'PAGE_CREATED',
-  PAGE_UPDATED = 'PAGE_UPDATED',
-  PAGE_DELETED = 'PAGE_DELETED',
-  PAGE_CONTENT_DIFF_UPDATED = 'PAGE_CONTENT_DIFF_UPDATED',
-  ATLAS_DOCUMENT_CREATE = 'ATLAS_DOCUMENT_CREATE',
-  ATLAS_DOCUMENT_DELETE = 'ATLAS_DOCUMENT_DELETE',
-}
-
-export type AtlasSSEMessageContent = ValueOf<
-  {
-    [K in AtlasSSEEvent]: {
-      type: K;
-      payload: SourceAtlasSSEEventPayload[K];
-    };
-  }
->;
-
-export class SourceAtlasSSEEventPayload implements Record<AtlasSSEEvent, Record<string, any>> {
-  [AtlasSSEEvent.ATLAS_UPDATED]!: {
-    atlasId: string;
-    atlas: IAtlas;
-  };
-
-  [AtlasSSEEvent.ATLAS_DELETED]!: {
-    atlasId: string;
-    userId?: string;
-  };
-
-  [AtlasSSEEvent.GROUP_CREATED]!: {
-    atlasId: string;
-    group: IAtlasGroup;
-  };
-
-  [AtlasSSEEvent.GROUP_UPDATED]!: {
-    atlasId: string;
-    group: IAtlasGroup;
-  };
-
-  [AtlasSSEEvent.GROUP_DELETED]!: {
-    atlasId: string;
-    groupId: string;
-  };
-
-  [AtlasSSEEvent.PAGE_CREATED]!: {
-    atlasId: string;
-    page: IAtlasPage;
-  };
-
-  [AtlasSSEEvent.PAGE_UPDATED]!: {
-    atlasId: string;
-    page: IAtlasPage;
-  };
-
-  [AtlasSSEEvent.PAGE_DELETED]!: {
-    atlasId: string;
-    pageId: string;
-  };
-
-  [AtlasSSEEvent.PAGE_CONTENT_DIFF_UPDATED]!: {
-    atlasId: string;
-    pageId: string;
-    diff: string | null;
-    version: number;
-    lastModifiedByUserId?: string;
-  };
-
-  [AtlasSSEEvent.ATLAS_DOCUMENT_CREATE]!: {
-    atlasId: string;
-    atlasPageId: string;
-    atlasDocument: IAtlasDocument;
-  };
-
-  [AtlasSSEEvent.ATLAS_DOCUMENT_DELETE]!: {
-    atlasId: string;
-    atlasPageId: string;
-    atlasDocumentId: string;
-  };
-}
-
-export type AtlasSSEEventContent = AtlasSSEMessageContent | SystemSSEMessageContent;
+import { SystemSSEMessageContent } from '..';
+import { ValueOf } from '../../../types';
+import { IAtlas, IAtlasGroup, IAtlasPage, IAtlasDocument } from '../../../types/interface';
+
+export enum AtlasSSEEvent {
+  ATLAS_UPDATED = 'ATLAS_UPDATED',
+  ATLAS_DELETED = 'ATLAS_DELETED',
+  GROUP_CREATED = 'GROUP_CREATED',
+  GROUP_UPDATED = 'GROUP_UPDATED',
+  GROUP_DELETED = 'GROUP_DELETED',
+  PAGE_CREATED = 'PAGE_CREATED',
+  PAGE_UPDATED = 'PAGE_UPDATED',
+  PAGE_DELETED = 'PAGE_DELETED',
+  PAGE_CONTENT_DIFF_UPDATED = 'PAGE_CONTENT_DIFF_UPDATED',
+  ATLAS_DOCUMENT_CREATE = 'ATLAS_DOCUMENT_CREATE',
+  ATLAS_DOCUMENT_DELETE = 'ATLAS_DOCUMENT_DELETE',
+}
+
+export type AtlasSSEMessageContent = ValueOf<
+  {
+    [K in AtlasSSEEvent]: {
+      type: K;
+      payload: SourceAtlasSSEEventPayload[K];
+    };
+  }
+>;
+
+export class SourceAtlasSSEEventPayload implements Record<AtlasSSEEvent, Record<string, any>> {
+  [AtlasSSEEvent.ATLAS_UPDATED]!: {
+    atlasId: string;
+    atlas: IAtlas;
+  };
+
+  [AtlasSSEEvent.ATLAS_DELETED]!: {
+    atlasId: string;
+    userId?: string;
+  };
+
+  [AtlasSSEEvent.GROUP_CREATED]!: {
+    atlasId: string;
+    group: IAtlasGroup;
+  };
+
+  [AtlasSSEEvent.GROUP_UPDATED]!: {
+    atlasId: string;
+    group: IAtlasGroup;
+  };
+
+  [AtlasSSEEvent.GROUP_DELETED]!: {
+    atlasId: string;
+    groupId: string;
+  };
+
+  [AtlasSSEEvent.PAGE_CREATED]!: {
+    atlasId: string;
+    page: IAtlasPage;
+  };
+
+  [AtlasSSEEvent.PAGE_UPDATED]!: {
+    atlasId: string;
+    page: IAtlasPage;
+  };
+
+  [AtlasSSEEvent.PAGE_DELETED]!: {
+    atlasId: string;
+    pageId: string;
+  };
+
+  [AtlasSSEEvent.PAGE_CONTENT_DIFF_UPDATED]!: {
+    atlasId: string;
+    pageId: string;
+    diff: string | null;
+    version: number;
+    lastModifiedByUserId?: string;
+  };
+
+  [AtlasSSEEvent.ATLAS_DOCUMENT_CREATE]!: {
+    atlasId: string;
+    atlasPageId: string;
+    atlasDocument: IAtlasDocument;
+  };
+
+  [AtlasSSEEvent.ATLAS_DOCUMENT_DELETE]!: {
+    atlasId: string;
+    atlasPageId: string;
+    atlasDocumentId: string;
+  };
+}
+
+export type AtlasSSEEventContent = AtlasSSEMessageContent | SystemSSEMessageContent;

package/src/server-sent-events/protocols/atlas/index.ts

@@ -1 +1 @@
-export * from './atlas.sse-protocol';
+export * from './atlas.sse-protocol';