@jitsu/protocols 1.1.0-canary.212.20230220173912 → 1.2.0

package/analytics.d.ts

@@ -39,6 +39,10 @@ export interface AnalyticsClientEvent {
 }
 
 export type ServerContextReservedProps = {
+  //always filled with an IP from where request came from
+  //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;
   receivedAt?: ISO8601Date;
   sentAt?: ISO8601Date;
@@ -53,6 +57,7 @@ export type ServerContext = ServerContextReservedProps & { [k: string]: any };
 
 interface ProcessingContext {
   $table?: string;
+
   [k: `$${string}`]: any;
 }
 
@@ -70,6 +75,7 @@ export type Integrations = {
 
 export type Options = {
   integrations?: Integrations;
+  userId?: ID;
   anonymousId?: ID;
   timestamp?: Date | string;
   context?: AnalyticsContext;
@@ -101,8 +107,10 @@ export type PageReservedProps = {
 
 interface AnalyticsContext {
   /**
-   * Ip address of the originating request. Generally, shouldn't be set
-   * for client-side track calls.
+   * 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)
+   * If request is sent from server-to-server, this field is not automatically populated
+   * and should be filled manually
    */
   ip?: string;
 
@@ -163,13 +171,13 @@ export interface AnalyticsInterface {
     options?: Options | Callback,
     callback?: Callback
   ): Promise<DispatchedEvent>;
-  //Original Segment Identify, not supported yet, see a subset below
-  // identify(
-  //   id?: ID | object,
-  //   traits?: JSONObject | Callback | null,
-  //   options?: Options | Callback,
-  //   callback?: Callback,
-  // ): Promise<DispatchedEvent>;
+
+  group(
+    groupId?: ID | object,
+    traits?: JSONObject | null,
+    options?: Options,
+    callback?: Callback
+  ): Promise<DispatchedEvent>;
 
   identify(id?: ID | object, traits?: JSONObject | Callback | null, callback?: Callback): Promise<DispatchedEvent>;
 
@@ -177,20 +185,13 @@ export interface AnalyticsInterface {
 
   user(): any;
 
-  //TODO: user,reset
-
   // alias(
   //   to: string | number,
   //   from?: string | number | Options,
   //   options?: Options | Callback,
   //   callback?: Callback
   // ): Promise<DispatchedEvent>;
-  // group(
-  //   id?: ID | object,
-  //   traits?: JSONObject | Callback | null,
-  //   options?: Options | Callback,
-  //   callback?: Callback
-  // ): Promise<DispatchedEvent>;
+
   // screen(
   //   category?: string | object,
   //   name?: string | object | Callback,

package/async-request.d.ts

@@ -1,6 +1,9 @@
 import { ISO8601Date } from "./iso8601";
 
+export type IngestType = "s2s" | "browser";
+
 export type IngestMessage = {
+  ingestType: IngestType;
   messageCreated: ISO8601Date;
   writeKey: string;
   messageId: string;

package/functions.d.ts

@@ -1,13 +1,23 @@
+import { AnalyticsServerEvent } from "./analytics";
+import { RequestOptions } from "http";
+
 export type SetOpts = { ttlMs?: number } | { ttlSec?: number };
 
 /**
  * A key value store that exposed to a function
  */
-export type Store = {
+interface Store {
   get(key: string): Promise<any>;
   del(key: string): Promise<void>;
   set(key: string, value: any, opts?: SetOpts): Promise<void>;
-};
+}
+
+/**
+ * Store for incoming events, destination results and function log messages
+ */
+interface EventsStore {
+  log(error: boolean, msg: Record<string, any>): Promise<void>;
+}
 
 /**
  * A special properties that user can set on an event to define how
@@ -33,18 +43,34 @@ export type FetchResponse = {
 export type FetchOpts = {
   method?: string;
   headers?: Record<string, string>;
+  agent?: RequestOptions["agent"] | ((parsedUrl: URL) => RequestOptions["agent"]);
   body?: string;
 };
-export type GlobalContext = {
+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;
   };
-  fetch: (url: string, opts?: FetchOpts) => Promise<FetchResponse>;
+  fetch: (url: string, opts?: FetchOpts, logToRedis?: boolean) => Promise<FetchResponse>;
   store: Store;
 };
 
+export type AnonymousEventsStore = {
+  addEvent(collectionName: string, anonymousId: string, event: AnalyticsServerEvent, ttlDays: number): Promise<void>;
+  evictEvents(collectionName: string, anonymousId: string): Promise<AnalyticsServerEvent[]>;
+};
+
+/**
+ * Function execution context available for builin functions only
+ */
+export type SystemContext = {
+  $system: {
+    anonymousEventsStore: AnonymousEventsStore;
+  };
+};
+
 export type EventContext = {
   /**
    * Headers of incoming request
@@ -61,6 +87,13 @@ export type EventContext = {
   destination?: {
     id: string;
     type: string;
+    updatedAt: Date;
+    hash: string;
+  };
+  connection?: {
+    id: string;
+    mode?: string;
+    options?: any;
   };
 };
 
@@ -71,15 +104,18 @@ export type FunctionConfigContext<P extends AnyProps = AnyProps> = {
 /**
  * Parameters for a function
  */
-export type FunctionContext<P extends AnyProps = AnyProps> = EventContext & GlobalContext & FunctionConfigContext<P>;
+export type FullContext<P extends AnyProps = AnyProps> = EventContext &
+  FunctionContext &
+  FunctionConfigContext<P> &
+  (SystemContext | {});
 
 //equivalent to returning [] from a function
-export type FunctionCommand = "interrupt";
+export type FunctionCommand = "drop";
 
 export type FuncReturn = AnyEvent[] | AnyEvent | null | undefined | FunctionCommand;
 
 export interface JitsuFunction<E extends AnyEvent = AnyEvent, P extends AnyProps = AnyProps> {
-  (event: E, ctx: FunctionContext<P>): Promise<FuncReturn> | FuncReturn;
+  (event: E, ctx: FullContext<P>): Promise<FuncReturn> | FuncReturn;
 
   displayName?: string;
   //for future use - config schema of the function
@@ -91,3 +127,4 @@ export interface JitsuFunction<E extends AnyEvent = AnyEvent, P extends AnyProps
 
 export type BuiltinFunctionName<T extends string = string> = `builtin.${T}`;
 export type BuiltinDestinationFunctionName = BuiltinFunctionName<`destination.${string}`>;
+export type BuiltinTransformationFunctionName = BuiltinFunctionName<`transformation.${string}`>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jitsu/protocols",
-  "version": "1.1.0-canary.212.20230220173912",
+  "version": "1.2.0",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "publishConfig": {
@@ -9,6 +9,5 @@
   "license": "MIT",
   "private": false,
   "devDependencies": {},
-  "dependencies": {},
   "scripts": {}
 }