@codaco/analytics 2.0.0 → 2.1.1

package/.eslintrc.js

@@ -1,4 +1,4 @@
-module.exports = {
-  root: true,
-  extends: ["custom/next"],
-};
+module.exports = {
+  root: true,
+  extends: ["custom/next"],
+};

package/.turbo/turbo-build.log

@@ -1,16 +1,16 @@
 
-> @codaco/analytics@2.0.0 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
+> @codaco/analytics@2.0.0 build D:\Projects\Network Canvas\error-analytics-microservice\packages\analytics
 > tsup src/index.ts --format esm --dts --clean --sourcemap
 
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
-CLI Target: es2022
-CLI Cleaning output folder
-ESM Build start
-ESM dist/index.mjs     4.06 KB
-ESM dist/index.mjs.map 8.47 KB
-ESM ⚡️ Build success in 123ms
-DTS Build start
-DTS ⚡️ Build success in 776ms
-DTS dist/index.d.mts 1.48 KB
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.2.0
+CLI Target: es2022
+CLI Cleaning output folder
+ESM Build start
+ESM dist\index.mjs     4.06 KB
+ESM dist\index.mjs.map 8.81 KB
+ESM ⚡️ Build success in 17ms
+DTS Build start
+DTS ⚡️ Build success in 1007ms
+DTS dist\index.d.mts 1.38 KB

package/README.md

@@ -1,9 +1,9 @@
-# @codaco/analytics
-
-This npm package implements methods and types for sending analytics and errors from Fresco instances to a custom error and analytics microservice.
-
-It exports two functions:
-
-**createRouteHandler** - A function that creates a NextJs route handler which geolocates requests, and forwards the event payload to the microservice.
-
-**makeEventTracker** - A function that returns a `trackEvent` function, which attaches timestamp data to an event, and then calls the route handler.
+# @codaco/analytics
+
+This npm package implements methods and types for sending analytics and errors from Fresco instances to a custom error and analytics microservice.
+
+It exports two functions:
+
+**createRouteHandler** - A function that creates a NextJs route handler which geolocates requests, and forwards the event payload to the microservice.
+
+**makeEventTracker** - A function that returns a `trackEvent` function, which attaches timestamp data to an event, and then calls the route handler.

package/dist/index.d.mts

