@codaco/analytics 3.0.0 → 4.0.0

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,17 @@
-
-> @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.81 KB
-ESM ⚡️ Build success in 17ms
-DTS Build start
-DTS ⚡️ Build success in 1007ms
-DTS dist\index.d.mts 1.38 KB
+
+
+> @codaco/analytics@4.0.0 build /Users/jmh629/Projects/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     5.69 KB
+ESM dist/index.mjs.map 11.29 KB
+ESM ⚡️ Build success in 31ms
+DTS Build start
+DTS ⚡️ Build success in 980ms
+DTS dist/index.d.mts 5.97 KB

package/.turbo/turbo-test.log

@@ -0,0 +1,31 @@
+
+> @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.
+

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

@@ -1,34 +1,172 @@
 import { NextRequest } from 'next/server';
 import { WebServiceClient } from '@maxmind/geoip2-node';
+import z from 'zod';
 
-type GeoLocation = {
-    countryCode: string;
-};
-type AnalyticsEventBase = {
-    type: "DataExported" | "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
-    metadata?: Record<string, unknown>;
-};
-type AnalyticsEvent = AnalyticsEventBase & {
-    type: "InterviewCompleted" | "DataExported" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
-};
-type AnalyticsError = AnalyticsEventBase & {
+declare const eventTypes: readonly ["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"];
+declare const RawEventSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "AppSetup" | "ProtocolInstalled" | "InterviewStarted" | "InterviewCompleted" | "DataExported";
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    type: "AppSetup" | "ProtocolInstalled" | "InterviewStarted" | "InterviewCompleted" | "DataExported";
+    metadata?: Record<string, unknown> | undefined;
+}>, z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodLiteral<"Error">;
+    error: z.ZodObject<{
+        message: z.ZodString;
+        name: z.ZodString;
+        stack: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    }, {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
     type: "Error";
-    error: Error;
-};
-type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
-type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
-    timestamp: Date;
-};
-type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {
+    error: {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    };
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    type: "Error";
+    error: {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    };
+    metadata?: Record<string, unknown> | undefined;
+}>]>;
+type RawEvent = z.infer<typeof RawEventSchema>;
+declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "AppSetup" | "ProtocolInstalled" | "InterviewStarted" | "InterviewCompleted" | "DataExported";
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    type: "AppSetup" | "ProtocolInstalled" | "InterviewStarted" | "InterviewCompleted" | "DataExported";
+    metadata?: Record<string, unknown> | undefined;
+}>, z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodLiteral<"Error">;
+    error: z.ZodObject<{
+        message: z.ZodString;
+        name: z.ZodString;
+        stack: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    }, {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "Error";
+    error: {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    };
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    type: "Error";
+    error: {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    };
+    metadata?: Record<string, unknown> | undefined;
+}>]>, z.ZodObject<{
+    timestamp: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    timestamp: string;
+}, {
+    timestamp: string;
+}>>;
+type TrackableEvent = z.infer<typeof TrackableEventSchema>;
+declare const DispatchableEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "AppSetup" | "ProtocolInstalled" | "InterviewStarted" | "InterviewCompleted" | "DataExported";
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    type: "AppSetup" | "ProtocolInstalled" | "InterviewStarted" | "InterviewCompleted" | "DataExported";
+    metadata?: Record<string, unknown> | undefined;
+}>, z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodLiteral<"Error">;
+    error: z.ZodObject<{
+        message: z.ZodString;
+        name: z.ZodString;
+        stack: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    }, {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "Error";
+    error: {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    };
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    type: "Error";
+    error: {
+        message: string;
+        name: string;
+        stack?: string | undefined;
+    };
+    metadata?: Record<string, unknown> | undefined;
+}>]>, z.ZodObject<{
+    timestamp: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    timestamp: string;
+}, {
+    timestamp: string;
+}>>, z.ZodObject<{
+    installationId: z.ZodString;
+    countryISOCode: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     installationId: string;
-    geolocation?: GeoLocation;
-};
+    countryISOCode: string;
+}, {
+    installationId: string;
+    countryISOCode: string;
+}>>;
+type DispatchableEvent = z.infer<typeof DispatchableEventSchema>;
 type RouteHandlerConfiguration = {
     platformUrl?: string;
     installationId: string;
     maxMindClient: WebServiceClient;
 };
 declare const createRouteHandler: ({ platformUrl, installationId, maxMindClient, }: RouteHandlerConfiguration) => (request: NextRequest) => Promise<Response>;
