@codaco/analytics 1.0.0-alpha → 1.0.1-alpha-1

package/.turbo/turbo-build.log

@@ -1,18 +1,16 @@
 
-> @codaco/analytics@1.0.0-alpha build /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics
-> tsup src/index.ts --format cjs,esm --dts
+> @codaco/analytics@1.0.1-alpha-1 build /Users/buckhalt/Code/complexdatacollective/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
-CJS Build start
+CLI Cleaning output folder
 ESM Build start
-CJS dist/index.js 1.94 KB
-CJS ⚡️ Build success in 66ms
-ESM dist/index.mjs 950.00 B
-ESM ⚡️ Build success in 65ms
+ESM dist/index.mjs     2.91 KB
+ESM dist/index.mjs.map 6.65 KB
+ESM ⚡️ Build success in 44ms
 DTS Build start
-DTS ⚡️ Build success in 726ms
-DTS dist/index.d.ts  583.00 B
-DTS dist/index.d.mts 583.00 B
+DTS ⚡️ Build success in 985ms
+DTS dist/index.d.mts 1.63 KB

package/.turbo/turbo-lint.log

@@ -1,5 +1,5 @@
 
-> @codaco/analytics@1.0.0-alpha lint /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics
+> @codaco/analytics@1.0.1-alpha-1 lint /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics
 > eslint .
 
 Pages directory cannot be found at /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics/pages or /Users/buckhalt/Code/complexdatacollective/error-analytics-microservice/packages/analytics/src/pages. If using a custom path, please configure with the `no-html-link-for-pages` rule in your eslint config file.

package/README.md

@@ -2,40 +2,8 @@
 
 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 methods:
+It exports two functions:
 
-1. trackEvent - sends an event payload to the microservice.
+**createRouteHandler** - A function that creates a NextJs route handler which geolocates requests, and forwards the event payload to the microservice.
 
-```ts
-type EventPayload = {
-  type:
-    | "InterviewCompleted"
-    | "InterviewStarted"
-    | "ProtocolInstalled"
-    | "AppSetup";
-  metadata?: string;
-  timestamp?: string;
-  isocode?: string;
-  installationid: string;
-};
-
-trackEvent(event: EventPayload);
-
-```
-
-2. trackError - sends an error payload to the microservice.
-
-```ts
-type ErrorPayload = {
-  code: number;
-  message: string;
-  details: string;
-  stacktrace: string;
-  installationid: string;
-  timestamp?: string;
-  path: string;
-};
-
-trackError(error: ErrorPayload);
-
-```
+**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

@@ -1,20 +1,43 @@
-type EventPayload = {
+import { NextRequest } from 'next/server';
+import { WebServiceClient } from '@maxmind/geoip2-node';
+
+type GeoLocation = {
+    countryCode: string;
+};
+type AnalyticsEventBase = {
+    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
+};
+type AnalyticsEvent = AnalyticsEventBase & {
     type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
-    metadata?: string;
-    timestamp?: string;
-    isocode?: string;
-    installationid: string;
+    metadata?: Record<string, unknown>;
+};
+type AnalyticsError = AnalyticsEventBase & {
+    type: "Error";
+    error: {
+        message: string;
+        details: string;
+        stacktrace: string;
+        path: string;
+    };
+};
+type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
+type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
+    timestamp: Date;
+};
+type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
+    installationId: string;
+    geolocation?: GeoLocation;
 };
-type ErrorPayload = {
-    code: number;
-    message: string;
-    details: string;
-    stacktrace: string;
-    installationid: string;
-    timestamp?: string;
-    path: string;
+type RouteHandlerConfiguration = {
+    maxMindAccountId: string;
+    maxMindLicenseKey: string;
+    platformUrl?: string;
+    getInstallationId: () => Promise<string>;
+    WebServiceClient: typeof WebServiceClient;
 };
-declare function trackEvent(event: EventPayload): Promise<void>;
-declare function trackError(error: ErrorPayload): Promise<void>;
+declare const createRouteHandler: ({ maxMindAccountId, maxMindLicenseKey, platformUrl, getInstallationId, WebServiceClient, }: RouteHandlerConfiguration) => (request: NextRequest) => Promise<Response>;
+declare const makeEventTracker: ({ endpoint }: {
+    endpoint: string;
+}) => (event: AnalyticsEventOrError) => Promise<void>;
 
-export { ErrorPayload, EventPayload, trackError, trackEvent };
+export { AnalyticsError, AnalyticsEvent, AnalyticsEventBase, AnalyticsEventOrError, AnalyticsEventOrErrorWithTimestamp, DispatchableAnalyticsEvent, createRouteHandler, makeEventTracker };

package/dist/index.mjs

@@ -1,39 +1,114 @@
-// src/index.ts
-async function trackEvent(event) {
-  const endpoint = "http://localhost:3000/api/event";
+// src/utils.ts
+function ensureError(value) {
+  if (!value)
+    return new Error("No value was thrown");
+  if (value instanceof Error)
+    return value;
+  if (value.isPrototypeOf(Error))
+    return value;
+  let stringified = "[Unable to stringify the thrown value]";
   try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify(event)
-    });
-    if (!response.ok) {
-      throw new Error(`HTTP error! Status: ${response.status}`);
-    }
-  } catch (error) {
-    throw new Error("Failed to make the request");
+    stringified = JSON.stringify(value);
+  } catch {
   }