@@ -5,10 +5,10 @@ type GeoLocation = {
     countryCode: string;
 };
 type AnalyticsEventBase = {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
+    type: "DataExported" | "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
 };
 type AnalyticsEvent = AnalyticsEventBase & {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
+    type: "InterviewCompleted" | "DataExported" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
     metadata?: Record<string, unknown>;
 };
 type AnalyticsError = AnalyticsEventBase & {

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/utils.ts","../src/index.ts"],"sourcesContent":["// Helper function that ensures that a value is an Error\nexport function ensureError(value: unknown): Error {\n  if (!value) return new Error(\"No value was thrown\");\n\n  if (value instanceof Error) return value;\n\n  // Test if value inherits from Error\n  if (value.isPrototypeOf(Error)) return value as Error & typeof value;\n\n  let stringified = \"[Unable to stringify the thrown value]\";\n  try {\n    stringified = JSON.stringify(value);\n  } catch {}\n\n  const error = new Error(\n    `This value was thrown as is, not through an Error: ${stringified}`\n  );\n  return error;\n}\n\nexport function getBaseUrl() {\n  if (typeof window !== \"undefined\")\n    // browser should use relative path\n    return \"\";\n\n  if (process.env.VERCEL_URL)\n    // reference for vercel.com\n    return `https://${process.env.VERCEL_URL}`;\n\n  if (process.env.NEXT_PUBLIC_URL)\n    // Manually set deployment URL from env\n    return process.env.NEXT_PUBLIC_URL;\n\n  // assume localhost\n  return `http://127.0.0.1:3000`;\n}\n","import type { NextRequest } from \"next/server\";\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { ensureError, getBaseUrl } from \"./utils\";\n\ntype GeoLocation = {\n  countryCode: string;\n};\n\nexport type AnalyticsEventBase = {\n  type:\n    | \"InterviewCompleted\"\n    | \"InterviewStarted\"\n    | \"ProtocolInstalled\"\n    | \"AppSetup\"\n    | \"Error\";\n};\n\nexport type AnalyticsEvent = AnalyticsEventBase & {\n  type:\n    | \"InterviewCompleted\"\n    | \"InterviewStarted\"\n    | \"ProtocolInstalled\"\n    | \"AppSetup\";\n  metadata?: Record<string, unknown>;\n};\n\nexport type AnalyticsError = AnalyticsEventBase & {\n  type: \"Error\";\n  error: {\n    message: string;\n    details: string;\n    stacktrace: string;\n    path: string;\n  };\n};\n\nexport type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;\n\nexport type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {\n  timestamp: Date;\n};\n\nexport type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {\n  installationId: string;\n  geolocation?: GeoLocation;\n};\n\ntype RouteHandlerConfiguration = {\n  platformUrl?: string;\n  installationId: string;\n  maxMindClient: WebServiceClient;\n};\n\nexport const createRouteHandler = ({\n  platformUrl = \"https://analytics.networkcanvas.com\",\n  installationId,\n  maxMindClient,\n}: RouteHandlerConfiguration) => {\n  return async (request: NextRequest) => {\n    try {\n      const event =\n        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;\n\n      const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\n        res.text()\n      );\n\n      const { country } = await maxMindClient.country(ip);\n      const countryCode = country?.isoCode ?? \"Unknown\";\n\n      const dispatchableEvent: DispatchableAnalyticsEvent = {\n        ...event,\n        installationId,\n        geolocation: {\n          countryCode,\n        },\n      };\n\n      // Forward to microservice\n      const response = await fetch(`${platformUrl}/api/event`, {\n        keepalive: true,\n        method: \"POST\",\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n        body: JSON.stringify(dispatchableEvent),\n      });\n\n      if (!response.ok) {\n        if (response.status === 404) {\n          console.error(\n            `Analytics platform not found. Please specify a valid platform URL.`\n          );\n        } else if (response.status === 500) {\n          console.error(\n            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`\n          );\n        } else {\n          console.error(\n            `General error when forwarding event: ${response.statusText}`\n          );\n        }\n\n        return new Response(\n          JSON.stringify({ error: \"Internal Server Error\" }),\n          {\n            status: 500,\n            headers: {\n              \"Content-Type\": \"application/json\",\n            },\n          }\n        );\n      }\n\n      console.info(`🚀 Analytics event forwarded successfully.`);\n      console.info(JSON.stringify(dispatchableEvent, null, 2));\n\n      return new Response(\n        JSON.stringify({ message: \"Event forwarded successfully\" }),\n        {\n          status: 200,\n          headers: {\n            \"Content-Type\": \"application/json\",\n          },\n        }\n      );\n    } catch (e) {\n      const error = ensureError(e);\n      console.error(\"Error in route handler:\", error);\n\n      // Return an appropriate error response\n      return new Response(JSON.stringify({ error: \"Internal Server Error\" }), {\n        status: 500,\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n      });\n    }\n  };\n};\n\nexport const makeEventTracker =\n  (endpoint: string = \"/api/analytics\") =>\n  async (event: AnalyticsEventOrError) => {\n    const endpointWithHost = getBaseUrl() + endpoint;\n\n    const eventWithTimeStamp = {\n      ...event,\n      timestamp: new Date(),\n    };\n\n    try {\n      const response = await fetch(endpointWithHost, {\n        method: \"POST\",\n        keepalive: true,\n        body: JSON.stringify(eventWithTimeStamp),\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n      });\n\n      if (!response.ok) {\n        if (response.status === 404) {\n          console.error(\n            `Analytics endpoint not found, did you forget to add the route?`\n          );\n          return;\n        }\n\n        if (response.status === 500) {\n          console.error(\n            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`\n          );\n          return;\n        }\n\n        console.error(\n          `General error sending analytics event: ${response.statusText}`\n        );\n      }\n    } catch (e) {\n      const error = ensureError(e);\n\n      console.error(\"Internal error with analytics:\", error.message);\n    }\n  };\n"],"mappings":";AACO,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC;AAAO,WAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB;AAAO,WAAO;AAGnC,MAAI,MAAM,cAAc,KAAK;AAAG,WAAO;AAEvC,MAAI,cAAc;AAClB,MAAI;AACF,kBAAc,KAAK,UAAU,KAAK;AAAA,EACpC,QAAQ;AAAA,EAAC;AAET,QAAM,QAAQ,IAAI;AAAA,IAChB,sDAAsD,WAAW;AAAA,EACnE;AACA,SAAO;AACT;AAEO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW;AAEpB,WAAO;AAET,MAAI,QAAQ,IAAI;AAEd,WAAO,WAAW,QAAQ,IAAI,UAAU;AAE1C,MAAI,QAAQ,IAAI;AAEd,WAAO,QAAQ,IAAI;AAGrB,SAAO;AACT;;;ACkBO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,QACH,MAAM,QAAQ,KAAK;AAEtB,YAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,QAAK,CAAC,QACtD,IAAI,KAAK;AAAA,MACX;AAEA,YAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,YAAM,cAAc,SAAS,WAAW;AAExC,YAAM,oBAAgD;AAAA,QACpD,GAAG;AAAA,QACH;AAAA,QACA,aAAa;AAAA,UACX;AAAA,QACF;AAAA,MACF;AAGA,YAAM,WAAW,MAAM,MAAM,GAAG,WAAW,cAAc;AAAA,QACvD,WAAW;AAAA,QACX,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,iBAAiB;AAAA,MACxC,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AAChB,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF,WAAW,SAAS,WAAW,KAAK;AAClC,kBAAQ;AAAA,YACN,sEAAsE,SAAS,UAAU;AAAA,UAC3F;AAAA,QACF,OAAO;AACL,kBAAQ;AAAA,YACN,wCAAwC,SAAS,UAAU;AAAA,UAC7D;AAAA,QACF;AAEA,eAAO,IAAI;AAAA,UACT,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC;AAAA,UACjD;AAAA,YACE,QAAQ;AAAA,YACR,SAAS;AAAA,cACP,gBAAgB;AAAA,YAClB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,cAAQ,KAAK,mDAA4C;AACzD,cAAQ,KAAK,KAAK,UAAU,mBAAmB,MAAM,CAAC,CAAC;AAEvD,aAAO,IAAI;AAAA,QACT,KAAK,UAAU,EAAE,SAAS,+BAA+B,CAAC;AAAA,QAC1D;AAAA,UACE,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,UAClB;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,MAAM,2BAA2B,KAAK;AAG9C,aAAO,IAAI,SAAS,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC,GAAG;AAAA,QACtE,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,IAAM,mBACX,CAAC,WAAmB,qBACpB,OAAO,UAAiC;AACtC,QAAM,mBAAmB,WAAW,IAAI;AAExC,QAAM,qBAAqB;AAAA,IACzB,GAAG;AAAA,IACH,WAAW,oBAAI,KAAK;AAAA,EACtB;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,kBAAkB;AAAA,MAC7C,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,MACvC,SAAS;AAAA,QACP,gBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN;AAAA,QACF;AACA;AAAA,MACF;AAEA,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN,uDAAuD,SAAS,UAAU;AAAA,QAC5E;AACA;AAAA,MACF;AAEA,cAAQ;AAAA,QACN,0CAA0C,SAAS,UAAU;AAAA,MAC/D;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AACV,UAAM,QAAQ,YAAY,CAAC;AAE3B,YAAQ,MAAM,kCAAkC,MAAM,OAAO;AAAA,EAC/D;AACF;","names":[]}
+{"version":3,"sources":["../src/utils.ts","../src/index.ts"],"sourcesContent":["// Helper function that ensures that a value is an Error\r\nexport function ensureError(value: unknown): Error {\r\n  if (!value) return new Error(\"No value was thrown\");\r\n\r\n  if (value instanceof Error) return value;\r\n\r\n  // Test if value inherits from Error\r\n  if (value.isPrototypeOf(Error)) return value as Error & typeof value;\r\n\r\n  let stringified = \"[Unable to stringify the thrown value]\";\r\n  try {\r\n    stringified = JSON.stringify(value);\r\n  } catch {}\r\n\r\n  const error = new Error(\r\n    `This value was thrown as is, not through an Error: ${stringified}`\r\n  );\r\n  return error;\r\n}\r\n\r\nexport function getBaseUrl() {\r\n  if (typeof window !== \"undefined\")\r\n    // browser should use relative path\r\n    return \"\";\r\n\r\n  if (process.env.VERCEL_URL)\r\n    // reference for vercel.com\r\n    return `https://${process.env.VERCEL_URL}`;\r\n\r\n  if (process.env.NEXT_PUBLIC_URL)\r\n    // Manually set deployment URL from env\r\n    return process.env.NEXT_PUBLIC_URL;\r\n\r\n  // assume localhost\r\n  return `http://127.0.0.1:3000`;\r\n}\r\n","import type { NextRequest } from \"next/server\";\r\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\r\nimport { ensureError, getBaseUrl } from \"./utils\";\r\n\r\ntype GeoLocation = {\r\n  countryCode: string;\r\n};\r\n\r\nexport type AnalyticsEventBase = {\r\n  type:\r\n    | \"DataExported\"\r\n    | \"InterviewCompleted\"\r\n    | \"InterviewStarted\"\r\n    | \"ProtocolInstalled\"\r\n    | \"AppSetup\"\r\n    | \"Error\";\r\n};\r\n\r\nexport type AnalyticsEvent = AnalyticsEventBase & {\r\n  type:\r\n    | \"InterviewCompleted\"\r\n    | \"DataExported\"\r\n    | \"InterviewStarted\"\r\n    | \"ProtocolInstalled\"\r\n    | \"AppSetup\";\r\n  metadata?: Record<string, unknown>;\r\n};\r\n\r\nexport type AnalyticsError = AnalyticsEventBase & {\r\n  type: \"Error\";\r\n  error: {\r\n    message: string;\r\n    details: string;\r\n    stacktrace: string;\r\n    path: string;\r\n  };\r\n};\r\n\r\nexport type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;\r\n\r\nexport type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {\r\n  timestamp: Date;\r\n};\r\n\r\nexport type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {\r\n  installationId: string;\r\n  geolocation?: GeoLocation;\r\n};\r\n\r\ntype RouteHandlerConfiguration = {\r\n  platformUrl?: string;\r\n  installationId: string;\r\n  maxMindClient: WebServiceClient;\r\n};\r\n\r\nexport const createRouteHandler = ({\r\n  platformUrl = \"https://analytics.networkcanvas.com\",\r\n  installationId,\r\n  maxMindClient,\r\n}: RouteHandlerConfiguration) => {\r\n  return async (request: NextRequest) => {\r\n    try {\r\n      const event =\r\n        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;\r\n\r\n      const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\r\n        res.text()\r\n      );\r\n\r\n      const { country } = await maxMindClient.country(ip);\r\n      const countryCode = country?.isoCode ?? \"Unknown\";\r\n\r\n      const dispatchableEvent: DispatchableAnalyticsEvent = {\r\n        ...event,\r\n        installationId,\r\n        geolocation: {\r\n          countryCode,\r\n        },\r\n      };\r\n\r\n      // Forward to microservice\r\n      const response = await fetch(`${platformUrl}/api/event`, {\r\n        keepalive: true,\r\n        method: \"POST\",\r\n        headers: {\r\n          \"Content-Type\": \"application/json\",\r\n        },\r\n        body: JSON.stringify(dispatchableEvent),\r\n      });\r\n\r\n      if (!response.ok) {\r\n        if (response.status === 404) {\r\n          console.error(\r\n            `Analytics platform not found. Please specify a valid platform URL.`\r\n          );\r\n        } else if (response.status === 500) {\r\n          console.error(\r\n            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`\r\n          );\r\n        } else {\r\n          console.error(\r\n            `General error when forwarding event: ${response.statusText}`\r\n          );\r\n        }\r\n\r\n        return new Response(\r\n          JSON.stringify({ error: \"Internal Server Error\" }),\r\n          {\r\n            status: 500,\r\n            headers: {\r\n              \"Content-Type\": \"application/json\",\r\n            },\r\n          }\r\n        );\r\n      }\r\n\r\n      console.info(`🚀 Analytics event forwarded successfully.`);\r\n      console.info(JSON.stringify(dispatchableEvent, null, 2));\r\n\r\n      return new Response(\r\n        JSON.stringify({ message: \"Event forwarded successfully\" }),\r\n        {\r\n          status: 200,\r\n          headers: {\r\n            \"Content-Type\": \"application/json\",\r\n          },\r\n        }\r\n      );\r\n    } catch (e) {\r\n      const error = ensureError(e);\r\n      console.error(\"Error in route handler:\", error);\r\n\r\n      // Return an appropriate error response\r\n      return new Response(JSON.stringify({ error: \"Internal Server Error\" }), {\r\n        status: 500,\r\n        headers: {\r\n          \"Content-Type\": \"application/json\",\r\n        },\r\n      });\r\n    }\r\n  };\r\n};\r\n\r\nexport const makeEventTracker =\r\n  (endpoint: string = \"/api/analytics\") =>\r\n  async (event: AnalyticsEventOrError) => {\r\n    const endpointWithHost = getBaseUrl() + endpoint;\r\n\r\n    const eventWithTimeStamp = {\r\n      ...event,\r\n      timestamp: new Date(),\r\n    };\r\n\r\n    try {\r\n      const response = await fetch(endpointWithHost, {\r\n        method: \"POST\",\r\n        keepalive: true,\r\n        body: JSON.stringify(eventWithTimeStamp),\r\n        headers: {\r\n          \"Content-Type\": \"application/json\",\r\n        },\r\n      });\r\n\r\n      if (!response.ok) {\r\n        if (response.status === 404) {\r\n          console.error(\r\n            `Analytics endpoint not found, did you forget to add the route?`\r\n          );\r\n          return;\r\n        }\r\n\r\n        if (response.status === 500) {\r\n          console.error(\r\n            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`\r\n          );\r\n          return;\r\n        }\r\n\r\n        console.error(\r\n          `General error sending analytics event: ${response.statusText}`\r\n        );\r\n      }\r\n    } catch (e) {\r\n      const error = ensureError(e);\r\n\r\n      console.error(\"Internal error with analytics:\", error.message);\r\n    }\r\n  };\r\n"],"mappings":";AACO,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC;AAAO,WAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB;AAAO,WAAO;AAGnC,MAAI,MAAM,cAAc,KAAK;AAAG,WAAO;AAEvC,MAAI,cAAc;AAClB,MAAI;AACF,kBAAc,KAAK,UAAU,KAAK;AAAA,EACpC,QAAQ;AAAA,EAAC;AAET,QAAM,QAAQ,IAAI;AAAA,IAChB,sDAAsD,WAAW;AAAA,EACnE;AACA,SAAO;AACT;AAEO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW;AAEpB,WAAO;AAET,MAAI,QAAQ,IAAI;AAEd,WAAO,WAAW,QAAQ,IAAI,UAAU;AAE1C,MAAI,QAAQ,IAAI;AAEd,WAAO,QAAQ,IAAI;AAGrB,SAAO;AACT;;;ACoBO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,QACH,MAAM,QAAQ,KAAK;AAEtB,YAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,QAAK,CAAC,QACtD,IAAI,KAAK;AAAA,MACX;AAEA,YAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,YAAM,cAAc,SAAS,WAAW;AAExC,YAAM,oBAAgD;AAAA,QACpD,GAAG;AAAA,QACH;AAAA,QACA,aAAa;AAAA,UACX;AAAA,QACF;AAAA,MACF;AAGA,YAAM,WAAW,MAAM,MAAM,GAAG,WAAW,cAAc;AAAA,QACvD,WAAW;AAAA,QACX,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,iBAAiB;AAAA,MACxC,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AAChB,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF,WAAW,SAAS,WAAW,KAAK;AAClC,kBAAQ;AAAA,YACN,sEAAsE,SAAS,UAAU;AAAA,UAC3F;AAAA,QACF,OAAO;AACL,kBAAQ;AAAA,YACN,wCAAwC,SAAS,UAAU;AAAA,UAC7D;AAAA,QACF;AAEA,eAAO,IAAI;AAAA,UACT,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC;AAAA,UACjD;AAAA,YACE,QAAQ;AAAA,YACR,SAAS;AAAA,cACP,gBAAgB;AAAA,YAClB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,cAAQ,KAAK,mDAA4C;AACzD,cAAQ,KAAK,KAAK,UAAU,mBAAmB,MAAM,CAAC,CAAC;AAEvD,aAAO,IAAI;AAAA,QACT,KAAK,UAAU,EAAE,SAAS,+BAA+B,CAAC;AAAA,QAC1D;AAAA,UACE,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,UAClB;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,MAAM,2BAA2B,KAAK;AAG9C,aAAO,IAAI,SAAS,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC,GAAG;AAAA,QACtE,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,IAAM,mBACX,CAAC,WAAmB,qBACpB,OAAO,UAAiC;AACtC,QAAM,mBAAmB,WAAW,IAAI;AAExC,QAAM,qBAAqB;AAAA,IACzB,GAAG;AAAA,IACH,WAAW,oBAAI,KAAK;AAAA,EACtB;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,kBAAkB;AAAA,MAC7C,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,MACvC,SAAS;AAAA,QACP,gBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN;AAAA,QACF;AACA;AAAA,MACF;AAEA,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN,uDAAuD,SAAS,UAAU;AAAA,QAC5E;AACA;AAAA,MACF;AAEA,cAAQ;AAAA,QACN,0CAA0C,SAAS,UAAU;AAAA,MAC/D;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AACV,UAAM,QAAQ,YAAY,CAAC;AAE3B,YAAQ,MAAM,kCAAkC,MAAM,OAAO;AAAA,EAC/D;AACF;","names":[]}

package/jest.config.js

@@ -1,198 +1,198 @@
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
-/** @type {import('jest').Config} */
-const config = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/vc/szx71k5j5sqcmrljl1w44ryddl7zmw/T/jest_pb0330",
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  // clearMocks: false,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: false,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  // coverageDirectory: undefined,
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  testEnvironment: "node",
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  testMatch: [
-    "**/__tests__/**/*.[jt]s?(x)",
-    "**/?(*.)+(spec|test).m[tj]s?(x)"
-  ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-};
-
-module.exports = config;
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/vc/szx71k5j5sqcmrljl1w44ryddl7zmw/T/jest_pb0330",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/__tests__/**/*.[jt]s?(x)",
+    "**/?(*.)+(spec|test).m[tj]s?(x)"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+module.exports = config;

package/package.json

@@ -1,24 +1,24 @@
-{
-  "name": "@codaco/analytics",
-  "version": "2.0.0",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
-  "author": "Complex Data Collective <developers@coda.co>",
-  "description": "Utilities for tracking analytics and error reporting in Fresco",
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean --sourcemap",
-    "lint": "eslint .",
-    "dev": "npm run build -- --watch"
-  },
-  "peerDependencies": {
-    "next": "13 || 14",
-    "@maxmind/geoip2-node": "^5.0.0"
-  },
-  "devDependencies": {
-    "eslint-config-custom": "workspace:*",
-    "tsconfig": "workspace:*",
-    "tsup": "^7.2.0",
-    "typescript": "^5.3.2"
-  },
-  "dependencies": {}
-}
+{
+  "name": "@codaco/analytics",
+  "version": "2.1.1",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "author": "Complex Data Collective <developers@coda.co>",
+  "description": "Utilities for tracking analytics and error reporting in Fresco",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --sourcemap",
+    "lint": "eslint .",
+    "dev": "npm run build -- --watch"
+  },
+  "peerDependencies": {
+    "next": "13 || 14",
+    "@maxmind/geoip2-node": "^5.0.0"
+  },
+  "devDependencies": {
+    "eslint-config-custom": "workspace:*",
+    "tsconfig": "workspace:*",
+    "tsup": "^7.2.0",
+    "typescript": "^5.3.2"
+  },
+  "dependencies": {}
+}

