@jitsu/protocols 1.9.0-canary.581.20240115194116 → 1.9.0

package/functions.d.ts

@@ -37,12 +37,6 @@ export interface TTLStore extends Store {
   getWithTTL(key: string): Promise<{ value: any; ttl: number } | undefined>;
 }
 
-/**
- * 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
@@ -59,24 +53,24 @@ export type AnyProps = Record<string, any>;
 
 export type FetchResponse = Response;
 
-export type FetchType = (url: string, opts?: FetchOpts, logToRedis?: boolean) => Promise<FetchResponse>;
+export type FetchType = (url: string, opts?: FetchOpts, extras?: any) => Promise<FetchResponse>;
 
 export type FetchOpts = {
   method?: string;
   headers?: Record<string, string>;
-  body?: string;
+  body?: string | Buffer;
 };
-export type FunctionLogger = {
-  info: (message: string, ...args: any[]) => void;
-  warn: (message: string, ...args: any[]) => void;
-  debug: (message: string, ...args: any[]) => void;
-  error: (message: string, ...args: any[]) => void;
+export type FunctionLogger<Sync extends boolean = false> = {
+  info: (message: string, ...args: any[]) => void | Promise<void>;
+  warn: (message: string, ...args: any[]) => void | Promise<void>;
+  debug: (message: string, ...args: any[]) => void | Promise<void>;
+  error: (message: string, ...args: any[]) => void | Promise<void>;
 };
 export type FunctionContext = {
   log: FunctionLogger;
   fetch: FetchType;
-  store: Store;
-  metrics: Metrics;
+  store: TTLStore;
+  metrics?: Metrics;
 };
 
 export type PrivacyOpts = {
@@ -164,6 +158,9 @@ export type EventContext = {
     mode?: string;
     options?: any;
   };
+  workspace: {
+    id: string;
+  };
   // number of retries attempted
   retries?: number;
 };
@@ -182,6 +179,19 @@ export type FunctionCommand = "drop";
 
 export type FuncReturn = AnyEvent[] | AnyEvent | null | undefined | FunctionCommand | false;
 
+export type SyncFunction<
+  Dest extends AnyProps = AnyProps,
+  Cred extends AnyProps = AnyProps,
+  SyncProps extends AnyProps = AnyProps
+> = (p: {
+  source: { package: string; credentials: Cred; syncProps: SyncProps };
+  destination: Dest;
+  ctx: {
+    log: FunctionLogger;
+    store: Store;
+  };
+}) => Promise<void>;
+
 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.9.0-canary.581.20240115194116",
+  "version": "1.9.0",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "publishConfig": {