+  const error = new Error(
+    `This value was thrown as is, not through an Error: ${stringified}`
+  );
+  return error;
 }
-async function trackError(error) {
-  const endpoint = "http://localhost:3000/api/error";
+
+// src/index.ts
+var createRouteHandler = ({
+  maxMindAccountId,
+  maxMindLicenseKey,
+  platformUrl = "https://analytics.networkcanvas.com",
+  getInstallationId,
+  WebServiceClient
+}) => {
+  return async (request) => {
+    try {
+      const maxMindClient = new WebServiceClient(
+        maxMindAccountId,
+        maxMindLicenseKey,
+        {
+          host: "geolite.info"
+        }
+      );
+      const installationId = await getInstallationId();
+      const event = await request.json();
+      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 = {
+        ...event,
+        installationId,
+        geolocation: {
+          countryCode
+        }
+      };
+      console.log(dispatchableEvent);
+      const response = await fetch(`${platformUrl}/api/event`, {
+        keepalive: true,
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(dispatchableEvent)
+      });
+      if (!response.ok) {
+        throw new Error(
+          `Failed to forward event to microservice: ${response.statusText}`
+        );
+      }
+      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 new Response(JSON.stringify({ error: "Internal Server Error" }), {
+        status: 500,
+        headers: {
+          "Content-Type": "application/json"
+        }
+      });
+    }
+  };
+};
+var makeEventTracker = ({ endpoint }) => async (event) => {
+  const eventWithTimeStamp = {
+    ...event,
+    timestamp: /* @__PURE__ */ new Date()
+  };
   try {
     const response = await fetch(endpoint, {
       method: "POST",
+      keepalive: true,
+      body: JSON.stringify(eventWithTimeStamp),
       headers: {
         "Content-Type": "application/json"
-      },
-      body: JSON.stringify(error)
+      }
     });
     if (!response.ok) {
-      throw new Error(`HTTP error! Status: ${response.status}`);
+      throw new Error(
+        `Failed to send analytics event: ${response.statusText}`
+      );
     }
-  } catch (error2) {
-    throw new Error("Failed to make the request");
+  } catch (e) {
+    const error = ensureError(e);
+    console.error("Error sending analytics event:", error.message);
   }
-}
+};
 export {
-  trackError,
-  trackEvent
+  createRouteHandler,
+  makeEventTracker
 };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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","import type { NextRequest } from \"next/server\";\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { ensureError } 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  maxMindAccountId: string;\n  maxMindLicenseKey: string;\n  platformUrl?: string;\n  getInstallationId: () => Promise<string>;\n  WebServiceClient: typeof WebServiceClient;\n};\n\nexport const createRouteHandler = ({\n  maxMindAccountId,\n  maxMindLicenseKey,\n  platformUrl = \"https://analytics.networkcanvas.com\",\n  getInstallationId,\n  WebServiceClient,\n}: RouteHandlerConfiguration) => {\n  return async (request: NextRequest) => {\n    try {\n      const maxMindClient = new WebServiceClient(\n        maxMindAccountId,\n        maxMindLicenseKey,\n        {\n          host: \"geolite.info\",\n        }\n      );\n\n      const installationId = await getInstallationId();\n\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      console.log(dispatchableEvent);\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        throw new Error(\n          `Failed to forward event to microservice: ${response.statusText}`\n        );\n      }\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 }: { endpoint: string }) =>\n  async (event: AnalyticsEventOrError) => {\n    const eventWithTimeStamp = {\n      ...event,\n      timestamp: new Date(),\n    };\n\n    try {\n      const response = await fetch(endpoint, {\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        throw new Error(\n          `Failed to send analytics event: ${response.statusText}`\n        );\n      }\n    } catch (e) {\n      const error = ensureError(e);\n\n      console.error(\"Error sending analytics event:\", 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;;;ACqCO,IAAM,qBAAqB,CAAC;AAAA,EACjC;AAAA,EACA;AAAA,EACA,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,gBAAgB,IAAI;AAAA,QACxB;AAAA,QACA;AAAA,QACA;AAAA,UACE,MAAM;AAAA,QACR;AAAA,MACF;AAEA,YAAM,iBAAiB,MAAM,kBAAkB;AAE/C,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;AAEA,cAAQ,IAAI,iBAAiB;AAG7B,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,cAAM,IAAI;AAAA,UACR,4CAA4C,SAAS,UAAU;AAAA,QACjE;AAAA,MACF;AAEA,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,EAAE,SAAS,MACZ,OAAO,UAAiC;AACtC,QAAM,qBAAqB;AAAA,IACzB,GAAG;AAAA,IACH,WAAW,oBAAI,KAAK;AAAA,EACtB;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,UAAU;AAAA,MACrC,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,YAAM,IAAI;AAAA,QACR,mCAAmC,SAAS,UAAU;AAAA,MACxD;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

