@jitsu/protocols 1.7.2 → 1.9.0-canary.548.20240108170646

package/analytics.d.ts

@@ -4,6 +4,70 @@ export type ID = string | null | undefined;
 
 export type DataLayoutType = "segment" | "jitsu-legacy" | "segment-single-table" | "passthrough";
 
+export type WithConfidence<T> = T & {
+  //A value from 0-100 indicating how confident we are in the result
+  confidence?: number;
+};
+
+export type Geo = {
+  continent?: {
+    code: "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
+  };
+  country?: {
+    /**
+     * Two-letter country code (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+     */
+    code: string;
+    isEU: boolean;
+  };
+  region?: WithConfidence<{
+    /**
+     * Code of the region (ISO 3166-2): https://en.wikipedia.org/wiki/ISO_3166-2.
+     * For USA it's two-letter capitaluzed state code (such as NY)
+     */
+    code: string;
+  }>;
+  city?: WithConfidence<{
+    name: string;
+  }>;
+
+  postalCode?: WithConfidence<{
+    code: string;
+  }>;
+
+  location?: {
+    latitude: number;
+    longitude: number;
+    accuracyRadius?: number;
+    /**
+     * Only for USA locations
+     */
+    usaData?: {
+      populationDensity?: number;
+      metroCode?: number;
+      averageIncome?: number;
+    };
+  };
+  provider?: {
+    /**
+     * Autonomous system number
+     */
+    as?: {
+      num?: number;
+      name?: string;
+    };
+    connectionType?: string;
+    domain?: string;
+    isAnonymousVpn?: boolean;
+    isHostingProvider?: boolean;
+    isLegitimateProxy?: boolean;
+    isPublicProxy?: boolean;
+    isResidentialProxy?: boolean;
+    isTorExitNode?: boolean;
+    userType?: string;
+    isp?: string;
+  };
+};
 /**
  * Event coming from client library
  */
