@abyss-project/tools 1.0.5 → 1.2.0

package/src/api/beam.api.ts

@@ -0,0 +1,300 @@
+import { AbyssToolsCore } from '..';
+import type {
+  IGetBeamParams,
+  IGetBeamResponse,
+  IGetBeamBySlugParams,
+  IGetBeamPublicResponse,
+  IUnlockBeamPublicParams,
+  IUnlockBeamPublicBody,
+  IUnlockBeamPublicResponse,
+  IPaginateBeamQuery,
+  IPaginateBeamResponse,
+  IPaginateProjectBeamParams,
+  IPaginateOrganizationBeamParams,
+  ICreateBeamBody,
+  ICreateBeamResponse,
+  ICreateForOrganizationBeamParams,
+  IUpdateBeamParams,
+  IUpdateBeamBody,
+  IUpdateBeamResponse,
+  IDeleteBeamParams,
+  IDeleteBeamResponse,
+  ICreateBeamPublicBody,
+  IAddBeamFilesParams,
+  IAddBeamFilesBody,
+  IAddBeamFilesResponse,
+  IImportCloudBeamFilesParams,
+  IImportCloudBeamFilesBody,
+  IFinalizeBeamParams,
+  IFinalizeBeamBody,
+  IFinalizeBeamResponse,
+  IRenewBeamParams,
+  IRenewBeamResponse,
+  IReactivateBeamParams,
+  IReactivateBeamResponse,
+  ICreateBeamShareParams,
+  ICreateBeamShareBody,
+  ICreateBeamShareResponse,
+  IListBeamSharesParams,
+  IListBeamSharesResponse,
+  IRevokeBeamShareParams,
+  IRevokeBeamShareResponse,
+  IAddRecipientsBeamBody,
+  IAddRecipientsBeamResponse,
+  IListRecipientsBeamResponse,
+} from '../types';
+import { BEAM_MANAGE_TOKEN_HEADER } from '../constants/beam.constants';
+
+// Anonymous management requests carry the plaintext manage token as a header the
+// API (BeamMiddleware) compares to beam_transfers.manageTokenHash. Owner requests
+// omit it and authorize via the session JWT instead.
+const manageTokenHeader = (manageToken?: string): { headers?: Record<string, string> } =>
+  manageToken ? { headers: { [BEAM_MANAGE_TOKEN_HEADER]: manageToken } } : {};
+
+export const beamApi = {
+  get: async (params: IGetBeamParams): Promise<IGetBeamResponse> => {
+    const response = await AbyssToolsCore.axios.get<IGetBeamResponse>(`/beam/${params.beamId}`);
+    return response.data;
+  },
+
+  getBySlug: async (params: IGetBeamBySlugParams): Promise<IGetBeamPublicResponse> => {
+    const response = await AbyssToolsCore.axios.get<IGetBeamPublicResponse>(`/b/${params.slug}`);
+    return response.data;
+  },
+
+  unlock: async (
+    params: IUnlockBeamPublicParams,
+    body: IUnlockBeamPublicBody,
+  ): Promise<IUnlockBeamPublicResponse> => {
+    const response = await AbyssToolsCore.axios.post<IUnlockBeamPublicResponse>(
+      `/b/${params.slug}/unlock`,
+      body,
+    );
+    return response.data;
+  },
+
+  paginate: async (query: IPaginateBeamQuery): Promise<IPaginateBeamResponse> => {
+    const response = await AbyssToolsCore.axios.get<IPaginateBeamResponse>('/beam/paginate', {
+      params: query,
+    });
+    return response.data;
+  },
+
+  paginateProject: async (
+    params: IPaginateProjectBeamParams,
+    query: IPaginateBeamQuery,
+  ): Promise<IPaginateBeamResponse> => {
+    const response = await AbyssToolsCore.axios.get<IPaginateBeamResponse>(
+      `/beam/project/${params.projectId}/paginate`,
+      { params: query },
+    );
+    return response.data;
+  },
+
+  paginateOrganization: async (
+    params: IPaginateOrganizationBeamParams,
+    query: IPaginateBeamQuery,
+  ): Promise<IPaginateBeamResponse> => {
+    const response = await AbyssToolsCore.axios.get<IPaginateBeamResponse>(
+      `/beam/organization/${params.organizationId}/paginate`,
+      { params: query },
+    );
+    return response.data;
+  },
+
+  create: async (body: ICreateBeamBody): Promise<ICreateBeamResponse> => {
+    const response = await AbyssToolsCore.axios.post<ICreateBeamResponse>('/beam', body);
+    return response.data;
+  },
+
+  createForOrganization: async (
+    params: ICreateForOrganizationBeamParams,
+    body: ICreateBeamBody,
+  ): Promise<ICreateBeamResponse> => {
+    const response = await AbyssToolsCore.axios.post<ICreateBeamResponse>(
+      `/beam/organization/${params.organizationId}`,
+      body,
+    );
+    return response.data;
+  },
+
+  update: async (
+    params: IUpdateBeamParams,
+    body: IUpdateBeamBody,
+  ): Promise<IUpdateBeamResponse> => {
+    const response = await AbyssToolsCore.axios.put<IUpdateBeamResponse>(
+      `/beam/${params.beamId}`,
+      body,
+    );
+    return response.data;
+  },
+
+  delete: async (params: IDeleteBeamParams): Promise<IDeleteBeamResponse> => {
+    const response = await AbyssToolsCore.axios.delete<IDeleteBeamResponse>(
+      `/beam/${params.beamId}`,
+    );
+    return response.data;
+  },
+
+  renew: async (params: IRenewBeamParams): Promise<IRenewBeamResponse> => {
+    return (
+      await AbyssToolsCore.axios.post<IRenewBeamResponse>(`/beam/${params.beamId}/renew`)
+    ).data;
+  },
+
+  reactivate: async (params: IReactivateBeamParams): Promise<IReactivateBeamResponse> => {
+    return (
+      await AbyssToolsCore.axios.post<IReactivateBeamResponse>(`/beam/${params.beamId}/reactivate`)
+    ).data;
+  },
+
+  share: {
+    create: async (
+      params: ICreateBeamShareParams,
+      body: ICreateBeamShareBody,
+    ): Promise<ICreateBeamShareResponse> => {
+      return (
+        await AbyssToolsCore.axios.post<ICreateBeamShareResponse>(
+          `/beam/${params.beamId}/share`,
+          body,
+        )
+      ).data;
+    },
+    list: async (params: IListBeamSharesParams): Promise<IListBeamSharesResponse> => {
+      return (
+        await AbyssToolsCore.axios.get<IListBeamSharesResponse>(`/beam/${params.beamId}/share`)
+      ).data;
+    },
+    revoke: async (params: IRevokeBeamShareParams): Promise<IRevokeBeamShareResponse> => {
+      return (
+        await AbyssToolsCore.axios.delete<IRevokeBeamShareResponse>(
+          `/beam/${params.beamId}/share/${params.shareId}`,
+        )
+      ).data;
+    },
+  },
+
+  recipients: {
+    add: async (
+      params: { beamId: string },
+      body: IAddRecipientsBeamBody,
+    ): Promise<IAddRecipientsBeamResponse> =>
+      (
+        await AbyssToolsCore.axios.post<IAddRecipientsBeamResponse>(
+          `beam/${params.beamId}/recipients`,
+          body,
+        )
+      ).data,
+    list: async (params: { beamId: string }): Promise<IListRecipientsBeamResponse> =>
+      (
+        await AbyssToolsCore.axios.get<IListRecipientsBeamResponse>(
+          `beam/${params.beamId}/recipients`,
+        )
+      ).data,
+  },
+
+  addFiles: async (
+    params: IAddBeamFilesParams,
+    body: IAddBeamFilesBody,
+  ): Promise<IAddBeamFilesResponse> => {
+    return (
+      await AbyssToolsCore.axios.post<IAddBeamFilesResponse>(`/beam/${params.beamId}/files`, body)
+    ).data;
+  },
+
+  importCloudFiles: async (
+    params: IImportCloudBeamFilesParams,
+    body: IImportCloudBeamFilesBody,
+  ): Promise<IAddBeamFilesResponse> => {
+    return (
+      await AbyssToolsCore.axios.post<IAddBeamFilesResponse>(
+        `/beam/${params.beamId}/files/import-cloud`,
+        body,
+      )
+    ).data;
+  },
+
+  finalize: async (
+    params: IFinalizeBeamParams,
+    body?: IFinalizeBeamBody,
+  ): Promise<IFinalizeBeamResponse> => {
+    return (
+      await AbyssToolsCore.axios.post<IFinalizeBeamResponse>(
+        `/beam/${params.beamId}/finalize`,
+        body ?? {},
+      )
+    ).data;
+  },
+
+  public: {
+    create: async (body: ICreateBeamPublicBody): Promise<ICreateBeamResponse> => {
+      return (await AbyssToolsCore.axios.post<ICreateBeamResponse>(`/beam/public`, body)).data;
+    },
+    addFiles: async (
+      params: IAddBeamFilesParams,
+      body: IAddBeamFilesBody,
+    ): Promise<IAddBeamFilesResponse> => {
+      return (
+        await AbyssToolsCore.axios.post<IAddBeamFilesResponse>(
+          `/beam/public/${params.beamId}/files`,
+          body,
+        )
+      ).data;
+    },
+    finalize: async (
+      params: IFinalizeBeamParams,
+      body?: IFinalizeBeamBody,
+    ): Promise<IFinalizeBeamResponse> => {
+      return (
+        await AbyssToolsCore.axios.post<IFinalizeBeamResponse>(
+          `/beam/public/${params.beamId}/finalize`,
+          body ?? {},
+        )
+      ).data;
+    },
+    renew: async (
+      params: IRenewBeamParams & { manageToken?: string },
+    ): Promise<IRenewBeamResponse> => {
+      return (
+        await AbyssToolsCore.axios.post<IRenewBeamResponse>(
+          `/beam/${params.beamId}/renew`,
+          undefined,
+          manageTokenHeader(params.manageToken),
+        )
+      ).data;
+    },
+    reactivate: async (
+      params: IReactivateBeamParams & { manageToken?: string },
+    ): Promise<IReactivateBeamResponse> => {
+      return (
+        await AbyssToolsCore.axios.post<IReactivateBeamResponse>(
+          `/beam/${params.beamId}/reactivate`,
+          undefined,
+          manageTokenHeader(params.manageToken),
+        )
+      ).data;
+    },
+    update: async (
+      params: IUpdateBeamParams & { manageToken?: string },
+      body: IUpdateBeamBody,
+    ): Promise<IUpdateBeamResponse> => {
+      return (
+        await AbyssToolsCore.axios.put<IUpdateBeamResponse>(
+          `/beam/${params.beamId}`,
+          body,
+          manageTokenHeader(params.manageToken),
+        )
+      ).data;
+    },
+    delete: async (
+      params: IDeleteBeamParams & { manageToken?: string },
+    ): Promise<IDeleteBeamResponse> => {
+      return (
+        await AbyssToolsCore.axios.delete<IDeleteBeamResponse>(
+          `/beam/${params.beamId}`,
+          manageTokenHeader(params.manageToken),
+        )
+      ).data;
+    },
+  },
+};

