@jitsu/protocols 1.3.1-canary.300.20231019141252 → 1.3.1-canary.300.20231019144955

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
-@jitsu/protocols:build: cache hit, replaying output 22b3d5af05e43d81
+@jitsu/protocols:build: cache hit, replaying output 289e72e4051edeb2
 @jitsu/protocols:build: 
 @jitsu/protocols:build: > @jitsu/protocols@0.0.0 build /Users/ildarnurislamov/Projects/newjitsu/types/protocols
 @jitsu/protocols:build: > tsc -p .

package/.turbo/turbo-clean.log

@@ -1,4 +1,4 @@
-@jitsu/protocols:clean: cache hit, replaying output af92744365495cf5
+@jitsu/protocols:clean: cache hit, replaying output bb5c3df4b389eb97
 @jitsu/protocols:clean: 
 @jitsu/protocols:clean: > @jitsu/protocols@0.0.0 clean /Users/ildarnurislamov/Projects/newjitsu/types/protocols
 @jitsu/protocols:clean: > rm -rf ./dist

package/dist/functions.d.ts

@@ -0,0 +1,202 @@
+import { AnalyticsServerEvent } from "./analytics";
+export type SetOpts = {
+    ttlMs?: number;
+} | {
+    ttlSec?: number;
+};
+/**
+ * A key value store that exposed to a function
+ */
+export 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
+ */
+export 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
+ */
+export type EventControlOpts = {
+    /**
+     * Table name to store event in. Non-SQL destinations might ignore this property
+     */
+    JITSU_TABLE_NAME?: string;
+};
+export type AnyEvent = Record<string, any> & EventControlOpts;
+export type AnyProps = Record<string, any>;
+export type FetchResponse = Response;
+export type FetchType = (url: string, opts?: FetchOpts, logToRedis?: boolean) => Promise<FetchResponse>;
+export type FetchOpts = {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string;
+};
+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: FetchType;
+    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 & {
+    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
+     */
+    headers: Record<string, string>;
+    /**
+     * Source of the incoming event
+     */
+    source?: {
+        id: string;
+        name?: string;
+        domain?: string;
+    };
+    destination?: {
+        id: string;
+        type: string;
+        updatedAt: Date;
+        hash: string;
+    };
+    connection?: {
+        id: string;
+        mode?: string;
+        options?: any;
+    };
+    retries?: number;
+};
+export type FunctionConfigContext<P extends AnyProps = AnyProps> = {
+    props: P;
+};
+/**
+ * Parameters for a function
+ */
+export type FullContext<P extends AnyProps = AnyProps> = EventContext & FunctionContext & FunctionConfigContext<P> & (SystemContext | {});
+export type FunctionCommand = "drop";
+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;
+    displayName?: string;
+    configSchema?: any;
+    description?: any;
+}
+export type BuiltinFunctionName<T extends string = string> = `builtin.${T}`;
+export type BuiltinDestinationFunctionName = BuiltinFunctionName<`destination.${string}`>;
+export type BuiltinTransformationFunctionName = BuiltinFunctionName<`transformation.${string}`>;
+export declare const DropRetryErrorName = "Drop & RetryError";
+export declare const RetryErrorName = "RetryError";
+export declare class RetryError extends Error {
+    constructor(message?: any, options?: {
+        drop: boolean;
+    });
+}

package/dist/functions.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetryError = exports.RetryErrorName = exports.DropRetryErrorName = void 0;
+exports.DropRetryErrorName = "Drop & RetryError";
+exports.RetryErrorName = "RetryError";
+class RetryError extends Error {
+    constructor(message, options) {
+        super(message);
+        this.name = (options === null || options === void 0 ? void 0 : options.drop) ? `${exports.DropRetryErrorName}` : `${exports.RetryErrorName}`;
+    }
+}
+exports.RetryError = RetryError;

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@jitsu/protocols",
-  "version": "1.3.1-canary.300.20231019141252",
+  "version": "1.3.1-canary.300.20231019144955",
   "description": "",
+  "main": "dist/functions.js",
+  "module": "dist/functions.js",
+  "types": "dist/functions.d.ts",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "publishConfig": {
     "access": "public"

package/tsconfig.json

@@ -7,7 +7,6 @@
     "target": "ES2019",
     "module": "commonjs",
     "lib": ["ES2019", "dom"],
-    "noEmit": true
   },
   "exclude": [
     "__tests__",