-declare const makeEventTracker: (endpoint?: string) => (event: AnalyticsEventOrError) => Promise<void>;
+type ConsumerConfiguration = {
+    enabled?: boolean;
+    endpoint?: string;
+};
+type EventTrackerReturn = {
+    error: string | null;
+    success: boolean;
+};
+declare const makeEventTracker: ({ enabled, endpoint }: ConsumerConfiguration) => (event: RawEvent) => Promise<EventTrackerReturn>;
 
-export { AnalyticsError, AnalyticsEvent, AnalyticsEventBase, AnalyticsEventOrError, AnalyticsEventOrErrorWithTimestamp, DispatchableAnalyticsEvent, createRouteHandler, makeEventTracker };
+export { DispatchableEvent, DispatchableEventSchema, EventTrackerReturn, RawEvent, RawEventSchema, TrackableEvent, TrackableEventSchema, createRouteHandler, eventTypes, makeEventTracker };

package/dist/index.mjs

@@ -27,6 +27,47 @@ function getBaseUrl() {
 }
 
 // src/index.ts
+import z from "zod";
+var eventTypes = [
+  "AppSetup",
+  "ProtocolInstalled",
+  "InterviewStarted",
+  "InterviewCompleted",
+  "DataExported"
+];
+var SharedEventAndErrorSchema = z.object({
+  metadata: z.record(z.unknown()).optional()
+});
+var EventSchema = z.object({
+  type: z.enum(eventTypes)
+});
+var ErrorSchema = z.object({
+  type: z.literal("Error"),
+  error: z.object({
+    message: z.string(),
+    name: z.string(),
+    stack: z.string().optional()
+  }).strict()
+});
+var RawEventSchema = z.discriminatedUnion("type", [
+  SharedEventAndErrorSchema.merge(EventSchema),
+  SharedEventAndErrorSchema.merge(ErrorSchema)
+]);
+var TrackablePropertiesSchema = z.object({
+  timestamp: z.string()
+});
+var TrackableEventSchema = z.intersection(
+  RawEventSchema,
+  TrackablePropertiesSchema
+);
+var DispatchablePropertiesSchema = z.object({
+  installationId: z.string(),
+  countryISOCode: z.string()
+});
+var DispatchableEventSchema = z.intersection(
+  TrackableEventSchema,
+  DispatchablePropertiesSchema
+);
 var createRouteHandler = ({
   platformUrl = "https://analytics.networkcanvas.com",
   installationId,
@@ -34,18 +75,31 @@ var createRouteHandler = ({
 }) => {
   return async (request) => {
     try {
-      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 incomingEvent = await request.json();
+      const trackableEvent = TrackableEventSchema.safeParse(incomingEvent);
+      if (!trackableEvent.success) {
+        console.error("Invalid event:", trackableEvent.error);
+        return new Response(JSON.stringify({ error: "Invalid event" }), {
+          status: 400,
+          headers: {
+            "Content-Type": "application/json"
+          }
+        });
+      }
+      let countryISOCode = "Unknown";
+      try {
+        const ip = await fetch("https://api64.ipify.org").then(
+          (res) => res.text()
+        );
+        const { country } = await maxMindClient.country(ip);
+        countryISOCode = country?.isoCode ?? "Unknown";
+      } catch (e) {
+        console.error("Geolocation failed:", e);
+      }
       const dispatchableEvent = {
-        ...event,
+        ...trackableEvent.data,
         installationId,
-        geolocation: {
-          countryCode
-        }
+        countryISOCode
       };
       const response = await fetch(`${platformUrl}/api/event`, {
         keepalive: true,
@@ -56,55 +110,45 @@ var createRouteHandler = ({
         body: JSON.stringify(dispatchableEvent)
       });
       if (!response.ok) {
+        let error = `Analytics platform returned an unexpected error: ${response.statusText}`;
+        if (response.status === 400) {
+          error = `Analytics platform rejected the event as invalid. Please check the event schema`;
+        }
         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}`
-          );
+          error = `Analytics platform could not be reached. Please specify a valid platform URL, or check that the platform is online.`;
+        }
+        if (response.status === 500) {
+          error = `Analytics platform returned an internal server error. Please check the platform logs.`;
         }
-        return new Response(
-          JSON.stringify({ error: "Internal Server Error" }),
+        console.info("\u26A0\uFE0F Analytics platform rejected event.");
+        return Response.json(
           {
-            status: 500,
-            headers: {
-              "Content-Type": "application/json"
-            }
-          }
+            error
+          },
+          { status: 500 }
         );
       }
-      return new Response(
-        JSON.stringify({ message: "Event forwarded successfully" }),
-        {
-          status: 200,
-          headers: {
-            "Content-Type": "application/json"
-          }
-        }
-      );
+      console.info("\u{1F680} Analytics event sent to platform!");
+      return Response.json({ message: "Event forwarded successfully" });
     } 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"
-        }
-      });
+      console.info("\u{1F6AB} Internal error with sending analytics event.");
+      return Response.json(
+        { error: `Error in analytics route handler: ${error.message}` },
+        { status: 500 }
+      );
     }
   };
 };
-var makeEventTracker = (endpoint = "/api/analytics") => async (event) => {
+var makeEventTracker = ({ enabled = false, endpoint = "/api/analytics" }) => async (event) => {
+  if (!enabled) {
+    console.log("Analytics disabled, not sending event");
+    return { error: null, success: true };
+  }
   const endpointWithHost = getBaseUrl() + endpoint;
   const eventWithTimeStamp = {
     ...event,
-    timestamp: /* @__PURE__ */ new Date()
+    timestamp: (/* @__PURE__ */ new Date()).toJSON()
   };
   try {
     const response = await fetch(endpointWithHost, {
@@ -117,28 +161,37 @@ var makeEventTracker = (endpoint = "/api/analytics") => async (event) => {
     });
     if (!response.ok) {
       if (response.status === 404) {
-        console.error(
-          `Analytics endpoint not found, did you forget to add the route?`
-        );
-        return;
+        return {
+          error: `Analytics endpoint not found, did you forget to add the route?`,
+          success: false
+        };
       }
-      if (response.status === 500) {
-        console.error(
-          `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`
-        );
-        return;
+      if (response.status === 400) {
+        return {
+          error: `Invalid event sent to analytics endpoint: ${response.statusText}`,
+          success: false
+        };
       }
-      console.error(
-        `General error sending analytics event: ${response.statusText}`
-      );
+      return {
+        error: `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`,
+        success: false
+      };
     }
+    return { error: null, success: true };
   } catch (e) {
     const error = ensureError(e);
-    console.error("Internal error with analytics:", error.message);
+    return {
+      error: `Internal error when sending analytics event: ${error.message}`,
+      success: false
+    };
   }
 };
 export {
+  DispatchableEventSchema,
+  RawEventSchema,
+  TrackableEventSchema,
   createRouteHandler,
+  eventTypes,
   makeEventTracker
 };
 //# sourceMappingURL=index.mjs.map

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\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  metadata?: Record<string, unknown>;\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};\r\n\r\nexport type AnalyticsError = AnalyticsEventBase & {\r\n  type: \"Error\";\r\n  error: Error;\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      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;;;ACeO,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,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\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\";\nimport z from \"zod\";\n\n// Todo: it would be great to work out a way to support arbitrary types here.\nexport const eventTypes = [\n  \"AppSetup\",\n  \"ProtocolInstalled\",\n  \"InterviewStarted\",\n  \"InterviewCompleted\",\n  \"DataExported\",\n] as const;\n\n// Properties that everything has in common.\nconst SharedEventAndErrorSchema = z.object({\n  metadata: z.record(z.unknown()).optional(),\n});\n\nconst EventSchema = z.object({\n  type: z.enum(eventTypes),\n});\n\nconst ErrorSchema = z.object({\n  type: z.literal(\"Error\"),\n  error: z\n    .object({\n      message: z.string(),\n      name: z.string(),\n      stack: z.string().optional(),\n    })\n    .strict(),\n});\n\n// Raw events are the events that are sent trackEvent.\nexport const RawEventSchema = z.discriminatedUnion(\"type\", [\n  SharedEventAndErrorSchema.merge(EventSchema),\n  SharedEventAndErrorSchema.merge(ErrorSchema),\n]);\nexport type RawEvent = z.infer<typeof RawEventSchema>;\n\n// Trackable events are the events that are sent to the route handler.\nconst TrackablePropertiesSchema = z.object({\n  timestamp: z.string(),\n});\n\nexport const TrackableEventSchema = z.intersection(\n  RawEventSchema,\n  TrackablePropertiesSchema\n);\nexport type TrackableEvent = z.infer<typeof TrackableEventSchema>;\n\n// Dispatchable events are the events that are sent to the platform.\nconst DispatchablePropertiesSchema = z.object({\n  installationId: z.string(),\n  countryISOCode: z.string(),\n});\n\nexport const DispatchableEventSchema = z.intersection(\n  TrackableEventSchema,\n  DispatchablePropertiesSchema\n);\nexport type DispatchableEvent = z.infer<typeof DispatchableEventSchema>;\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 incomingEvent = (await request.json()) as unknown;\n\n      // Validate the event\n      const trackableEvent = TrackableEventSchema.safeParse(incomingEvent);\n\n      if (!trackableEvent.success) {\n        console.error(\"Invalid event:\", trackableEvent.error);\n        return new Response(JSON.stringify({ error: \"Invalid event\" }), {\n          status: 400,\n          headers: {\n            \"Content-Type\": \"application/json\",\n          },\n        });\n      }\n\n      // We don't want failures in third party services to prevent us from\n      // tracking analytics events.\n      let countryISOCode = \"Unknown\";\n      try {\n        const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\n          res.text()\n        );\n        const { country } = await maxMindClient.country(ip);\n        countryISOCode = country?.isoCode ?? \"Unknown\";\n      } catch (e) {\n        console.error(\"Geolocation failed:\", e);\n      }\n\n      const dispatchableEvent: DispatchableEvent = {\n        ...trackableEvent.data,\n        installationId,\n        countryISOCode,\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        let error = `Analytics platform returned an unexpected error: ${response.statusText}`;\n\n        if (response.status === 400) {\n          error = `Analytics platform rejected the event as invalid. Please check the event schema`;\n        }\n\n        if (response.status === 404) {\n          error = `Analytics platform could not be reached. Please specify a valid platform URL, or check that the platform is online.`;\n        }\n\n        if (response.status === 500) {\n          error = `Analytics platform returned an internal server error. Please check the platform logs.`;\n        }\n\n        console.info(\"⚠️ Analytics platform rejected event.\");\n        return Response.json(\n          {\n            error,\n          },\n          { status: 500 }\n        );\n      }\n      console.info(\"🚀 Analytics event sent to platform!\");\n      return Response.json({ message: \"Event forwarded successfully\" });\n    } catch (e) {\n      const error = ensureError(e);\n      console.info(\"🚫 Internal error with sending analytics event.\");\n\n      return Response.json(\n        { error: `Error in analytics route handler: ${error.message}` },\n        { status: 500 }\n      );\n    }\n  };\n};\n\ntype ConsumerConfiguration = {\n  enabled?: boolean;\n  endpoint?: string;\n};\n\nexport type EventTrackerReturn = {\n  error: string | null;\n  success: boolean;\n};\n\nexport const makeEventTracker =\n  ({ enabled = false, endpoint = \"/api/analytics\" }: ConsumerConfiguration) =>\n  async (event: RawEvent): Promise<EventTrackerReturn> => {\n    // If analytics is disabled don't send analytics events.\n    if (!enabled) {\n      console.log(\"Analytics disabled, not sending event\");\n      return { error: null, success: true };\n    }\n\n    const endpointWithHost = getBaseUrl() + endpoint;\n\n    const eventWithTimeStamp: TrackableEvent = {\n      ...event,\n      timestamp: new Date().toJSON(),\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          return {\n            error: `Analytics endpoint not found, did you forget to add the route?`,\n            success: false,\n          };\n        }\n\n        // createRouteHandler will return a 400 if the event failed schema validation.\n        if (response.status === 400) {\n          return {\n            error: `Invalid event sent to analytics endpoint: ${response.statusText}`,\n            success: false,\n          };\n        }\n\n        // createRouteHandler will return a 500 for all error states\n        return {\n          error: `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`,\n          success: false,\n        };\n      }\n\n      return { error: null, success: true };\n    } catch (e) {\n      const error = ensureError(e);\n      return {\n        error: `Internal error when sending analytics event: ${error.message}`,\n        success: false,\n      };\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;;;AChCA,OAAO,OAAO;AAGP,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAGA,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,SAAS;AAC3C,CAAC;AAED,IAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,MAAM,EAAE,KAAK,UAAU;AACzB,CAAC;AAED,IAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,MAAM,EAAE,QAAQ,OAAO;AAAA,EACvB,OAAO,EACJ,OAAO;AAAA,IACN,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,OAAO;AAAA,IACf,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,CAAC,EACA,OAAO;AACZ,CAAC;AAGM,IAAM,iBAAiB,EAAE,mBAAmB,QAAQ;AAAA,EACzD,0BAA0B,MAAM,WAAW;AAAA,EAC3C,0BAA0B,MAAM,WAAW;AAC7C,CAAC;AAID,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,WAAW,EAAE,OAAO;AACtB,CAAC;AAEM,IAAM,uBAAuB,EAAE;AAAA,EACpC;AAAA,EACA;AACF;AAIA,IAAM,+BAA+B,EAAE,OAAO;AAAA,EAC5C,gBAAgB,EAAE,OAAO;AAAA,EACzB,gBAAgB,EAAE,OAAO;AAC3B,CAAC;AAEM,IAAM,0BAA0B,EAAE;AAAA,EACvC;AAAA,EACA;AACF;AASO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,gBAAiB,MAAM,QAAQ,KAAK;AAG1C,YAAM,iBAAiB,qBAAqB,UAAU,aAAa;AAEnE,UAAI,CAAC,eAAe,SAAS;AAC3B,gBAAQ,MAAM,kBAAkB,eAAe,KAAK;AACpD,eAAO,IAAI,SAAS,KAAK,UAAU,EAAE,OAAO,gBAAgB,CAAC,GAAG;AAAA,UAC9D,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,UAClB;AAAA,QACF,CAAC;AAAA,MACH;AAIA,UAAI,iBAAiB;AACrB,UAAI;AACF,cAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,UAAK,CAAC,QACtD,IAAI,KAAK;AAAA,QACX;AACA,cAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,yBAAiB,SAAS,WAAW;AAAA,MACvC,SAAS,GAAG;AACV,gBAAQ,MAAM,uBAAuB,CAAC;AAAA,MACxC;AAEA,YAAM,oBAAuC;AAAA,QAC3C,GAAG,eAAe;AAAA,QAClB;AAAA,QACA;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,QAAQ,oDAAoD,SAAS,UAAU;AAEnF,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,QACV;AAEA,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,QACV;AAEA,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,QACV;AAEA,gBAAQ,KAAK,iDAAuC;AACpD,eAAO,SAAS;AAAA,UACd;AAAA,YACE;AAAA,UACF;AAAA,UACA,EAAE,QAAQ,IAAI;AAAA,QAChB;AAAA,MACF;AACA,cAAQ,KAAK,6CAAsC;AACnD,aAAO,SAAS,KAAK,EAAE,SAAS,+BAA+B,CAAC;AAAA,IAClE,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,KAAK,wDAAiD;AAE9D,aAAO,SAAS;AAAA,QACd,EAAE,OAAO,qCAAqC,MAAM,OAAO,GAAG;AAAA,QAC9D,EAAE,QAAQ,IAAI;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AACF;AAYO,IAAM,mBACX,CAAC,EAAE,UAAU,OAAO,WAAW,iBAAiB,MAChD,OAAO,UAAiD;AAEtD,MAAI,CAAC,SAAS;AACZ,YAAQ,IAAI,uCAAuC;AACnD,WAAO,EAAE,OAAO,MAAM,SAAS,KAAK;AAAA,EACtC;AAEA,QAAM,mBAAmB,WAAW,IAAI;AAExC,QAAM,qBAAqC;AAAA,IACzC,GAAG;AAAA,IACH,YAAW,oBAAI,KAAK,GAAE,OAAO;AAAA,EAC/B;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,eAAO;AAAA,UACL,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,MACF;AAGA,UAAI,SAAS,WAAW,KAAK;AAC3B,eAAO;AAAA,UACL,OAAO,6CAA6C,SAAS,UAAU;AAAA,UACvE,SAAS;AAAA,QACX;AAAA,MACF;AAGA,aAAO;AAAA,QACL,OAAO,uDAAuD,SAAS,UAAU;AAAA,QACjF,SAAS;AAAA,MACX;AAAA,IACF;AAEA,WAAO,EAAE,OAAO,MAAM,SAAS,KAAK;AAAA,EACtC,SAAS,GAAG;AACV,UAAM,QAAQ,YAAY,CAAC;AAC3B,WAAO;AAAA,MACL,OAAO,gDAAgD,MAAM,OAAO;AAAA,MACpE,SAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}