@jitsu/protocols 1.1.0-canary.227.20230222142636 → 1.3.0-canary.231.20230920071611

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jitsu Labs, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/analytics.d.ts

@@ -2,7 +2,7 @@ import { ISO8601Date } from "./iso8601.d";
 
 export type ID = string | null | undefined;
 
-export type DataLayoutType = "segment" | "jitsu-legacy" | "segment-single-table";
+export type DataLayoutType = "segment" | "jitsu-legacy" | "segment-single-table" | "passthrough";
 
 /**
  * Event coming from client library
@@ -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,11 @@
 import { ISO8601Date } from "./iso8601";
+import { Geo } from "./functions";
+
+export type IngestType = "s2s" | "browser";
 
 export type IngestMessage = {
+  geo?: Geo;
+  ingestType: IngestType;
   messageCreated: ISO8601Date;
   writeKey: string;
   messageId: string;

package/functions.d.ts

@@ -1,14 +1,22 @@
+import { AnalyticsServerEvent } from "./analytics";
+
 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(connectionId: string, error: boolean, msg: Record<string, any>): void;
+}
 /**
  * A special properties that user can set on an event to define how
  * event will be processed further
@@ -35,17 +43,125 @@ export type FetchOpts = {
   headers?: Record<string, string>;
   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 PrivacyOpts = {
+  /**
+   * IP address processing mode
+   * "keep" means that the IP address will be kept as is
+   * "reduce" means that the IP address will be reduced to the first 3 octets
+   * "hash" means that the IP address will be hashed with SHA256 (not implemented yet)
+   *
+   * "reduce" is the default behavior
+   */
+  ip?: "reduce" | "keep" | "hash";
+  /**
+   * Replaces cookie based anonymous ID with a fingerprint hash
+   * "hash1" means that anyonymous ID will be replaced with hash(ip + user_agent)
+   */
+  anonymousId?: "hash1" | "keep" | ((opts: { ip: string; ip3octets: string; userAgent: string }) => string);
+};
+
+export type CoreLib = {
+  privacy(event: AnalyticsServerEvent, opts?: PrivacyOpts): AnalyticsServerEvent;
+};
+
+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 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 EventContext = {
+  /**
+   * Geo data of incoming request
+   */
+  geo?: Geo;
   /**
    * Headers of incoming request
    */
@@ -61,6 +177,13 @@ export type EventContext = {
   destination?: {
     id: string;
     type: string;
+    updatedAt: Date;
+    hash: string;
+  };
+  connection?: {
+    id: string;
+    mode?: string;
+    options?: any;
   };
 };
 
@@ -71,15 +194,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 type FuncReturn = AnyEvent[] | AnyEvent | null | undefined | FunctionCommand | false;
 
 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 +217,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.227.20230222142636",
+  "version": "1.3.0-canary.231.20230920071611",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "publishConfig": {
@@ -9,6 +9,5 @@
   "license": "MIT",
   "private": false,
   "devDependencies": {},
-  "dependencies": {},
   "scripts": {}
 }

package/.pnpm-debug.log

@@ -1,24 +0,0 @@
-{
-  "0 debug pnpm:scope": {
-    "selected": 1,
-    "workspacePrefix": "/Users/ildarnurislamov/Projects/onetag"
-  },
-  "1 info pnpm": {
-    "err": {
-      "name": "Error",
-      "message": "not found: build",
-      "code": "ENOENT",
-      "stack": "Error: not found: build\n    at getNotFoundError (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:41714:51)\n    at Function.whichSync [as sync] (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:41791:13)\n    at getCommandAbsolutePathSync (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:43356:44)\n    at default_1 (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:43365:32)\n    at /opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:178485:39"
-    }
-  },
-  "2 error pnpm": {
-    "code": "ERR_PNPM_RECURSIVE_EXEC_FIRST_FAIL",
-    "prefix": "/Users/ildarnurislamov/Projects/onetag/types/jitsu",
-    "err": {
-      "name": "pnpm",
-      "message": "not found: build",
-      "code": "ERR_PNPM_RECURSIVE_EXEC_FIRST_FAIL",
-      "stack": "Error: not found: build\n    at getNotFoundError (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:41714:51)\n    at Function.whichSync [as sync] (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:41791:13)\n    at getCommandAbsolutePathSync (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:43356:44)\n    at default_1 (/opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:43365:32)\n    at /opt/homebrew/lib/node_modules/pnpm/dist/pnpm.cjs:178485:39"
-    }
-  }
-}