@vrplatform/log 2.0.0-alpha.30 → 2.0.0-alpha.32

package/src/tracking/index.ts

@@ -2,52 +2,20 @@ 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 { type WorkerLog, useLog } from '../log';
 import { convertKeysToSnakeCase, isTest } from '../utils';
 import { convertValuesToString } from '../utils/convertValuesToString';
-import { useIntercom } from './intercom';
-import type { TrackingEvent } from './types';
+import type {
+  GroupProps,
+  IdentifyProps,
+  TrackProps,
+  TrackingProps,
+} from './types';
 
 export * from './types';
 
-export type TrackingProps = {
-  name: string;
-  dataset: string;
-  env: {
-    INTERCOM_TOKEN?: string;
-    JUNESO_TOKEN?: string;
-    POSTHOG_TOKEN?: string;
-  } & 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,
   isDev?: boolean
@@ -59,7 +27,6 @@ export const useTracking = (
   log: WorkerLog;
   june?: Analytics;
   intercom?: IntercomClient;
-  _intercom?: ReturnType<typeof useIntercom>;
   posthog?: PostHog;
 } => {
   const log = useLog({ name, dataset, env });
@@ -74,9 +41,6 @@ export const useTracking = (
           }),
       })
     : undefined;
-  const _intercom = env.INTERCOM_TOKEN
-    ? useIntercom(env.INTERCOM_TOKEN, log)
-    : undefined;
 
   const june = env.JUNESO_TOKEN ? new Analytics(env.JUNESO_TOKEN) : undefined;
 
@@ -187,27 +151,6 @@ export const useTracking = (
         },
         (err) => (err ? console.error(err) : {})
       );
