@jitsu/protocols 1.9.9 → 1.9.11

package/analytics.d.ts

@@ -189,7 +189,7 @@ interface AnalyticsContext {
 
   locale?: string;
 
-  library?: {
+  xlibrary?: {
     name: string;
     version: string;
     //allow to add custom fields
@@ -316,6 +316,8 @@ export type RuntimeFacade = {
   pageTitle(): string | undefined;
 };
 
+export type ErrorHandler = (message: string, ...args: any[]) => void;
+
 export type JitsuOptions = {
   /**
    * API Key. Optional. If not set, Jitsu will send event to the server without auth, and server
@@ -372,6 +374,11 @@ export type JitsuOptions = {
    */
   idEndpoint?: string;
 
+  /**
+   * What to do with errors. It can log it, rethrow or run a custom handler. Default value: "log"
+   */
+  errorPolicy?: ErrorHandler | "rethrow" | "log";
+
   privacy?: {
     dontSend?: boolean;
     disableUserIds?: boolean;
@@ -382,6 +389,17 @@ export type JitsuOptions = {
 
 export type DynamicJitsuOptions = Pick<JitsuOptions, "privacy" | "debug" | "echoEvents">;
 
+export type Traits = {
+  [key: string]: JSONValue;
+  //some traits, all starting with $, are reserved for signalling the behavior of the event
+
+  /**
+   * Tells Jitsu to process event, but not send it to server. Used for .identify() and .group() calls
+   * that are intended to update user/group state, but not send events
+   */
+  $doNotSend?: boolean;
+};
+
 export interface AnalyticsInterface {
   track(
     eventName: string | JSONObject,
@@ -400,12 +418,12 @@ export interface AnalyticsInterface {
 
   group(
     groupId?: ID | object,
-    traits?: JSONObject | null,
+    traits?: Traits | null,
     options?: Options,
     callback?: Callback
   ): Promise<DispatchedEvent>;
 
-  identify(id?: ID | object, traits?: JSONObject | Callback | null, callback?: Callback): Promise<DispatchedEvent>;
+  identify(id?: ID | Traits, traits?: Traits | Callback | null, callback?: Callback): Promise<DispatchedEvent>;
 
   reset(callback?: (...params: any[]) => any): Promise<any>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jitsu/protocols",
-  "version": "1.9.9",
+  "version": "1.9.11",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "publishConfig": {

package/profile.d.ts

@@ -2,15 +2,24 @@ import { FunctionContext } from "./functions";
 import { AnalyticsServerEvent } from "./analytics";
 
 export type ProfileResult = {
-  properties: Record<string, any>;
+  traits: Record<string, any>;
+};
+
+export type ProfileUser = {
+  id?: string;
+  anonymousId?: string;
+  traits: Record<string, any>;
+};
+
+export type ProfileBuilderContext = {
+  profileBuilder: {
+    id: string;
+    version: number;
+  };
 };
 
 export type ProfileFunction = (
   events: Iterable<AnalyticsServerEvent>,
-  user: {
-    id?: string;
-    anonymousId?: string;
-    traits: Record<string, any>;
-  },
-  context: FunctionContext
+  user: ProfileUser,
+  context: FunctionContext & ProfileBuilderContext
 ) => Promise<ProfileResult | undefined>;