@meltwater/conversations-api-services 1.0.0

package/.drone.yml

@@ -0,0 +1,13 @@
+---
+kind: pipeline
+type: docker
+name: Publish TechDocs
+trigger:
+  branch:
+  - main
+  event:
+  - push
+
+steps:
+- name: Publish TechDocs
+  image: meltwater/drone-techdocs:1

package/.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credential: false
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: NPM Auth Setup
+        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
+      - name: NPM whoami
+        run: npm whoami
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify signatures
+        run: npm audit signatures
+      - name: Release
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: npx semantic-release

package/.nvmrc

@@ -0,0 +1 @@
+20.11.0

package/README.md

@@ -0,0 +1,91 @@
+# conversations-api-services
+
+Repository to contain all conversations api services shared across our services
+
+---
+
+This section should answer:
+
+> What is this?
+
+Adding visuals to this project description will make your project more memorable and the README easier to understand.
+
+Great examples:
+
+-   [meltwater/contact-source-service](https://github.com/meltwater/contact-source-service) - _It is the backend behind the Influencers application used by Meltwater customers. It provides sources/contacts management and search capabilities._
+-   [release-it/release-it](https://github.com/release-it/release-it) - _‌Generic CLI tool to automate versioning and package publishing related tasks_
+
+## Product / Business Purpose
+
+An explanation of the business purpose of this repo, e.g. the Meltwater Product that this ties into. This section should answer:
+
+> Why does this exist?
+
+Great examples:
+
+-   [meltwater/chat-message-integration](https://github.com/meltwater/chat-message-integration) _The chat-message-integration project is the API that is used to configure and handle messages for Slack and Teams integrations in the MI App._
+-   [meltwater/explore-compare-service](https://github.com/meltwater/explore-compare-service) - _Compares in Explorer allow users to run several saved queries at the same time and do a comparison._
+
+## Maintainers
+
+Meltwater's current ownership model assumes that every piece of software running in Production is owned by a team. This section should answer:
+
+> Who owns this?
+> Who to contact for help?
+
+Example:
+
+> Maintained by TEAM_NAME (TEAM_EMAIL_ADDRESS@meltwater.com).
+> Contact us via #TEAM_SLACK_CHANNEL in Slack.
+
+## Contributing
+
+Make it easier for people to understand how they can contribute to your project. Remember that these people could be from your own team, or another team.
+
+Example:
+
+> We welcome and appreciate any and all contributions, even if it is a typo fix to this README.
+> When working on a larger contribution, please open an issue first, so that we can discuss the approach.
+> Once you have your contribution ready, please open a Pull Requests containing your changes and contact us via #TEAM_SLACK_CHANNEL in Slack.
+
+## How do I use it? (Installation)
+
+Instructions targeted at the **user** of your project, rather than at a co-developer in your team. This section should answer:
+
+> How to use this?
+
+If this is an internal tool that is just used within your team, then you can share this here as well.
+
+## Development Guide
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. This section should answer:
+
+> How to get started with developing on this project?
+
+This is essential for onboarding new members on your team but also for allowing people from outside of your team to contribute.
+
+This Development Guide may contain different sub-sections, depending on what stack/ecosystem your project is using. Below some examples of sub-sections that apply to most projects.
+
+### Prerequisites
+
+What things do you need to install the software and how to install them? Including links here is helpful.
+
+### Running it locally
+
+A step-by-step series of examples that tell you how to get a development env running.
+
+End with an example of getting some data out of the system or using it for a little demo.
+
+### Running the tests
+
+Explain how to run the automated tests for this system.
+
+### Deployment
+
+Add additional notes about how to deploy this on a live system.
+You may also want to link to the different environments where this is deployed (e.g. Staging, Production).
+
+### Monitoring & Troubleshooting
+
+How can you inspect the system running in remote environments (Staging, Production)?
+This should include logs, dashboards, etc.

package/catalog-info.yaml

@@ -0,0 +1,12 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: "conversations-api-services"
+  description: "Repository to contain all conversations api services shared across our services"
+  annotations:
+    github.com/project-slug: meltwater/conversations-api-services
+    backstage.io/techdocs-ref: dir:.
+spec:
+  type: "module"
+  lifecycle: experimental
+  owner: "group:default/phoenix"

package/docs/index.md

@@ -0,0 +1,28 @@
+## conversations-api-services
+
+Repository to contain all conversations api services shared across our services
+
+## Getting started
+
+Start write your documentation by adding more markdown (.md) files to this folder (/docs) or replace the content in this file.
+
+## Table of Contents
+
+The Table of Contents on the right is generated automatically based on the hierarchy
+of headings. Only use one H1 (`#` in Markdown) per file.
+
+## Site navigation
+
+For new pages to appear in the left hand navigation you need edit the `mkdocs.yml`
+file in root of your repo. The navigation can also link out to other sites.
+
+Alternatively, if there is no `nav` section in `mkdocs.yml`, a navigation section
+will be created for you. However, you will not be able to use alternate titles for
+pages, or include links to other sites.
+
+Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work.
+See also <https://www.mkdocs.org/user-guide/configuration/>.
+
+## Support
+
+That's it. If you need support, reach out in [#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) on Discord.

package/mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: "conversations-api-services"
+site_description: "Repository to contain all conversations api services shared across our services"
+
+nav:
+  - Introduction: index.md
+
+plugins:
+  - techdocs-core

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@meltwater/conversations-api-services",
+  "version": "1.0.0",
+  "description": "Repository to contain all conversations api services shared across our services",
+  "type": "module",
+  "main": "src/data-access/index.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "prettier": "@meltwater/engage-prettier-config",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meltwater/conversations-api-services.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/meltwater/conversations-api-services/issues"
+  },
+  "homepage": "https://github.com/meltwater/conversations-api-services#readme",
+  "dependencies": {
+    "@hapi/joi": "^17.1.1",
+    "@meltwater/date-range": "^3.6.0",
+    "@meltwater/engage-conversations-schemas": "^2.3.10",
+    "@meltwater/xrunes": "^1.1.1",
+    "@meltwater/xrunes-core": "^3.0.0",
+    "apollo-server-hapi": "^3.13.0",
+    "aws-sdk": "^2.1562.0",
+    "dataloader": "^2.2.2",
+    "html-entities": "^2.4.0",
+    "jsonwebtoken": "^9.0.2",
+    "lodash": "^4.17.21",
+    "moment": "^2.30.1",
+    "prom-client": "^15.1.0",
+    "superagent": "^8.1.2",
+    "winston": "^3.11.0"
+  },
+  "devDependencies": {
+    "@meltwater/engage-prettier-config": "^1.0.0"
+  }
+}

package/src/data-access/http/InstagramVideoClient.js

@@ -0,0 +1,37 @@
+import superagent from 'superagent';
+import configuration from '../../lib/configuration.js';
+import logger from '../../lib/logger.js';
+
+export class InstagramVideoClient {
+    /**
+     * @private
+     * @param {string} url
+     * @returns {Promise<object>}
+     */
+    _getDownloadLink = async (url) => {
+        const apiUrl = configuration.get('UGC_MEDIA_API_URL');
+        const apiToken = configuration.get('UGC_MEDIA_API_TOKEN');
+        try {
+            const response = await superagent
+                .get(`${apiUrl}/instagram/video/`)
+                .set('x-api-token', apiToken)
+                .query({ url });
+
+            return response.body?.data;
+        } catch (error) {
+            logger.error(`Could not retrieve video link from ${url}`, {
+                error,
+            });
+            throw new Error('Could not retrieve video link');
+        }
+    };
+
+    /**
+     *
+     * @param {string} url
+     * @returns {Promise<object>}
+     */
+    getVideoLink = async (url) => {
+        return await this._getDownloadLink(url);
+    };
+}

package/src/data-access/http/WarpZoneApi.client.js

@@ -0,0 +1,39 @@
+import superagent from 'superagent';
+import logger from '../../lib/logger.js';
+import configuration from '../../lib/configuration.js';
+
+export class WarpZoneApiClient {
+    constructor() {
+        this.warpzoneURL = configuration.get('WARPZONE_API_URL');
+        this.warpzoneAPI = configuration.get('WARPZONE_API_KEY');
+    }
+
+    async sendPost(postData = undefined) {
+        let response = {};
+        try {
+            response = await superagent
+                .post(this.warpzoneURL + 'event')
+                .set('Accept', 'application/json')
+                .set('Content-Type', 'application/json')
+                .set('X-API-Key', this.warpzoneAPI)
+                .send(postData);
+        } catch (err) {
+            if (
+                err &&
+                err.response &&
+                err.response.body &&
+                err.response.body.error
+            ) {
+                logger.error(
+                    `Failed to call warp zone api: ${err.response.body.error.message}`
+                );
+            } else {
+                logger.error(`Failed to call warp zone api`, err);
+            }
+
+            throw err;
+        }
+
+        return response;
+    }
+}

package/src/data-access/http/amazonS3.js

@@ -0,0 +1,41 @@
+import AWS from 'aws-sdk';
+import assert from 'assert';
+
+class AWS_S3 {
+    constructor() {}
+
+    async getClient() {
+        const {
+            Credentials: { AccessKeyId, SecretAccessKey, SessionToken } = {},
+        } = await assetManagerTvmRepository.get(companyId);
+
+        if (!AccessKeyId || !SecretAccessKey || !SessionToken) {
+            // probably a bit extreme, what would you prefer to do
+            throw 'No Credentials available';
+        }
+
+        return new AWS.S3({
+            accessKeyId: AccessKeyId,
+            secretAccessKey: SecretAccessKey,
+            sessionToken: SessionToken,
+            useAccelerateEndpoint: true,
+        });
+    }
+
+    GetS3ObjectQuery(bucket, filename) {
+        assert(bucket, 'S3 bucket is required');
+        assert(filename, 'filePath is required');
+        assert(typeof filename === 'string', 'filePath should be a string.');
+
+        return {
+            config: {
+                Bucket: bucket,
+                Key: filename.replace(`/${bucket}/`, ''),
+                GrantRead:
+                    'uri=http://acs.amazonaws.com/groups/global/AllUsers',
+            },
+        };
+    }
+}
+
+export const awsS3Client = new AWS_S3();

package/src/data-access/http/asset-manager-tvm.client.js

@@ -0,0 +1,32 @@
+import superagent from 'superagent';
+import logger from '../../lib/logger.js';
+
+const { ASSET_MANAGER_TVM_API_KEY, ASSET_MANAGER_TVM_URL } = process.env;
+
+class AssetManagerTVMRepository {
+    apiKey;
+    constructor() {}
+
+    async get(companyId) {
+        let response;
+        try {
+            response = await superagent
+                .get(`https://${ASSET_MANAGER_TVM_URL}/tvm`)
+                .query({
+                    companyId,
+                })
+                .timeout(5000)
+                .set({
+                    'x-api-key': ASSET_MANAGER_TVM_API_KEY,
+                })
+                .then((result) => result.body);
+        } catch (error) {
+            logger.error(error);
+            throw error;
+        }
+
+        return response;
+    }
+}
+
+export const assetManagerTvmRepository = new AssetManagerTVMRepository();

package/src/data-access/http/companiesApi.client.js

@@ -0,0 +1,35 @@
+import superagent from 'superagent';
+import logger from '../../lib/logger.js';
+import configuration from '../../lib/configuration.js';
+
+export class CompanyApiClient {
+    constructor({ services }) {
+        this.companiesApiUrl = configuration.get('COMPANIES_API_URL');
+
+        this.authService = services.auth;
+    }
+
+    async getById(companyId, jwt, retries = 0) {
+        let company;
+        try {
+            let resignedToken = await this.authService.getResignedToken(jwt);
+            company = await superagent
+                .get(`${this.companiesApiUrl}/${companyId}`)
+                .set('Authorization', resignedToken)
+                .set('x-client-name', configuration.get('CLIENT_NAME_HEADER'))
+                .then((result) => result.body);
+        } catch (error) {
+            logger.error(
+                `Failed requesting Companies Api for companyId ${companyId} retry ${retries}`,
+                error
+            );
+
+            if (retries <= 3) {
+                return this.getById(companyId, jwt, ++retries);
+            }
+            return;
+        }
+
+        return company;
+    }
+}

package/src/data-access/http/credentialsApi.client.js

@@ -0,0 +1,137 @@
+import superagent from 'superagent'; // @todo remove superagent
+import logger from '../../lib/logger.js';
+import configuration from '../../lib/configuration.js';
+
+export class CredentialsApiClient {
+    constructor() {
+        this.credentialsApiUrl = configuration.get('CREDENTIALS_API_URL');
+        this.credentialsApiApplicationId = configuration.get(
+            'CREDENTIALS_API_APPLICATION_ID'
+        );
+    }
+
+    async getCredential(
+        { companyId, userId, accountId, productArea },
+        userPermissionsEnabled
+    ) {
+        const credentials = await this.getCredentialsByCompany(
+            { companyId, userId, productArea },
+            userPermissionsEnabled
+        );
+
+        if (!credentials) {
+            throw 'No credentials returned';
+        }
+
+        const credential = credentials.find(
+            (credential) => credential.social_account_id == accountId
+        );
+
+        if (!credential) {
+            throw `${sourceId} credential was not found.`;
+        }
+
+        return credential;
+    }
+
+    async getCredentialsByCompany(
+        { companyId, userId, productArea },
+        userPermissionsEnabled
+    ) {
+        let credentials;
+        try {
+            if (productArea) {
+                logger.info(
+                    `Get Credentials for company: ${companyId} and user: ${userId}`
+                );
+                credentials = await superagent
+                    .get(
+                        `${this.credentialsApiUrl}/api/v4.0/CompanyCredentials/${this.credentialsApiApplicationId}/${companyId}/${userId}`
+                    )
+                    .query({
+                        productArea,
+                    })
+                    .then((result) => result.body.data);
+            } else if (userPermissionsEnabled) {
+                credentials = await superagent
+                    .get(
+                        `${this.credentialsApiUrl}/api/v4.0/CompanyCredentials/${this.credentialsApiApplicationId}/${companyId}/${userId}`
+                    )
+                    .then((result) => result.body.data);
+            } else {
+                credentials = await superagent
+                    .get(
+                        `${this.credentialsApiUrl}/api/v3.0/CompanyCredentials/${this.credentialsApiApplicationId}/${companyId}/${userId}`
+                    )
+                    .then((result) => result.body.data);
+            }
+        } catch (error) {
+            logger.error(
+                `Failed requesting Credentials API for companyId ${companyId} ${userId}`,
+                error
+            );
+            return [];
+        }
+
+        logger.info(
+            `Finished requesting Credentials API for companyId ${companyId}`
+        );
+
+        return credentials;
+    }
+
+    // todo: will this need to ever use productArea?
+    async getToken(credentialId, companyId) {
+        let token;
+        try {
+            token = await superagent
+                .get(
+                    `${this.credentialsApiUrl}/api/Token/${credentialId}/${companyId}`
+                )
+                .then((result) => {
+                    return result.body;
+                });
+        } catch (error) {
+            logger.error(
+                `Failed requesting Credentials API for credentialId ${credentialId} and companyId ${companyId}`,
+                error
+            );
+            return;
+        }
+
+        logger.info(
+            `Finished requesting Credentials API for credentialId ${credentialId} and companyId ${companyId}`
+        );
+
+        return token;
+    }
+
+    async getCredentialIdByAccountId(accountId, channel) {
+        let credentialId;
+        try {
+            credentialId = await superagent
+                .get(
+                    `${this.credentialsApiUrl}/api/CompanyCredentials/GetCredential/${channel}/${accountId}`
+                )
+                .then((result) => {
+                    return (
+                        result.body &&
+                        result.body.data &&
+                        result.body.data.credentialId
+                    );
+                });
+        } catch (error) {
+            logger.error(
+                `Failed requesting Credentials API for credentialId ${accountId} and channel ${channel}`,
+                error
+            );
+            return;
+        }
+
+        logger.info(
+            `Finished requesting Credentials API for credentialId ${accountId} and channel ${channel}`
+        );
+
+        return credentialId;
+    }
+}

package/src/data-access/http/entitlementsApi.client.js

@@ -0,0 +1,41 @@
+import superagent from 'superagent';
+import logger from '../../lib/logger.js';
+import configuration from '../../lib/configuration.js';
+
+export class EntitlementsApiClient {
+    constructor({ services }) {
+        this.entitlementsApiUrl = configuration.get('ENTITLEMENTS_API_URL');
+
+        this.authService = services.auth;
+    }
+
+    async getById(entitlementId, companyId, jwt, retries = 0) {
+        let entitlement;
+        try {
+            let resignedToken = await this.authService.getResignedToken(jwt);
+            entitlement = await superagent
+                .get(
+                    `${this.entitlementsApiUrl}/company/${companyId}/${entitlementId}`
+                )
+                .set('Authorization', resignedToken)
+                .set('x-client-name', configuration.get('CLIENT_NAME_HEADER'))
+                .then((result) => result.body);
+        } catch (error) {
+            logger.error(
+                `Failed requesting entitlement ${entitlementId} for companyId ${companyId} retry ${retries}`,
+                error
+            );
+
+            if (retries <= 3) {
+                return this.getById(entitlementId, companyId, jwt, ++retries);
+            }
+            return;
+        }
+
+        logger.info(
+            `Finished requesting entitlement ${entitlementId} for companyId ${companyId}`
+        );
+
+        return entitlement;
+    }
+}