@abyss-project/tools 1.1.1 → 1.3.0

package/src/api/extraction.api.ts

@@ -42,6 +42,7 @@ import {
   IListTemplatesResponse,
   IGetTemplateResponse,
   IListTemplateVersionsResponse,
+  IGetTemplateWitnessUrlResponse,
   IExtractionTemplateCollection,
   IImportTemplateCollectionResponse,
   IGetJobResponse,
@@ -62,6 +63,7 @@ import {
   ICreateTemplateBody,
   IUpdateTemplateBody,
   IPatchTemplateMetaBody,
+  IListTemplatesQuery,
   ISubmitFeedbackExtractionBody,
   IPatchFeedbackBody,
   IListFeedbackQuery,
@@ -82,7 +84,7 @@ import type {
   IResetSecretExtractionWebhookResponse,
 } from '../types';
 
-const DEFAULT_API_KEY_HEADER = 'x-api-key';
+const DEFAULT_API_KEY_HEADER = 'abyss-api-key';
 
 function authHeader(apiKey?: string): Record<string, string> {
   return apiKey ? { [DEFAULT_API_KEY_HEADER]: apiKey } : {};
@@ -478,7 +480,7 @@ export const toggleExtractionTraining = async (
 // ─── TEMPLATES ───────────────────────────────
 
 export const listTemplates = async (
-  query: { kind?: 'spatial' | 'dsl' } & IExtractionTemplateScopeQuery = {},
+  query: IListTemplatesQuery & IExtractionTemplateScopeQuery = {},
   apiKey?: string,
 ): Promise<IListTemplatesResponse> => {
   return (
@@ -566,19 +568,58 @@ export const listTemplateVersions = async (
   ).data;
 };
 
+/**
+ * Presigned download URL for a template version's witness PDF.
+ * 404 when the version has no witness.
+ * GET /extract/templates/:id/versions/:version/witness-url
+ */
+export const getTemplateWitnessUrl = async (
+  templateId: string,
+  version: number,
+  scope: IExtractionTemplateScopeQuery = {},
+  apiKey?: string,
+): Promise<IGetTemplateWitnessUrlResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetTemplateWitnessUrlResponse>(
+      `extract/templates/${templateId}/versions/${version}/witness-url`,
+      { params: serializeParams(scope), headers: authHeader(apiKey) },
+    )
+  ).data;
+};
+
+/**
+ * Delete a template version's witness PDF (frees the billed storage).
+ * 404 when the version has no witness. Allowed on archived templates.
+ * DELETE /extract/templates/:id/versions/:version/witness
+ */
+export const deleteTemplateWitness = async (
+  templateId: string,
+  version: number,
+  scope: IExtractionTemplateScopeQuery = {},
+  apiKey?: string,
+): Promise<void> => {
+  await AbyssToolsCore.axios.delete(`extract/templates/${templateId}/versions/${version}/witness`, {
+    params: serializeParams(scope),
+    headers: authHeader(apiKey),
+  });
+};
+
 export const exportTemplateCollection = async (
   ids: string[] | null,
   scope: IExtractionTemplateScopeQuery = {},
   apiKey?: string,
 ): Promise<IExtractionTemplateCollection> => {
-  const res = await AbyssToolsCore.axios.get<IExtractionTemplateCollection>(`extract/templates/export`, {
-    params: {
-      ...(ids && ids.length ? { ids: ids.join(',') } : {}),
-      ...serializeParams(scope),
+  const res = await AbyssToolsCore.axios.get<IExtractionTemplateCollection>(
+    `extract/templates/export`,
+    {
+      params: {
+        ...(ids && ids.length ? { ids: ids.join(',') } : {}),
+        ...serializeParams(scope),
+      },
+      headers: authHeader(apiKey),
+      responseType: 'json',
     },
-    headers: authHeader(apiKey),
-    responseType: 'json',
-  });
+  );
   return res.data;
 };
 
@@ -792,10 +833,10 @@ export const getExtractionWebhook = async (
   apiKey?: string,
 ): Promise<IGetExtractionWebhookResponse> =>
   (
-    await AbyssToolsCore.axios.get<IGetExtractionWebhookResponse>(
-      `extract/webhook/${webhookId}`,
-      { params: serializeParams(scope), headers: authHeader(apiKey) },
-    )
+    await AbyssToolsCore.axios.get<IGetExtractionWebhookResponse>(`extract/webhook/${webhookId}`, {
+      params: serializeParams(scope),
+      headers: authHeader(apiKey),
+    })
   ).data;
 
 export const createExtractionWebhook = async (
@@ -804,11 +845,10 @@ export const createExtractionWebhook = async (
   apiKey?: string,
 ): Promise<ICreateExtractionWebhookResponse> =>
   (
-    await AbyssToolsCore.axios.post<ICreateExtractionWebhookResponse>(
-      `extract/webhook`,
-      body,
-      { params: serializeParams(scope), headers: authHeader(apiKey) },
-    )
+    await AbyssToolsCore.axios.post<ICreateExtractionWebhookResponse>(`extract/webhook`, body, {
+      params: serializeParams(scope),
+      headers: authHeader(apiKey),
+    })
   ).data;
 
 export const updateExtractionWebhook = async (

package/src/api/memo.api.ts

@@ -1,97 +1,97 @@
-import { AbyssToolsCore } from '..';
-import {
-  ICreateMemoBody,
-  ICreateMemoResponse,
-  ICreateForOrganizationMemoParams,
-  IDeleteMemoParams,
-  IDeleteMemoResponse,
-  IGetMemoParams,
-  IGetMemoResponse,
-  IPaginateMemoQuery,
-  IPaginateMemoResponse,
-  IPaginateProjectMemoParams,
-  IPaginateOrganizationMemoParams,
-  IUpdateMemoBody,
-  IUpdateMemoParams,
-  IUpdateMemoResponse,
-  ITransferContentBody,
-  ITransferMemoResponse,
-  ICountOrganizationResponse,
-} from '../types';
-
-export const paginateMemo = async (query: IPaginateMemoQuery): Promise<IPaginateMemoResponse> => {
-  return (await AbyssToolsCore.axios.get<IPaginateMemoResponse>(`memo/paginate`, { params: query }))
-    .data;
-};
-
-export const paginateProjectMemo = async (
-  params: IPaginateProjectMemoParams,
-  query: IPaginateMemoQuery,
-): Promise<IPaginateMemoResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IPaginateMemoResponse>(`project/${params.projectId}/memo/paginate`, {
-      params: query,
-    })
-  ).data;
-};
-
-export const getMemo = async (params: IGetMemoParams): Promise<IGetMemoResponse> => {
-  return (await AbyssToolsCore.axios.get<IGetMemoResponse>(`memo/${params.memoId}`)).data;
-};
-
-export const deleteMemo = async (params: IDeleteMemoParams): Promise<IDeleteMemoResponse> => {
-  return (await AbyssToolsCore.axios.delete<IDeleteMemoResponse>(`memo/${params.memoId}`)).data;
-};
-
-export const updateMemo = async (
-  params: IUpdateMemoParams,
-  body: IUpdateMemoBody,
-): Promise<IUpdateMemoResponse> => {
-  return (await AbyssToolsCore.axios.put<IUpdateMemoResponse>(`memo/${params.memoId}`, body)).data;
-};
-
-export const createMemo = async (body: ICreateMemoBody): Promise<ICreateMemoResponse> => {
-  return (await AbyssToolsCore.axios.post<ICreateMemoResponse>(`memo`, body)).data;
-};
-
-export const paginateOrganizationMemo = async (
-  params: IPaginateOrganizationMemoParams,
-  query: IPaginateMemoQuery,
-): Promise<IPaginateMemoResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IPaginateMemoResponse>(
-      `organization/${params.organizationId}/memo/paginate`,
-      { params: query },
-    )
-  ).data;
-};
-
-export const createForOrganizationMemo = async (
-  params: ICreateForOrganizationMemoParams,
-  body: ICreateMemoBody,
-): Promise<ICreateMemoResponse> => {
-  return (await AbyssToolsCore.axios.post<ICreateMemoResponse>(`memo/organization/${params.organizationId}`, body))
-    .data;
-};
-
-export const transferMemo = async (
-  params: { memoId: string },
-  body: ITransferContentBody,
-): Promise<ITransferMemoResponse> => {
-  return (
-    await AbyssToolsCore.axios.post<ITransferMemoResponse>(
-      `memo/${params.memoId}/transfer`,
-      body,
-    )
-  ).data;
-};
-
-export const countOrganizationMemo = async (
-  params: { organizationId: string },
-): Promise<ICountOrganizationResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<ICountOrganizationResponse>(
-      `memo/organization/${params.organizationId}/count`,
-    )
-  ).data;
-};
+import { AbyssToolsCore } from '..';
+import {
+  ICreateMemoBody,
+  ICreateMemoResponse,
+  ICreateForOrganizationMemoParams,
+  IDeleteMemoParams,
+  IDeleteMemoResponse,
+  IGetMemoParams,
+  IGetMemoResponse,
+  IPaginateMemoQuery,
+  IPaginateMemoResponse,
+  IPaginateProjectMemoParams,
+  IPaginateOrganizationMemoParams,
+  IUpdateMemoBody,
+  IUpdateMemoParams,
+  IUpdateMemoResponse,
+  ITransferContentBody,
+  ITransferMemoResponse,
+  ICountOrganizationResponse,
+} from '../types';
+
+export const paginateMemo = async (query: IPaginateMemoQuery): Promise<IPaginateMemoResponse> => {
+  return (await AbyssToolsCore.axios.get<IPaginateMemoResponse>(`memo/paginate`, { params: query }))
+    .data;
+};
+
+export const paginateProjectMemo = async (
+  params: IPaginateProjectMemoParams,
+  query: IPaginateMemoQuery,
+): Promise<IPaginateMemoResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IPaginateMemoResponse>(`project/${params.projectId}/memo/paginate`, {
+      params: query,
+    })
+  ).data;
+};
+
+export const getMemo = async (params: IGetMemoParams): Promise<IGetMemoResponse> => {
+  return (await AbyssToolsCore.axios.get<IGetMemoResponse>(`memo/${params.memoId}`)).data;
+};
+
+export const deleteMemo = async (params: IDeleteMemoParams): Promise<IDeleteMemoResponse> => {
+  return (await AbyssToolsCore.axios.delete<IDeleteMemoResponse>(`memo/${params.memoId}`)).data;
+};
+
+export const updateMemo = async (
+  params: IUpdateMemoParams,
+  body: IUpdateMemoBody,
+): Promise<IUpdateMemoResponse> => {
+  return (await AbyssToolsCore.axios.put<IUpdateMemoResponse>(`memo/${params.memoId}`, body)).data;
+};
+
+export const createMemo = async (body: ICreateMemoBody): Promise<ICreateMemoResponse> => {
+  return (await AbyssToolsCore.axios.post<ICreateMemoResponse>(`memo`, body)).data;
+};
+
+export const paginateOrganizationMemo = async (
+  params: IPaginateOrganizationMemoParams,
+  query: IPaginateMemoQuery,
+): Promise<IPaginateMemoResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IPaginateMemoResponse>(
+      `organization/${params.organizationId}/memo/paginate`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const createForOrganizationMemo = async (
+  params: ICreateForOrganizationMemoParams,
+  body: ICreateMemoBody,
+): Promise<ICreateMemoResponse> => {
+  return (await AbyssToolsCore.axios.post<ICreateMemoResponse>(`memo/organization/${params.organizationId}`, body))
+    .data;
+};
+
+export const transferMemo = async (
+  params: { memoId: string },
+  body: ITransferContentBody,
+): Promise<ITransferMemoResponse> => {
+  return (
+    await AbyssToolsCore.axios.post<ITransferMemoResponse>(
+      `memo/${params.memoId}/transfer`,
+      body,
+    )
+  ).data;
+};
+
+export const countOrganizationMemo = async (
+  params: { organizationId: string },
+): Promise<ICountOrganizationResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<ICountOrganizationResponse>(
+      `memo/organization/${params.organizationId}/count`,
+    )
+  ).data;
+};