package/src/api/board-card-checklist.api.ts

@@ -1,99 +1,99 @@
-import { AbyssToolsCore } from '..';
-import {
-  IAddRowBoardCardChecklistBody,
-  IAddRowBoardCardChecklistParams,
-  IAddRowBoardCardChecklistResponse,
-  ICreateBoardCardChecklistBody,
-  ICreateBoardCardChecklistParams,
-  ICreateBoardCardChecklistResponse,
-  IDeleteBoardCardChecklistParams,
-  IDeleteBoardCardChecklistResponse,
-  IGetBoardCardChecklistParams,
-  IGetBoardCardChecklistResponse,
-  IRemoveRowBoardCardChecklistParams,
-  IRemoveRowBoardCardChecklistResponse,
-  IUpdateBoardCardChecklistBody,
-  IUpdateBoardCardChecklistParams,
-  IUpdateBoardCardChecklistResponse,
-  IUpdateRowBoardCardChecklistBody,
-  IUpdateRowBoardCardChecklistParams,
-  IUpdateRowBoardCardChecklistResponse,
-} from '../types';
-
-export const getBoardCardChecklist = async (
-  params: IGetBoardCardChecklistParams,
-): Promise<IGetBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IGetBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}`,
-    )
-  ).data;
-};
-
-export const deleteBoardCardChecklist = async (
-  params: IDeleteBoardCardChecklistParams,
-): Promise<IDeleteBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.delete<IDeleteBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}`,
-    )
-  ).data;
-};
-
-export const updateBoardCardChecklist = async (
-  params: IUpdateBoardCardChecklistParams,
-  body: IUpdateBoardCardChecklistBody,
-): Promise<IUpdateBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.put<IUpdateBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}`,
-      body,
-    )
-  ).data;
-};
-
-export const createBoardCardChecklist = async (
-  params: ICreateBoardCardChecklistParams,
-  body: ICreateBoardCardChecklistBody,
-): Promise<ICreateBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.post<ICreateBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist`,
-      body,
-    )
-  ).data;
-};
-
-export const addRowBoardCardChecklist = async (
-  params: IAddRowBoardCardChecklistParams,
-  body: IAddRowBoardCardChecklistBody,
-): Promise<IAddRowBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.post<IAddRowBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}/row`,
-      body,
-    )
-  ).data;
-};
-
-export const removeRowBoardCardChecklist = async (
-  params: IRemoveRowBoardCardChecklistParams,
-): Promise<IRemoveRowBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.delete<IRemoveRowBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}/row/${params.boardCardChecklistRowId}`,
-    )
-  ).data;
-};
-
-export const updateRowBoardCardChecklist = async (
-  params: IUpdateRowBoardCardChecklistParams,
-  body: IUpdateRowBoardCardChecklistBody,
-): Promise<IUpdateRowBoardCardChecklistResponse> => {
-  return (
-    await AbyssToolsCore.axios.put<IUpdateRowBoardCardChecklistResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}/row/${params.boardCardChecklistRowId}`,
-      body,
-    )
-  ).data;
-};
+import { AbyssToolsCore } from '..';
+import {
+  IAddRowBoardCardChecklistBody,
+  IAddRowBoardCardChecklistParams,
+  IAddRowBoardCardChecklistResponse,
+  ICreateBoardCardChecklistBody,
+  ICreateBoardCardChecklistParams,
+  ICreateBoardCardChecklistResponse,
+  IDeleteBoardCardChecklistParams,
+  IDeleteBoardCardChecklistResponse,
+  IGetBoardCardChecklistParams,
+  IGetBoardCardChecklistResponse,
+  IRemoveRowBoardCardChecklistParams,
+  IRemoveRowBoardCardChecklistResponse,
+  IUpdateBoardCardChecklistBody,
+  IUpdateBoardCardChecklistParams,
+  IUpdateBoardCardChecklistResponse,
+  IUpdateRowBoardCardChecklistBody,
+  IUpdateRowBoardCardChecklistParams,
+  IUpdateRowBoardCardChecklistResponse,
+} from '../types';
+
+export const getBoardCardChecklist = async (
+  params: IGetBoardCardChecklistParams,
+): Promise<IGetBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}`,
+    )
+  ).data;
+};
+
+export const deleteBoardCardChecklist = async (
+  params: IDeleteBoardCardChecklistParams,
+): Promise<IDeleteBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.delete<IDeleteBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}`,
+    )
+  ).data;
+};
+
+export const updateBoardCardChecklist = async (
+  params: IUpdateBoardCardChecklistParams,
+  body: IUpdateBoardCardChecklistBody,
+): Promise<IUpdateBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.put<IUpdateBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}`,
+      body,
+    )
+  ).data;
+};
+
+export const createBoardCardChecklist = async (
+  params: ICreateBoardCardChecklistParams,
+  body: ICreateBoardCardChecklistBody,
+): Promise<ICreateBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.post<ICreateBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist`,
+      body,
+    )
+  ).data;
+};
+
+export const addRowBoardCardChecklist = async (
+  params: IAddRowBoardCardChecklistParams,
+  body: IAddRowBoardCardChecklistBody,
+): Promise<IAddRowBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.post<IAddRowBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}/row`,
+      body,
+    )
+  ).data;
+};
+
+export const removeRowBoardCardChecklist = async (
+  params: IRemoveRowBoardCardChecklistParams,
+): Promise<IRemoveRowBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.delete<IRemoveRowBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}/row/${params.boardCardChecklistRowId}`,
+    )
+  ).data;
+};
+
+export const updateRowBoardCardChecklist = async (
+  params: IUpdateRowBoardCardChecklistParams,
+  body: IUpdateRowBoardCardChecklistBody,
+): Promise<IUpdateRowBoardCardChecklistResponse> => {
+  return (
+    await AbyssToolsCore.axios.put<IUpdateRowBoardCardChecklistResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/checklist/${params.boardCardChecklistId}/row/${params.boardCardChecklistRowId}`,
+      body,
+    )
+  ).data;
+};

