@abyss-project/tools 1.0.5 → 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/api/tests/beam.api.spec.ts

@@ -0,0 +1,42 @@
+import { AbyssToolsCore } from '../../index';
+import { BeamVisibility } from '../../types';
+
+describe('beamApi', () => {
+  it('exposes the beam CRUD namespace on the SDK facade', () => {
+    const beam = AbyssToolsCore.sdk.beam;
+    expect(typeof beam.get).toBe('function');
+    expect(typeof beam.getBySlug).toBe('function');
+    expect(typeof beam.paginate).toBe('function');
+    expect(typeof beam.paginateProject).toBe('function');
+    expect(typeof beam.paginateOrganization).toBe('function');
+    expect(typeof beam.create).toBe('function');
+    expect(typeof beam.update).toBe('function');
+    expect(typeof beam.delete).toBe('function');
+  });
+
+  it('create posts to /beam and returns the wrapped transfer', async () => {
+    const post = jest
+      .spyOn(AbyssToolsCore.axios, 'post')
+      .mockResolvedValue({ data: { data: { beamTransfer: { id: 't1' } } } });
+
+    const res = await AbyssToolsCore.sdk.beam.create({
+      title: 'T',
+      visibility: BeamVisibility.PUBLIC,
+    });
+
+    expect(post).toHaveBeenCalledWith('/beam', { title: 'T', visibility: BeamVisibility.PUBLIC });
+    expect(res.data.beamTransfer.id).toBe('t1');
+    post.mockRestore();
+  });
+
+  it('getBySlug reads the public /b/:slug path', async () => {
+    const get = jest
+      .spyOn(AbyssToolsCore.axios, 'get')
+      .mockResolvedValue({ data: { data: { beamTransfer: { id: 't1', slug: 'abcdefghij' } } } });
+
+    await AbyssToolsCore.sdk.beam.getBySlug({ slug: 'abcdefghij' });
+
+    expect(get).toHaveBeenCalledWith('/b/abcdefghij');
+    get.mockRestore();
+  });
+});

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

@@ -0,0 +1,4 @@
+// Header carrying the anonymous transfer management secret (spec §7). The front
+// keeps the plaintext manageToken in the URL fragment and sends it here; the API
+// (BeamMiddleware) compares sha256(header) to beam_transfers.manageTokenHash.
+export const BEAM_MANAGE_TOKEN_HEADER = 'x-beam-manage-token';

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/index.ts

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

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;