@jitsu/protocols 0.0.0

package/analytics.d.ts

@@ -0,0 +1,201 @@
+import { ISO8601Date } from "./iso8601.d";
+
+export type ID = string | null | undefined;
+
+export type DataLayoutType = "segment" | "jitsu-legacy" | "segment-single-table";
+
+/**
+ * Event coming from client library
+ */
+export interface AnalyticsClientEvent {
+  /**
+   * Unique message ID
+   */
+  messageId: string;
+  timestamp?: Date | ISO8601Date;
+  type: "track" | "page" | "identify" | "group" | "alias" | "screen";
+  // page specific
+  category?: string;
+  name?: string;
+
+  properties?: {
+    [k: string]: JSONValue;
+  };
+  /**
+   * Traits can be either here, or in context.traits (depending on a library)
+   */
+  traits?: JSONObject;
+
+  context: AnalyticsContext;
+
+  userId?: ID;
+  anonymousId?: ID;
+  groupId?: ID;
+  previousId?: ID;
+
+  event?: string;
+  writeKey?: string;
+  sentAt?: Date | ISO8601Date;
+}
+
+export type ServerContextReservedProps = {
+  request_ip?: string;
+  receivedAt?: ISO8601Date;
+  sentAt?: ISO8601Date;
+  timestamp?: ISO8601Date;
+  userId?: ISO8601Date;
+  type?: ISO8601Date;
+};
+/**
+ * A context of an event that is added on server-side
+ */
+export type ServerContext = ServerContextReservedProps & { [k: string]: any };
+
+interface ProcessingContext {
+  $table?: string;
+  [k: `$${string}`]: any;
+}
+
+export type AnalyticsServerEvent = AnalyticsClientEvent & ServerContext & ProcessingContext;
+
+export type JSONPrimitive = string | number | boolean | null;
+export type JSONValue = JSONPrimitive | JSONObject | JSONArray;
+export type JSONObject = { [member: string]: JSONValue };
+export type JSONArray = Array<JSONValue>;
+
+export type Integrations = {
+  All?: boolean;
+  [integration: string]: boolean | JSONObject | undefined;
+};
+
+export type Options = {
+  integrations?: Integrations;
+  anonymousId?: ID;
+  timestamp?: Date | string;
+  context?: AnalyticsContext;
+  traits?: JSONObject;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
+};
+
+type CompactMetricType = "g" | "c";
+
+export interface CompactMetric {
+  m: string; // metric name
+  v: number; // value
+  k: CompactMetricType;
+  t: string[]; // tags
+  e: number; // timestamp in unit milliseconds
+}
+
+export type PageReservedProps = {
+  path?: string;
+  referrer?: string;
+  host?: string;
+  referring_domain?: string;
+  search?: string;
+  title?: string;
+  url?: string;
+};
+
+interface AnalyticsContext {
+  /**
+   * Ip address of the originating request. Generally, shouldn't be set
+   * for client-side track calls.
+   */
+  ip?: string;
+
+  page?: PageReservedProps & { [key: string]: any };
+  metrics?: CompactMetric[];
+
+  userAgent?: string;
+
+  userAgentVendor?: string;
+
+  locale?: string;
+
+  library?: {
+    name: string;
+    version: string;
+  };
+
+  traits?: { crossDomainId?: string } & JSONObject;
+
+  campaign?: {
+    name?: string;
+    term?: string;
+    source?: string;
+    medium?: string;
+    content?: string;
+    [key: string]: any;
+  };
+
+  referrer?: {
+    btid?: string;
+    urid?: string;
+  };
+
+  amp?: {
+    id: string;
+  };
+
+  [key: string]: any;
+}
+
+export type Context = any;
+export type DispatchedEvent = Context;
+
+export type Callback = (ctx: Context | undefined) => Promise<unknown> | unknown;
+
+export interface AnalyticsInterface {
+  track(
+    eventName: string | JSONObject,
+    properties?: JSONObject | Callback,
+    options?: Options | Callback,
+    callback?: Callback
+  ): Promise<DispatchedEvent>;
+
+  page(
+    category?: string | object,
+    name?: string | object | Callback,
+    properties?: object | Options | Callback | null,
+    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>;
+
+  identify(id?: ID | object, traits?: JSONObject | Callback | null, callback?: Callback): Promise<DispatchedEvent>;
+
+  reset(callback?: (...params: any[]) => any): Promise<any>;
+
+  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,
+  //   properties?: JSONObject | Options | Callback | null,
+  //   options?: Options | Callback,
+  //   callback?: Callback
+  // ): Promise<DispatchedEvent>;
+}

package/async-request.d.ts

@@ -0,0 +1,16 @@
+import { ISO8601Date } from "./iso8601";
+
+export type IngestMessage = {
+  messageCreated: ISO8601Date;
+  writeKey: string;
+  messageId: string;
+  connectionId: string;
+  type: string;
+  origin: {
+    baseUrl: string;
+    slug?: string;
+    domain?: string;
+  };
+  httpHeaders: Record<string, string>;
+  httpPayload: any;
+};

package/functions.d.ts

@@ -0,0 +1,93 @@
+export type SetOpts = { ttlMs?: number } | { ttlSec?: number };
+
+/**
+ * A key value store that exposed to a function
+ */
+export type Store = {
+  get(key: string): Promise<any>;
+  del(key: string): Promise<void>;
+  set(key: string, value: any, opts?: SetOpts): Promise<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 = {
+  status: number;
+  statusText: string;
+  text: () => Promise<string>;
+  json: () => Promise<any>;
+};
+
+export type FetchOpts = {
+  method?: string;
+  headers?: Record<string, string>;
+  body?: string;
+};
+export type GlobalContext = {
+  log: {
+    info: (message: string, ...args: any[]) => void;
+    debug: (message: string, ...args: any[]) => void;
+    error: (message: string, ...args: any[]) => void;
+  };
+  fetch: (url: string, opts?: FetchOpts) => Promise<FetchResponse>;
+  store: Store;
+};
+
+export type EventContext = {
+  /**
+   * 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;
+  };
+};
+
+export type FunctionConfigContext<P extends AnyProps = AnyProps> = {
+  props: P;
+};
+
+/**
+ * Parameters for a function
+ */
+export type FunctionContext<P extends AnyProps = AnyProps> = EventContext & GlobalContext & FunctionConfigContext<P>;
+
+//equivalent to returning [] from a function
+export type FunctionCommand = "interrupt";
+
+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;
+
+  displayName?: string;
+  //for future use - config schema of the function
+  configSchema?: any;
+
+  //It's allowed to use basic JSX
+  description?: any;
+}
+
+export type BuiltinFunctionName<T extends string = string> = `builtin.${T}`;
+export type BuiltinDestinationFunctionName = BuiltinFunctionName<`destination.${string}`>;

package/iso8601.d.ts

@@ -0,0 +1,2 @@
+//TODO: add an actual type for ISO 8601 date
+export type ISO8601Date = string;

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@jitsu/protocols",
+  "version": "0.0.0",
+  "description": "",
+  "author": "Jitsu Dev Team <dev@jitsu.com>",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "private": false,
+  "devDependencies": {},
+  "dependencies": {},
+  "scripts": {}
+}