@jitsu/protocols 1.2.0 → 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

package/async-request.d.ts

@@ -1,8 +1,10 @@
 import { ISO8601Date } from "./iso8601";
+import { Geo } from "./functions";
 
 export type IngestType = "s2s" | "browser";
 
 export type IngestMessage = {
+  geo?: Geo;
   ingestType: IngestType;
   messageCreated: ISO8601Date;
   writeKey: string;

package/functions.d.ts

@@ -1,5 +1,4 @@
 import { AnalyticsServerEvent } from "./analytics";
-import { RequestOptions } from "http";
 
 export type SetOpts = { ttlMs?: number } | { ttlSec?: number };
 
@@ -16,9 +15,8 @@ interface Store {
  * Store for incoming events, destination results and function log messages
  */
 interface EventsStore {
-  log(error: boolean, msg: Record<string, any>): Promise<void>;
+  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
@@ -43,7 +41,6 @@ export type FetchResponse = {
 export type FetchOpts = {
   method?: string;
   headers?: Record<string, string>;
-  agent?: RequestOptions["agent"] | ((parsedUrl: URL) => RequestOptions["agent"]);
   body?: string;
 };
 export type FunctionContext = {
@@ -57,6 +54,27 @@ export type FunctionContext = {
   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[]>;
@@ -71,7 +89,79 @@ export type SystemContext = {
   };
 };
 
+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
    */
@@ -112,7 +202,7 @@ export type FullContext<P extends AnyProps = AnyProps> = EventContext &
 //equivalent to returning [] from a function
 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: FullContext<P>): Promise<FuncReturn> | FuncReturn;

package/package.json

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