@vrplatform/log 2.0.0 → 2.0.1

package/src/log/type.ts

@@ -25,11 +25,15 @@ export type LogFn = (
   message: any,
   additionalContext?: Record<string, any>
 ) => void;
-export type Log = {
+
+export type LogFns = {
   error: LogFn;
   info: LogFn;
   debug: LogFn;
   warn: LogFn;
+};
+
+export type Log = LogFns & {
   child: (data: ChildLogOptions) => Log;
   addContext: (data: Record<string, any>) => void;
 };

package/src/tracking/index.ts

@@ -1,55 +1,123 @@
+declare module 'intercom-client' {
+  export namespace Intercom {
+    export interface CreateContactRequestWithExternalId {
+      /** A unique identifier for the contact which is given to Intercom */
+      external_id: string;
+      /** The contacts phone */
+      phone?: string;
+      /** The contacts name */
+      name?: string;
+      /** An image URL containing the avatar of a contact */
+      avatar?: string;
+      /** The time specified for when a contact signed up */
+      signed_up_at?: number;
+      /** The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) */
+      last_seen_at?: number;
+      /** The id of an admin that has been assigned account ownership of the contact */
+      owner_id?: number;
+      /** Whether the contact is unsubscribed from emails */
+      unsubscribed_from_emails?: boolean;
+      /** The custom attributes which are set for the contact */
+      custom_attributes?: ContactCustomAttributes;
+    }
+    interface UpdateContactRequest {
+      /** The role of the contact. */
+      role?: 'user' | 'lead';
+      /** A unique identifier for the contact which is given to Intercom */
+      external_id?: string;
+      /** The contacts email */
+      email?: string;
+      /** The contacts phone */
+      phone?: string;
+      /** The contacts name */
+      name?: string;
+      /** An image URL containing the avatar of a contact */
+      avatar?: string;
+      /** The time specified for when a contact signed up */
+      signed_up_at?: number;
+      /** The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) */
+      last_seen_at?: number;
+      /** The id of an admin that has been assigned account ownership of the contact */
+      owner_id?: number;
+      /** Whether the contact is unsubscribed from emails */
+      unsubscribed_from_emails?: boolean;
+      /** The custom attributes which are set for the contact */
+      custom_attributes?: ContactCustomAttributes;
+    }
+    interface ContactCustomAttributes {
+      Onboarding_Support?: string; // The customer's preferred onboarding level
+      userType?: string; // User Type (user or owner)
+      // ARCHIVED
+      // article_id?: string; // undefined
+      // workflowInstanceId?: number; // undefined
+      // Active_Listings?: string; // The number of active listings a user has
+      // Accounting_Software?: string; // The client's accounting software
+    }
+    interface CreateOrUpdateCompanyRequest {
+      /** The name of the Company */
+      name?: string;
+      /** The company id you have defined for the company. Can't be updated */
+      company_id?: string;
+      /** The name of the plan you have associated with the company. */
+      plan?: string;
+      /** The number of employees in this company. */
+      size?: number;
+      /** The URL for this company's website. Please note that the value specified here is not validated. Accepts any string. */
+      website?: string;
+      /** The industry that this company operates in. */
+      industry?: string;
+      /** A hash of key/value pairs containing any other data about the company you want Intercom to store. */
+      custom_attributes?: CompanyCustomAttributes;
+      /** The time the company was created by you. */
+      remote_created_at?: number;
+      /** How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2\*\*31-1 or 2147483647.. */
+      monthly_spend?: number;
+    }
+    interface CompanyCustomAttributes {
+      teamId?: string; // undefined
+      team?: string; // undefined
+      type?: string; // undefined
+      status?: string; // undefined
+      pms?: string; // undefined
+      accountingSoftware?: string; // Accounting software used by the team.
+      creation_source?: string; // undefined
+      activeListings?: number; // Active Listings
+      paymentMethodType?: string; // Payment Method
+      partnerName?: string; // Partner Name
+      billingPortalUrl?: string; // Billing Portal URL
+      billingStatus?: string; // undefined
+      billingPartner?: string; // Name of billing partner
+      // ARCHIVED
+      // firstName?: string; // undefined
+      // lastName?: string; // undefined
+      // email?: string; // undefined
+      // apps?: string; // All active connections besides pms/accounting
+      // accountingPartner?: string; // Name of accounting partner
+      // 'SaaS User'?: boolean; // undefined
+    }
+  }
+}
+
 import { Analytics } from '@june-so/analytics-node';
+import { Intercom, IntercomClient } from 'intercom-client';
+import { fetcher } from 'intercom-client/core/fetcher/Fetcher';
 import { PostHog } from 'posthog-node';
 import { type LogBindings, type WorkerLog, useLog } from '../log';
-import { useIntercom } from './intercom';
-import type { TrackingEvent } from './types';
+import { convertKeysToSnakeCase, isTest } from '../utils';
+import { convertValuesToString } from '../utils/convertValuesToString';
+import type {
+  GroupProps,
+  IdentifyProps,
+  TrackProps,
+  TrackingEvent,
+} from './types';
 
 export * from './types';
+export * from 'intercom-client';
+export * from '../utils';
 
-const E2E_TEST_USERS = {
-  'e2e-invite-member@finalytic.io': '113d73d8-ee21-46b7-a12a-a74f632401ca',
-  'e2e-invite-owner@finalytic.io': '917b7c4e-cb03-491c-9e94-d33a5bdeca05',
-  'e2e-sign-up@finalytic.io': 'ec8e5572-74d0-4ae6-af73-bca8db9a27e9',
-  'lars+checkly@finalytic.co': '9e7dfc88-503c-4222-9905-9116169d2203',
-};
-
-const E2E_TEST_TEAMS = {
-  'VRP Automated Testing': 'c4fd21b4-8447-43a2-bdcb-f06a85a935ad',
-  test_company_xxxx: '8f21060e-afe6-410a-b2f4-00a3caa20786',
-};
-
-export const isTest = (userId: string, groupId?: string, userEmail?: string) =>
-  Object.values(E2E_TEST_USERS).includes(userId) ||
-  (groupId && Object.values(E2E_TEST_TEAMS).includes(groupId)) ||
-  (userEmail && Object.keys(E2E_TEST_USERS).includes(userEmail));
-
-const camelToSnakeCase = (str: string) =>
-  str.replace(/([a-z])([A-Z])/g, '$1_$2').toLowerCase();
-
-// todo: move to utils
-export const convertKeysToSnakeCase = (obj?: Record<string, any>) => {
-  const result: Record<string, any> = {};
-  const hasOwnProperty = Object.prototype.hasOwnProperty;
-
-  for (const key in obj) {
-    if (hasOwnProperty.call(obj, key)) {
-      const snakeKey = camelToSnakeCase(key);
-      if (
-        typeof obj[key] === 'object' &&
-        !Array.isArray(obj[key]) &&
-        obj[key] !== null
-      ) {
-        result[snakeKey] = convertKeysToSnakeCase(obj[key]);
-      } else {
-        result[snakeKey] = obj[key];
-      }
-    }
-  }
-
-  return result;
-};
-
-export type TrackingProps = {
+export type Tracking = ReturnType<typeof useTracking>;
+export type UseTracking = {
   name: string;
   dataset: string;
   env: {
@@ -59,51 +127,31 @@ export type TrackingProps = {
   } & LogBindings;
   debugging?: boolean;
 };
-export type Tracking = ReturnType<typeof useTracking>;
-
-export type TrackProps = OptionalUser<{
-  groupId: string;
-  event: TrackingEvent;
-  properties: Record<string, string | number | boolean | null | undefined>;
-  timestamp?: Date;
-}>;
-export type IdentifyProps = {
-  userId: string;
-  traits: Record<string, string | number | boolean | null | undefined>;
-  disableGeoip?: boolean;
-  timestamp?: Date;
-};
-export type GroupProps = OptionalUser<{
-  groupId: string;
-  traits?: Record<string, string | number | boolean | null | undefined>;
-  timestamp?: Date;
-}>;
-type OptionalUser<T> = T &
-  (
-    | { userId: string; anonymousId?: string }
-    | {
-        userId?: string;
-        anonymousId: string;
-      }
-  );
 
 export const useTracking = (
-  { dataset, env, name }: TrackingProps,
+  { dataset, env, name }: UseTracking,
   isDev?: boolean
 ): {
-  track: (props: TrackProps) => Promise<void>;
+  track: <T extends TrackingEvent>(props: TrackProps<T>) => Promise<void>;
   identify: (props: IdentifyProps) => Promise<void>;
   group: (props: GroupProps) => Promise<void>;
   shutdown: () => Promise<any>;
   log: WorkerLog;
   june?: Analytics;
-  _intercom?: ReturnType<typeof useIntercom>;
+  intercom?: IntercomClient;
   posthog?: PostHog;
 } => {
   const log = useLog({ name, dataset, env });
 
-  const _intercom = env.INTERCOM_TOKEN
-    ? useIntercom(env.INTERCOM_TOKEN, log)
+  const intercom = env.INTERCOM_TOKEN
+    ? new IntercomClient({
+        token: env.INTERCOM_TOKEN,
+        fetcher: (args) =>
+          fetcher({
+            ...args,
+            headers: { ...args.headers, accept: 'application/json' },
+          }),
+      })
     : undefined;
 
   const june = env.JUNESO_TOKEN ? new Analytics(env.JUNESO_TOKEN) : undefined;
@@ -116,14 +164,14 @@ export const useTracking = (
 
   return {
     // General
-    track: async ({
+    track: async <T extends TrackingEvent>({
       userId,
       anonymousId,
       groupId,
       event,
       properties,
       timestamp,
-    }: TrackProps) => {
+    }: TrackProps<T>) => {
       if (isDev || isTest(userId || anonymousId || '', groupId)) return;
 
       if (anonymousId) {
@@ -136,6 +184,7 @@ export const useTracking = (
           timestamp,
           properties: convertKeysToSnakeCase(properties),
         });
+
         june?.track(
           {
             anonymousId,
@@ -160,6 +209,7 @@ export const useTracking = (
           timestamp,
           properties: convertKeysToSnakeCase(properties),
         });
+
         june?.track(
           {
             userId,
@@ -173,15 +223,22 @@ export const useTracking = (
           }
         );
 
-        try {
-          await _intercom?.trackEvent({
-            user_id: userId,
+        const intercomUserId = (
+          await intercom?.contacts.search({
+            query: {
+              field: 'external_id',
+              operator: Intercom.SingleFilterSearchRequestOperator.Equals,
+              value: userId,
+            },
+          })
+        )?.data.at(0)?.id;
+        if (intercomUserId)
+          await intercom?.events.create({
+            user_id: intercomUserId,
             event_name: event,
-            metadata: properties,
+            metadata: convertValuesToString(properties),
+            created_at: timestamp ? timestamp.getTime() : Date.now(),
           });
-        } catch (error: any) {
-          console.error(error);
-        }
       }
     },
     identify: async ({
@@ -197,16 +254,45 @@ export const useTracking = (
         properties: convertKeysToSnakeCase(traits),
         disableGeoip,
       });
+
       june?.identify(
         {
           userId,
           traits,
           timestamp,
         },
-        (err) => {
-          if (err) console.error(err);
-        }
+        (err) => (err ? console.error(err) : {})
       );
+
+      // upsert intercom user
+      const data = {
+        external_id: userId,
+        email: traits?.email,
+        name:
+          traits?.name ||
+          (traits?.firstName
+            ? `${traits.firstName} ${traits.lastName}`
+            : traits?.lastName),
+        avatar: traits?.avatar,
+        signed_up_at: traits?.createdAt
+          ? new Date(traits.createdAt).getTime() / 1000
+          : undefined,
+        last_seen_at: new Date().getTime() / 1000,
+        custom_attributes: { userType: traits?.role },
+      };
+
+      const intercomUser = (
+        await intercom?.contacts.search({
+          query: {
+            field: 'external_id',
+            operator: Intercom.SingleFilterSearchRequestOperator.Equals,
+            value: userId,
+          },
+        })
+      )?.data.at(0);
+      if (intercomUser?.id)
+        await intercom?.contacts.update(intercomUser?.id, data);
+      else await intercom?.contacts.create(data);
     },
     group: async ({
       traits,
@@ -217,6 +303,36 @@ export const useTracking = (
     }: GroupProps) => {
       if (isDev || isTest(userId || anonymousId || '', groupId)) return;
 
+      const cid = traits?.billingCustomerId || traits?.hyperlineCustomerId;
+      const intercomCompany = await intercom?.companies.create({
+        name: traits?.name,
+        company_id: groupId,
+        plan: traits?.plan,
+        remote_created_at: traits?.createdAt
+          ? new Date(traits.createdAt).getTime() / 1000
+          : undefined,
+        monthly_spend: traits?.mrr,
+        custom_attributes: {
+          teamId: groupId,
+          team: traits?.name,
+          type: traits?.type,
+          status: traits?.status,
+          pms: traits?.pms,
+          accountingSoftware: traits?.accountingSoftware,
+          activeListings: traits?.activeListings,
+          paymentMethodType: traits?.paymentMethodType,
+          partnerName: traits?.partner || traits?.accountingPartner,
+          billingPortalUrl: cid
+            ? `https://billing.vrplatform.app/portal/${cid}`
+            : undefined,
+          billingStatus: traits?.billingSubscriptionStatus,
+          billingPartner:
+            traits?.billingPartner ||
+            traits?.partner ||
+            traits?.accountingPartner,
+        },
+      });
+
       if (anonymousId) {
         posthog?.groupIdentify({
           groupKey: groupId,
@@ -224,9 +340,10 @@ export const useTracking = (
           properties: convertKeysToSnakeCase(traits),
           distinctId: anonymousId,
         });
-        june?.group({ anonymousId, groupId, traits, timestamp }, (err) => {
-          if (err) console.error(err);
-        });
+
+        june?.group({ anonymousId, groupId, traits, timestamp }, (err) =>
+          err ? console.error(err) : {}
+        );
       } else if (userId) {
         posthog?.groupIdentify({
           groupKey: groupId,
@@ -234,15 +351,31 @@ export const useTracking = (
           properties: convertKeysToSnakeCase(traits),
           distinctId: userId,
         });
-        june?.group({ userId, groupId, traits, timestamp }, (err) => {
-          if (err) console.error(err);
-        });
+
+        june?.group({ userId, groupId, traits, timestamp }, (err) =>
+          err ? console.error(err) : {}
+        );
+
+        // attach intercom user to intercom company
+        const intercomUser = (
+          await intercom?.contacts.search({
+            query: {
+              field: 'external_id',
+              operator: Intercom.SingleFilterSearchRequestOperator.Equals,
+              value: userId,
+            },
+          })
+        )?.data.at(0);
+        if (intercomUser?.id && intercomCompany?.id)
+          intercom?.companies.attachContact(intercomUser?.id, {
+            id: intercomCompany?.id,
+          });
       }
     },
     shutdown: async () =>
       Promise.all([posthog?.shutdown(), june?.closeAndFlush(), log?.flush()]),
     // export dependencies
-    _intercom,
+    intercom,
     posthog,
     june,
     log,