@meltwater/conversations-api-services 1.0.18 → 1.0.20

package/dist/esm/lib/logger.helpers.js

@@ -0,0 +1,60 @@
+const MeltwaterAttributes = {
+  COMPANYID: 'meltwater.company.id',
+  // Unique identifier of a company as it applies to meltwater search
+  DOCUMENTID: 'meltwater.document.id',
+  // Unique identifier of a document indexed into search
+  DOCUMENTLANG: 'meltwater.document.lang',
+  // Two-letter country code (lower-case) of the original document
+  DOCUMENTEXTERNALID: 'meltwater.document.external_id',
+  // The external ID of the document
+  REQUESTFORMAT: 'meltwater.document.request_format',
+  // The document format requested (“gyda”/”quiddity”)
+  DOCUMENTIDS: 'meltwater.document_ids',
+  // A list of document Ids
+  SEARCHIDS: 'meltwater.search_ids',
+  // List of IDs of saved searches.
+  AUTHORLISTIDS: 'meltwater.authorlist_ids',
+  // List of IDs of author lists.
+  TAGNAMES: 'meltwater.tag_names',
+  // List of tag names
+  SEARCHID: 'meltwater.search.id',
+  // ID for a saved search
+  CREDENTIALID: 'meltwater.social.credential_id',
+  // Identifier for Owned and Paid Social Connections.
+  CREDENTIALIDS: 'meltwater.social.credential_ids',
+  // List of Credential IDs
+  SOCIALEXTERNALID: 'meltwater.social.external_id',
+  // External ID for Owned and Paid Social Connections.
+  ASSETID: 'meltwater.asset.id',
+  // Asset ID in the asset library
+  ASSETIDS: 'meltwater.asset.ids',
+  // List of Asset IDs
+  WORKSPACEID: 'meltwater.workspace.id',
+  // Workspace ID
+  PRODUCTTYPE: 'meltwater.product_type',
+  // The name of the product for the search request
+  CLIENTNAME: 'meltwater.client_name',
+  // The “client_name” identifier used for API calls
+  ORIGINALCLIENTNAME: 'meltwater.original_client_name',
+  // The originating “client_name” identifier used for API calls
+  AUTHKEYID: 'meltwater.auth.kid',
+  // The JWT Key ID for the request.
+  AUTHEXP: 'meltwater.auth.exp',
+  // The expiration of the auth credentials.
+  AUTHPERMISSIONS: 'meltwater.auth.permissions',
+  // List of auth permermissions.
+  USERID: 'user.id' // ID of the user
+};
+export function loggerDebug(logger, message) {
+  let meta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  if (logger) logger.debug(message, meta);
+}
+export function loggerInfo(logger, message) {
+  let meta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  if (logger) logger.info(message, meta);
+}
+export function loggerError(logger, message) {
+  let meta = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  if (logger) logger.error(message, meta);
+}
+export { MeltwaterAttributes };

package/dist/esm/lib/logger.js

@@ -0,0 +1,16 @@
+import winston from 'winston';
+import { ecsFormat } from '@elastic/ecs-winston-format';
+const format = ecsFormat({
+  serviceName: process.env.NODE_ENV ? `conversations-api-services-${process.env.NODE_ENV}` : 'conversations-api-services',
+  serviceVersion: process.env.npm_package_version,
+  serviceEnvironment: process.env.NODE_ENV
+});
+const logger = winston.createLogger({
+  level: process.env.LOG_LEVEL || 'info',
+  format,
+  defaultMeta: {},
+  transports: [new winston.transports.Console({
+    format
+  })]
+});
+export default logger;

package/dist/esm/lib/message.helpers.js

@@ -0,0 +1,52 @@
+export function isMention(_ref, credential) {
+  let {
+    appData: {
+      isMention = false
+    } = {},
+    body: {
+      mentions = []
+    } = {},
+    metaData: {
+      authors: [{
+        authorInfo: {
+          externalId: authorExternalId,
+          handle: authorHandle
+        } = {}
+      } = {}] = [{}],
+      inReplyTo: {
+        author: {
+          externalId: inReplyToExternalId,
+          handle: inReplyToHandle
+        } = {}
+      } = {},
+      discussionType = '',
+      source: {
+        socialOriginType
+      } = {}
+    } = {},
+    providerSpecific
+  } = _ref;
+  if (socialOriginType == 'twitter' && discussionType != 'og') {
+    return false;
+  }
+  // if inReplyToExternalId is the same as the credential's social_account_id, then it's not a mention
+  if (inReplyToExternalId && credential.social_account_id && inReplyToExternalId === credential.social_account_id || inReplyToHandle === credential.username) {
+    return false;
+  }
+  if (authorExternalId && credential.social_account_id && authorExternalId === credential.social_account_id || authorHandle?.length && (authorHandle.toLowerCase() === credential.username?.toLowerCase || authorHandle.toLowerCase() === credential.handle?.toLowerCase())) {
+    return false;
+  }
+  let retIsMention = (['og', 're', 'qt'].includes(discussionType) || discussionType === 'dm' && socialOriginType === 'instagram') && (mentions?.length && mentions.some(mention => mention.toLowerCase() === credential.pageName?.toLowerCase() || mention.toLowerCase() === credential.target_page_name?.toLowerCase() || mention.toLowerCase() === credential.userName?.toLowerCase() || mention.toLowerCase() === credential.username?.toLowerCase()) || isMention && socialOriginType === 'facebook');
+  if (providerSpecific) {
+    let hasMention = providerSpecific.some(_ref2 => {
+      let {
+        facebookPostType
+      } = _ref2;
+      return facebookPostType === 'mention';
+    });
+    if (hasMention) {
+      retIsMention = true;
+    }
+  }
+  return retIsMention;
+}

