@certik/skynet 0.22.2 → 0.22.3

package/src/opsgenie.ts

@@ -1,20 +1,126 @@
 import md5 from "md5";
 
-type OpsgenieResponse = {
-  data: {
-    success: boolean;
-    action: string;
-    processedAt: string;
-    integrationId: string;
-    isSuccess: boolean;
-    status: string;
-    alertId: string;
-    alias: string;
-  };
+// ---- Request Types (Create Alert) ----
+// See: https://docs.opsgenie.com/docs/alert-api#create-alert
+
+export type OpsgeniePriority = "P1" | "P2" | "P3" | "P4" | "P5";
+
+export interface TeamRefById {
+  id: string;
+  type: "team";
+}
+export interface TeamRefByName {
+  name: string;
+  type: "team";
+}
+export type TeamRef = TeamRefById | TeamRefByName;
+
+export interface UserRefById {
+  id: string;
+  type: "user";
+}
+export interface UserRefByUsername {
+  username: string;
+  type: "user";
+}
+export type UserRef = UserRefById | UserRefByUsername;
+
+export interface EscalationRefById {
+  id: string;
+  type: "escalation";
+}
+export interface EscalationRefByName {
+  name: string;
+  type: "escalation";
+}
+export type EscalationRef = EscalationRefById | EscalationRefByName;
+
+export interface ScheduleRefById {
+  id: string;
+  type: "schedule";
+}
+export interface ScheduleRefByName {
+  name: string;
+  type: "schedule";
+}
+export type ScheduleRef = ScheduleRefById | ScheduleRefByName;
+
+export type ResponderRef = TeamRef | UserRef | EscalationRef | ScheduleRef;
+
+export interface VisibleToTeamById {
+  id: string;
+  type: "team";
+}
+export interface VisibleToTeamByName {
+  name: string;
+  type: "team";
+}
+export type VisibleToTeam = VisibleToTeamById | VisibleToTeamByName;
+export interface VisibleToUserById {
+  id: string;
+  type: "user";
+}
+export interface VisibleToUserByUsername {
+  username: string;
+  type: "user";
+}
+export type VisibleToUser = VisibleToUserById | VisibleToUserByUsername;
+export type VisibleToRef = VisibleToTeam | VisibleToUser;
+
+export interface CreateAlertRequest {
+  message: string; // required
+  alias?: string;
+  description?: string;
+  responders?: ResponderRef[];
+  visibleTo?: VisibleToRef[];
+  actions?: string[]; // up to 10
+  tags?: string[]; // up to 20
+  details?: Record<string, string>;
+  entity?: string;
+  source?: string;
+  priority?: OpsgeniePriority; // default P3
+  user?: string; // display name of request owner
+  note?: string; // additional note added while creating
+}
+
+// ---- Generic Async Request Response (202 Accepted) ----
+// Many Opsgenie alert mutation endpoints return only: { result, took, requestId }
+export interface OpsgenieAcceptedResponse {
+  result: string; // "Request will be processed"
   took: number;
   requestId: string;
-  result: string;
-};
+}
+
+// ---- Request Status (polling) Response ----
+// When querying request status we receive a "data" envelope with success info.
+export interface OpsgenieRequestStatusData {
+  success: boolean;
+  action: string; // e.g. Create, Acknowledge, etc.
+  processedAt: string; // ISO timestamp
+  integrationId: string;
+  isSuccess: boolean;
+  status: string; // human readable status e.g. "Created alert"
+  alertId: string; // may be empty string when failed
+  alias: string; // may be empty when failed
+}
+
+export interface OpsgenieRequestStatusResponse extends OpsgenieAcceptedResponse {
+  data: OpsgenieRequestStatusData;
+}
+
+// Some endpoints (create alert) return OpsgenieAcceptedResponse immediately, so our
+// function currently returns whatever JSON body shape is present. We model the union.
+export type OpsgenieResponse = OpsgenieAcceptedResponse | OpsgenieRequestStatusResponse;
+
+// ---- Error Shape (from Opsgenie docs/experience) ----
+// Keep loose to not block callers; refine if needed later.
+export interface OpsgenieErrorResponse {
+  message?: string;
+  took?: number;
+  requestId?: string;
+  errors?: unknown;
+  status?: number | string;
+}
 
 function getGenieKey(key?: string) {
   return key || process.env["SKYNET_OPSGENIE_API_KEY"];
@@ -25,14 +131,10 @@ function getGenieEndPoint() {
 }
 
 export async function postGenieMessage(
-  body: {
-    alias?: string;
-    message: string;
-    description?: string;
-  },
+  body: CreateAlertRequest,
   apiKey?: string,
   verbose?: boolean,
-) {
+): Promise<OpsgenieResponse> {
   try {
     const genieKey = apiKey || getGenieKey();
     const genieEndPoint = getGenieEndPoint();
@@ -56,15 +158,19 @@ export async function postGenieMessage(
       body: JSON.stringify(body),
     });
 
-    const result = (await response.json()) as OpsgenieResponse;
+    const json = (await response.json()) as OpsgenieResponse | OpsgenieErrorResponse;
     if (verbose) {
-      console.log(`Result of API call to Opsgenie... ${result}`);
+      console.log("Result of API call to Opsgenie...", json);
+    }
+
+    if ("result" in json) {
+      return json;
     }
 
-    return result;
+    console.error("Error response from Opsgenie API", json);
+    throw new Error(json.message || 'Unknown error from Opsgenie API');
   } catch (error) {
     console.error("Failed to make opsgenie API call", error);
-
     throw error;
   }
 }

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-    "conventionalCommits.scopes": [
-        "lib-skynet"
-    ]
-}