@certik/skynet 0.10.60 → 0.10.62

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.10.62
+
+- Added: opensearch helpers
+
+## 0.10.61
+
+- Added dns library
+
 ## 0.10.60
 
 - Fixed: print skynet API route error stack trace

package/dns.d.ts

@@ -0,0 +1 @@
+export function hasTxtRecord(domainName: string, txtRecord: string): Promise<boolean>;

package/dns.js

@@ -0,0 +1,29 @@
+// https://nodejs.org/api/dns.html#dns
+const dns = require("dns").promises;
+
+async function hasTxtRecord(domainName, txtRecord) {
+  let nsAddresses;
+  // get all nameservers for the domain
+  const nameservers = await dns.resolveNs(domainName);
+
+  // get default nameserver addresses
+  const defaultServers = dns.getServers();
+
+  // iterate over nameservers to see if they have the TXT record
+  for (const ns of nameservers) {
+    //reset serverAddresses to get nameserver addresses
+    dns.setServers(defaultServers);
+
+    // get nameserver addresses and use them to resolve domain's TXT record, in order to skip caches in DNS servers.
+    nsAddresses = await dns.resolve(ns);
+    dns.setServers(nsAddresses);
+    const txtRecords = await dns.resolveTxt(domainName);
+
+    if (txtRecords && txtRecords.length > 0 && txtRecords.find((txt) => txt.indexOf(txtRecord) > -1)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+module.exports = { hasTxtRecord };

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.60",
+  "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",
@@ -30,9 +31,9 @@
   },
   "devDependencies": {
     "ava": "^5.0.1",
-    "eslint": "^8.18.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint": "^8.39.0",
+    "eslint-plugin-import": "^2.27.5",
     "sinon": "^14.0.0"
   },
   "license": "MIT"
-}
+}