package/src/api/board-card-comment.api.ts

@@ -1,57 +1,57 @@
-import { AbyssToolsCore } from '..';
-import {
-  ICreateBoardCardCommentBody,
-  ICreateBoardCardCommentParams,
-  ICreateBoardCardCommentResponse,
-  IDeleteBoardCardCommentParams,
-  IDeleteBoardCardCommentResponse,
-  IGetBoardCardCommentParams,
-  IGetBoardCardCommentResponse,
-  IUpdateBoardCardCommentBody,
-  IUpdateBoardCardCommentParams,
-  IUpdateBoardCardCommentResponse,
-} from '../types';
-
-export const getBoardCardComment = async (
-  params: IGetBoardCardCommentParams,
-): Promise<IGetBoardCardCommentResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IGetBoardCardCommentResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/comment/${params.boardCardCommentId}`,
-    )
-  ).data;
-};
-
-export const deleteBoardCardComment = async (
-  params: IDeleteBoardCardCommentParams,
-): Promise<IDeleteBoardCardCommentResponse> => {
-  return (
-    await AbyssToolsCore.axios.delete<IDeleteBoardCardCommentResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/comment/${params.boardCardCommentId}`,
-    )
-  ).data;
-};
-
-export const updateBoardCardComment = async (
-  params: IUpdateBoardCardCommentParams,
-  body: IUpdateBoardCardCommentBody,
-): Promise<IUpdateBoardCardCommentResponse> => {
-  return (
-    await AbyssToolsCore.axios.put<IUpdateBoardCardCommentResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/comment/${params.boardCardCommentId}`,
-      body,
-    )
-  ).data;
-};
-
-export const createBoardCardComment = async (
-  params: ICreateBoardCardCommentParams,
-  body: ICreateBoardCardCommentBody,
-): Promise<ICreateBoardCardCommentResponse> => {
-  return (
-    await AbyssToolsCore.axios.post<ICreateBoardCardCommentResponse>(
-      `board/${params.boardId}/card/${params.boardCardId}/comment`,
-      body,
-    )
-  ).data;
-};
+import { AbyssToolsCore } from '..';
+import {
+  ICreateBoardCardCommentBody,
+  ICreateBoardCardCommentParams,
+  ICreateBoardCardCommentResponse,
+  IDeleteBoardCardCommentParams,
+  IDeleteBoardCardCommentResponse,
+  IGetBoardCardCommentParams,
+  IGetBoardCardCommentResponse,
+  IUpdateBoardCardCommentBody,
+  IUpdateBoardCardCommentParams,
+  IUpdateBoardCardCommentResponse,
+} from '../types';
+
+export const getBoardCardComment = async (
+  params: IGetBoardCardCommentParams,
+): Promise<IGetBoardCardCommentResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetBoardCardCommentResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/comment/${params.boardCardCommentId}`,
+    )
+  ).data;
+};
+
+export const deleteBoardCardComment = async (
+  params: IDeleteBoardCardCommentParams,
+): Promise<IDeleteBoardCardCommentResponse> => {
+  return (
+    await AbyssToolsCore.axios.delete<IDeleteBoardCardCommentResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/comment/${params.boardCardCommentId}`,
+    )
+  ).data;
+};
+
+export const updateBoardCardComment = async (
+  params: IUpdateBoardCardCommentParams,
+  body: IUpdateBoardCardCommentBody,
+): Promise<IUpdateBoardCardCommentResponse> => {
+  return (
+    await AbyssToolsCore.axios.put<IUpdateBoardCardCommentResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/comment/${params.boardCardCommentId}`,
+      body,
+    )
+  ).data;
+};
+
+export const createBoardCardComment = async (
+  params: ICreateBoardCardCommentParams,
+  body: ICreateBoardCardCommentBody,
+): Promise<ICreateBoardCardCommentResponse> => {
+  return (
+    await AbyssToolsCore.axios.post<ICreateBoardCardCommentResponse>(
+      `board/${params.boardId}/card/${params.boardCardId}/comment`,
+      body,
+    )
+  ).data;
+};