@honeyhive/control-plane-sdk 1.0.0-rc.1

package/src/generated/apiTypes.ts

@@ -0,0 +1,471 @@
+// AUTO-GENERATED — do not edit manually. Run `pnpm turbo run generate` to regenerate.
+
+// ---- Request types ----
+
+export interface ListAlertsRequest {
+  /** @description The unique identifier of the project whose alerts are listed */
+  project_id: string;
+  /** @description 1-indexed page number */
+  page?: number;
+  /** @description Number of alerts to return per page */
+  limit?: number;
+  /** @description Only return alerts in this status */
+  status?: 'ACTIVE' | 'TRIGGERED' | 'PAUSED' | 'RESOLVED';
+  /** @description Field to sort results by */
+  sort_by?: 'created_at' | 'updated_at' | 'name' | 'status' | 'frequency' | 'last_triggered';
+  /** @description Sort order */
+  sort_order?: 'asc' | 'desc';
+}
+
+export interface CreateAlertRequest {
+  /** @description The unique identifier of the project the alert is created in */
+  project_id: string;
+  name: string;
+  description?: string;
+  /** @enum {string} */
+  frequency: 'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY';
+  /** @default 0 */
+  minimum_sample_size?: number;
+  /**
+   * @default AGGREGATE
+   * @enum {string}
+   */
+  alert_type?: 'DRIFT' | 'AGGREGATE' | 'PER_EVENT';
+  /**
+   * @default AVERAGE
+   * @enum {string}
+   */
+  aggregation?: 'AVERAGE' | 'COUNT' | 'SUM' | 'MIN' | 'MAX' | 'P90' | 'P95' | 'P99' | 'MEDIAN';
+  thresholds: PostAlertRequestThresholds;
+  filters: SingleFilter[];
+  projections: string[];
+  notification_details: PostAlertRequestNotificationDetails;
+  /** @enum {string} */
+  status?: 'ACTIVE' | 'TRIGGERED' | 'PAUSED' | 'RESOLVED';
+}
+
+export interface GetAlertRequest {
+  /** @description The unique identifier of the project the alert belongs to */
+  project_id: string;
+  /** @description The unique identifier of the alert to retrieve */
+  alert_id: string;
+}
+
+export interface CreateProjectRequest {
+  /** @description The unique identifier of the workspace the project is created in */
+  workspace_id: string;
+  /** @description Project display name */
+  name: string;
+  /** @description Project description */
+  description?: string;
+  /**
+   * Format: email
+   * @description Email of the user to grant the project-creator membership to (API key actors only)
+   */
+  project_creator?: string;
+}
+
+export interface GetProjectRequest {
+  /** @description The unique identifier of the project to retrieve */
+  project_id: string;
+}
+
+export interface UpdateProjectRequest {
+  /** @description The unique identifier of the project to update */
+  project_id: string;
+  /** @description Project display name */
+  name?: string;
+  /** @description Project description */
+  description?: string;
+}
+
+export interface DeleteProjectRequest {
+  /** @description The unique identifier of the project to delete */
+  project_id: string;
+}
+
+// ---- Response types ----
+
+/**
+ * @description A paginated list of alerts
+ */
+export type ListAlertsResponse = {
+  /** @enum {boolean} */
+  success: true;
+  data: AlertItem[];
+  pagination: Pagination;
+};
+
+/**
+ * @description The created alert
+ */
+export type CreateAlertResponse = {
+  /** @enum {boolean} */
+  success: true;
+  data: AlertItem;
+};
+
+/**
+ * @description A single alert
+ */
+export type GetAlertResponse = {
+  /** @enum {boolean} */
+  success: true;
+  data: AlertItem;
+};
+
+/**
+ * @description The created project
+ */
+export type CreateProjectResponse = {
+  success: boolean;
+  data: ProjectItem;
+};
+
+/**
+ * @description A single project
+ */
+export type GetProjectResponse = {
+  success: boolean;
+  data: ProjectItem;
+};
+
+/**
+ * @description The updated project
+ */
+export type UpdateProjectResponse = {
+  success: boolean;
+  data: ProjectItem;
+};
+
+/**
+ * @description The deleted (archived) project
+ */
+export type DeleteProjectResponse = {
+  success: boolean;
+  data: ProjectItem;
+};
+
+// ---- Internal types ----
+//
+// These types are not part of the public API surface (not re-exported
+// from index.ts) and are tagged @inline so TypeDoc renders their
+// bodies inline at use sites rather than as standalone pages.
+
+/**
+ * @description Alert object
+ * @inline
+ */
+export type AlertItem = {
+  id: string;
+  name: string;
+  description?: string | null;
+  /** @enum {string} */
+  status: 'ACTIVE' | 'TRIGGERED' | 'PAUSED' | 'RESOLVED';
+  /** @enum {string} */
+  frequency: 'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY';
+  minimum_sample_size: number;
+  /** @enum {string} */
+  alert_type: 'DRIFT' | 'AGGREGATE' | 'PER_EVENT';
+  aggregation: string;
+  event_filters: AlertEventFilter[];
+  event_metrics: AlertEventMetric[];
+  thresholds: AlertItemThresholds;
+  last_run_at?: string | null;
+  last_result?:
+    | ({
+        current_bucket_score?: number | boolean;
+        previous_bucket_score?: number | boolean;
+        last_triggered_baseline?: number | boolean;
+        drift_percentage?: number;
+        thresholds?: AlertItemLastResultThresholds;
+        event_filters?: unknown[];
+        event_metrics?: unknown[];
+        aggregation?: string;
+      } & {
+        [key: string]: unknown;
+      })
+    | null;
+  trigger_error?: string | null;
+  is_active: boolean;
+  is_muted: boolean;
+  created_at: string;
+  updated_at?: string | null;
+  last_trigger_id?: string | null;
+  scope_type: string;
+  scope_id: string;
+  created_by?: string | null;
+  last_trigger?: AlertTrigger;
+  triggers?: AlertTrigger[];
+  notifications?: AlertNotification[];
+};
+
+/**
+ * @inline
+ */
+export type AlertEventFilter = {
+  filter: SingleFilter;
+  /** @enum {string} */
+  type: 'float' | 'numeric' | 'boolean' | 'string' | 'null';
+};
+
+/**
+ * @inline
+ */
+export type SingleFilter = {
+  field: string;
+  /** @enum {string} */
+  operator:
+    | 'exists'
+    | 'not exists'
+    | 'is'
+    | 'is not'
+    | 'contains'
+    | 'not contains'
+    | 'greater than'
+    | 'less than'
+    | 'after'
+    | 'before';
+  value: string | number | boolean | null;
+  /** @enum {string} */
+  type: 'string' | 'number' | 'boolean' | 'datetime';
+};
+
+/**
+ * @inline
+ */
+export type AlertEventMetric = {
+  /** @description Projected field or metric for this entry */
+  projection: string;
+  /** @enum {string} */
+  type: 'float' | 'numeric' | 'boolean' | 'string' | 'null';
+};
+
+/**
+ * @inline
+ */
+export type AlertTrigger = {
+  id: string;
+  alert_id: string;
+  result: AlertTriggerResult;
+  muted: boolean;
+  notification_sent: boolean;
+  triggered_time: string;
+  resolved_time: string | null;
+  resolved_by: string | null;
+  created_at: string;
+  updated_at: string;
+};
+
+/**
+ * @inline
+ */
+export type AlertNotification = {
+  id: string;
+  alert_id: string;
+  /** @enum {string} */
+  stage: 'CRITICAL' | 'RESOLUTION';
+  /** @enum {string} */
+  channel: 'EMAIL' | 'SLACK' | 'WEBHOOK';
+  /** @enum {string} */
+  scope: 'ALL_PROJECT_MEMBERS' | 'SPECIFIC_MEMBER';
+  membership_id?: string | null;
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
+  last_sent_at?: string | null;
+  created_at: string;
+  membership?: {
+    user: AlertNotificationMembershipUser;
+  } | null;
+};
+
+/**
+ * @inline
+ */
+export type Pagination = {
+  page: number;
+  limit: number;
+  total: number;
+  total_unfiltered: number;
+  total_pages: number;
+  has_next: boolean;
+  has_prev: boolean;
+};
+
+/**
+ * @description Project object
+ * @inline
+ */
+export type ProjectItem = {
+  id: string;
+  /** @description Project display name */
+  name: string;
+  /** @description Project description */
+  description: string;
+  created_at: string;
+  updated_at?: string | null;
+};
+
+/**
+ * @inline
+ */
+export type AlertItemThresholdsCritical = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type AlertItemThresholdsResolved = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type AlertItemThresholds = {
+  critical: AlertItemThresholdsCritical;
+  resolved: AlertItemThresholdsResolved;
+};
+
+/**
+ * @inline
+ */
+export type AlertItemLastResultThresholdsCritical = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type AlertItemLastResultThresholdsResolved = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type AlertItemLastResultThresholds = {
+  critical: AlertItemLastResultThresholdsCritical;
+  resolved: AlertItemLastResultThresholdsResolved;
+};
+
+/**
+ * @inline
+ */
+export type AlertTriggerResultThresholdsCritical = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type AlertTriggerResultThresholdsResolved = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type AlertTriggerResultThresholds = {
+  critical: AlertTriggerResultThresholdsCritical;
+  resolved: AlertTriggerResultThresholdsResolved;
+};
+
+/**
+ * @inline
+ */
+export type AlertTriggerResult = {
+  current_bucket_score?: number | boolean;
+  previous_bucket_score?: number | boolean;
+  last_triggered_baseline?: number | boolean;
+  drift_percentage?: number;
+  thresholds?: AlertTriggerResultThresholds;
+  event_filters?: unknown[];
+  event_metrics?: unknown[];
+  aggregation?: string;
+} & {
+  [key: string]: unknown;
+};
+
+/**
+ * @inline
+ */
+export type AlertNotificationMembershipUser = {
+  id: string;
+};
+
+/**
+ * @inline
+ */
+export type PostAlertRequestThresholdsCritical = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type PostAlertRequestThresholdsResolved = {
+  /** @enum {string} */
+  operator: 'greater_than' | 'less_than' | 'equal_to';
+  value: number;
+};
+
+/**
+ * @inline
+ */
+export type PostAlertRequestThresholds = {
+  critical: PostAlertRequestThresholdsCritical;
+  resolved: PostAlertRequestThresholdsResolved;
+};
+
+/**
+ * @inline
+ */
+export type PostAlertRequestNotificationDetailsCritical = {
+  /** @enum {string} */
+  channel: 'EMAIL' | 'SLACK' | 'WEBHOOK';
+  /** @enum {string} */
+  scope: 'ALL_PROJECT_MEMBERS' | 'SPECIFIC_MEMBER';
+  user_ids?: string[];
+  metadata: {
+    [key: string]: unknown;
+  };
+};
+
+/**
+ * @inline
+ */
+export type PostAlertRequestNotificationDetailsResolved = {
+  /** @enum {string} */
+  channel: 'EMAIL' | 'SLACK' | 'WEBHOOK';
+  /** @enum {string} */
+  scope: 'ALL_PROJECT_MEMBERS' | 'SPECIFIC_MEMBER';
+  user_ids?: string[];
+  metadata: {
+    [key: string]: unknown;
+  };
+};
+
+/**
+ * @inline
+ */
+export type PostAlertRequestNotificationDetails = {
+  critical: PostAlertRequestNotificationDetailsCritical;
+  resolved: PostAlertRequestNotificationDetailsResolved;
+};

