@ginger-ai/ginger-js 0.0.1 → 0.0.3

package/src/client/index.ts

@@ -1,7 +1,8 @@
 import {
   trackInputs,
-  getTrackedFields,
-  removeListener,
+  trackingData,
+  removePageListener,
+  reset,
 } from "../behaviour";
 
 import { buildInitialPayload } from "../device";
@@ -23,10 +24,14 @@ import {
   BehaviourPayloadResponseData,
 } from "../core";
 
+type EventPayload = {
+  event: BehaviourPayload;
+};
+
 interface GingerClient {
   initialize(configs: Configurations): Promise<PayloadResponse | undefined>;
   trackEvent(params: BehaviourParams): void;
-  getTrackedData(): BehaviourPayload;
+  getTrackedData(): EventPayload;
   submitEvent(): Promise<BehaviourPayloadResponseData>;
 }
 
@@ -43,7 +48,7 @@ export class GingerJsClient implements GingerClient {
 
   async initialize() {
     try {
-      const sdkInfo = { name: '@ginger-ai/ginger-js', version: '0.0.1' };
+      const sdkInfo = { name: "@ginger-ai/ginger-js", version: "0.0.3" };
       const payload = await buildInitialPayload(this.requestId, sdkInfo);
       const response = await this.httpClient.post<Payload, PayloadResponse>({
         url: `/api/v1/devices`,
@@ -99,13 +104,15 @@ export class GingerJsClient implements GingerClient {
       );
     }
 
-    const trackData = getTrackedFields();
+    const trackData = trackingData();
 
     return {
-      event_type: this.trackDetails.event_type,
-      request_id: this.trackDetails.request_id,
-      fingerprint_id: this.trackDetails.fingerprint_id,
-      data: { ...trackData },
+      event: {
+        event_type: this.trackDetails.event_type,
+        request_id: this.trackDetails.request_id,
+        fingerprint_id: this.trackDetails.fingerprint_id,
+        data: { ...trackData },
+      },
     };
   };
 
@@ -117,11 +124,12 @@ export class GingerJsClient implements GingerClient {
 
     try {
       const response = await this.httpClient.post<
-        BehaviourPayload,
+        EventPayload,
         BehaviourPayloadResponse
       >({ url: `/api/v1/events`, payload });
 
-      removeListener();
+      removePageListener();
+      reset();
       return response.data;
     } catch (error) {
       throw new GingerClientError(

package/src/core/constants.ts

@@ -1,4 +1,4 @@
 export const CONSTANTS = {
     LIVE_URL: "https://app.getrayyan.com",
-    TEST_URL: "https://test.getrayyan.com"
+    TEST_URL: "https://api-sandbox.useginger.ai"
 }

package/src/core/dto/metrics.dto.ts

@@ -12,9 +12,15 @@ export interface FieldMetrics {
   started_at: number;
   ended_at: number;
   interaction_count: number;
-  fill_method: FillMethod;
+  characters_count: number;
   paste_count: number;
+  autofill_count: number;
   corrections_count: number;
   pauses: number;
-  pauseDurations: number[];
+  hesitation_time: number;
+  pause_durations: number[];
+  key_hold_times: number[];
+  modifier_key_count: number;
 }
+
+export type FocusMetrics = Record<string, number | null>

package/src/core/helpers.ts

@@ -4,7 +4,7 @@ import { GingerClientError } from "./util/error";
 export default function getBasePath(apikey: string) {
   if (apikey.includes("sk_live") || apikey.includes("pk_live"))
     return CONSTANTS.LIVE_URL;
-  
+
   return CONSTANTS.TEST_URL;
 }
 
@@ -21,9 +21,9 @@ export const pageVisibility = () => {
 
   return {
     getCount: () => leaveCount,
-    addListener: () =>
+    addPageListener: () =>
       document.addEventListener("visibilitychange", visibilityHandler),
-    removeListener: () =>
+    removePageListener: () =>
       document.removeEventListener("visibilitychange", visibilityHandler),
   };
 };
@@ -31,3 +31,43 @@ export const pageVisibility = () => {
 export const validatePresence = (key: string) => {
   if (!key) throw new GingerClientError("'apikey' must be provided.");
 };
+
+const getEncoderKey = (apikey: string): string => {
+  const last6 = apikey.slice(-6);
+  const secondCharacterAfterPrefix = apikey.split("_")[2]?.[1];
+  return last6 + secondCharacterAfterPrefix;
+};
+
+export const encode = (apikey: string, payload: unknown): string => {
+  try {
+    const key = getEncoderKey(apikey);
+    const data = JSON.stringify(payload);
+
+    let encoded = "";
+
+    for (let i = 0; i < data.length; i++) {
+      const keyChar = key.charCodeAt(i % key.length);
+      // eslint-disable-next-line no-bitwise
+      encoded += String.fromCharCode(data.charCodeAt(i) ^ keyChar);
+    }
+
+    return btoa(encoded);
+  } catch (error) {
+    throw new Error("Encoding failed");
+  }
+};
+
+export const decode = (apikey: string, encoded: string): unknown => {
+  const key = getEncoderKey(apikey);
+  const decoded = atob(encoded);
+
+  let result = "";
+
+  for (let i = 0; i < decoded.length; i++) {
+    const keyChar = key.charCodeAt(i % key.length);
+    // eslint-disable-next-line no-bitwise
+    result += String.fromCharCode(decoded.charCodeAt(i) ^ keyChar);
+  }
+
+  return JSON.parse(result);
+};

package/src/core/http/request.ts

@@ -1,3 +1,4 @@
+import { encode } from "../helpers";
 import { handleException } from "../util/error";
 
 type Method = "POST" | "GET" | "PUT" | "DELETE";
@@ -8,7 +9,6 @@ export const makeRequest = async <Request, Response>(
   method: Method,
   apikey: string
 ): Promise<Response> => {
-
   try {
     const response = await fetch(url, {
       method,
@@ -17,7 +17,7 @@ export const makeRequest = async <Request, Response>(
         Accept: "application/json",
         Authorization: `Bearer ${apikey}`,
       },
-      body: JSON.stringify(payload),
+      body: JSON.stringify(encode(apikey, payload)),
     });
 
     if (!response.ok) {