@@ -43,7 +107,7 @@ export type ServerContextReservedProps = {
   //if request came server-to-server, then it's an IP of a server
   //for device events it will be an IP of a device
   //don't use this field in functions, use context.ip instead
-  request_ip?: string;
+  requestIp?: string;
   receivedAt?: ISO8601Date;
   sentAt?: ISO8601Date;
   timestamp?: ISO8601Date;
@@ -63,7 +127,7 @@ interface ProcessingContext {
 
 export type AnalyticsServerEvent = AnalyticsClientEvent & ServerContext & ProcessingContext;
 
-export type JSONPrimitive = string | number | boolean | null;
+export type JSONPrimitive = string | number | boolean | null | undefined;
 export type JSONValue = JSONPrimitive | JSONObject | JSONArray;
 export type JSONObject = { [member: string]: JSONValue };
 export type JSONArray = Array<JSONValue>;
@@ -108,7 +172,7 @@ export type PageReservedProps = {
 interface AnalyticsContext {
   /**
    * IP address of the originating request. If event is sent from a device, then it's an IP of a device
-   * (copied from request_ip)
+   * (copied from requestIp)
    * If request is sent from server-to-server, this field is not automatically populated
    * and should be filled manually
    */
@@ -126,6 +190,8 @@ interface AnalyticsContext {
   library?: {
     name: string;
     version: string;
+    //allow to add custom fields
+    [key: string]: any;
   };
 
   traits?: { crossDomainId?: string } & JSONObject;
@@ -154,7 +220,7 @@ interface AnalyticsContext {
     //Client ID of GA4 property
     ga4?: {
       clientId: string;
-      sessions?: Record<string, string>;
+      sessionIds?: any;
     };
     //from cookies: _fbc - Facebook click ID, _fbp - Facebook browser ID.
     //see https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters
@@ -162,6 +228,45 @@ interface AnalyticsContext {
     fbp?: string;
   };
 
+  geo?: Geo;
+
+  //mobile
+  app?: {
+    name: string;
+    version: string;
+    build?: string;
+    namespace?: string;
+    [key: string]: any;
+  };
+  device?: {
+    id?: string;
+    advertisingId?: string;
+    adTrackingEnabled?: boolean;
+    manufacturer?: string;
+    model?: string;
+    name?: string;
+    type?: string;
+    token?: string;
+    [key: string]: any;
+  };
+  network?: {
+    bluetooth?: boolean;
+    carrier?: string;
+    cellular?: boolean;
+    wifi?: boolean;
+    [key: string]: any;
+  };
+  os?: {
+    name: string;
+    version: string;
+  };
+  screen?: {
+    width: number;
+    height: number;
+    density?: number;
+    [key: string]: any;
+  };
+
   [key: string]: any;
 }
 

package/async-request.d.ts

@@ -1,5 +1,5 @@
 import { ISO8601Date } from "./iso8601";
-import type { Geo } from "./functions";
+import type { Geo } from "./analytics";
 
 export type IngestType = "s2s" | "browser";
 
@@ -9,7 +9,10 @@ export type IngestMessage = {
   messageCreated: ISO8601Date;
   writeKey: string;
   messageId: string;
+  //currently this not being filled
   connectionId: string;
+  //id of a stream where this message should eventually go. For debugging purposes so far
+  streamId?: string;
   type: string;
   origin: {
     baseUrl: string;

package/functions.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsServerEvent } from "./analytics";
+import { AnalyticsServerEvent, Geo } from "./analytics";
 
 /**
  * Store set options: ttl in seconds or string representation of duration (e.g. "1d")
@@ -15,6 +15,10 @@ export interface Store {
   ttl(key: string): Promise<number>;
 }
 
+export interface TTLStore extends Store {
+  getWithTTL(key: string): Promise<{ value: any; ttl: number } | undefined>;
+}
+
 /**
  * Store for incoming events, destination results and function log messages
  */
@@ -44,13 +48,14 @@ export type FetchOpts = {
   headers?: Record<string, string>;
   body?: string;
 };
+export type FunctionLogger = {
+  info: (message: string, ...args: any[]) => void;
+  warn: (message: string, ...args: any[]) => void;
+  debug: (message: string, ...args: any[]) => void;
+  error: (message: string, ...args: any[]) => void;
+};
 export type FunctionContext = {
-  log: {
-    info: (message: string, ...args: any[]) => void;
-    warn: (message: string, ...args: any[]) => void;
-    debug: (message: string, ...args: any[]) => void;
-    error: (message: string, ...args: any[]) => void;
-  };
+  log: FunctionLogger;
   fetch: FetchType;
   store: Store;
 };
@@ -81,74 +86,6 @@ export type AnonymousEventsStore = {
   evictEvents(collectionName: string, anonymousId: string): Promise<AnalyticsServerEvent[]>;
 };
 
-export type WithConfidence<T> = T & {
-  //A value from 0-100 indicating how confident we are in the result
-  confidence?: number;
-};
-
-export type Geo = {
-  /**
-   * IP address of the incoming request
-   */
-  continent?: {
-    code: "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
-  };
-  country?: {
-    /**
-     * Two-letter country code (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
-     */
-    code: string;
-    isEU: boolean;
-  };
-  region?: WithConfidence<{
-    /**
-     * Code of the region (ISO 3166-2): https://en.wikipedia.org/wiki/ISO_3166-2.
-     * For USA it's two-letter capitaluzed state code (such as NY)
-     */
-    code: string;
-  }>;
-  city?: WithConfidence<{
-    name: string;
-  }>;
-
-  postalCode?: WithConfidence<{
-    code: string;
-  }>;
-
-  location?: {
-    latitude: number;
-    longitude: number;
-    accuracyRadius?: number;
-    /**
-     * Only for USA locations
-     */
-    usaData?: {
-      populationDensity?: number;
-      metroCode?: number;
-      averageIncome?: number;
-    };
-  };
-  provider?: {
-    /**
-     * Autonomous system number
-     */
-    as?: {
-      num: number;
-      name?: string;
-    };
-    connectionType?: string;
-    domain: string;
-    isAnonymousVpn?: boolean;
-    isHostingProvider?: boolean;
-    isLegitimateProxy?: boolean;
-    isPublicProxy?: boolean;
-    isResidentialProxy?: boolean;
-    isTorExitNode?: boolean;
-    userType?: string;
-    isp?: string;
-  };
-};
-
 export type UserAgent = {
   browser: {
     name: string;
@@ -193,12 +130,14 @@ export type EventContext = {
   source: {
     id: string;
     name?: string;
+    //if request was sent from browser or server-to-server api
+    type: "browser" | "s2s";
     domain?: string;
   };
   destination: {
     id: string;
     type: string;
-    updatedAt: Date;
+    updatedAt?: Date;
     hash: string;
   };
   connection: {

package/package.json

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