-
-      const intercomUserId = (
-        await intercom?.contacts.search({
-          query: {
-            field: 'external_id',
-            operator: Intercom.SingleFilterSearchRequestOperator.Equals,
-            value: userId,
-          },
-        })
-      )?.data.at(0)?.id;
-      const props = {
-        external_id: userId,
-        name: traits.name ? traits.name.toString() : undefined,
-        email: traits.email ? traits.email.toString() : undefined,
-        role: traits.role ? traits.role.toString() : undefined,
-        avatar: traits.avatar ? traits.avatar.toString() : undefined,
-        custom_attributes: traits,
-      };
-      if (intercomUserId)
-        await intercom?.contacts.update(intercomUserId, props);
-      else await intercom?.contacts.create(props);
     },
     group: async ({
       traits,
@@ -218,18 +161,6 @@ export const useTracking = (
     }: GroupProps) => {
       if (isDev || isTest(userId || anonymousId || '', groupId)) return;
 
-      // upsert intercom company
-      const intercomCompanyId = (
-        await intercom?.companies.create(
-          {
-            name: groupId,
-            company_id: groupId,
-            remote_created_at: timestamp ? timestamp.getTime() : Date.now(),
-          },
-          traits
-        )
-      )?.id;
-
       if (anonymousId) {
         posthog?.groupIdentify({
           groupKey: groupId,
@@ -252,28 +183,12 @@ export const useTracking = (
         june?.group({ userId, groupId, traits, timestamp }, (err) =>
           err ? console.error(err) : {}
         );
-
-        // attach user to intercom company
-        const intercomUserId = (
-          await intercom?.contacts.search({
-            query: {
-              field: 'external_id',
-              operator: Intercom.SingleFilterSearchRequestOperator.Equals,
-              value: userId,
-            },
-          })
-        )?.data.at(0)?.id;
-        if (intercomUserId && intercomCompanyId)
-          intercom?.companies.attachContact(intercomUserId, {
-            id: intercomCompanyId,
-          });
       }
     },
     shutdown: async () =>
       Promise.all([posthog?.shutdown(), june?.closeAndFlush(), log?.flush()]),
     // export dependencies
     intercom,
-    _intercom,
     posthog,
     june,
     log,

package/src/tracking/types.ts

@@ -1,3 +1,5 @@
+import type { LogBindings } from '../log';
+
 type AuthEvent =
   | 'account_signin_completed'
   | 'account_signup_code_requested'
@@ -95,3 +97,181 @@ export type TrackingEvent =
   | ListingEvent
   | ReportEvent
   | TestEvent;
+
+type IntercomContactCustomAttributes = {
+  article_id?: string; // undefined
+  workflowInstanceId?: number; // undefined
+  Onboarding_Support?: string; // The customer's preferred onboarding level
+  Active_Listings?: string; // The number of active listings a user has
+  Accounting_Software?: string; // The client's accounting software
+  userType?: string; // User Type (user or owner)
+};
+export type IntercomContactAttributes = {
+  role?: string; // A person's role in their company, such as the name of their department
+  name?: string; // A person's full name
+  owner_id?: number; // The teammate that owns a lead or user in Intercom
+  email?: string; // The email address assigned to a user or lead
+  email_domain?: string; // The email domain of a user or lead
+  phone?: string; // A person's phone number
+  external_id?: string; // A number identifying a person (applies to both users and leads)
+  created_at?: Date; // The first day a person visited your site or app
+  signed_up_at?: Date; // The day a person first signed up for your product
+  last_seen_at?: Date; // The last day a person visited your site or app
+  last_contacted_at?: Date; // The last day you or a teammate contacted a person
+  last_replied_at?: Date; // The last day a person contacted you via a message or email
+  last_email_opened_at?: Date; // The last day a person opened an email
+  last_email_clicked_at?: Date; // The last day a person clicked on a link in an email
+  location?: {
+    country?: string; // The country a person is in (or their IP address location)
+    region?: string; // A subdivision of a country, such as a state, province or territory
+    city?: string; // The city a person is in (or their IP address location)
+  };
+  browser_language?: string; // The language set by the browser a person is using
+  language_override?: string; // A preferred language setting for a person, used by the Intercom Messenger even if their browser settings change
+  browser?: string; // The browser a person is using
+  browser_version?: string; // The precise version of the browser a person is using
+  os?: string; // The operating system a person is using
+  unsubscribed_from_emails?: boolean; // Has a person unsubscribed from emails from your team?
+  marked_email_as_spam?: boolean; // Has a person marked an email from your team as spam?
+  has_hard_bounced?: boolean; // Has an email sent from your team to a person bounced?
+  whatsapp_number?: string; // A person's WhatsApp number
+  phone_country?: string; // The ISO country code of the person's phone number
+  id?: string; // The Intercom defined id representing the user
+  avatar?: string; // An avatar image URL
+  updated_at?: Date; // The last time the user was updated
+  workspace_id?: string; // The Intercom defined id representing the workspace
+  android_app_name?: string; // The name of Android app a person is using
+  android_sdk_version?: string; // The version of the Android SDK a person is using
+  ios_app_name?: string; // The name of iOS app a person is using
+  ios_sdk_version?: string; // The version of the iOS SDK a person is using
+  custom_attributes?: IntercomContactCustomAttributes;
+};
+
+type IntercomCompanyCustomAttributes = {
+  firstName?: string; // undefined
+  lastName?: string; // undefined
+  email?: string; // undefined
+  teamId?: string; // undefined
+  team?: string; // undefined
+  type?: string; // undefined
+  status?: string; // undefined
+  'SaaS User'?: boolean; // undefined
+  pms?: string; // undefined
+  accountingSoftware?: string; // Accounting software used by the team.
+  creation_source?: string; // undefined
+  activeListings?: number; // Active Listings
+  partnerName?: string; // Partner Name
+  paymentMethodType?: string; // Payment Method
+  billingPortalUrl?: string; // Billing Portal URL
+  billingStatus?: string; // undefined
+  billingPartner?: string; // Name of billing partner
+  accountingPartner?: string; // Name of accounting partner
+  apps?: string; // All active connections besides pms/accounting
+};
+export type IntercomCompanyAttributes = {
+  name?: string; // The name of a company
+  company_id?: string; // A number identifying a company
+  last_request_at?: Date; // The last day anyone from a company visited your site or app
+  remote_created_at?: Date; // The day a company was added to Intercom
+  user_count?: number; // The number of people in a company
+  session_count?: number; // All visits from anyone in a company to your product's site or app
+  monthly_spend?: number; // The monthly revenue you receive from a company
+  size?: number; // The number of people employed in this company, expressed as a single number
+  industry?: string; // The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'
+  website?: string; // The web address for the company's primary marketing site
+  id?: string; // The Intercom defined id representing the company
+  created_at?: Date; // The time the company was added to Intercom
+  updated_at?: Date; // The last time the company was updated
+  plan?: {
+    id?: string; // The Intercom defined id representing the plan
+    name?: string; // A specific plan or level within your product that companies have signed up to
+  };
+  app_id?: string; // The Intercom defined id representing the app
+  custom_attributes?: IntercomCompanyCustomAttributes;
+};
+
+declare module 'intercom-client' {
+  export namespace Intercom {
+    interface UpdateContactRequest {
+      /** The role of the contact. */
+      role?: string;
+      /** 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?: IntercomContactCustomAttributes;
+    }
+    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?: IntercomCompanyCustomAttributes;
+      /** 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;
+    }
+  }
+}
+
+export type TrackingProps = {
+  name: string;
+  dataset: string;
+  env: {
+    INTERCOM_TOKEN?: string;
+    JUNESO_TOKEN?: string;
+    POSTHOG_TOKEN?: string;
+  } & LogBindings;
+  debugging?: boolean;
+};
+
+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;
+      }
+  );