@meltwater/conversations-api-services 1.0.11 → 1.0.13

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

@@ -2,6 +2,7 @@ import superagent from 'superagent';
 import configuration from '../../lib/configuration.js';
 import { CredentialsApiClient } from '../http/credentialsApi.client.js';
 import logger from '../../lib/logger.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class LinkedInApiClient {
     constructor() {
@@ -27,25 +28,25 @@ export class LinkedInApiClient {
         } = document;
 
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
-            'meltwater.document.externalId': externalId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
         });
 
         let response;
         let payload = { actor: socialAccountId, object: externalId };
         let query = likedByUser
             ? `${configuration.get(
-                  'LINKEDIN_API'
-              )}/socialActions/${fixedEncodeURIComponent(externalId)}/likes`
+                'LINKEDIN_API'
+            )}/socialActions/${fixedEncodeURIComponent(externalId)}/likes`
             : `${configuration.get(
-                  'LINKEDIN_API'
-              )}/socialActions/${fixedEncodeURIComponent(
-                  externalId
-              )}/likes/${fixedEncodeURIComponent(
-                  payload.actor
-              )}?actor=${fixedEncodeURIComponent(payload.actor)}`;
+                'LINKEDIN_API'
+            )}/socialActions/${fixedEncodeURIComponent(
+                externalId
+            )}/likes/${fixedEncodeURIComponent(
+                payload.actor
+            )}?actor=${fixedEncodeURIComponent(payload.actor)}`;
 
         try {
             let credential = await this.credentialsAPI.getToken(
@@ -55,7 +56,7 @@ export class LinkedInApiClient {
             if (!likedByUser) {
                 loggerChild.debug(`${documentId} - trying Delete `, {
                     query,
-                    payload,
+                    payload: JSON.stringify(payload),
                 });
                 response = await superagent
                     .delete(query)
@@ -70,7 +71,7 @@ export class LinkedInApiClient {
             } else {
                 loggerChild.debug(`${documentId} - sending to linkedin `, {
                     query,
-                    payload,
+                    payload: JSON.stringify(payload),
                 });
                 response = await superagent
                     .post(query)
@@ -95,9 +96,7 @@ export class LinkedInApiClient {
                 }
             );
         } catch (err) {
-            loggerChild.error(documentId + ' - exception details', {
-                err,
-            });
+            loggerChild.error(`${documentId} - exception details`, err);
             throw err;
         }
         return response.connection || response;
@@ -120,10 +119,10 @@ export class LinkedInApiClient {
         } = document;
 
         const loggerChild = logger.child({
-            'meltwater.document.id': documentId,
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
-            'meltwater.document.externalId': externalId,
+            [MeltwaterAttributes.DOCUMENTID]: documentId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
         });
 
         const [, comment] = externalId.split(',');
@@ -257,14 +256,11 @@ export class LinkedInApiClient {
             };
         } catch (err) {
             logger.error(
-                documentId + ' - exception linkedin publish ' + err,
-                err,
-                {
-                    'meltwater.document.id': documentId,
-                    'meltwater.company.id': companyId,
-                    'meltwater.social.credential_id': credentialId,
-                }
-            );
+                `${documentId} - exception linkedin publish`, err, {
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            });
         }
 
         return response;
@@ -312,14 +308,11 @@ export class LinkedInApiClient {
             return response;
         } catch (err) {
             logger.error(
-                documentId + ' - exception linkedin media register ' + err,
-                err,
-                {
-                    'meltwater.document.id': documentId,
-                    'meltwater.company.id': companyId,
-                    'meltwater.social.credential_id': credentialId,
-                }
-            );
+                `${documentId} - exception linkedin media register`, err, {
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            });
         }
     }
 
