@certik/skynet 0.22.3 → 0.23.0

package/src/goalert.ts

@@ -0,0 +1,70 @@
+export type GoAlertAction = "close";
+
+export interface GoAlertGenericIncomingRequest {
+  /** Short description of the alert sent as SMS and voice. */
+  summary: string;
+  /** Additional information about the alert, supports markdown. */
+  details?: string;
+  /** If set to `close`, it will close any matching alerts. */
+  action?: GoAlertAction;
+  /** All calls for the same service with the same `dedup` string will update the same alert (if open) or create a new one. Defaults to using summary & details together. */
+  dedup?: string;
+}
+
+export interface GoAlertSendOptions {
+  url?: string;
+}
+
+export interface GoAlertSendResult {
+  ok: boolean;
+  status: number;
+}
+
+function getGoAlertUrl(url?: string) {
+  return url || process.env["SKYNET_GOALERT_URL"];
+}
+
+export async function sendGoAlertAlert(
+  body: GoAlertGenericIncomingRequest,
+  options: GoAlertSendOptions = {},
+): Promise<GoAlertSendResult> {
+  if (!body?.summary) {
+    throw new Error("missing GoAlert summary");
+  }
+
+  const url = getGoAlertUrl(options.url);
+  if (!url) {
+    throw new Error("missing SKYNET_GOALERT_URL");
+  }
+
+  const response = await fetch(url, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+    },
+    body: JSON.stringify(body),
+  });
+
+  let parsed: unknown = undefined;
+  const contentType = response.headers.get("content-type") || "";
+  try {
+    if (contentType.includes("application/json")) {
+      parsed = await response.json();
+    } else {
+      const text = await response.text();
+      parsed = text.length ? text : undefined;
+    }
+  } catch {
+    parsed = undefined;
+  }
+
+  if (!response.ok) {
+    const extra = typeof parsed === "string" && parsed ? `: ${parsed}` : "";
+    throw new Error(`GoAlert API error ${response.status}${extra}`);
+  }
+
+  return {
+    ok: response.ok,
+    status: response.status,
+  };
+}

package/src/indexer.ts

@@ -615,7 +615,6 @@ ${selector ? getSelectorDesc(selector) : ""}
       {
         importMeta: import.meta,
         description: false,
-        version: false,
         flags: {
           ...getSelectorFlags(selector),
           mode: {
@@ -684,7 +683,6 @@ ${selector ? getSelectorDesc(selector) : ""}
       {
         importMeta: import.meta,
         description: false,
-        version: false,
         flags: {
           ...getSelectorFlags(selector),
           verbose: {

package/src/slack.ts

@@ -13,7 +13,7 @@ async function postMessageToConversation({
   verbose,
 }: {
   conversationId: string;
-  message: string | Partial<ChatPostMessageArguments>;
+  message: string | ChatPostMessageArguments;
   token?: string;
   verbose?: boolean;
 }) {
@@ -42,3 +42,5 @@ async function postMessageToConversation({
 }
 
 export { postMessageToConversation };
+
+export type { ChatPostMessageArguments };

package/dist/opsgenie.d.ts

@@ -1,99 +0,0 @@
-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;
-    alias?: string;
-    description?: string;
-    responders?: ResponderRef[];
-    visibleTo?: VisibleToRef[];
-    actions?: string[];
-    tags?: string[];
-    details?: Record<string, string>;
-    entity?: string;
-    source?: string;
-    priority?: OpsgeniePriority;
-    user?: string;
-    note?: string;
-}
-export interface OpsgenieAcceptedResponse {
-    result: string;
-    took: number;
-    requestId: string;
-}
-export interface OpsgenieRequestStatusData {
-    success: boolean;
-    action: string;
-    processedAt: string;
-    integrationId: string;
-    isSuccess: boolean;
-    status: string;
-    alertId: string;
-    alias: string;
-}
-export interface OpsgenieRequestStatusResponse extends OpsgenieAcceptedResponse {
-    data: OpsgenieRequestStatusData;
-}
-export type OpsgenieResponse = OpsgenieAcceptedResponse | OpsgenieRequestStatusResponse;
-export interface OpsgenieErrorResponse {
-    message?: string;
-    took?: number;
-    requestId?: string;
-    errors?: unknown;
-    status?: number | string;
-}
-export declare function postGenieMessage(body: CreateAlertRequest, apiKey?: string, verbose?: boolean): Promise<OpsgenieResponse>;

package/dist/opsgenie.js

@@ -1,43 +0,0 @@
-// src/opsgenie.ts
-import md5 from "md5";
-function getGenieKey(key) {
-  return key || process.env["SKYNET_OPSGENIE_API_KEY"];
-}
-function getGenieEndPoint() {
-  return process.env["SKYNET_OPSGENIE_END_POINT"] || "https://api.opsgenie.com/v2/alerts";
-}
-async function postGenieMessage(body, apiKey, verbose) {
-  try {
-    const genieKey = apiKey || getGenieKey();
-    const genieEndPoint = getGenieEndPoint();
-    if (!body.alias) {
-      body.alias = md5(body.message);
-    }
-    if (verbose) {
-      console.log(`Making API call to Opsgenie`, JSON.stringify(body, null, 2));
-    }
-    const response = await fetch(genieEndPoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `GenieKey ${genieKey}`
-      },
-      body: JSON.stringify(body)
-    });
-    const json = await response.json();
-    if (verbose) {
-      console.log("Result of API call to Opsgenie...", json);
-    }
-    if ("result" in json) {
-      return json;
-    }
-    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;
-  }
-}
-export {
-  postGenieMessage
-};

package/src/opsgenie.ts

@@ -1,176 +0,0 @@
-import md5 from "md5";
-
-// ---- 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;
-}
-
-// ---- 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"];
-}
-
-function getGenieEndPoint() {
-  return process.env["SKYNET_OPSGENIE_END_POINT"] || "https://api.opsgenie.com/v2/alerts";
-}
-
-export async function postGenieMessage(
-  body: CreateAlertRequest,
-  apiKey?: string,
-  verbose?: boolean,
-): Promise<OpsgenieResponse> {
-  try {
-    const genieKey = apiKey || getGenieKey();
-    const genieEndPoint = getGenieEndPoint();
-
-    // Prevents duplicate alerts (See Opsgenie doc about alias)
-    if (!body.alias) {
-      body.alias = md5(body.message);
-    }
-
-    if (verbose) {
-      console.log(`Making API call to Opsgenie`, JSON.stringify(body, null, 2));
-    }
-
-    // Makes the call using fetch and ENV variables
-    const response = await fetch(genieEndPoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `GenieKey ${genieKey}`,
-      },
-      body: JSON.stringify(body),
-    });
-
-    const json = (await response.json()) as OpsgenieResponse | OpsgenieErrorResponse;
-    if (verbose) {
-      console.log("Result of API call to Opsgenie...", json);
-    }
-
-    if ("result" in json) {
-      return json;
-    }
-
-    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;
-  }
-}