@certik/skynet 0.10.61 → 0.10.62

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.10.62
+
+- Added: opensearch helpers
+
 ## 0.10.61
 
 - Added dns library

package/opensearch.d.ts

@@ -0,0 +1,16 @@
+import { Client, ClientOptions } from "@opensearch-project/opensearch";
+
+export declare function newOpensearchClient(
+  endpoint: string,
+  key: string,
+  secret: string,
+  options?: ClientOptions
+): Client;
+
+export declare async function sendToOpensearch(
+  client: Client,
+  appName: string,
+  index: string,
+  record: string,
+  indexSuffixes?: string[]
+): Promise<{ status: string; result: Object }>;

package/opensearch.js

@@ -0,0 +1,39 @@
+const { Client } = require("@opensearch-project/opensearch");
+
+// newOpensearchClient creates a new opensearch client with the given endpoint, key, secret and extra opensearch client options.
+function newOpensearchClient(endpoint, key, secret, options = {}) {
+  return new Client({
+    node: endpoint,
+    auth: {
+      username: key,
+      password: secret,
+    },
+    ...options,
+  });
+}
+
+// sendToOpensearch sends a record object to the given index using the given opensearch client. An appName is also attached to the record
+// as an identifier for who sends the record. The indexSuffixes is an array of strings that will be appended to the index name using `-`.
+// A typical usage of indexSuffixes could be the date e.g. ["2023", "08"] so that new indexes are created on the monthly basis to prevent
+// the index from growing too large.
+// Returns an object with status and result properties. The status is either "ok" or "error". The result is the response from opensearch
+// if the status is "ok" or the error message if the status is "error".
+async function sendToOpensearch(client, appName, index, record, indexSuffixes = []) {
+  try {
+    const result = await client.index({
+      index: indexSuffixes ? [index, ...indexSuffixes].join("-") : index,
+      body: { app: appName, timestamp: new Date(), record },
+    });
+    if (result.statusCode === 201) {
+      return { status: "ok", result };
+    }
+    return { status: "error", result };
+  } catch (err) {
+    return { status: "error", result: err.stack ? err.stack : err };
+  }
+}
+
+module.exports = {
+  newOpensearchClient,
+  sendToOpensearch,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@certik/skynet",
-  "version": "0.10.61",
+  "version": "0.10.62",
   "description": "Skynet Shared JS library",
   "main": "index.js",
   "author": "CertiK Engineering",
@@ -12,6 +12,7 @@
     "node": ">= 14"
   },
   "dependencies": {
+    "@opensearch-project/opensearch": "^2.3.1",
     "@slack/web-api": "^6.4.0",
     "ably": "^1.2.22",
     "abort-controller": "^3.0.0",
@@ -35,4 +36,4 @@
     "sinon": "^14.0.0"
   },
   "license": "MIT"
-}
+}