@jitsu/protocols 1.9.10 → 1.9.12

package/analytics.d.ts

@@ -12,12 +12,19 @@ export type WithConfidence<T> = T & {
 export type Geo = {
   continent?: {
     code: "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
+    /**
+     * Localized name of the continent
+     */
+    name: string;
   };
   country?: {
     /**
      * Two-letter country code (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
      */
     code: string;
+    /**
+     * Localized name of the country
+     */
     name: string;
     isEU: boolean;
   };
@@ -27,8 +34,15 @@ export type Geo = {
      * For USA it's two-letter capitaluzed state code (such as NY)
      */
     code: string;
+    /**
+     * Localized name of the region
+     */
+    name: string;
   }>;
   city?: WithConfidence<{
+    /**
+     * Localized name of the city
+     */
     name: string;
   }>;
 
@@ -189,7 +203,7 @@ interface AnalyticsContext {
 
   locale?: string;
 
-  library?: {
+  xlibrary?: {
     name: string;
     version: string;
     //allow to add custom fields
@@ -316,6 +330,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
@@ -330,12 +346,29 @@ export type JitsuOptions = {
    * To enable debug logging
    */
   debug?: boolean;
+  /**
+   * Default payload context to be included in all requests.
+   * These attributes are merged with the request-specific payload context,
+   * allowing common or global data (e.g., browser timezone, some extra user identifier)
+   * to be automatically included to every request.
+   *
+   * The context can be a nested structure.
+   */
+  defaultPayloadContext?: Record<string, JSONValue>;
   /**
    * Explicitly specify cookie domain. If not set, cookie domain will be set to top level
    * of the current domain. Example: if JS lives on "app.example.com", cookie domain will be
    * set to ".example.com". If it lives on "example.com", cookie domain will be set to ".example.com" too
    */
   cookieDomain?: string;
+  /**
+   * Additional cookies to capture, where the keys are cookie names and
+   * the values are the corresponding cookie values. By default, the following cookies are captured:
+   * - Facebook: `_fbc`, `_fbp`
+   * - Google Analytics 4: GA4 client ID
+   * This property allows you to capture additional cookies beyond the defaults.
+   */
+  cookieCapture?: Record<string, string>;
   /**
    * Provide fetch implementation. It is required if you want to use Jitsu in NodeJS
    */
@@ -372,6 +405,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 +420,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 +449,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.10",
+  "version": "1.9.12",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "publishConfig": {