@rallycry/conveyor-incidents 0.3.6 → 0.3.7

package/dist/index.d.ts

@@ -1,3 +1,40 @@
+/**
+ * Source-event identity and outcome hints for incident reports: what lets a
+ * retried delivery dedupe, a recurrence open a new occurrence, and detection
+ * time come from the source rather than from Conveyor's clock.
+ */
+/**
+ * Identity of the source event behind a report. Send a stable `id` so a
+ * retried delivery is a no-op, and `observedAt` so detection time is the
+ * source's, not the time Conveyor received the request.
+ */
+interface ReportEventInput {
+    id?: string;
+    /** ISO timestamp or Date of the source observation. */
+    observedAt?: string | Date;
+}
+/** Outcome hints applied only when the report opens a new incident occurrence. */
+interface ReportOutcomeInput {
+    detectedBy?: "partner" | "player" | "internal" | "monitor" | "agent" | "unknown";
+    impact?: string;
+    environment?: string;
+    failureStartedAt?: string | Date;
+    /** Probe/acceptance incidents: excluded from delivery metrics. */
+    synthetic?: boolean;
+}
+interface ReportResolvedInput {
+    title: string;
+    source?: string;
+    fingerprintKey?: string;
+    severity?: "critical" | "high" | "medium" | "low";
+    event?: ReportEventInput;
+}
+interface ReportResolvedResult {
+    /** The incident the evidence was recorded on; null when nothing was open. */
+    incidentId: string | null;
+    ignored: boolean;
+}
+
 declare class ConveyorIncidentsError extends Error {
     readonly status: number;
     readonly body: unknown;
@@ -99,6 +136,10 @@ interface ReportIncidentInput {
      * account still gets a reply.
      */
     reporter?: ReportReporter;
+    /** Incident reports only: source-event identity (retries, recurrence). */
+    event?: ReportEventInput;
+    /** Incident reports only: outcome hints for a new occurrence. */
+    outcome?: ReportOutcomeInput;
 }
 interface AttachmentResult {
     fileName: string;
@@ -124,7 +165,13 @@ declare class ConveyorIncidents {
     private readonly fetchImpl;
     constructor(opts: ConveyorIncidentsOptions);
     report(input: ReportIncidentInput): Promise<ReportIncidentResult>;
+    /**
+     * Tell Conveyor the source saw the failure clear. This is recovery
+     * EVIDENCE on the open incident — a person still confirms the service was
+     * restored. Nothing open to match → `{ ignored: true, incidentId: null }`.
+     */
+    reportResolved(input: ReportResolvedInput): Promise<ReportResolvedResult>;
     private uploadAttachment;
 }
 
-export { type AttachmentResult, type ConveyorCardType, ConveyorIncidents, ConveyorIncidentsError, type ConveyorIncidentsOptions, type IncidentAttachment, type IncidentSeverity, MAX_ATTACHMENT_BYTES, type NetworkCaptureOptions, type NetworkLogEntry, type ReportIncidentInput, type ReportIncidentResult, type ReportReporter, buildNetworkLogAttachment, clearNetworkLogEntries, getNetworkLogEntries, installNetworkCapture, uninstallNetworkCapture };
+export { type AttachmentResult, type ConveyorCardType, ConveyorIncidents, ConveyorIncidentsError, type ConveyorIncidentsOptions, type IncidentAttachment, type IncidentSeverity, MAX_ATTACHMENT_BYTES, type NetworkCaptureOptions, type NetworkLogEntry, type ReportEventInput, type ReportIncidentInput, type ReportIncidentResult, type ReportOutcomeInput, type ReportReporter, type ReportResolvedInput, type ReportResolvedResult, buildNetworkLogAttachment, clearNetworkLogEntries, getNetworkLogEntries, installNetworkCapture, uninstallNetworkCapture };

package/dist/index.js

@@ -10,6 +10,18 @@ var ConveyorIncidentsError = class extends Error {
   }
 };
 
+// src/report-event.ts
+function isoOf(value) {
+  if (value === void 0) return void 0;
+  return value instanceof Date ? value.toISOString() : value;
+}
+function serializeEvent(event) {
+  return { id: event.id, observedAt: isoOf(event.observedAt) };
+}
+function serializeOutcome(outcome) {
+  return { ...outcome, failureStartedAt: isoOf(outcome.failureStartedAt) };
+}
+
 // src/index.ts
 var DEFAULT_BASE_URL = "https://api.conveyor.rallycryapp.com";
 var DEFAULT_SOURCE = "client";
@@ -128,7 +140,9 @@ var ConveyorIncidents = class {
       assigned: input.assigned,
       review: input.review,
       createdBy: input.createdBy,
-      reporter: normalizeReporter(input.reporter)
+      reporter: normalizeReporter(input.reporter),
+      event: input.event ? { ...serializeEvent(input.event), kind: "firing" } : void 0,
+      outcome: input.outcome ? serializeOutcome(input.outcome) : void 0
     };
     const res = await this.fetchImpl(`${this.baseUrl}/api/incidents/report`, {
       method: "POST",
@@ -162,6 +176,40 @@ var ConveyorIncidents = class {
     }
     return { incidentId, cardId: incidentId, attachmentResults };
   }
+  /**
+   * Tell Conveyor the source saw the failure clear. This is recovery
+   * EVIDENCE on the open incident — a person still confirms the service was
+   * restored. Nothing open to match → `{ ignored: true, incidentId: null }`.
+   */
+  async reportResolved(input) {
+    const body = {
+      projectId: this.projectId,
+      source: input.source ?? DEFAULT_SOURCE,
+      severity: input.severity ?? DEFAULT_SEVERITY,
+      title: input.title,
+      fingerprintKey: input.fingerprintKey,
+      type: "incident",
+      event: { ...serializeEvent(input.event ?? {}), kind: "resolved" }
+    };
+    const res = await this.fetchImpl(`${this.baseUrl}/api/incidents/report`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${this.apiKey}`
+      },
+      body: JSON.stringify(body)
+    });
+    const payload = await readJson(res);
+    if (!res.ok) {
+      throw new ConveyorIncidentsError(
+        `Failed to report resolution: ${res.status} ${res.statusText}`,
+        res.status,
+        payload
+      );
+    }
+    const incidentId = extractId(payload, "incidentId") ?? null;
+    return { incidentId, ignored: incidentId === null };
+  }
   async uploadAttachment(incidentId, attachment) {
     try {
       const bytes = typeof attachment.content === "string" ? new TextEncoder().encode(attachment.content) : attachment.content;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rallycry/conveyor-incidents",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "Typed TypeScript client for Conveyor's public incidents REST API",
   "keywords": [
     "client",