@abyss-project/probe 2.0.1 → 3.0.0

package/src/api/probe-webhook.api.ts

@@ -1,119 +0,0 @@
-// ──────────────────────────────────────────────
-// AbyssProbe webhook subscription API — CRUD over registered `probe_webhooks`
-// (create / list / delete / update, + paginated delivery history — mirrors
-// apps/api/src/api/controllers/probe-webhook.controller.ts EXACTLY, see that
-// file's header comment). No `probe/` path prefix — `@Controller({
-// prefixPath: '/webhook' })` mounts directly at `webhook`.
-//
-// See probe-webhook.application.api.ts for the application/API-key-auth
-// counterpart of this client (`/application/:applicationId/webhook...`,
-// Phase 3a) — it reuses every request/response type verbatim; only the URL
-// prefix, the extra `applicationId` argument, and the auth header differ.
-// ──────────────────────────────────────────────
-
-import { AbyssProbeCore } from '..';
-import type {
-  ICreateProbeWebhookBody,
-  IUpdateProbeWebhookBody,
-  IProbeWebhookScopeQuery,
-  IListProbeWebhookDeliveriesQuery,
-  ICreateProbeWebhookResponse,
-  IListProbeWebhookResponse,
-  IDeleteProbeWebhookResponse,
-  IUpdateProbeWebhookResponse,
-  IListProbeWebhookDeliveriesResponse,
-} from '../types';
-
-const DEFAULT_API_KEY_HEADER = 'abyss-api-key';
-
-function authHeader(apiKey?: string): Record<string, string> {
-  return apiKey ? { [DEFAULT_API_KEY_HEADER]: apiKey } : {};
-}
-
-/** Renames `organizationId` to the wire's `organization_id` (see probe-scan.api.ts). */
-function serializeProbeQuery<T extends object>(query: T): Record<string, unknown> {
-  const out: Record<string, unknown> = {};
-  for (const [key, value] of Object.entries(query as Record<string, unknown>)) {
-    if (value === undefined || value === null) continue;
-    const wireKey = key === 'organizationId' ? 'organization_id' : key;
-    out[wireKey] = value instanceof Date ? value.toISOString() : value;
-  }
-  return out;
-}
-
-/**
- * `POST /webhook` — register a callbackUrl for the caller's scope. The
- * response's `secret` field (HMAC signing secret) is returned ONLY here —
- * store it immediately, it cannot be re-revealed later.
- */
-export const createProbeWebhook = async (
-  body: ICreateProbeWebhookBody,
-  scope: IProbeWebhookScopeQuery = {},
-  apiKey?: string,
-): Promise<ICreateProbeWebhookResponse> =>
-  (
-    await AbyssProbeCore.axios.post<ICreateProbeWebhookResponse>('webhook', body, {
-      params: serializeProbeQuery(scope),
-      headers: authHeader(apiKey),
-    })
-  ).data;
-
-/** `GET /webhook` — flat, scope-filtered list (not paginated — bounded by WEBHOOK_MAX_PER_SCOPE server-side). */
-export const listProbeWebhook = async (
-  scope: IProbeWebhookScopeQuery = {},
-  apiKey?: string,
-): Promise<IListProbeWebhookResponse> =>
-  (
-    await AbyssProbeCore.axios.get<IListProbeWebhookResponse>('webhook', {
-      params: serializeProbeQuery(scope),
-      headers: authHeader(apiKey),
-    })
-  ).data;
-
-/** `DELETE /webhook/:webhookId`. */
-export const deleteProbeWebhook = async (
-  webhookId: string,
-  scope: IProbeWebhookScopeQuery = {},
-  apiKey?: string,
-): Promise<IDeleteProbeWebhookResponse> =>
-  (
-    await AbyssProbeCore.axios.delete<IDeleteProbeWebhookResponse>(`webhook/${webhookId}`, {
-      params: serializeProbeQuery(scope),
-      headers: authHeader(apiKey),
-    })
-  ).data;
-
-/**
- * `PATCH /webhook/:webhookId` (WS5-5) — edit `callbackUrl` and/or `active`.
- * At least one field is required. Scoped like {@link deleteProbeWebhook}
- * (404, never 403, for a webhookId outside the resolved scope). The response
- * includes `secret` — re-displayable now, see {@link IProbeWebhook}.
- */
-export const updateProbeWebhook = async (
-  webhookId: string,
-  body: IUpdateProbeWebhookBody,
-  scope: IProbeWebhookScopeQuery = {},
-  apiKey?: string,
-): Promise<IUpdateProbeWebhookResponse> =>
-  (
-    await AbyssProbeCore.axios.patch<IUpdateProbeWebhookResponse>(`webhook/${webhookId}`, body, {
-      params: serializeProbeQuery(scope),
-      headers: authHeader(apiKey),
-    })
-  ).data;
-
-/**
- * `GET /webhook/:webhookId/deliveries` (WS5-6) — paginated delivery-attempt
- * history for one registered webhook. Scoped like {@link deleteProbeWebhook}.
- */
-export const listProbeWebhookDeliveries = async (
-  webhookId: string,
-  query: IListProbeWebhookDeliveriesQuery = {},
-  apiKey?: string,
-): Promise<IListProbeWebhookDeliveriesResponse> =>
-  (
-    await AbyssProbeCore.axios.get<IListProbeWebhookDeliveriesResponse>(
-      `webhook/${webhookId}/deliveries`,
-      { params: serializeProbeQuery(query), headers: authHeader(apiKey) },
-    )
-  ).data;