package/dist/esm/lib/metrics.helper.js

@@ -0,0 +1,90 @@
+import Prometheus from 'prom-client';
+import logger from './logger.js';
+const podMetricsByName = new Map();
+const metricNames = ['irGetByDocumentId', 'irRatelimited', 'irSearch'];
+
+// todo: make this a dynamic process
+const irGetByDocumentIdHistogram = new Prometheus.Histogram({
+  name: 'irGetByDocumentId_Avg_Reponse_Time',
+  help: 'metric_help',
+  buckets: Prometheus.linearBuckets(0, 200, 40)
+});
+const irGetByDocumentIdCountHistogram = new Prometheus.Histogram({
+  name: 'irGetByDocumentId_Count',
+  help: 'metric_help',
+  buckets: Prometheus.linearBuckets(0, 1, 40)
+});
+metricNames.forEach(metricName => {
+  podMetricsByName.set(metricName, new Prometheus.Counter({
+    name: metricName,
+    help: `${metricName}_help`
+  }));
+});
+class Metrics {
+  constructor() {
+    this.requestMetricsByName = new Map();
+    metricNames.forEach(metricName => {
+      this.requestMetricsByName.set(metricName, []);
+    });
+    this.getMetrics = metricName => {
+      return {
+        podMetrics: podMetricsByName.get(metricName),
+        requestMetrics: this.requestMetricsByName.get(metricName)
+      };
+    };
+  }
+  count(metricName) {
+    const {
+      podMetrics,
+      requestMetrics
+    } = this.getMetrics(metricName);
+    if (podMetrics) {
+      podMetrics.inc();
+    } else {
+      logger.error(`No pod level metric exists for ${metricName}`);
+    }
+    const metricObject = {
+      type: 'count',
+      timestamp: Date.now()
+    };
+    if (requestMetrics) {
+      requestMetrics.push(metricObject);
+    }
+    return metricObject;
+  }
+  finishOperation(metricName, metricObject) {
+    const {
+      requestMetrics
+    } = this.getMetrics(metricName);
+    if (requestMetrics) {
+      const matchingMetric = requestMetrics.find(requestMetricExiting => requestMetricExiting.timestamp === metricObject.timestamp);
+      matchingMetric.duration = Date.now() - matchingMetric.timestamp;
+    }
+  }
+  async somethingCompleted() {
+    let name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'IR.getByDocumentId';
+    let start = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+  } // duration math
+  async finishRequest() {
+    const {
+      requestMetrics
+    } = this.getMetrics('irGetByDocumentId');
+    let arrHasDuration = requestMetrics.filter(metric => metric.duration);
+    if (arrHasDuration.length) {
+      let avgDuration = arrHasDuration.reduce((avg, metric) => avg + metric.duration, 0) / arrHasDuration.length;
+      irGetByDocumentIdHistogram.observe(avgDuration);
+    }
+    if (requestMetrics.length > 0) {
+      irGetByDocumentIdCountHistogram.observe(requestMetrics.length);
+    }
+  }
+}
+function createEnum(values) {
+  const enumObject = {};
+  for (const val of values) {
+    enumObject[val] = val;
+  }
+  return Object.freeze(enumObject);
+}
+const metricN = createEnum(metricNames);
+export { Metrics, metricN };

package/package.json

@@ -1,15 +1,22 @@
 {
   "name": "@meltwater/conversations-api-services",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "description": "Repository to contain all conversations api services shared across our services",
-  "type": "module",
-  "main": "src/data-access/index.js",
+  "main": "dist/cjs/data-access/index.js",
+  "module": "dist/esm/data-access/index.js",
+  "exports": {
+    "require": "./dist/cjs/data-access/index.js",
+    "import": "./dist/esm/data-access/index.js"
+  },
   "directories": {
     "doc": "docs"
   },
   "prettier": "@meltwater/engage-prettier-config",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:cjs": "BABEL_ENV=cjs babel src --out-dir dist/cjs",
+    "build:esm": "BABEL_ENV=esm babel src --out-dir dist/esm",
+    "build": "npm run build:cjs && npm run build:esm"
   },
   "repository": {
     "type": "git",
@@ -41,6 +48,9 @@
     "winston": "^3.11.0"
   },
   "devDependencies": {
+    "@babel/cli": "^7.25.9",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
     "@meltwater/engage-prettier-config": "^1.0.0"
   }
 }