@codaco/analytics 5.1.0 → 6.0.0-alpha.2

package/.turbo/turbo-build.log

@@ -1,17 +1,12 @@
 
 
-> @codaco/analytics@5.0.0 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
+> @codaco/analytics@5.1.0 build /Users/jmh629/Projects/network-canvas/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.3.0
+CLI tsup v8.0.2
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
-ESM dist/index.js     5.77 KB
-ESM dist/index.js.map 11.87 KB
-ESM ⚡️ Build success in 18ms
 DTS Build start
-DTS ⚡️ Build success in 907ms
-DTS dist/index.d.ts 5.64 KB

package/dist/index.d.ts

@@ -7,68 +7,72 @@ declare const eventTypes: readonly ["AppSetup", "ProtocolInstalled", "InterviewS
  * events or errors. We discriminate on the `type` property to determine which
  * schema to use, and then merge the shared properties.
  */
-declare const RawEventSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+declare const RawEventSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, {
     type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
-}, "strip", z.ZodTypeAny, {
+}>, "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<{
+}>, z.ZodObject<z.objectUtil.extendShape<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, {
     type: z.ZodLiteral<"Error">;
     message: z.ZodString;
     name: z.ZodString;
     stack: z.ZodOptional<z.ZodString>;
     cause: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     type: "Error";
     message: string;
     name: string;
-    metadata?: Record<string, unknown> | undefined;
     stack?: string | undefined;
     cause?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }, {
     type: "Error";
     message: string;
     name: string;
-    metadata?: Record<string, unknown> | undefined;
     stack?: string | undefined;
     cause?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }>]>;
 type RawEvent = z.infer<typeof RawEventSchema>;
-declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, {
     type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
-}, "strip", z.ZodTypeAny, {
+}>, "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<{
+}>, z.ZodObject<z.objectUtil.extendShape<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, {
     type: z.ZodLiteral<"Error">;
     message: z.ZodString;
     name: z.ZodString;
     stack: z.ZodOptional<z.ZodString>;
     cause: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     type: "Error";
     message: string;
     name: string;
-    metadata?: Record<string, unknown> | undefined;
     stack?: string | undefined;
     cause?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }, {
     type: "Error";
     message: string;
     name: string;
-    metadata?: Record<string, unknown> | undefined;
     stack?: string | undefined;
     cause?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }>]>, z.ZodObject<{
     timestamp: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -82,36 +86,38 @@ type TrackableEvent = z.infer<typeof TrackableEventSchema>;
  * validate the event before it is inserted into the database. It is the
  * intersection of the trackable event and the dispatchable properties.
  */
-declare const AnalyticsEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+declare const AnalyticsEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, {
     type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
-}, "strip", z.ZodTypeAny, {
+}>, "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<{
+}>, z.ZodObject<z.objectUtil.extendShape<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, {
     type: z.ZodLiteral<"Error">;
     message: z.ZodString;
     name: z.ZodString;
     stack: z.ZodOptional<z.ZodString>;
     cause: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     type: "Error";
     message: string;
     name: string;
-    metadata?: Record<string, unknown> | undefined;
     stack?: string | undefined;
     cause?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }, {
     type: "Error";
     message: string;
     name: string;
-    metadata?: Record<string, unknown> | undefined;
     stack?: string | undefined;
     cause?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }>]>, z.ZodObject<{
     timestamp: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -130,12 +136,11 @@ declare const AnalyticsEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDis
 }>>;
 type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;
 declare const createRouteHandler: ({ platformUrl, installationId, }: {
-    platformUrl?: string | undefined;
+    platformUrl?: string;
     installationId: string;
 }) => (request: NextRequest) => Promise<Response>;