@@ -393,15 +386,15 @@ export class LinkedInApiClient {
     async getAllStats(externalId, token) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.document.externalId': externalId,
+            [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
         });
 
         try {
             response = await superagent
                 .get(
                     configuration.get('LINKEDIN_API') +
-                        '/socialMetadata/' +
-                        fixedEncodeURIComponent(externalId)
+                    '/socialMetadata/' +
+                    fixedEncodeURIComponent(externalId)
                 )
                 .timeout(5000) // 5 seconds
                 .set({
@@ -412,7 +405,7 @@ export class LinkedInApiClient {
                     'LinkedIn-Version': '202311',
                 });
         } catch (error) {
-            loggerChild.error('Error in getAllStats ' + error, error);
+            loggerChild.error('Error in getAllStats', error);
         }
 
         let { commentSummary, reactionSummaries } = response.body || {};
@@ -420,9 +413,8 @@ export class LinkedInApiClient {
             return { commentSummary, reactionSummaries };
         } else {
             loggerChild.error(
-                `Invalid response getting all Linkedin Stats for externalId = ${externalId} ` +
-                    response,
-                response
+                `Invalid response getting all Linkedin Stats for externalId = ${externalId}`,
+                { response: JSON.stringify(response) }
             );
             return {};
         }
@@ -440,8 +432,8 @@ export class LinkedInApiClient {
                 reactionSummaries,
             };
         } catch (error) {
-            logger.error('Error in getSocialStats: ' + error, error, {
-                'meltwater.document.externalId': externalId,
+            logger.error('Error in getSocialStats', error, {
+                [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
             });
         }
     }
@@ -449,8 +441,8 @@ export class LinkedInApiClient {
     async getImageMedia(mediaId, credentialId, companyId) {
         let response = {};
         const loggerChild = logger.child({
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
         });
 
         let credential = await this.credentialsAPI.getToken(
@@ -469,8 +461,8 @@ export class LinkedInApiClient {
             response = await superagent
                 .get(
                     configuration.get('LINKEDIN_API') +
-                        '/images/' +
-                        fixedEncodeURIComponent(mediaId)
+                    '/images/' +
+                    fixedEncodeURIComponent(mediaId)
                 )
                 .timeout(5000) // 5 seconds
                 .set({
@@ -481,7 +473,7 @@ export class LinkedInApiClient {
                     'LinkedIn-Version': '202311',
                 });
         } catch (error) {
-            loggerChild.error('Error in getImageMedia ' + error, error);
+            loggerChild.error('Error in getImageMedia', error);
         }
 
         let { downloadUrl } = response.body || {};
@@ -489,9 +481,8 @@ export class LinkedInApiClient {
             return { downloadUrl };
         } else {
             loggerChild.error(
-                `Invalid response getting Linkedin media for mediaId = ${mediaId} ` +
-                    response,
-                response
+                `Invalid response getting Linkedin media for mediaId: ${mediaId}`,
+                { response: JSON.stringify(response) }
             );
             return {};
         }
@@ -501,8 +492,8 @@ export class LinkedInApiClient {
         let response = {};
         let tempValue;
         const loggerChild = logger.child({
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
         });
 
         let credential = await this.credentialsAPI.getToken(
@@ -529,8 +520,8 @@ export class LinkedInApiClient {
             response = await superagent
                 .get(
                     configuration.get('LINKEDIN_API') +
-                        '/videos/' +
-                        fixedEncodeURIComponent(mediaId)
+                    '/videos/' +
+                    fixedEncodeURIComponent(mediaId)
                 )
                 .timeout(5000) // 5 seconds
                 .set({
@@ -541,7 +532,7 @@ export class LinkedInApiClient {
                     'LinkedIn-Version': '202311',
                 });
         } catch (error) {
-            loggerChild.error('Error in getVideoMedia ' + error, error);
+            loggerChild.error('Error in getVideoMedia', error);
         }
 
         let { thumbnail, downloadUrl } = response.body || {};
@@ -549,9 +540,8 @@ export class LinkedInApiClient {
             return { thumbnail, downloadUrl };
         } else {
             loggerChild.error(
-                `Invalid response getting Linkedin media for mediaId = ${mediaId} ` +
-                    response,
-                response
+                `Invalid response getting Linkedin media for mediaId: ${mediaId}`,
+                { response: JSON.stringify(response) }
             );
             return {};
         }
@@ -589,9 +579,9 @@ export class LinkedInApiClient {
 
             return {};
         } catch (error) {
-            logger.error('Error in getMedia: ' + error, error, {
-                'meltwater.company.id': companyId,
-                'meltwater.social.credential_id': credentialId,
+            logger.error('Error in getMedia', error, {
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
             });
         }
     }
@@ -626,10 +616,10 @@ export class LinkedInApiClient {
                 })
                 .then((result) => result.body);
         } catch (error) {
-            logger.error('Error in getLikesByUser: ' + error, error, {
-                'meltwater.company.id': companyId,
-                'meltwater.document.externalId': externalId,
-                'meltwater.social.credential_id': credentialId,
+            logger.error('Error in getLikesByUser', error, {
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.DOCUMENTEXTERNALID]: externalId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
             });
             return false;
         }

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

@@ -1,6 +1,7 @@
 import superagent from 'superagent';
 import logger from '../../lib/logger.js';
 import configuration from '../../lib/configuration.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class MasfClient {
     constructor() {
@@ -25,7 +26,7 @@ export class MasfClient {
             logger.error(
                 `Failed requesting Search Services for search list `,
                 error,
-                { 'meltwater.company.id': companyId }
+                { [MeltwaterAttributes.COMPANYID]: companyId }
             );
         }
     }
@@ -50,7 +51,7 @@ export class MasfClient {
             logger.error(
                 `Failed requesting Search Services for author list `,
                 error,
-                { 'meltwater.company.id': companyId }
+                { [MeltwaterAttributes.COMPANYID]: companyId }
             );
         }
     }
@@ -67,7 +68,7 @@ export class MasfClient {
             logger.error(
                 `Failed requesting Search Services for author list `,
                 error,
-                { 'meltwater.company.id': companyId }
+                { [MeltwaterAttributes.COMPANYID]: companyId }
             );
         }
     }

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

@@ -3,6 +3,7 @@ import configuration from '../../lib/configuration.js';
 import logger from '../../lib/logger.js';
 import { removePrefix } from '../../lib/externalId.helpers.js';
 import { CredentialsApiClient } from '../http/credentialsApi.client.js';
+import { MeltwaterAttributes } from '../../lib/logger.helpers.js';
 
 export class TikTokApiClient {
     constructor() {
@@ -26,15 +27,11 @@ export class TikTokApiClient {
             );
             return `${credential.token}`;
         } catch (error) {
-            logger.error(
-                `${documentId} - error getting tiktok token - ${error.code}`,
-                error,
-                {
-                    'meltwater.document.id': documentId,
-                    'meltwater.company.id': companyId,
-                    'meltwater.social.credential_id': credentialId,
-                }
-            );
+            logger.error(`${documentId} - error getting tiktok token - ${error.code}`, error, {
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+                [MeltwaterAttributes.COMPANYID]: companyId,
+                [MeltwaterAttributes.CREDENTIALID]: credentialId,
+            });
         }
     }
 
@@ -106,7 +103,7 @@ export class TikTokApiClient {
                 `Failed to call tiktok api for documentId ${document.documentId}`,
                 response.body,
                 {
-                    'meltwater.document.id': document.documentId,
+                    [MeltwaterAttributes.DOCUMENTID]: document.documentId,
                 }
             );
             let error = new Error(
@@ -146,7 +143,7 @@ export class TikTokApiClient {
                     paramArray.forEach((paramString) => {
                         let discussionTypeBucket =
                             retObj[
-                                `${paramString}${document.systemData.connectionsCredential}`
+                            `${paramString}${document.systemData.connectionsCredential}`
                             ];
                         if (!discussionTypeBucket) {
                             discussionTypeBucket = {
@@ -190,14 +187,13 @@ export class TikTokApiClient {
                         } = documentsByTypeAndCredential.document;
                         const trimmedBusinessId = removePrefix(business_id);
                         const requestResult = await this.sendRequest({
-                            paramString: `${
-                                documentsByTypeAndCredential.paramString
-                            }?business_id=${trimmedBusinessId}&fields=["item_id","create_time","thumbnail_url","share_url","embed_url","caption","video_views","likes","comments","shares"]&filters=${JSON.stringify(
-                                {
-                                    video_ids:
-                                        documentsByTypeAndCredential.externalIds,
-                                }
-                            )}`,
+                            paramString: `${documentsByTypeAndCredential.paramString
+                                }?business_id=${trimmedBusinessId}&fields=["item_id","create_time","thumbnail_url","share_url","embed_url","caption","video_views","likes","comments","shares"]&filters=${JSON.stringify(
+                                    {
+                                        video_ids:
+                                            documentsByTypeAndCredential.externalIds,
+                                    }
+                                )}`,
                             document: documentsByTypeAndCredential.document,
                         });
                         requestResult.data.videos.forEach(
@@ -343,26 +339,19 @@ export class TikTokApiClient {
             } else {
                 response = await this.unhide(document, parentDoc);
             }
-            logger.info(
-                `Native Tiktok API Hide Response for documentId ${documentId}`,
-                {
-                    status: response.status,
-                    ok: response.ok,
-                    'meltwater.document.id': documentId,
-                }
-            );
+            logger.info(`Native Tiktok API Hide Response for documentId ${documentId}`, {
+                status: response.status,
+                ok: response.ok,
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+            });
 
             if (response.message === 'OK') {
                 return response;
             }
         } catch (error) {
-            logger.error(
-                `${documentId} - error recieved - ${error.code}`,
-                error,
-                {
-                    'meltwater.document.id': documentId,
-                }
-            );
+            logger.error(`${documentId} - error recieved - ${error.code}`, error, {
+                [MeltwaterAttributes.DOCUMENTID]: documentId,
+            });
         }
     }
 
@@ -419,9 +408,9 @@ export class TikTokApiClient {
         const video_id =
             discussionType === 're'
                 ? parentDoc?.metaData?.inReplyTo?.id ||
-                  parentDoc?.metaData?.inReplyTo?.externalId
+                parentDoc?.metaData?.inReplyTo?.externalId
                 : document?.metaData?.inReplyTo?.id ||
-                  document?.metaData?.inReplyTo?.externalId;
+                document?.metaData?.inReplyTo?.externalId;
 
         const { body: publishedMessage } =
             (await this.sendPost({

package/src/data-access/index.js

@@ -13,6 +13,13 @@ import { LinkedInApiClient } from './http/linkedInApi.client.js';
 import { TikTokApiClient } from './http/tiktokApi.client.js';
 import { MasfClient } from './http/masf.client.js';
 import { WarpZoneApiClient } from './http/WarpZoneApi.client.js';
+import * as messageHelpers from '../lib/message.helpers.js';
+import * as applicationTagFunctions  from '../lib/applicationTags.helpers.js';
+
+const DocumentHelperFunctions = {
+    ...messageHelpers,
+    ...applicationTagFunctions
+}
 
 export {
     awsS3Client,
@@ -30,4 +37,5 @@ export {
     TikTokApiClient,
     MasfClient,
     WarpZoneApiClient,
+    DocumentHelperFunctions,
 };

package/src/lib/applicationTags.helpers.js

@@ -20,3 +20,8 @@ export function checkApplicationTagsForUserLikes(applicationTags) {
         return false;
     }
 }
+
+export function getCredentialIdFromApplicationTags(applicationTags) {
+    return applicationTags.find((appTag) => appTag.startsWith('connectionsCredential=') || appTag.startsWith('connectionscredential='))
+            ?.substring(22);
+}

package/src/lib/hiddenComment.helper.js

@@ -2,6 +2,7 @@ import logger from '../lib/logger.js';
 import { IRClient } from '../data-access/http/ir.clien.jst';
 import XRunes from '@meltwater/xrunes';
 import xRunesCore from '@meltwater/xrunes-core';
+import { MeltwaterAttributes } from '../lib/logger.helpers.js';
 
 class HiddenCommentHelper {
     constructor({ company, user, traceId }) {
@@ -88,15 +89,15 @@ class HiddenCommentHelper {
         runes.query = await this.xRunes.render(runes.query);
 
         logger.debug(`export api query: ${JSON.stringify(runes.query)}`, {
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
         });
 
         let results = await this.irClient.export(runes);
 
         logger.debug(`export api result: ${JSON.stringify(results)}`, {
-            'meltwater.company.id': companyId,
-            'meltwater.social.credential_id': credentialId,
+            [MeltwaterAttributes.COMPANYID]: companyId,
+            [MeltwaterAttributes.CREDENTIALID]: credentialId,
         });
 
         return results;

package/src/lib/logger.helpers.js

@@ -0,0 +1,27 @@
+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 { MeltwaterAttributes };

package/src/lib/message.helpers.js

@@ -0,0 +1,72 @@
+
+
+
+export function isMention({
+    appData:{
+        isMention = false,
+    } = {},
+    body:{
+        mentions = []
+    } = {},
+    metaData:{
+        authors:[
+            {
+                authorInfo:{
+                    externalId: authorExternalId
+                } = {}
+            } = {}
+        ] = [{}],
+        inReplyTo:{
+            author:{
+                externalId: inReplyToExternalId,
+                handle: inReplyToHandle,
+            } = {},
+        } = {},
+        discussionType = '',
+        source:{
+            socialOriginType
+        } = {}
+    } = {},
+    providerSpecific,
+}, credential){
+
+    // 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;
+    }
+    
+    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(
+            ({ facebookPostType }) => facebookPostType === 'mention'
+        );
+
+        if (hasMention) {
+            retIsMention = true;
+        }
+    }
+    console.log('isMention '+retIsMention);
+    return retIsMention;
+}