@usermaven/sdk-js 1.0.0 → 1.0.4

package/dist/npm/usermaven.d.ts

@@ -27,7 +27,7 @@ export type UsermavenClient = {
   rawTrack: (payload: any) => void
 
   /**
-   * Sets a user data
+   * Sets a user data including organization/company data
    * @param userData user data (as map id_type --> value, such as "email": "a@bcd.com"
    * @param doNotSendEvent if true (false by default), separate "id" event won't be sent to server
    * @return Promise, see _send3p documentation
@@ -59,7 +59,6 @@ export type UsermavenClient = {
    * User
    */
   unset(propertyName: string, opts: { eventType?: string, persist?: boolean });
-
 }
 
 /**
@@ -88,6 +87,11 @@ export type Policy = 'strict' | 'keep' | 'comply'
  */
 export type UsermavenOptions = {
 
+  /**
+   * If auto-capturing is enabled on all sort of events | for future work
+   */
+  autocapture?: boolean,
+
   /**
    * If Usermaven should work in compatibility mode. If set to true:
    *  - event_type will be set to 'eventn' instead of 'usermaven'
@@ -182,9 +186,37 @@ export type UsermavenOptions = {
    */
   log_level?: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'NONE';
 
+  /**
+   * Type of persistence required
+   * Possible values: cookie | localStorage | localStorage+cookie | memory
+   * Default value: cookie
+   */
+   persistence?: PersistenceType;
+
+  /**
+   * Persistent connection name
+   */
+   persistence_name?: string;
+
+  /**
+   * Persistent connection version
+   */
+  project_id?: string;
+
   //NOTE: If any property is added here, please make sure it's added to browser.ts usermavenProps as well
+  
 };
 
+/**
+ * Company Attributes
+ */
+export interface CompanyProps {
+  id: string; // Company ID
+  name: string; // Company Name
+  created_at: string; // Company creation date
+  custom: any; // Optional attributes such as industry, website, employee count etc.
+}
+
 /**
  * User properties (ids).
  */
@@ -193,6 +225,7 @@ export interface UserProps {
   id?: string                       //user id (non anonymous). If not set, first known id (from propName below) will be used
   email?: string                    //user id (non anonymous). If not set, first known id (from propName below) will be used
   [propName: string]: any           //any other forms of ids
+  company?: CompanyProps
 }
 
 /**
@@ -221,6 +254,7 @@ export type Conversion = {
 export type EventCtx = {
   event_id: string                 //unique event id or empty string for generating id on the backend side
   user: UserProps                  //user properties
+  company?: CompanyProps           //company properties
   ids?: ThirdpartyIds              //user ids from external systems
   user_agent: string               //user
   utc_time: string                 //current UTC time in ISO 8601
@@ -228,7 +262,7 @@ export type EventCtx = {
   referer: string                  //document referer
   url: string                      //current url
   page_title: string               //page title
-                                   //see UTM_TYPES for all supported utm tags
+  //see UTM_TYPES for all supported utm tags
   doc_path: string                 //document path
   doc_host: string                 //document host
   doc_search: string               //document search string
@@ -258,9 +292,9 @@ export type Transport = (url: string, jsonPayload: string) => Promise<void>
  * Type of event source
  */
 export type EventSrc =
-  'jitsu'    |                     //event came directly from Usermaven
-  'eventn'   |                     //same as usermaven but for 'compat' mode, see
-  'ga'       |                     //event is intercepted from GA
+  'usermaven' |                     //event came directly from Usermaven
+  'eventn' |                     //same as usermaven but for 'compat' mode, see
+  'ga' |                     //event is intercepted from GA
   '3rdparty' |                     //event is intercepted from 3rdparty source
   'ajs';                           //event is intercepted from analytics.js
 
@@ -287,3 +321,4 @@ export type EventCompat = EventBasics & {
   eventn_ctx: EventCtx
 } & EventPayload;
 
+export type PersistenceType = 'cookie' | 'localStorage' | 'localStorage+cookie' | 'memory';