package/src/index.ts

@@ -1,186 +1,188 @@
-import type { NextRequest } from "next/server";
-import { WebServiceClient } from "@maxmind/geoip2-node";
-import { ensureError, getBaseUrl } from "./utils";
-
-type GeoLocation = {
-  countryCode: string;
-};
-
-export type AnalyticsEventBase = {
-  type:
-    | "InterviewCompleted"
-    | "InterviewStarted"
-    | "ProtocolInstalled"
-    | "AppSetup"
-    | "Error";
-};
-
-export type AnalyticsEvent = AnalyticsEventBase & {
-  type:
-    | "InterviewCompleted"
-    | "InterviewStarted"
-    | "ProtocolInstalled"
-    | "AppSetup";
-  metadata?: Record<string, unknown>;
-};
-
-export type AnalyticsError = AnalyticsEventBase & {
-  type: "Error";
-  error: {
-    message: string;
-    details: string;
-    stacktrace: string;
-    path: string;
-  };
-};
-
-export type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
-
-export type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
-  timestamp: Date;
-};
-
-export type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
-  installationId: string;
-  geolocation?: GeoLocation;
-};
-
-type RouteHandlerConfiguration = {
-  platformUrl?: string;
-  installationId: string;
-  maxMindClient: WebServiceClient;
-};
-
-export const createRouteHandler = ({
-  platformUrl = "https://analytics.networkcanvas.com",
-  installationId,
-  maxMindClient,
-}: RouteHandlerConfiguration) => {
-  return async (request: NextRequest) => {
-    try {
-      const event =
-        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;
-
-      const ip = await fetch("https://api64.ipify.org").then((res) =>
-        res.text()
-      );
-
-      const { country } = await maxMindClient.country(ip);
-      const countryCode = country?.isoCode ?? "Unknown";
-
-      const dispatchableEvent: DispatchableAnalyticsEvent = {
-        ...event,
-        installationId,
-        geolocation: {
-          countryCode,
-        },
-      };
-
-      // Forward to microservice
-      const response = await fetch(`${platformUrl}/api/event`, {
-        keepalive: true,
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(dispatchableEvent),
-      });
-
-      if (!response.ok) {
-        if (response.status === 404) {
-          console.error(
-            `Analytics platform not found. Please specify a valid platform URL.`
-          );
-        } else if (response.status === 500) {
-          console.error(
-            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`
-          );
-        } else {
-          console.error(
-            `General error when forwarding event: ${response.statusText}`
-          );
-        }
-
-        return new Response(
-          JSON.stringify({ error: "Internal Server Error" }),
-          {
-            status: 500,
-            headers: {
-              "Content-Type": "application/json",
-            },
-          }
-        );
-      }
-
-      console.info(`🚀 Analytics event forwarded successfully.`);
-      console.info(JSON.stringify(dispatchableEvent, null, 2));
-
-      return new Response(
-        JSON.stringify({ message: "Event forwarded successfully" }),
-        {
-          status: 200,
-          headers: {
-            "Content-Type": "application/json",
-          },
-        }
-      );
-    } catch (e) {
-      const error = ensureError(e);
-      console.error("Error in route handler:", error);
-
-      // Return an appropriate error response
-      return new Response(JSON.stringify({ error: "Internal Server Error" }), {
-        status: 500,
-        headers: {
-          "Content-Type": "application/json",
-        },
-      });
-    }
-  };
-};
-
-export const makeEventTracker =
-  (endpoint: string = "/api/analytics") =>
-  async (event: AnalyticsEventOrError) => {
-    const endpointWithHost = getBaseUrl() + endpoint;
-
-    const eventWithTimeStamp = {
-      ...event,
-      timestamp: new Date(),
-    };
-
-    try {
-      const response = await fetch(endpointWithHost, {
-        method: "POST",
-        keepalive: true,
-        body: JSON.stringify(eventWithTimeStamp),
-        headers: {
-          "Content-Type": "application/json",
-        },
-      });
-
-      if (!response.ok) {
-        if (response.status === 404) {
-          console.error(
-            `Analytics endpoint not found, did you forget to add the route?`
-          );
-          return;
-        }
-
-        if (response.status === 500) {
-          console.error(
-            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`
-          );
-          return;
-        }
-
-        console.error(
-          `General error sending analytics event: ${response.statusText}`
-        );
-      }
-    } catch (e) {
-      const error = ensureError(e);
-
-      console.error("Internal error with analytics:", error.message);
-    }
-  };
+import type { NextRequest } from "next/server";
+import { WebServiceClient } from "@maxmind/geoip2-node";
+import { ensureError, getBaseUrl } from "./utils";
+
+type GeoLocation = {
+  countryCode: string;
+};
+
+export type AnalyticsEventBase = {
+  type:
+    | "DataExported"
+    | "InterviewCompleted"
+    | "InterviewStarted"
+    | "ProtocolInstalled"
+    | "AppSetup"
+    | "Error";
+};
+
+export type AnalyticsEvent = AnalyticsEventBase & {
+  type:
+    | "InterviewCompleted"
+    | "DataExported"
+    | "InterviewStarted"
+    | "ProtocolInstalled"
+    | "AppSetup";
+  metadata?: Record<string, unknown>;
+};
+
+export type AnalyticsError = AnalyticsEventBase & {
+  type: "Error";
+  error: {
+    message: string;
+    details: string;
+    stacktrace: string;
+    path: string;
+  };
+};
+
+export type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
+
+export type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
+  timestamp: Date;
+};
+
+export type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
+  installationId: string;
+  geolocation?: GeoLocation;
+};
+
+type RouteHandlerConfiguration = {
+  platformUrl?: string;
+  installationId: string;
+  maxMindClient: WebServiceClient;
+};
+
+export const createRouteHandler = ({
+  platformUrl = "https://analytics.networkcanvas.com",
+  installationId,
+  maxMindClient,
+}: RouteHandlerConfiguration) => {
+  return async (request: NextRequest) => {
+    try {
+      const event =
+        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;
+
+      const ip = await fetch("https://api64.ipify.org").then((res) =>
+        res.text()
+      );
+
+      const { country } = await maxMindClient.country(ip);
+      const countryCode = country?.isoCode ?? "Unknown";
+
+      const dispatchableEvent: DispatchableAnalyticsEvent = {
+        ...event,
+        installationId,
+        geolocation: {
+          countryCode,
+        },
+      };
+
+      // Forward to microservice
+      const response = await fetch(`${platformUrl}/api/event`, {
+        keepalive: true,
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(dispatchableEvent),
+      });
+
+      if (!response.ok) {
+        if (response.status === 404) {
+          console.error(
+            `Analytics platform not found. Please specify a valid platform URL.`
+          );
+        } else if (response.status === 500) {
+          console.error(
+            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`
+          );
+        } else {
+          console.error(
+            `General error when forwarding event: ${response.statusText}`
+          );
+        }
+
+        return new Response(
+          JSON.stringify({ error: "Internal Server Error" }),
+          {
+            status: 500,
+            headers: {
+              "Content-Type": "application/json",
+            },
+          }
+        );
+      }
+
+      console.info(`🚀 Analytics event forwarded successfully.`);
+      console.info(JSON.stringify(dispatchableEvent, null, 2));
+
+      return new Response(
+        JSON.stringify({ message: "Event forwarded successfully" }),
+        {
+          status: 200,
+          headers: {
+            "Content-Type": "application/json",
+          },
+        }
+      );
+    } catch (e) {
+      const error = ensureError(e);
+      console.error("Error in route handler:", error);
+
+      // Return an appropriate error response
+      return new Response(JSON.stringify({ error: "Internal Server Error" }), {
+        status: 500,
+        headers: {
+          "Content-Type": "application/json",
+        },
+      });
+    }
+  };
+};
+
+export const makeEventTracker =
+  (endpoint: string = "/api/analytics") =>
+  async (event: AnalyticsEventOrError) => {
+    const endpointWithHost = getBaseUrl() + endpoint;
+
+    const eventWithTimeStamp = {
+      ...event,
+      timestamp: new Date(),
+    };
+
+    try {
+      const response = await fetch(endpointWithHost, {
+        method: "POST",
+        keepalive: true,
+        body: JSON.stringify(eventWithTimeStamp),
+        headers: {
+          "Content-Type": "application/json",
+        },
+      });
+
+      if (!response.ok) {
+        if (response.status === 404) {
+          console.error(
+            `Analytics endpoint not found, did you forget to add the route?`
+          );
+          return;
+        }
+
+        if (response.status === 500) {
+          console.error(
+            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`
+          );
+          return;
+        }
+
+        console.error(
+          `General error sending analytics event: ${response.statusText}`
+        );
+      }
+    } catch (e) {
+      const error = ensureError(e);
+
+      console.error("Internal error with analytics:", error.message);
+    }
+  };

package/src/utils.ts

@@ -1,36 +1,36 @@
-// Helper function that ensures that a value is an Error
-export function ensureError(value: unknown): Error {
-  if (!value) return new Error("No value was thrown");
-
-  if (value instanceof Error) return value;
-
-  // Test if value inherits from Error
-  if (value.isPrototypeOf(Error)) return value as Error & typeof value;
-
-  let stringified = "[Unable to stringify the thrown value]";
-  try {
-    stringified = JSON.stringify(value);
-  } catch {}
-
-  const error = new Error(
-    `This value was thrown as is, not through an Error: ${stringified}`
-  );
-  return error;
-}
-
-export function getBaseUrl() {
-  if (typeof window !== "undefined")
-    // browser should use relative path
-    return "";
-
-  if (process.env.VERCEL_URL)
-    // reference for vercel.com
-    return `https://${process.env.VERCEL_URL}`;
-
-  if (process.env.NEXT_PUBLIC_URL)
-    // Manually set deployment URL from env
-    return process.env.NEXT_PUBLIC_URL;
-
-  // assume localhost
-  return `http://127.0.0.1:3000`;
-}
+// Helper function that ensures that a value is an Error
+export function ensureError(value: unknown): Error {
+  if (!value) return new Error("No value was thrown");
+
+  if (value instanceof Error) return value;
+
+  // Test if value inherits from Error
+  if (value.isPrototypeOf(Error)) return value as Error & typeof value;
+
+  let stringified = "[Unable to stringify the thrown value]";
+  try {
+    stringified = JSON.stringify(value);
+  } catch {}
+
+  const error = new Error(
+    `This value was thrown as is, not through an Error: ${stringified}`
+  );
+  return error;
+}
+
+export function getBaseUrl() {
+  if (typeof window !== "undefined")
+    // browser should use relative path
+    return "";
+
+  if (process.env.VERCEL_URL)
+    // reference for vercel.com
+    return `https://${process.env.VERCEL_URL}`;
+
+  if (process.env.NEXT_PUBLIC_URL)
+    // Manually set deployment URL from env
+    return process.env.NEXT_PUBLIC_URL;
+
+  // assume localhost
+  return `http://127.0.0.1:3000`;
+}

package/tsconfig.json

@@ -1,11 +1,11 @@
-{
-  "extends": "tsconfig/react-library.json",
-  "include": [
-    "."
-  ],
-  "exclude": [
-    "dist",
-    "build",
-    "node_modules"
-  ]
+{
+  "extends": "tsconfig/react-library.json",
+  "include": [
+    "."
+  ],
+  "exclude": [
+    "dist",
+    "build",
+    "node_modules"
+  ]
 }

package/.turbo/turbo-test.log

@@ -1,31 +0,0 @@
-
-> @codaco/analytics@0.6.0-alpha test /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
-> NODE_OPTIONS=--experimental-vm-modules jest "--watch"
-
-(node:55883) ExperimentalWarning: VM Modules is an experimental feature and might change at any time
-(Use `node --trace-warnings ...` to show where the warning was created)
-FAIL src/index.test.mjs
-  Analytics client package
-    ✕ should be able to create a new client (1 ms)
-
-  ● Analytics client package › should be able to create a new client
-
-    TypeError: Cannot read properties of undefined (reading 'platformUrl')
-
-      50 |   private platformUrl?: string = "https://analytics.networkcanvas.dev";
-      51 |   private installationId: string | null = null;
-    > 52 |
-         | ^
-      53 |   private dispatchQueue: QueueObject<AnalyticsEventOrError>;
-      54 |
-      55 |   private enabled: boolean = true;
-
-      at new s (src/index.ts:52:11)
-      at Object.<anonymous> (src/index.test.mjs:6:20)
-
-Test Suites: 1 failed, 1 total
-Tests:       1 failed, 1 total
-Snapshots:   0 total
-Time:        0.215 s, estimated 1 s
-Ran all test suites related to changed files.
-