@abyss-project/extract 0.0.0-stage → 1.0.0

package/src/api/extraction-settings.api.ts

@@ -0,0 +1,53 @@
+// ──────────────────────────────────────────────
+// Extraction Settings API (P4 / T7) — per-scope improvement-consent defaults.
+//
+// GET  /extract/settings   — fetch effective improvementDefault for the caller's scope.
+// PUT  /extract/settings   — upsert improvementDefault for the caller's scope.
+//
+// Scope is resolved by the server from standard ?organization_id / ?project_id
+// query params (same as every other extract route).
+// ──────────────────────────────────────────────
+
+import { AbyssExtractCore } from '..';
+import type { IGetExtractionSettingsQuery, IUpsertExtractionSettingsBody } from '../types';
+import type { IGetExtractionSettingsResponse, IUpsertExtractionSettingsResponse } from '../types';
+
+const DEFAULT_API_KEY_HEADER = 'abyss-api-key';
+
+function authHeader(apiKey?: string): Record<string, string> {
+  return apiKey ? { [DEFAULT_API_KEY_HEADER]: apiKey } : {};
+}
+
+/**
+ * Fetch the effective improvementDefault for the caller's scope.
+ * Returns `{ data: { improvement_default: boolean } }`.
+ * Pass `query.organization_id` or `query.project_id` to select org / project scope;
+ * omit both for personal (user) scope.
+ */
+export const getExtractionSettings = async (
+  query: IGetExtractionSettingsQuery = {},
+  apiKey?: string,
+): Promise<IGetExtractionSettingsResponse> => {
+  return (
+    await AbyssExtractCore.axios.get<IGetExtractionSettingsResponse>(`extract/settings`, {
+      params: query,
+      headers: authHeader(apiKey),
+    })
+  ).data;
+};
+
+/**
+ * Upsert the improvementDefault for the caller's scope.
+ * Body: `{ improvement_default: boolean }`.
+ * Returns `{ data: { improvement_default: boolean } }` on success.
+ */
+export const upsertExtractionSettings = async (
+  body: IUpsertExtractionSettingsBody,
+  apiKey?: string,
+): Promise<IUpsertExtractionSettingsResponse> => {
+  return (
+    await AbyssExtractCore.axios.put<IUpsertExtractionSettingsResponse>(`extract/settings`, body, {
+      headers: authHeader(apiKey),
+    })
+  ).data;
+};