@jitsu/protocols 1.3.2 → 1.6.1

package/analytics.d.ts

@@ -152,8 +152,14 @@ interface AnalyticsContext {
    */
   clientIds?: {
     //Client ID of GA4 property
-    ga4?: string;
-    [key: string]: string;
+    ga4?: {
+      clientId: string;
+      sessions?: Record<string, string>;
+    };
+    //from cookies: _fbc - Facebook click ID, _fbp - Facebook browser ID.
+    //see https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters
+    fbc?: string;
+    fbp?: string;
   };
 
   [key: string]: any;

package/functions.d.ts

@@ -1,6 +1,9 @@
 import { AnalyticsServerEvent } from "./analytics";
 
-export type SetOpts = { ttlMs?: number } | { ttlSec?: number };
+/**
+ * Store set options: ttl in seconds or string representation of duration (e.g. "1d")
+ */
+export type SetOpts = number | string | { ttl: number };
 
 /**
  * A key value store that exposed to a function
@@ -9,6 +12,7 @@ export interface Store {
   get(key: string): Promise<any>;
   del(key: string): Promise<void>;
   set(key: string, value: any, opts?: SetOpts): Promise<void>;
+  ttl(key: string): Promise<number>;
 }
 
 /**
@@ -77,15 +81,6 @@ export type AnonymousEventsStore = {
   evictEvents(collectionName: string, anonymousId: string): Promise<AnalyticsServerEvent[]>;
 };
 
-/**
- * Function execution context available for builin functions only
- */
-export type SystemContext = {
-  $system: {
-    anonymousEventsStore: AnonymousEventsStore;
-  };
-};
-
 export type WithConfidence<T> = T & {
   //A value from 0-100 indicating how confident we are in the result
   confidence?: number;
@@ -154,11 +149,40 @@ export type Geo = {
   };
 };
 
+export type UserAgent = {
+  browser: {
+    name: string;
+    version: string;
+    major: string; //@deprecated
+  };
+  engine: {
+    name: string;
+    version: string;
+  };
+  os: {
+    name: string;
+    version: string;
+  };
+  device: {
+    model: string;
+    type: "console" | "mobile" | "tablet" | "smarttv" | "wearable" | "embedded" | "desktop";
+    vendor: string;
+  };
+  cpu: {
+    architecture: string;
+  };
+  bot?: boolean;
+};
+
 export type EventContext = {
   /**
    * Geo data of incoming request
    */
   geo?: Geo;
+  /**
+   * Parsed User Agent of incoming request
+   */
+  ua?: UserAgent;
   /**
    * Headers of incoming request
    */
@@ -166,18 +190,18 @@ export type EventContext = {
   /**
    * Source of the incoming event
    */
-  source?: {
+  source: {
     id: string;
     name?: string;
     domain?: string;
   };
-  destination?: {
+  destination: {
     id: string;
     type: string;
     updatedAt: Date;
     hash: string;
   };
-  connection?: {
+  connection: {
     id: string;
     mode?: string;
     options?: any;
@@ -193,10 +217,7 @@ export type FunctionConfigContext<P extends AnyProps = AnyProps> = {
 /**
  * Parameters for a function
  */
-export type FullContext<P extends AnyProps = AnyProps> = EventContext &
-  FunctionContext &
-  FunctionConfigContext<P> &
-  (SystemContext | {});
+export type FullContext<P extends AnyProps = AnyProps> = EventContext & FunctionContext & FunctionConfigContext<P>;
 
 //equivalent to returning [] from a function
 export type FunctionCommand = "drop";

package/package.json

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