package/src/api/metrics.api.ts

@@ -1,27 +1,27 @@
-import { AbyssToolsCore } from '..';
-import {
-  IGetOrganizationToolsMetricsParams,
-  IGetOrganizationToolsMetricsResponse,
-  IGetProjectToolsMetricsParams,
-  IGetProjectToolsMetricsResponse,
-} from '../types';
-
-export const getOrganizationToolsMetrics = async (
-  params: IGetOrganizationToolsMetricsParams,
-): Promise<IGetOrganizationToolsMetricsResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IGetOrganizationToolsMetricsResponse>(
-      `metrics/organization/${params.organizationId}`,
-    )
-  ).data;
-};
-
-export const getProjectToolsMetrics = async (
-  params: IGetProjectToolsMetricsParams,
-): Promise<IGetProjectToolsMetricsResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IGetProjectToolsMetricsResponse>(
-      `metrics/project/${params.projectId}`,
-    )
-  ).data;
-};
+import { AbyssToolsCore } from '..';
+import {
+  IGetOrganizationToolsMetricsParams,
+  IGetOrganizationToolsMetricsResponse,
+  IGetProjectToolsMetricsParams,
+  IGetProjectToolsMetricsResponse,
+} from '../types';
+
+export const getOrganizationToolsMetrics = async (
+  params: IGetOrganizationToolsMetricsParams,
+): Promise<IGetOrganizationToolsMetricsResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetOrganizationToolsMetricsResponse>(
+      `metrics/organization/${params.organizationId}`,
+    )
+  ).data;
+};
+
+export const getProjectToolsMetrics = async (
+  params: IGetProjectToolsMetricsParams,
+): Promise<IGetProjectToolsMetricsResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetProjectToolsMetricsResponse>(
+      `metrics/project/${params.projectId}`,
+    )
+  ).data;
+};

