@skillswaveca/nova-shared-libraries 4.22.0 → 4.24.0

package/docs-base/package-info.js

@@ -1,31 +1,31 @@
 export const packageInfo = [
   {
     "name": "@skillswaveca/nova-utils",
-    "version": "4.21.0",
+    "version": "4.23.0",
     "description": "A collection of random utils used in nova repos",
     "docsPath": "./nova-utils/index.html"
   },
   {
     "name": "@skillswaveca/nova-router",
-    "version": "4.21.0",
+    "version": "4.23.0",
     "description": "An extended Koa router that enables better validation",
     "docsPath": "./nova-router/index.html"
   },
   {
     "name": "@skillswaveca/nova-model",
-    "version": "4.21.0",
+    "version": "4.23.0",
     "description": "Nova model stuff",
     "docsPath": "./nova-model/index.html"
   },
   {
     "name": "@skillswaveca/nova-middleware",
-    "version": "4.21.0",
+    "version": "4.23.0",
     "description": "A collection of middleware used by nova projects",
     "docsPath": "./nova-middleware/index.html"
   },
   {
     "name": "@skillswaveca/nova-drivers",
-    "version": "4.21.0",
+    "version": "4.23.0",
     "description": "Some helper drivers for AWS services",
     "docsPath": "./drivers/index.html"
   }

package/index.js

@@ -9,6 +9,7 @@ export * from './packages/drivers/src/wave.js';
 export * from './packages/drivers/src/oauth.js';
 export * from './packages/drivers/src/nova-driver.js';
 export * from './packages/drivers/src/kraken-driver.js';
+export * from './packages/drivers/src/hubspot.js';
 export * from './packages/drivers/src/http.js';
 export * from './packages/drivers/src/config.js';
 export * from './packages/nova-model/src/stream/nova-stream-task-router.js';

package/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-shared-libraries",
   "description": "A monorepo of shared libraries for Nova projects.",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "main": "index.js",
   "license": "MIT",
   "keywords": [],
@@ -14,6 +14,7 @@
     "@aws-sdk/client-sqs": "^3.682.0",
     "@aws-sdk/client-ssm": "^3.682.0",
     "@aws-sdk/lib-dynamodb": "^3.682.0",
+    "@hubspot/api-client": "^13.0.0",
     "@koa/router": "^13.1.0",
     "aws-xray-sdk-core": "^3.6.0",
     "jsonwebtoken": "^9.0.2",

package/packages/drivers/index.js

@@ -2,6 +2,7 @@ export * from './src/wave.js';
 export * from './src/oauth.js';
 export * from './src/nova-driver.js';
 export * from './src/kraken-driver.js';
+export * from './src/hubspot.js';
 export * from './src/http.js';
 export * from './src/config.js';
 export * from './src/aws/sqs.js';

package/packages/drivers/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-drivers",
   "description": "Some helper drivers for AWS services",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/drivers/src/aws/aws-base-driver.js

@@ -25,6 +25,7 @@ export class AwsBaseDriver extends NovaDriver {
     super(configOverrides);
     this.__client = new clientType(opts);
     this.isProd = this.config.prod;
+    this.region = opts?.region;
     if (this.config.xray.enabled) xray.captureAWSv3Client(this.__client);
   }
 

package/packages/drivers/src/aws/secrets-manager.js

@@ -5,9 +5,9 @@ import { AwsBaseDriver } from './aws-base-driver.js';
  * SecretsManager class to simplify fetching secrets from AWS Secret Manager.
  */
 export class SecretsManager extends AwsBaseDriver {
-  constructor() {
+  constructor({ region } = {}) {
     super(SecretsManagerClient, {
-      region: process.env.AWS_REGION || 'us-east-1',
+      region: region || process.env.AWS_REGION || 'us-east-1',
     });
   }
 
@@ -34,8 +34,13 @@ export class SecretsManager extends AwsBaseDriver {
       return;
     }
 
+    const useArn = region && rootEnvironmentAwsAccountId;
+    if (useArn && region !== this.region) {
+      this.log.warn({ requestedRegion: region, configuredRegion: this.region }, 'Requested region does not match configured region');
+    }
+
     try {
-      const secretId = region && rootEnvironmentAwsAccountId ?
+      const secretId = useArn ?
         `arn:aws:secretsmanager:${region}:${rootEnvironmentAwsAccountId}:secret:${secretName}` :
         secretName;
       const data = await this.client.send(new GetSecretValueCommand({ SecretId: secretId }));

package/packages/drivers/src/hubspot.js

@@ -0,0 +1,180 @@
+import { Client } from '@hubspot/api-client';
+
+import log from '../../nova-utils/src/logger.js';
+import { NovaDriver } from './nova-driver.js';
+import { secretsManager } from './aws/secrets-manager.js';
+
+const HUBSPOT_USER_ATTRIBUTE_MAPPINGS = {
+  firstName: 'firstname',
+  lastName: 'lastname',
+  email: 'email',
+  guid: 'external_id',
+  tenantId: 'tenant_id',
+};
+
+/**
+ * HubSpotDriver class provides methods to interact with HubSpot's CRM API using the HubSpot API client.
+ */
+export class HubSpotDriver extends NovaDriver {
+
+    /**
+     * @param {Object} config
+     * @property {Object} hubSpot
+     * @property {string} hubSpot.secretName
+     * @property {string} hubSpot.secretKeyId
+     * @property {string} region
+     * @property {string} rootEnvironmentAwsAccountId
+     * @property {boolean} enabled
+     */
+    constructor(config) {
+        super(config);
+        this._client = null;
+        this.secretName = config.hubSpot.secretName;
+        this.secretKeyId = config.hubSpot.secretKeyId;
+    }
+
+    /**
+     * Maps a skillswave user to a hubSpot user object.
+     * @param {Object} user
+     * @returns {Object} The mapped HubSpot user object.
+     * @private
+     */
+    _mapToHubSpotUser(user) {
+        const hubSpotUser = {};
+        for (const [key, value] of Object.entries(user)) {
+            if (HUBSPOT_USER_ATTRIBUTE_MAPPINGS[key]) {
+                hubSpotUser[HUBSPOT_USER_ATTRIBUTE_MAPPINGS[key]] = value;
+            }
+        }
+
+        return hubSpotUser;
+    }
+
+    /**
+     * This method retrieves the access token from AWS Secrets Manager and creates a new HubSpot client instance. It will return the existing client if it has already been created.
+     * @returns {Promise<Client>} The HubSpot client instance.
+     * @private
+     */
+    async _getClient() {
+        if (!this._client) {
+            const accessToken = await secretsManager.getSecret(this.secretName, this.secretKeyId, this.config.region, this.config.rootEnvironmentAwsAccountId);
+            const hubSpotClient = new Client({ accessToken });
+
+            this._client = hubSpotClient;
+        }
+
+        return this._client;
+    }
+
+    /**
+     * Calls a HubSpot API method based on the provided method path and arguments.
+     * @param {string|Array<string>} methodPath
+     * @param  {...any} args
+     * @returns {Promise<any>} Returns the raw result from the HubSpot client method.
+     */
+    async _callHubSpot(methodPath, ...args) {
+        if (!this.enabled) {
+            log.warn('HubSpot driver is disabled');
+            return;
+        }
+
+        let client = await this._getClient();
+        if (!client) {
+            log.error('Failed to create HubSpot client');
+            return;
+        }
+
+        const path = Array.isArray(methodPath) ? methodPath : methodPath.split('.');
+        let parent = null;
+        for (const key of path) {
+            if (typeof client[key] === 'undefined') {
+                log.error(`Invalid HubSpot client method path: ${methodPath}`);
+                return;
+            }
+            parent = client;
+            client = client[key];
+        }
+
+        if (typeof client !== 'function') {
+            log.error(`Target at path ${methodPath} is not a function`);
+            return;
+        }
+
+        try {
+            return await client.apply(parent, args.length === 1 ? [args[0]] : args);
+        } catch (e) {
+            log.error({ error: e.message }, `Error calling HubSpot method ${methodPath}`);
+            throw e;
+        }
+    }
+
+    /**
+     * Updates a HubSpot deal with the given properties.
+     * @param {string} dealId 
+     * @param {object} properties 
+     * @returns The updated deal object.
+     */
+    async updateDeal(dealId, properties) {
+        return await this._callHubSpot('crm.deals.basicApi.update', dealId, { properties });
+    }
+
+    /**
+     * Looks up a HubSpot contact ID for a given user. May return multiple IDs.
+     * @param {Object} user 
+     * @returns {Promise<string[]|null>} An array of HubSpot contact IDs or null if no contact is found.
+     */
+    async lookupUserContactId(user) {
+        if (!user.email) {
+            log.error('User email is required for lookup');
+            return;
+        }
+
+        try {
+            const response = await this._callHubSpot('crm.contacts.searchApi.doSearch', {
+                filterGroups: [{
+                    filters: [{
+                        propertyName: 'email',
+                        operator: 'EQ',
+                        value: user.email,
+                    }]
+                }]
+            });
+
+            return response.results.length > 0 ? response.results.map(result => result.id) : [];
+        } catch (error) {
+            log.error({ error }, `Error looking up user ${user.email} in HubSpot`);
+            throw error;
+        }
+    }
+
+    /**
+     * Creates or updates a HubSpot contact. If the provided user has a `hubSpotContactId`, it will update the existing contact; otherwise, it will create a new one.
+     * @param {object} user 
+     * @returns {object} The created/updated HubSpot user.
+     */
+    async upsertUser(user) {
+        const hubSpotUser = this._mapToHubSpotUser(user);
+        let response;
+        if (user.hubSpotContactId) {
+            response = await this._callHubSpot('crm.contacts.basicApi.update', user.hubSpotContactId, { properties: hubSpotUser });
+        } else {
+            response = await this._callHubSpot('crm.contacts.basicApi.create', { properties: hubSpotUser });
+        }
+
+        return { hubSpotContactId: response.id, ...user };
+    }
+
+    /**
+     * Deletes a HubSpot user.
+     * @param {object} user 
+     * @returns {Promise<void>}
+     */
+    async deleteUser(user) {
+        if (!user.hubSpotContactId) {
+            log.error(`User ${user.email} does not have a HubSpot contact ID, skipping deletion.`);
+            return;
+        }
+
+        await this._callHubSpot('crm.contacts.basicApi.archive', user.hubSpotContactId);
+    }
+}

package/packages/nova-middleware/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-middleware",
   "description": "A collection of middleware used by nova projects",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-model/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-model",
   "description": "Nova model stuff",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-router/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-router",
   "description": "An extended Koa router that enables better validation",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-utils/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-utils",
   "description": "A collection of random utils used in nova repos",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",