package/src/generated/client.ts

@@ -0,0 +1,187 @@
+// AUTO-GENERATED — do not edit manually. Run `pnpm turbo run generate` to regenerate.
+
+import { type paths } from './types.js';
+import {
+  type ListAlertsRequest,
+  type CreateAlertRequest,
+  type GetAlertRequest,
+  type CreateProjectRequest,
+  type GetProjectRequest,
+  type UpdateProjectRequest,
+  type DeleteProjectRequest,
+  type ListAlertsResponse,
+  type CreateAlertResponse,
+  type GetAlertResponse,
+  type CreateProjectResponse,
+  type GetProjectResponse,
+  type UpdateProjectResponse,
+  type DeleteProjectResponse,
+} from './apiTypes.js';
+import { type ClientConfig, type FetchOptions, createApiClient, unwrap } from '../util.js';
+
+/** @inline */
+class AlertsNamespace {
+  #client: ReturnType<typeof createApiClient<paths>>;
+
+  constructor(client: ReturnType<typeof createApiClient<paths>>) {
+    this.#client = client;
+  }
+
+  /**
+   * List alerts
+   *
+   * List the alerts in a project. The project is identified by the `project_id` path parameter
+   * alone; the `x-hh-project-id` header does not participate. Supports offset pagination, an
+   * optional status filter, and sorting (defaults to most recently created first).
+   */
+  public list(request: ListAlertsRequest, options?: FetchOptions): Promise<ListAlertsResponse> {
+    const { project_id, page, limit, status, sort_by, sort_order } = request;
+    return unwrap(
+      this.#client.GET('/v1/projects/{project_id}/alerts', {
+        params: { path: { project_id }, query: { page, limit, status, sort_by, sort_order } },
+        ...options,
+      }),
+    );
+  }
+
+  /**
+   * Create an alert
+   *
+   * Create an alert in a project. The project is identified by the `project_id` path parameter
+   * alone; the `x-hh-project-id` header does not participate. The alert's `filters` and
+   * `projections` (metrics) are mapped against the project's logged-event schema; if no schema
+   * data matches them — e.g. no events have been logged to the project yet — the request fails
+   * with a 400.
+   */
+  public create(request: CreateAlertRequest, options?: FetchOptions): Promise<CreateAlertResponse> {
+    const { project_id, ...body } = request;
+    return unwrap(
+      this.#client.POST('/v1/projects/{project_id}/alerts', {
+        params: { path: { project_id } },
+        body,
+        ...options,
+      }),
+    );
+  }
+
+  /**
+   * Get an alert
+   *
+   * Retrieve a single alert by id, including its thresholds, triggers, and notification
+   * configuration. The alert's project is identified by the `project_id` path parameter alone;
+   * the `x-hh-project-id` header does not participate.
+   */
+  public get(request: GetAlertRequest, options?: FetchOptions): Promise<GetAlertResponse> {
+    const { project_id, alert_id } = request;
+    return unwrap(
+      this.#client.GET('/v1/projects/{project_id}/alerts/{alert_id}', {
+        params: { path: { project_id, alert_id } },
+        ...options,
+      }),
+    );
+  }
+}
+
+/** @inline */
+class ProjectsNamespace {
+  #client: ReturnType<typeof createApiClient<paths>>;
+
+  constructor(client: ReturnType<typeof createApiClient<paths>>) {
+    this.#client = client;
+  }
+
+  /**
+   * Create a project
+   *
+   * Create a project in a workspace. The parent workspace is identified by the `workspace_id`
+   * path parameter alone; the `x-hh-workspace-id` header does not participate.
+   *
+   * The optional `project_creator` field names the user (by email) who receives the
+   * project-creator membership on the new project. The named user must already be a member of
+   * the workspace. When omitted, the project is created without any membership. The field is
+   * only accepted on API-key-initiated requests — user-initiated creation always makes the
+   * calling user the creator and rejects the field with a 400.
+   */
+  public create(
+    request: CreateProjectRequest,
+    options?: FetchOptions,
+  ): Promise<CreateProjectResponse> {
+    const { workspace_id, ...body } = request;
+    return unwrap(
+      this.#client.POST('/v1/workspaces/{workspace_id}/projects', {
+        params: { path: { workspace_id } },
+        body,
+        ...options,
+      }),
+    );
+  }
+
+  /**
+   * Get a project
+   *
+   * Retrieve a single project by id. The project is identified by the `project_id` path
+   * parameter alone; the `x-hh-project-id` header does not participate.
+   */
+  public get(request: GetProjectRequest, options?: FetchOptions): Promise<GetProjectResponse> {
+    const { project_id } = request;
+    return unwrap(
+      this.#client.GET('/v1/projects/{project_id}', {
+        params: { path: { project_id } },
+        ...options,
+      }),
+    );
+  }
+
+  /**
+   * Update a project
+   *
+   * Update a project's display name and/or description. The project is identified by the
+   * `project_id` path parameter alone; the `x-hh-project-id` header does not participate.
+   * Only fields included in the request body are modified.
+   */
+  public update(
+    request: UpdateProjectRequest,
+    options?: FetchOptions,
+  ): Promise<UpdateProjectResponse> {
+    const { project_id, ...body } = request;
+    return unwrap(
+      this.#client.PUT('/v1/projects/{project_id}', {
+        params: { path: { project_id } },
+        body,
+        ...options,
+      }),
+    );
+  }
+
+  /**
+   * Delete a project
+   *
+   * Delete a project. The project is soft-deleted (archived) and no longer appears in reads;
+   * the response returns the archived project. The project is identified by the `project_id`
+   * path parameter alone; the `x-hh-project-id` header does not participate.
+   */
+  public delete(
+    request: DeleteProjectRequest,
+    options?: FetchOptions,
+  ): Promise<DeleteProjectResponse> {
+    const { project_id } = request;
+    return unwrap(
+      this.#client.DELETE('/v1/projects/{project_id}', {
+        params: { path: { project_id } },
+        ...options,
+      }),
+    );
+  }
+}
+
+export class Client {
+  #client: ReturnType<typeof createApiClient<paths>>;
+  readonly alerts: AlertsNamespace;
+  readonly projects: ProjectsNamespace;
+
+  constructor(options: ClientConfig = {}) {
+    this.#client = createApiClient<paths>(options);
+    this.alerts = new AlertsNamespace(this.#client);
+    this.projects = new ProjectsNamespace(this.#client);
+  }
+}