package/src/api/monitor.api.ts

@@ -1,6 +1,6 @@
-import { AbyssToolsCore } from '..';
-import { IUpMonitorResponse } from '../types';
-
-export const upMonitor = async (): Promise<IUpMonitorResponse> => {
-  return (await AbyssToolsCore.axios.get<IUpMonitorResponse>(`monitor/up`)).data;
-};
+import { AbyssToolsCore } from '..';
+import { IUpMonitorResponse } from '../types';
+
+export const upMonitor = async (): Promise<IUpMonitorResponse> => {
+  return (await AbyssToolsCore.axios.get<IUpMonitorResponse>(`monitor/up`)).data;
+};

package/src/api/organization.api.ts

@@ -1,14 +1,14 @@
-import { AbyssToolsCore } from '..';
-import { IRecentOrganizationResponse } from '../types';
-
-export const recentOrganization = async (
-  params: { organizationId: string },
-  query?: { limit?: number },
-): Promise<IRecentOrganizationResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IRecentOrganizationResponse>(
-      `organization/${params.organizationId}/recent`,
-      { params: query },
-    )
-  ).data;
-};
+import { AbyssToolsCore } from '..';
+import { IRecentOrganizationResponse } from '../types';
+
+export const recentOrganization = async (
+  params: { organizationId: string },
+  query?: { limit?: number },
+): Promise<IRecentOrganizationResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IRecentOrganizationResponse>(
+      `organization/${params.organizationId}/recent`,
+      { params: query },
+    )
+  ).data;
+};

