@certik/skynet 0.22.2 → 0.23.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.23.0
+
+- Added `goalert` module with `sendGoAlertAlert` helper
+- BREAKING: removed `opsgenie` module/export
+- Updated dependencies (including `@databricks/sql`, AWS SDK, Slack, Express)
+- Updated patch for `@databricks/sql@1.12.0` to avoid loading native `lz4`
+
+## 0.22.3
+
+- Refine types for opsgenie
+
 ## 0.22.2
 
 - Use bun to bundle js files, tsc is used to build types
@@ -38,7 +49,6 @@
 ## 0.20.0
 
 - Fix databricks with bun (extra step needed for projects using the lib):
-
   - Copy the patch file `patches/@databricks%2Fsql@1.9.0.patch`
   - Add the following configs to your `package.json`:
 

package/dist/api.js

@@ -201,7 +201,6 @@ ${getSelectorDesc(selector)}
       `, {
     importMeta: import.meta,
     description: false,
-    version: false,
     flags: {
       ...getSelectorFlags(selector),
       verbose: {

package/dist/app.js

@@ -201,7 +201,6 @@ ${getSelectorDesc(selector)}
       `, {
     importMeta: import.meta,
     description: false,
-    version: false,
     flags: {
       ...getSelectorFlags(selector),
       verbose: {
@@ -1141,7 +1140,6 @@ ${selector ? getSelectorDesc(selector) : ""}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         mode: {
@@ -1195,7 +1193,6 @@ ${selector ? getSelectorDesc(selector) : ""}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         verbose: {
@@ -1573,7 +1570,6 @@ ${getSelectorDesc(selector)}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         mode: {
@@ -1696,7 +1692,6 @@ ${getSelectorDesc(selector)}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         schedule: {

package/dist/deploy.js

@@ -424,7 +424,6 @@ ${getSelectorDesc(selector)}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         mode: {
@@ -547,7 +546,6 @@ ${getSelectorDesc(selector)}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         schedule: {

package/dist/goalert.d.ts

@@ -0,0 +1,19 @@
+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;
+}
+export declare function sendGoAlertAlert(body: GoAlertGenericIncomingRequest, options?: GoAlertSendOptions): Promise<GoAlertSendResult>;

package/dist/goalert.js

@@ -0,0 +1,43 @@
+// src/goalert.ts
+function getGoAlertUrl(url) {
+  return url || process.env["SKYNET_GOALERT_URL"];
+}
+async function sendGoAlertAlert(body, options = {}) {
+  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 = 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
+  };
+}
+export {
+  sendGoAlertAlert
+};

package/dist/indexer.js

@@ -996,7 +996,6 @@ ${selector ? getSelectorDesc(selector) : ""}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         mode: {
@@ -1050,7 +1049,6 @@ ${selector ? getSelectorDesc(selector) : ""}
       `, {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         verbose: {

package/dist/slack.d.ts

@@ -1,8 +1,9 @@
 import type { ChatPostMessageArguments } from "@slack/web-api";
 declare function postMessageToConversation({ conversationId, message, token, verbose, }: {
     conversationId: string;
-    message: string | Partial<ChatPostMessageArguments>;
+    message: string | ChatPostMessageArguments;
     token?: string;
     verbose?: boolean;
 }): Promise<void>;
 export { postMessageToConversation };
+export type { ChatPostMessageArguments };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@certik/skynet",
-  "version": "0.22.2",
+  "version": "0.23.0",
   "description": "Skynet Shared JS library",
   "type": "module",
   "exports": {
@@ -52,6 +52,10 @@
       "import": "./dist/env.js",
       "types": "./dist/env.d.ts"
     },
+    "./goalert": {
+      "import": "./dist/goalert.js",
+      "types": "./dist/goalert.d.ts"
+    },
     "./graphql": {
       "import": "./dist/graphql.js",
       "types": "./dist/graphql.d.ts"
@@ -68,10 +72,6 @@
       "import": "./dist/object-hash.js",
       "types": "./dist/object-hash.d.ts"
     },
-    "./opsgenie": {
-      "import": "./dist/opsgenie.js",
-      "types": "./dist/opsgenie.d.ts"
-    },
     "./por": {
       "import": "./dist/por.js",
       "types": "./dist/por.d.ts"
@@ -110,45 +110,46 @@
     "node": ">= 18"
   },
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.758.0",
-    "@aws-sdk/client-s3": "^3.758.0",
-    "@aws-sdk/client-sqs": "^3.758.0",
-    "@aws-sdk/lib-dynamodb": "^3.758.0",
-    "@databricks/sql": "^1.9.0",
-    "@elastic/elasticsearch": "^8.17.1",
+    "@aws-sdk/client-dynamodb": "^3.975.0",
+    "@aws-sdk/client-s3": "^3.975.0",
+    "@aws-sdk/client-sqs": "^3.975.0",
+    "@aws-sdk/lib-dynamodb": "^3.975.0",
+    "@databricks/sql": "^1.12.0",
+    "@elastic/elasticsearch": "^8.19.1",
     "@node-rs/xxhash": "^1.7.6",
-    "@slack/web-api": "^6.13.0",
-    "chalk": "^5.4.1",
-    "execa": "^9.5.2",
-    "express": "^4.21.2",
+    "@slack/web-api": "^7.13.0",
+    "chalk": "^5.6.2",
+    "execa": "^9.6.1",
+    "express": "^5.2.1",
     "md5": "^2.3.0",
-    "meow": "^13.2.0",
-    "p-memoize": "^7.1.1",
-    "p-throttle": "^7.0.0",
-    "quick-lru": "^7.0.0",
-    "type-fest": "^4.35.0",
-    "which": "^5.0.0"
+    "meow": "^14.0.0",
+    "p-memoize": "^8.0.0",
+    "p-throttle": "^8.1.0",
+    "quick-lru": "^7.3.0",
+    "type-fest": "^5.4.1",
+    "which": "^6.0.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.21.0",
-    "@types/bun": "^1.2.4",
-    "@types/express": "^5.0.0",
-    "@types/md5": "^2.3.5",
+    "@eslint/js": "^9.39.2",
+    "@types/bun": "^1.3.6",
+    "@types/express": "^5.0.6",
+    "@types/md5": "^2.3.6",
     "@types/which": "^3.0.4",
-    "eslint": "^9.21.0",
-    "eslint-plugin-import": "^2.31.0",
+    "eslint": "^9.39.2",
+    "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-md": "^1.0.19",
-    "eslint-plugin-prettier": "^5.2.3",
-    "prettier": "^3.5.2",
-    "rimraf": "^6.0.1",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.38.0"
+    "eslint-plugin-prettier": "^5.5.5",
+    "prettier": "^3.8.1",
+    "rimraf": "^6.1.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.53.1"
   },
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
   "patchedDependencies": {
-    "@databricks/sql@1.9.0": "patches/@databricks%2Fsql@1.9.0.patch"
+    "@databricks/sql@1.9.0": "patches/@databricks%2Fsql@1.9.0.patch",
+    "@databricks/sql@1.12.0": "patches/@databricks%2Fsql@1.12.0.patch"
   }
-}
+}

package/patches/@databricks%2Fsql@1.12.0.patch

@@ -0,0 +1,31 @@
+diff --git a/dist/utils/lz4.js b/dist/utils/lz4.js
+index 5f067ab1c3bdf1430deabf488c8259a804dd33f8..fe440516e86f428446afe3c78ab0211a5a5b139c 100644
+--- a/dist/utils/lz4.js
++++ b/dist/utils/lz4.js
+@@ -1,25 +1,7 @@
+ "use strict";
+ Object.defineProperty(exports, "__esModule", { value: true });
+ function tryLoadLZ4Module() {
+-    try {
+-        return require('lz4'); // eslint-disable-line global-require
+-    }
+-    catch (err) {
+-        if (!(err instanceof Error) || !('code' in err)) {
+-            console.warn('Unexpected error loading LZ4 module: Invalid error object', err);
+-            return undefined;
+-        }
+-        if (err.code === 'MODULE_NOT_FOUND') {
+-            return undefined;
+-        }
+-        if (err.code === 'ERR_DLOPEN_FAILED') {
+-            console.warn('LZ4 native module failed to load: Architecture or version mismatch', err);
+-            return undefined;
+-        }
+-        // If it's not a known error, return undefined
+-        console.warn('Unknown error loading LZ4 module: Unhandled error code', err);
+-        return undefined;
+-    }
++    return undefined;
+ }
+ exports.default = tryLoadLZ4Module();
+ //# sourceMappingURL=lz4.js.map

package/src/api.ts

@@ -156,7 +156,6 @@ ${getSelectorDesc(selector)}
     {
       importMeta: import.meta,
       description: false,
-      version: false,
       flags: {
         ...getSelectorFlags(selector),
         verbose: {

package/src/deploy.ts

@@ -491,7 +491,6 @@ ${getSelectorDesc(selector)}
       {
         importMeta: import.meta,
         description: false,
-        version: false,
         flags: {
           ...getSelectorFlags(selector),
           mode: {
@@ -655,7 +654,6 @@ ${getSelectorDesc(selector)}
       {
         importMeta: import.meta,
         description: false,
-        version: false,
         flags: {
           ...getSelectorFlags(selector),
           schedule: {

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,21 +0,0 @@
-type OpsgenieResponse = {
-    data: {
-        success: boolean;
-        action: string;
-        processedAt: string;
-        integrationId: string;
-        isSuccess: boolean;
-        status: string;
-        alertId: string;
-        alias: string;
-    };
-    took: number;
-    requestId: string;
-    result: string;
-};
-export declare function postGenieMessage(body: {
-    alias?: string;
-    message: string;
-    description?: string;
-}, apiKey?: string, verbose?: boolean): Promise<OpsgenieResponse>;
-export {};

package/dist/opsgenie.js

@@ -1,39 +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 result = await response.json();
-    if (verbose) {
-      console.log(`Result of API call to Opsgenie... ${result}`);
-    }
-    return result;
-  } catch (error) {
-    console.error("Failed to make opsgenie API call", error);
-    throw error;
-  }
-}
-export {
-  postGenieMessage
-};

package/src/opsgenie.ts

@@ -1,70 +0,0 @@
-import md5 from "md5";
-
-type OpsgenieResponse = {
-  data: {
-    success: boolean;
-    action: string;
-    processedAt: string;
-    integrationId: string;
-    isSuccess: boolean;
-    status: string;
-    alertId: string;
-    alias: string;
-  };
-  took: number;
-  requestId: string;
-  result: 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: {
-    alias?: string;
-    message: string;
-    description?: string;
-  },
-  apiKey?: string,
-  verbose?: boolean,
-) {
-  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 result = (await response.json()) as OpsgenieResponse;
-    if (verbose) {
-      console.log(`Result of API call to Opsgenie... ${result}`);
-    }
-
-    return result;
-  } catch (error) {
-    console.error("Failed to make opsgenie API call", error);
-
-    throw error;
-  }
-}