@skillswaveca/nova-shared-libraries 4.25.0 → 4.27.0

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.25.0",
+  "version": "4.27.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",
@@ -16,17 +16,20 @@
   "devDependencies": {
     "chai": "^5.1.0",
     "eslint": "^9.0.0",
-    "mocha": "^10.4.0"
+    "mocha": "^10.4.0",
+    "sinon": "^21.0.0",
+    "sinon-chai": "^4.0.0"
   },
   "dependencies": {
-    "simple-oauth2": "^5.0.0",
     "@aws-sdk/client-dynamodb": "^3.572.0",
     "@aws-sdk/client-secrets-manager": "^3.572.0",
     "@aws-sdk/client-sqs": "^3.572.0",
     "@aws-sdk/lib-dynamodb": "^3.572.0",
+    "@hubspot/api-client": "^13.0.0",
     "aws-xray-sdk-core": "^3.6.0",
     "lodash.chunk": "^4.2.0",
     "node-fetch": "^3.1.0",
-    "pino": "^9.0.0"
+    "pino": "^9.0.0",
+    "simple-oauth2": "^5.0.0"
   }
 }

package/packages/drivers/src/hubspot.js

@@ -113,8 +113,8 @@ export class HubSpotDriver extends NovaDriver {
 
     /**
      * Updates a HubSpot deal with the given properties.
-     * @param {string} dealId 
-     * @param {object} properties 
+     * @param {string} dealId
+     * @param {object} properties
      * @returns The updated deal object.
      */
     async updateDeal(dealId, properties) {
@@ -123,7 +123,7 @@ export class HubSpotDriver extends NovaDriver {
 
     /**
      * Looks up a HubSpot contact ID for a given user. May return multiple IDs.
-     * @param {Object} user 
+     * @param {Object} user
      * @returns {Promise<string[]|null>} An array of HubSpot contact IDs or null if no contact is found.
      */
     async lookupUserContactId(user) {
@@ -152,7 +152,7 @@ export class HubSpotDriver extends NovaDriver {
 
     /**
      * 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 
+     * @param {object} user
      * @returns {object} The created/updated HubSpot user.
      */
     async upsertUser(user) {
@@ -169,7 +169,7 @@ export class HubSpotDriver extends NovaDriver {
 
     /**
      * Deletes a HubSpot user.
-     * @param {object} user 
+     * @param {object} user
      * @returns {Promise<void>}
      */
     async deleteUser(user) {
@@ -184,7 +184,7 @@ export class HubSpotDriver extends NovaDriver {
     /**
      * Sends a custom event to HubSpot using the event definitions.
      * This method validates the event data against the predefined schema before sending.
-     * 
+     *
      * @param {string} eventName - The name of the event to send
      * @param {object} eventData - The event data to send
      * @returns {Promise<object>} The response from HubSpot API
@@ -192,6 +192,7 @@ export class HubSpotDriver extends NovaDriver {
      */
     async sendEvent(eventName, eventData) {
         try {
+            log.error({ eventName, eventData }, 'Sending event to HubSpot');
             // Validate the event exists and get its definition
             const eventDefinition = getEventDefinition(eventName);
             if (!eventDefinition) {
@@ -204,7 +205,7 @@ export class HubSpotDriver extends NovaDriver {
             const eventMetadata = await getEventMetadata(eventName, validatedData);
 
             const response = await this._callHubSpot('events.send.basicApi.send', {
-                eventName: `pe${this.accountId}_${eventName}`,
+                eventName: `pe${this.accountId}_${eventDefinition.name}`,
                 properties: validatedData,
                 occurredAt: new Date(),
                 ...eventMetadata,
@@ -213,14 +214,14 @@ export class HubSpotDriver extends NovaDriver {
             log.debug({ eventName, response }, 'Event sent to HubSpot successfully');
             return response;
         } catch (error) {
-            log.error({ 
-                eventName, 
-                eventData, 
+            log.error({
+                eventName,
+                eventData,
                 error: error.message,
-                stack: error.stack 
+                stack: error.stack
             }, 'Unexpected error while sending event');
-            
+
             throw error;
         }
     }
-}
+}

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.25.0",
+  "version": "4.27.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.25.0",
+  "version": "4.27.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.25.0",
+  "version": "4.27.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-utils/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@skillswaveca/nova-utils",
-  "version": "4.24.0",
+  "version": "4.25.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@skillswaveca/nova-utils",
-      "version": "4.24.0",
+      "version": "4.25.0",
       "license": "UNLICENSED",
       "dependencies": {
         "yup": "^1.4.0"

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.25.0",
+  "version": "4.27.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-utils/src/event-definitions.js

@@ -11,10 +11,37 @@ import * as yup from 'yup';
  * - validator: Yup validation schema for the event data
  */
 
-const testEventDefinition = {
-  name: 'hubspot_test_event',
-  description: 'Test event for HubSpot integration',
+const TENANT_PROPERTIES = {
+  tenant_id: {
+    type: 'string',
+    required: true,
+    description: 'The ID of the tenant',
+  },
+  tenant_name: {
+    type: 'string',
+    required: true,
+    description: 'The name of the tenant',
+  },
+};
+
+const TENANT_PROPERTIES_VALIDATOR = {
+  tenant_id: yup.string().required('Tenant ID is required'),
+  tenant_name: yup.string().required('Tenant name is required'),
+};
+
+const TENANT_METADATA_PROPERTIES = data => {
+  return {
+    tenant_id: data.tenant_id,
+    tenant_name: data.tenant_name,
+  };
+};
+
+const clientOnboardingCompletedEventDefinition = {
+  key: 'clientOnboardingCompleted',
+  name: 'client_onboarding_completed',
+  description: 'Client has finished PLG onboarding and pressed "create workspace."',
   properties: {
+    ...TENANT_PROPERTIES,
     email: {
       type: 'string',
       required: true,
@@ -22,10 +49,108 @@ const testEventDefinition = {
     },
   },
   validator: yup.object({
+    ...TENANT_PROPERTIES_VALIDATOR,
     email: yup.string().email('Must be a valid email').required('Email is required'),
   }),
   getMetadata: eventData => {
     return {
+      ...TENANT_METADATA_PROPERTIES(eventData),
+      email: eventData.email,
+    };
+  },
+};
+
+const usersInvitedEventDefinition = {
+  key: 'usersInvited',
+  name: 'users_invited',
+  description: 'PLG Admin has invited one or more users to their workspace.',
+  properties: {
+    ...TENANT_PROPERTIES,
+    email: {
+      type: 'string',
+      required: true,
+      description: 'Email address of the user',
+    },
+  },
+  validator: yup.object({
+    ...TENANT_PROPERTIES_VALIDATOR,
+    email: yup.string().email('Must be a valid email').required('Email is required'),
+  }),
+  getMetadata: eventData => {
+    return {
+      ...TENANT_METADATA_PROPERTIES(eventData),
+      email: eventData.email,
+    };
+  },
+};
+
+const creditCardEventDefinition = {
+  key: 'creditCardAdded',
+  name: 'credit_card_added',
+  description: 'PLG Admin added a credit card in Stripe.',
+  properties: {
+    ...TENANT_PROPERTIES,
+    email: {
+      type: 'string',
+      required: true,
+      description: 'Email address of the user',
+    },
+  },
+  validator: yup.object({
+    ...TENANT_PROPERTIES_VALIDATOR,
+    email: yup.string().email('Must be a valid email').required('Email is required'),
+  }),
+  getMetadata: eventData => {
+    return {
+      ...TENANT_METADATA_PROPERTIES(eventData),
+      email: eventData.email,
+    };
+  },
+};
+
+const firstRequestSubmittedEventDefinition = {
+  key: 'firstRequestSubmitted',
+  name: 'first_request_submitted',
+  description: 'A user in the PLG workspace has submitted the first request.',
+  properties: {
+    ...TENANT_PROPERTIES,
+    email: {
+      type: 'string',
+      required: true,
+      description: 'Email address of the user',
+    },
+  },
+  validator: yup.object({
+    ...TENANT_PROPERTIES_VALIDATOR,
+    email: yup.string().email('Must be a valid email').required('Email is required'),
+  }),
+  getMetadata: eventData => {
+    return {
+      ...TENANT_METADATA_PROPERTIES(eventData),
+      email: eventData.email,
+    };
+  },
+};
+
+const transactionsThresholdMetEventDefinition = {
+  key: 'transactionsThresholdMet',
+  name: 'transactions_threshold_met',
+  description: 'The PLG tenant has completed a specified number of transactions.',
+  properties: {
+    ...TENANT_PROPERTIES,
+    email: {
+      type: 'string',
+      required: true,
+      description: 'Email address of the user',
+    },
+  },
+  validator: yup.object({
+    ...TENANT_PROPERTIES_VALIDATOR,
+    email: yup.string().email('Must be a valid email').required('Email is required'),
+  }),
+  getMetadata: eventData => {
+    return {
+      ...TENANT_METADATA_PROPERTIES(eventData),
       email: eventData.email,
     };
   },
@@ -36,9 +161,12 @@ const testEventDefinition = {
  * Key: event name, Value: event definition object
  */
 export const eventDefinitions = {
-  [testEventDefinition.name]: testEventDefinition,
+  [clientOnboardingCompletedEventDefinition.key]: clientOnboardingCompletedEventDefinition,
+  [usersInvitedEventDefinition.key]: usersInvitedEventDefinition,
+  [creditCardEventDefinition.key]: creditCardEventDefinition,
+  [firstRequestSubmittedEventDefinition.key]: firstRequestSubmittedEventDefinition,
+  [transactionsThresholdMetEventDefinition.key]: transactionsThresholdMetEventDefinition,
 };
-
 /**
  * Get event definition by name
  * @param {string} eventName - The name of the event
@@ -84,7 +212,7 @@ export const validateEvent = async(eventName, eventData) => {
  * @returns {boolean} True if the event exists, false otherwise
  */
 export const isValidEventName = eventName => {
-  return eventDefinitions.hasOwnProperty(eventName);
+  return Object.hasOwn(eventDefinitions, eventName);
 };
 
 /**