package/src/api/retrospective-card.api.ts

@@ -1,74 +1,74 @@
-import { AbyssToolsCore } from '..';
-import {
-  IGetRetrospectiveCardParams,
-  IGetRetrospectiveCardResponse,
-  IPaginateRetrospectiveCardParams,
-  IPaginateRetrospectiveCardQuery,
-  IPaginateRetrospectiveCardResponse,
-  ICreateRetrospectiveCardParams,
-  ICreateRetrospectiveCardBody,
-  ICreateRetrospectiveCardResponse,
-  IUpdateRetrospectiveCardParams,
-  IUpdateRetrospectiveCardBody,
-  IUpdateRetrospectiveCardResponse,
-  IDeleteRetrospectiveCardParams,
-  IDeleteRetrospectiveCardResponse,
-} from '../types';
-
-export const getRetrospectiveCard = async (
-  params: IGetRetrospectiveCardParams,
-): Promise<IGetRetrospectiveCardResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IGetRetrospectiveCardResponse>(
-      `retrospective/${params.retrospectiveId}/card/${params.retrospectiveCardId}`,
-    )
-  ).data;
-};
-
-export const paginateRetrospectiveCard = async (
-  params: IPaginateRetrospectiveCardParams,
-  query?: IPaginateRetrospectiveCardQuery,
-): Promise<IPaginateRetrospectiveCardResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IPaginateRetrospectiveCardResponse>(
-      `retrospective/${params.retrospectiveId}/card/paginate`,
-      {
-        params: query,
-      },
-    )
-  ).data;
-};
-
-export const createRetrospectiveCard = async (
-  params: ICreateRetrospectiveCardParams,
-  body: ICreateRetrospectiveCardBody,
-): Promise<ICreateRetrospectiveCardResponse> => {
-  return (
-    await AbyssToolsCore.axios.post<ICreateRetrospectiveCardResponse>(
-      `retrospective/${params.retrospectiveId}/card`,
-      body,
-    )
-  ).data;
-};
-
-export const updateRetrospectiveCard = async (
-  params: IUpdateRetrospectiveCardParams,
-  body: IUpdateRetrospectiveCardBody,
-): Promise<IUpdateRetrospectiveCardResponse> => {
-  return (
-    await AbyssToolsCore.axios.put<IUpdateRetrospectiveCardResponse>(
-      `retrospective/${params.retrospectiveId}/card/${params.retrospectiveCardId}`,
-      body,
-    )
-  ).data;
-};
-
-export const deleteRetrospectiveCard = async (
-  params: IDeleteRetrospectiveCardParams,
-): Promise<IDeleteRetrospectiveCardResponse> => {
-  return (
-    await AbyssToolsCore.axios.delete<IDeleteRetrospectiveCardResponse>(
-      `retrospective/${params.retrospectiveId}/card/${params.retrospectiveCardId}`,
-    )
-  ).data;
-};
+import { AbyssToolsCore } from '..';
+import {
+  IGetRetrospectiveCardParams,
+  IGetRetrospectiveCardResponse,
+  IPaginateRetrospectiveCardParams,
+  IPaginateRetrospectiveCardQuery,
+  IPaginateRetrospectiveCardResponse,
+  ICreateRetrospectiveCardParams,
+  ICreateRetrospectiveCardBody,
+  ICreateRetrospectiveCardResponse,
+  IUpdateRetrospectiveCardParams,
+  IUpdateRetrospectiveCardBody,
+  IUpdateRetrospectiveCardResponse,
+  IDeleteRetrospectiveCardParams,
+  IDeleteRetrospectiveCardResponse,
+} from '../types';
+
+export const getRetrospectiveCard = async (
+  params: IGetRetrospectiveCardParams,
+): Promise<IGetRetrospectiveCardResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IGetRetrospectiveCardResponse>(
+      `retrospective/${params.retrospectiveId}/card/${params.retrospectiveCardId}`,
+    )
+  ).data;
+};
+
+export const paginateRetrospectiveCard = async (
+  params: IPaginateRetrospectiveCardParams,
+  query?: IPaginateRetrospectiveCardQuery,
+): Promise<IPaginateRetrospectiveCardResponse> => {
+  return (
+    await AbyssToolsCore.axios.get<IPaginateRetrospectiveCardResponse>(
+      `retrospective/${params.retrospectiveId}/card/paginate`,
+      {
+        params: query,
+      },
+    )
+  ).data;
+};
+
+export const createRetrospectiveCard = async (
+  params: ICreateRetrospectiveCardParams,
+  body: ICreateRetrospectiveCardBody,
+): Promise<ICreateRetrospectiveCardResponse> => {
+  return (
+    await AbyssToolsCore.axios.post<ICreateRetrospectiveCardResponse>(
+      `retrospective/${params.retrospectiveId}/card`,
+      body,
+    )
+  ).data;
+};
+
+export const updateRetrospectiveCard = async (
+  params: IUpdateRetrospectiveCardParams,
+  body: IUpdateRetrospectiveCardBody,
+): Promise<IUpdateRetrospectiveCardResponse> => {
+  return (
+    await AbyssToolsCore.axios.put<IUpdateRetrospectiveCardResponse>(
+      `retrospective/${params.retrospectiveId}/card/${params.retrospectiveCardId}`,
+      body,
+    )
+  ).data;
+};
+
+export const deleteRetrospectiveCard = async (
+  params: IDeleteRetrospectiveCardParams,
+): Promise<IDeleteRetrospectiveCardResponse> => {
+  return (
+    await AbyssToolsCore.axios.delete<IDeleteRetrospectiveCardResponse>(
+      `retrospective/${params.retrospectiveId}/card/${params.retrospectiveCardId}`,
+    )
+  ).data;
+};