-declare const makeEventTracker: ({ enabled, endpoint, }: {
-    enabled?: boolean | undefined;
-    endpoint?: string | undefined;
+declare const makeEventTracker: ({ endpoint }: {
+    endpoint?: string;
 }) => (event: RawEvent) => Promise<{
     error: string | null;
     success: boolean;

package/dist/index.js

@@ -1,15 +1,19 @@
+// src/index.ts
+import { NextResponse } from "next/server";
+
 // 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))
+  if (Object.prototype.isPrototypeOf.call(value, Error))
     return value;
   let stringified = "[Unable to stringify the thrown value]";
   try {
     stringified = JSON.stringify(value);
-  } catch {
+  } catch (e) {
+    console.error(e);
   }
   const error = new Error(
     `This value was thrown as is, not through an Error: ${stringified}`
@@ -74,15 +78,26 @@ var createRouteHandler = ({
   return async (request) => {
     try {
       const incomingEvent = await request.json();
+      if (process.env.DISABLE_ANALYTICS) {
+        console.info("\u{1F6D1} Analytics disabled. Payload not sent.");
+        try {
+          console.info(
+            "Payload:",
+            "\n",
+            JSON.stringify(incomingEvent, null, 2)
+          );
+        } catch (e) {
+          console.error("Error stringifying payload:", e);
+        }
+        return NextResponse.json(
+          { message: "Analytics disabled" },
+          { status: 200 }
+        );
+      }
       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"
-          }
-        });
+        return NextResponse.json({ error: "Invalid event" }, { status: 400 });
       }
       let countryISOCode = "Unknown";
       try {
@@ -92,7 +107,9 @@ var createRouteHandler = ({
         if (!ip) {
           throw new Error("Could not fetch IP address");
         }
-        const geoData = await fetch(`http://ip-api.com/json/${ip}`).then((res) => res.json());
+        const geoData = await fetch(`http://ip-api.com/json/${ip}`).then(
+          (res) => res.json()
+        );
         if (geoData.status === "success") {
           countryISOCode = geoData.countryCode;
         } else {
@@ -145,14 +162,7 @@ var createRouteHandler = ({
     }
   };
 };
-var makeEventTracker = ({
-  enabled = false,
-  endpoint = "/api/analytics"
-}) => async (event) => {
-  if (!enabled) {
-    console.log("Analytics disabled - event not sent.");
-    return { error: null, success: true };
-  }
+var makeEventTracker = ({ endpoint = "/api/analytics" }) => async (event) => {
   const endpointWithHost = getBaseUrl() + endpoint;
   const eventWithTimeStamp = {
     ...event,

package/dist/index.js.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 { 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\nconst EventSchema = z.object({\n  type: z.enum(eventTypes),\n});\n\nconst ErrorSchema = z.object({\n  type: z.literal(\"Error\"),\n  message: z.string(),\n  name: z.string(),\n  stack: z.string().optional(),\n  cause: z.string().optional(),\n});\n\nconst SharedEventAndErrorSchema = z.object({\n  metadata: z.record(z.unknown()).optional(),\n});\n\n/**\n * Raw events are the events that are sent trackEvent. They are either general\n * events or errors. We discriminate on the `type` property to determine which\n * schema to use, and then merge the shared properties.\n */\nexport const RawEventSchema = z.discriminatedUnion(\"type\", [\n  SharedEventAndErrorSchema.merge(EventSchema),\n  SharedEventAndErrorSchema.merge(ErrorSchema),\n]);\nexport type RawEvent = z.infer<typeof RawEventSchema>;\n\n/**\n * Trackable events are the events that are sent to the route handler. The\n * `trackEvent` function adds the timestamp to ensure it is not inaccurate\n * due to network latency or processing time.\n */\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/**\n * Dispatchable events are the events that are sent to the platform. The route\n * handler injects the installationId and countryISOCode properties.\n */\nconst DispatchablePropertiesSchema = z.object({\n  installationId: z.string(),\n  countryISOCode: z.string(),\n});\n\n/**\n * The final schema for an analytics event. This is the schema that is used to\n * validate the event before it is inserted into the database. It is the\n * intersection of the trackable event and the dispatchable properties.\n */\nexport const AnalyticsEventSchema = z.intersection(\n  TrackableEventSchema,\n  DispatchablePropertiesSchema\n);\nexport type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;\n\nexport const createRouteHandler = ({\n  platformUrl = \"https://analytics.networkcanvas.com\",\n  installationId,\n}: {\n  platformUrl?: string;\n  installationId: string;\n}) => {\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, so we'll catch any errors and log them\n      // and continue with an 'Unknown' country code.\n      let countryISOCode = \"Unknown\";\n      try {\n        const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\n          res.text()\n        );\n\n        if (!ip) {\n          throw new Error(\"Could not fetch IP address\");\n        }\n\n        const geoData = await fetch(`http://ip-api.com/json/${ip}`).then((res) => res.json());\n\n        if(geoData.status === \"success\") {\n          countryISOCode = geoData.countryCode;\n        } else {\n          throw new Error(geoData.message);\n        }\n      } catch (e) {\n        console.error(\"Geolocation failed:\", e);\n      }\n\n      const analyticsEvent: analyticsEvent = {\n        ...trackableEvent.data,\n        installationId,\n        countryISOCode,\n      };\n\n      // Forward to backend\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(analyticsEvent),\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: ${error}`);\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\nexport const makeEventTracker =\n  ({\n    enabled = false,\n    endpoint = \"/api/analytics\",\n  }: {\n    enabled?: boolean;\n    endpoint?: string;\n  }) =>\n  async (\n    event: RawEvent\n  ): Promise<{\n    error: string | null;\n    success: boolean;\n  }> => {\n    if (!enabled) {\n      console.log(\"Analytics disabled - event not sent.\");\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;;;ACjCA,OAAO,OAAO;AAGP,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEA,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,SAAS,EAAE,OAAO;AAAA,EAClB,MAAM,EAAE,OAAO;AAAA,EACf,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,OAAO,EAAE,OAAO,EAAE,SAAS;AAC7B,CAAC;AAED,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,SAAS;AAC3C,CAAC;AAOM,IAAM,iBAAiB,EAAE,mBAAmB,QAAQ;AAAA,EACzD,0BAA0B,MAAM,WAAW;AAAA,EAC3C,0BAA0B,MAAM,WAAW;AAC7C,CAAC;AAQD,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,WAAW,EAAE,OAAO;AACtB,CAAC;AAEM,IAAM,uBAAuB,EAAE;AAAA,EACpC;AAAA,EACA;AACF;AAOA,IAAM,+BAA+B,EAAE,OAAO;AAAA,EAC5C,gBAAgB,EAAE,OAAO;AAAA,EACzB,gBAAgB,EAAE,OAAO;AAC3B,CAAC;AAOM,IAAM,uBAAuB,EAAE;AAAA,EACpC;AAAA,EACA;AACF;AAGO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AACF,MAGM;AACJ,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;AAKA,UAAI,iBAAiB;AACrB,UAAI;AACF,cAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,UAAK,CAAC,QACtD,IAAI,KAAK;AAAA,QACX;AAEA,YAAI,CAAC,IAAI;AACP,gBAAM,IAAI,MAAM,4BAA4B;AAAA,QAC9C;AAEA,cAAM,UAAU,MAAM,MAAM,0BAA0B,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;AAEpF,YAAG,QAAQ,WAAW,WAAW;AAC/B,2BAAiB,QAAQ;AAAA,QAC3B,OAAO;AACL,gBAAM,IAAI,MAAM,QAAQ,OAAO;AAAA,QACjC;AAAA,MACF,SAAS,GAAG;AACV,gBAAQ,MAAM,uBAAuB,CAAC;AAAA,MACxC;AAEA,YAAM,iBAAiC;AAAA,QACrC,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,cAAc;AAAA,MACrC,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,mDAAyC,KAAK,EAAE;AAC7D,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;AAEO,IAAM,mBACX,CAAC;AAAA,EACC,UAAU;AAAA,EACV,WAAW;AACb,MAIA,OACE,UAII;AACJ,MAAI,CAAC,SAAS;AACZ,YAAQ,IAAI,sCAAsC;AAClD,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":[]}
+{"version":3,"sources":["../src/index.ts","../src/utils.ts"],"sourcesContent":["import { NextResponse, type NextRequest } from 'next/server';\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\nconst EventSchema = z.object({\n  type: z.enum(eventTypes),\n});\n\nconst ErrorSchema = z.object({\n  type: z.literal('Error'),\n  message: z.string(),\n  name: z.string(),\n  stack: z.string().optional(),\n  cause: z.string().optional(),\n});\n\nconst SharedEventAndErrorSchema = z.object({\n  metadata: z.record(z.unknown()).optional(),\n});\n\n/**\n * Raw events are the events that are sent trackEvent. They are either general\n * events or errors. We discriminate on the `type` property to determine which\n * schema to use, and then merge the shared properties.\n */\nexport const RawEventSchema = z.discriminatedUnion('type', [\n  SharedEventAndErrorSchema.merge(EventSchema),\n  SharedEventAndErrorSchema.merge(ErrorSchema),\n]);\nexport type RawEvent = z.infer<typeof RawEventSchema>;\n\n/**\n * Trackable events are the events that are sent to the route handler. The\n * `trackEvent` function adds the timestamp to ensure it is not inaccurate\n * due to network latency or processing time.\n */\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/**\n * Dispatchable events are the events that are sent to the platform. The route\n * handler injects the installationId and countryISOCode properties.\n */\nconst DispatchablePropertiesSchema = z.object({\n  installationId: z.string(),\n  countryISOCode: z.string(),\n});\n\n/**\n * The final schema for an analytics event. This is the schema that is used to\n * validate the event before it is inserted into the database. It is the\n * intersection of the trackable event and the dispatchable properties.\n */\nexport const AnalyticsEventSchema = z.intersection(\n  TrackableEventSchema,\n  DispatchablePropertiesSchema,\n);\nexport type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;\n\ntype GeoData = {\n  status: 'success' | 'fail';\n  countryCode: string;\n  message: string;\n};\n\nexport const createRouteHandler = ({\n  platformUrl = 'https://analytics.networkcanvas.com',\n  installationId,\n}: {\n  platformUrl?: string;\n  installationId: string;\n}) => {\n  return async (request: NextRequest) => {\n    try {\n      const incomingEvent = (await request.json()) as unknown;\n\n      // Check if analytics is disabled\n      // eslint-disable-next-line no-process-env, turbo/no-undeclared-env-vars\n      if (process.env.DISABLE_ANALYTICS) {\n        // eslint-disable-next-line no-console\n        console.info('🛑 Analytics disabled. Payload not sent.');\n        try {\n          // eslint-disable-next-line no-console\n          console.info(\n            'Payload:',\n            '\\n',\n            JSON.stringify(incomingEvent, null, 2),\n          );\n        } catch (e) {\n          // eslint-disable-next-line no-console\n          console.error('Error stringifying payload:', e);\n        }\n\n        return NextResponse.json(\n          { message: 'Analytics disabled' },\n          { status: 200 },\n        );\n      }\n\n      // Validate the event\n      const trackableEvent = TrackableEventSchema.safeParse(incomingEvent);\n\n      if (!trackableEvent.success) {\n        // eslint-disable-next-line no-console\n        console.error('Invalid event:', trackableEvent.error);\n        return NextResponse.json({ error: 'Invalid event' }, { status: 400 });\n      }\n\n      // We don't want failures in third party services to prevent us from\n      // tracking analytics events, so we'll catch any errors and log them\n      // and continue with an 'Unknown' country code.\n      let countryISOCode = 'Unknown';\n      try {\n        const ip = await fetch('https://api64.ipify.org').then((res) =>\n          res.text(),\n        );\n\n        if (!ip) {\n          throw new Error('Could not fetch IP address');\n        }\n\n        const geoData = (await fetch(`http://ip-api.com/json/${ip}`).then(\n          (res) => res.json(),\n        )) as GeoData;\n\n        if (geoData.status === 'success') {\n          countryISOCode = geoData.countryCode;\n        } else {\n          throw new Error(geoData.message);\n        }\n      } catch (e) {\n        // eslint-disable-next-line no-console\n        console.error('Geolocation failed:', e);\n      }\n\n      const analyticsEvent: analyticsEvent = {\n        ...trackableEvent.data,\n        installationId,\n        countryISOCode,\n      };\n\n      // Forward to backend\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(analyticsEvent),\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        // eslint-disable-next-line no-console\n        console.info(`⚠️ Analytics platform rejected event: ${error}`);\n        return Response.json(\n          {\n            error,\n          },\n          { status: 500 },\n        );\n      }\n      // eslint-disable-next-line no-console\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      // eslint-disable-next-line no-console\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\nexport const makeEventTracker =\n  ({ endpoint = '/api/analytics' }: { endpoint?: string }) =>\n  async (\n    event: RawEvent,\n  ): Promise<{\n    error: string | null;\n    success: boolean;\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","/* eslint-disable no-process-env */\n// 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 (Object.prototype.isPrototypeOf.call(value, Error))\n    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 (e) {\n    // eslint-disable-next-line no-console\n    console.error(e);\n  }\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"],"mappings":";AAAA,SAAS,oBAAsC;;;ACExC,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC;AAAO,WAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB;AAAO,WAAO;AAGnC,MAAI,OAAO,UAAU,cAAc,KAAK,OAAO,KAAK;AAClD,WAAO;AAET,MAAI,cAAc;AAClB,MAAI;AACF,kBAAc,KAAK,UAAU,KAAK;AAAA,EACpC,SAAS,GAAG;AAEV,YAAQ,MAAM,CAAC;AAAA,EACjB;AAEA,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;;;ADtCA,OAAO,OAAO;AAGP,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEA,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,SAAS,EAAE,OAAO;AAAA,EAClB,MAAM,EAAE,OAAO;AAAA,EACf,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,OAAO,EAAE,OAAO,EAAE,SAAS;AAC7B,CAAC;AAED,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,SAAS;AAC3C,CAAC;AAOM,IAAM,iBAAiB,EAAE,mBAAmB,QAAQ;AAAA,EACzD,0BAA0B,MAAM,WAAW;AAAA,EAC3C,0BAA0B,MAAM,WAAW;AAC7C,CAAC;AAQD,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,WAAW,EAAE,OAAO;AACtB,CAAC;AAEM,IAAM,uBAAuB,EAAE;AAAA,EACpC;AAAA,EACA;AACF;AAOA,IAAM,+BAA+B,EAAE,OAAO;AAAA,EAC5C,gBAAgB,EAAE,OAAO;AAAA,EACzB,gBAAgB,EAAE,OAAO;AAC3B,CAAC;AAOM,IAAM,uBAAuB,EAAE;AAAA,EACpC;AAAA,EACA;AACF;AASO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AACF,MAGM;AACJ,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,gBAAiB,MAAM,QAAQ,KAAK;AAI1C,UAAI,QAAQ,IAAI,mBAAmB;AAEjC,gBAAQ,KAAK,iDAA0C;AACvD,YAAI;AAEF,kBAAQ;AAAA,YACN;AAAA,YACA;AAAA,YACA,KAAK,UAAU,eAAe,MAAM,CAAC;AAAA,UACvC;AAAA,QACF,SAAS,GAAG;AAEV,kBAAQ,MAAM,+BAA+B,CAAC;AAAA,QAChD;AAEA,eAAO,aAAa;AAAA,UAClB,EAAE,SAAS,qBAAqB;AAAA,UAChC,EAAE,QAAQ,IAAI;AAAA,QAChB;AAAA,MACF;AAGA,YAAM,iBAAiB,qBAAqB,UAAU,aAAa;AAEnE,UAAI,CAAC,eAAe,SAAS;AAE3B,gBAAQ,MAAM,kBAAkB,eAAe,KAAK;AACpD,eAAO,aAAa,KAAK,EAAE,OAAO,gBAAgB,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,MACtE;AAKA,UAAI,iBAAiB;AACrB,UAAI;AACF,cAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,UAAK,CAAC,QACtD,IAAI,KAAK;AAAA,QACX;AAEA,YAAI,CAAC,IAAI;AACP,gBAAM,IAAI,MAAM,4BAA4B;AAAA,QAC9C;AAEA,cAAM,UAAW,MAAM,MAAM,0BAA0B,EAAE,EAAE,EAAE;AAAA,UAC3D,CAAC,QAAQ,IAAI,KAAK;AAAA,QACpB;AAEA,YAAI,QAAQ,WAAW,WAAW;AAChC,2BAAiB,QAAQ;AAAA,QAC3B,OAAO;AACL,gBAAM,IAAI,MAAM,QAAQ,OAAO;AAAA,QACjC;AAAA,MACF,SAAS,GAAG;AAEV,gBAAQ,MAAM,uBAAuB,CAAC;AAAA,MACxC;AAEA,YAAM,iBAAiC;AAAA,QACrC,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,cAAc;AAAA,MACrC,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;AAGA,gBAAQ,KAAK,mDAAyC,KAAK,EAAE;AAC7D,eAAO,SAAS;AAAA,UACd;AAAA,YACE;AAAA,UACF;AAAA,UACA,EAAE,QAAQ,IAAI;AAAA,QAChB;AAAA,MACF;AAEA,cAAQ,KAAK,6CAAsC;AACnD,aAAO,SAAS,KAAK,EAAE,SAAS,+BAA+B,CAAC;AAAA,IAClE,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAE3B,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;AAEO,IAAM,mBACX,CAAC,EAAE,WAAW,iBAAiB,MAC/B,OACE,UAII;AACJ,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":[]}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@codaco/analytics",
-  "version": "5.1.0",
+  "version": "6.0.0-alpha.2",
+  "packageManager": "pnpm@8.15.5+sha256.4b4efa12490e5055d59b9b9fc9438b7d581a6b7af3b5675eb5c5f447cee1a589",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "author": "Complex Data Collective <developers@coda.co>",
+  "author": "Complex Data Collective <hello@complexdatacollective.org>",
   "description": "Utilities for tracking analytics and error reporting in Fresco",
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts --clean --sourcemap",
@@ -12,15 +13,25 @@
     "dev": "npm run build -- --watch"
   },
   "peerDependencies": {
-    "next": "13 || 14"
+    "next": "13 || 14 || 15"
   },
   "devDependencies": {
-    "eslint-config-custom": "workspace:*",
-    "tsconfig": "workspace:*",
-    "tsup": "^7.2.0",
-    "typescript": "^5.3.2"
+    "@codaco/eslint-config": "workspace:*",
+    "@codaco/tsconfig": "workspace:*",
+    "eslint": "^8.57.0",
+    "prettier": "^3.2.5",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@codaco/eslint-config/base",
+      "@codaco/eslint-config/nextjs",
+      "@codaco/eslint-config/react"
+    ]
   }
 }

package/src/index.ts

@@ -1,14 +1,14 @@
-import { type NextRequest } from "next/server";
-import { ensureError, getBaseUrl } from "./utils";
-import z from "zod";
+import { NextResponse, type NextRequest } from 'next/server';
+import { ensureError, getBaseUrl, strictBooleanSchema } from './utils';
+import z from 'zod';
 
 // Todo: it would be great to work out a way to support arbitrary types here.
 export const eventTypes = [
-  "AppSetup",
-  "ProtocolInstalled",
-  "InterviewStarted",
-  "InterviewCompleted",
-  "DataExported",
+  'AppSetup',
+  'ProtocolInstalled',
+  'InterviewStarted',
+  'InterviewCompleted',
+  'DataExported',
 ] as const;
 
 const EventSchema = z.object({
@@ -16,7 +16,7 @@ const EventSchema = z.object({
 });
 
 const ErrorSchema = z.object({
-  type: z.literal("Error"),
+  type: z.literal('Error'),
   message: z.string(),
   name: z.string(),
   stack: z.string().optional(),
@@ -32,7 +32,7 @@ const SharedEventAndErrorSchema = z.object({
  * events or errors. We discriminate on the `type` property to determine which
  * schema to use, and then merge the shared properties.
  */
-export const RawEventSchema = z.discriminatedUnion("type", [
+export const RawEventSchema = z.discriminatedUnion('type', [
   SharedEventAndErrorSchema.merge(EventSchema),
   SharedEventAndErrorSchema.merge(ErrorSchema),
 ]);
@@ -49,7 +49,7 @@ const TrackablePropertiesSchema = z.object({
 
 export const TrackableEventSchema = z.intersection(
   RawEventSchema,
-  TrackablePropertiesSchema
+  TrackablePropertiesSchema,
 );
 export type TrackableEvent = z.infer<typeof TrackableEventSchema>;
 
@@ -69,12 +69,18 @@ const DispatchablePropertiesSchema = z.object({
  */
 export const AnalyticsEventSchema = z.intersection(
   TrackableEventSchema,
-  DispatchablePropertiesSchema
+  DispatchablePropertiesSchema,
 );
 export type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;
 
+type GeoData = {
+  status: 'success' | 'fail';
+  countryCode: string;
+  message: string;
+};
+
 export const createRouteHandler = ({
-  platformUrl = "https://analytics.networkcanvas.com",
+  platformUrl = 'https://analytics.networkcanvas.com',
   installationId,
 }: {
   platformUrl?: string;
@@ -84,41 +90,67 @@ export const createRouteHandler = ({
     try {
       const incomingEvent = (await request.json()) as unknown;
 
+      const disableAnalytics = strictBooleanSchema.parse(
+        // eslint-disable-next-line no-process-env
+        process.env.DISABLE_ANALYTICS,
+      );
+
+      // Check if analytics is disabled
+      if (disableAnalytics) {
+        // eslint-disable-next-line no-console
+        console.info('🛑 Analytics disabled. Payload not sent.');
+        try {
+          // eslint-disable-next-line no-console
+          console.info(
+            'Payload:',
+            '\n',
+            JSON.stringify(incomingEvent, null, 2),
+          );
+        } catch (e) {
+          // eslint-disable-next-line no-console
+          console.error('Error stringifying payload:', e);
+        }
+
+        return NextResponse.json(
+          { message: 'Analytics disabled' },
+          { status: 200 },
+        );
+      }
+
       // Validate the event
       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",
-          },
-        });
+        // eslint-disable-next-line no-console
+        console.error('Invalid event:', trackableEvent.error);
+        return NextResponse.json({ error: 'Invalid event' }, { status: 400 });
       }
 
       // We don't want failures in third party services to prevent us from
       // tracking analytics events, so we'll catch any errors and log them
       // and continue with an 'Unknown' country code.
-      let countryISOCode = "Unknown";
+      let countryISOCode = 'Unknown';
       try {
-        const ip = await fetch("https://api64.ipify.org").then((res) =>
-          res.text()
+        const ip = await fetch('https://api64.ipify.org').then((res) =>
+          res.text(),
         );
 
         if (!ip) {
-          throw new Error("Could not fetch IP address");
+          throw new Error('Could not fetch IP address');
         }
 
-        const geoData = await fetch(`http://ip-api.com/json/${ip}`).then((res) => res.json());
+        const geoData = (await fetch(`http://ip-api.com/json/${ip}`).then(
+          (res) => res.json(),
+        )) as GeoData;
 
-        if(geoData.status === "success") {
+        if (geoData.status === 'success') {
           countryISOCode = geoData.countryCode;
         } else {
           throw new Error(geoData.message);
         }
       } catch (e) {
-        console.error("Geolocation failed:", e);
+        // eslint-disable-next-line no-console
+        console.error('Geolocation failed:', e);
       }
 
       const analyticsEvent: analyticsEvent = {
@@ -130,9 +162,9 @@ export const createRouteHandler = ({
       // Forward to backend
       const response = await fetch(`${platformUrl}/api/event`, {
         keepalive: true,
-        method: "POST",
+        method: 'POST',
         headers: {
-          "Content-Type": "application/json",
+          'Content-Type': 'application/json',
         },
         body: JSON.stringify(analyticsEvent),
       });
@@ -152,48 +184,41 @@ export const createRouteHandler = ({
           error = `Analytics platform returned an internal server error. Please check the platform logs.`;
         }
 
+        // eslint-disable-next-line no-console
         console.info(`⚠️ Analytics platform rejected event: ${error}`);
         return Response.json(
           {
             error,
           },
-          { status: 500 }
+          { status: 500 },
         );
       }
-      console.info("🚀 Analytics event sent to platform!");
-      return Response.json({ message: "Event forwarded successfully" });
+      // eslint-disable-next-line no-console
+      console.info('🚀 Analytics event sent to platform!');
+      return Response.json({ message: 'Event forwarded successfully' });
     } catch (e) {
       const error = ensureError(e);
-      console.info("🚫 Internal error with sending analytics event.");
+      // eslint-disable-next-line no-console
+      console.info('🚫 Internal error with sending analytics event.');
 
       return Response.json(
         { error: `Error in analytics route handler: ${error.message}` },
-        { status: 500 }
+        { status: 500 },
       );
     }
   };
 };
 
 export const makeEventTracker =
-  ({
-    enabled = false,
-    endpoint = "/api/analytics",
-  }: {
-    enabled?: boolean;
-    endpoint?: string;
-  }) =>
+  (options?: { endpoint?: string }) =>
   async (
-    event: RawEvent
+    event: RawEvent,
   ): Promise<{
     error: string | null;
     success: boolean;
   }> => {
-    if (!enabled) {
-      console.log("Analytics disabled - event not sent.");
-      return { error: null, success: true };
-    }
-
-    const endpointWithHost = getBaseUrl() + endpoint;
+    const endpointWithHost =
+      getBaseUrl() + options?.endpoint ?? '/api/analytics';
 
     const eventWithTimeStamp: TrackableEvent = {
       ...event,
@@ -202,11 +227,11 @@ export const makeEventTracker =
 
     try {
       const response = await fetch(endpointWithHost, {
-        method: "POST",
+        method: 'POST',
         keepalive: true,
         body: JSON.stringify(eventWithTimeStamp),
         headers: {
-          "Content-Type": "application/json",
+          'Content-Type': 'application/json',
         },
       });
 

package/src/utils.ts

@@ -1,36 +1,49 @@
+/* eslint-disable no-process-env */
+
+import { z } from 'zod';
+
 // 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) 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;
+  if (Object.prototype.isPrototypeOf.call(value, Error))
+    return value as Error & typeof value;
 
-  let stringified = "[Unable to stringify the thrown value]";
+  let stringified = '[Unable to stringify the thrown value]';
   try {
     stringified = JSON.stringify(value);
-  } catch {}
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.error(e);
+  }
 
   const error = new Error(
-    `This value was thrown as is, not through an Error: ${stringified}`
+    `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)
+  if (process.env.PUBLIC_URL)
     // Manually set deployment URL from env
-    return process.env.NEXT_PUBLIC_URL;
+    return process.env.PUBLIC_URL;
 
   // assume localhost
   return `http://127.0.0.1:3000`;
 }
+
+// this is a workaround for this issue:https://github.com/colinhacks/zod/issues/1630
+// z.coerce.boolean() doesn't work as expected
+export const strictBooleanSchema = z
+  .enum(['true', 'false', 'True', 'False', 'TRUE', 'FALSE'])
+  .default('false')
+  .transform(
+    (value) => value === 'true' || value === 'True' || value === 'TRUE',
+  );

package/tsconfig.json

@@ -1,11 +1,9 @@
 {
-  "extends": "tsconfig/react-library.json",
-  "include": [
-    "."
-  ],
-  "exclude": [
-    "dist",
-    "build",
-    "node_modules"
-  ]
-}
+  "extends": "@codaco/tsconfig/base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["."],
+  "exclude": ["dist", "build", "node_modules"]
+}

package/.eslintrc.js

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