@@ -0,0 +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;

package/package.json

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

package/src/index.ts

@@ -1,60 +1,163 @@
-export type EventPayload = {
+import type { NextRequest } from "next/server";
+import { WebServiceClient } from "@maxmind/geoip2-node";
+import { ensureError } 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?: string;
-  timestamp?: string;
-  isocode?: string;
-  installationid: string;
-};
-
-export type ErrorPayload = {
-  code: number;
-  message: string;
-  details: string;
-  stacktrace: string;
-  installationid: string;
-  timestamp?: string;
-  path: string;
-};
-
-export async function trackEvent(event: EventPayload) {
-  const endpoint = "http://localhost:3000/api/event";
-
-  try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-      },
-      body: JSON.stringify(event),
-    });
-
-    if (!response.ok) {
-      throw new Error(`HTTP error! Status: ${response.status}`);
+  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 = {
+  maxMindAccountId: string;
+  maxMindLicenseKey: string;
+  platformUrl?: string;
+  getInstallationId: () => Promise<string>;
+  WebServiceClient: typeof WebServiceClient;
+};
+
+export const createRouteHandler = ({
+  maxMindAccountId,
+  maxMindLicenseKey,
+  platformUrl = "https://analytics.networkcanvas.com",
+  getInstallationId,
+  WebServiceClient,
+}: RouteHandlerConfiguration) => {
+  return async (request: NextRequest) => {
+    try {
+      const maxMindClient = new WebServiceClient(
+        maxMindAccountId,
+        maxMindLicenseKey,
+        {
+          host: "geolite.info",
+        }
+      );
+
+      const installationId = await getInstallationId();
+
+      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,
+        },
+      };
+
+      console.log(dispatchableEvent);
+
+      // 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) {
+        throw new Error(
+          `Failed to forward event to microservice: ${response.statusText}`
+        );
+      }
+
+      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",
+        },
+      });
     }
-  } catch (error) {
-    throw new Error("Failed to make the request");
-  }
-}
-
-export async function trackError(error: ErrorPayload) {
-  const endpoint = "http://localhost:3000/api/error";
-  try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-      },
-      body: JSON.stringify(error),
-    });
-
-    if (!response.ok) {
-      throw new Error(`HTTP error! Status: ${response.status}`);
+  };
+};
+
+export const makeEventTracker =
+  ({ endpoint }: { endpoint: string }) =>
+  async (event: AnalyticsEventOrError) => {
+    const eventWithTimeStamp = {
+      ...event,
+      timestamp: new Date(),
+    };
+
+    try {
+      const response = await fetch(endpoint, {
+        method: "POST",
+        keepalive: true,
+        body: JSON.stringify(eventWithTimeStamp),
+        headers: {
+          "Content-Type": "application/json",
+        },
+      });
+
+      if (!response.ok) {
+        throw new Error(
+          `Failed to send analytics event: ${response.statusText}`
+        );
+      }
+    } catch (e) {
+      const error = ensureError(e);
+
+      console.error("Error sending analytics event:", error.message);
     }
-  } catch (error) {
-    throw new Error("Failed to make the request");
-  }
-}
+  };

package/src/utils.ts

@@ -0,0 +1,19 @@
+// 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;
+}

package/dist/index.d.ts

@@ -1,20 +0,0 @@
-type EventPayload = {
-    type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
-    metadata?: string;
-    timestamp?: string;
-    isocode?: string;
-    installationid: string;
-};
-type ErrorPayload = {
-    code: number;
-    message: string;
-    details: string;
-    stacktrace: string;
-    installationid: string;
-    timestamp?: string;
-    path: string;
-};
-declare function trackEvent(event: EventPayload): Promise<void>;
-declare function trackError(error: ErrorPayload): Promise<void>;
-
-export { ErrorPayload, EventPayload, trackError, trackEvent };

package/dist/index.js

@@ -1,65 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  trackError: () => trackError,
-  trackEvent: () => trackEvent
-});
-module.exports = __toCommonJS(src_exports);
-async function trackEvent(event) {
-  const endpoint = "http://localhost:3000/api/event";
-  try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify(event)
-    });
-    if (!response.ok) {
-      throw new Error(`HTTP error! Status: ${response.status}`);
-    }
-  } catch (error) {
-    throw new Error("Failed to make the request");
-  }
-}
-async function trackError(error) {
-  const endpoint = "http://localhost:3000/api/error";
-  try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify(error)
-    });
-    if (!response.ok) {
-      throw new Error(`HTTP error! Status: ${response.status}`);
-    }
-  } catch (error2) {
-    throw new Error("Failed to make the request");
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  trackError,
-  trackEvent
-});