@codaco/analytics 6.0.0 → 8.0.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @codaco/analytics
+
+## 8.0.0
+
+### Major Changes
+
+- 3849e0e: Updated zod to version 4. Consumers must also use zod 4 to avoid type conflicts.

package/dist/index.d.ts

@@ -7,137 +7,76 @@ declare const eventTypes: readonly ["AppSetup", "ProtocolInstalled", "InterviewS
  * general 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<z.objectUtil.extendShape<{
+declare const RawEventSchema: z.ZodDiscriminatedUnion<[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<z.objectUtil.extendShape<{
+    type: z.ZodEnum<{
+        AppSetup: "AppSetup";
+        ProtocolInstalled: "ProtocolInstalled";
+        InterviewStarted: "InterviewStarted";
+        InterviewCompleted: "InterviewCompleted";
+        DataExported: "DataExported";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
     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, {
-    type: "Error";
-    message: string;
-    name: string;
-    stack?: string | undefined;
-    cause?: string | undefined;
-    metadata?: Record<string, unknown> | undefined;
-}, {
-    type: "Error";
-    message: string;
-    name: string;
-    stack?: string | undefined;
-    cause?: string | undefined;
-    metadata?: Record<string, unknown> | undefined;
-}>]>;
+}, z.core.$strip>], "type">;
 type RawEvent = z.infer<typeof RawEventSchema>;
-declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
+declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<[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<z.objectUtil.extendShape<{
+    type: z.ZodEnum<{
+        AppSetup: "AppSetup";
+        ProtocolInstalled: "ProtocolInstalled";
+        InterviewStarted: "InterviewStarted";
+        InterviewCompleted: "InterviewCompleted";
+        DataExported: "DataExported";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
     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, {
-    type: "Error";
-    message: string;
-    name: string;
-    stack?: string | undefined;
-    cause?: string | undefined;
-    metadata?: Record<string, unknown> | undefined;
-}, {
-    type: "Error";
-    message: string;
-    name: string;
-    stack?: string | undefined;
-    cause?: string | undefined;
-    metadata?: Record<string, unknown> | undefined;
-}>]>, z.ZodObject<{
+}, z.core.$strip>], "type">, z.ZodObject<{
     timestamp: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    timestamp: string;
-}, {
-    timestamp: string;
-}>>;
+}, z.core.$strip>>;
 type TrackableEvent = z.infer<typeof TrackableEventSchema>;
 /**
  * The final schema for an analytics event. This is the schema that is used to
  * 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<z.objectUtil.extendShape<{
+declare const AnalyticsEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<[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<z.objectUtil.extendShape<{
+    type: z.ZodEnum<{
+        AppSetup: "AppSetup";
+        ProtocolInstalled: "ProtocolInstalled";
+        InterviewStarted: "InterviewStarted";
+        InterviewCompleted: "InterviewCompleted";
+        DataExported: "DataExported";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
     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, {
-    type: "Error";
-    message: string;
-    name: string;
-    stack?: string | undefined;
-    cause?: string | undefined;
-    metadata?: Record<string, unknown> | undefined;
-}, {
-    type: "Error";
-    message: string;
-    name: string;
-    stack?: string | undefined;
-    cause?: string | undefined;
-    metadata?: Record<string, unknown> | undefined;
-}>]>, z.ZodObject<{
+}, z.core.$strip>], "type">, z.ZodObject<{
     timestamp: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    timestamp: string;
-}, {
-    timestamp: string;
-}>>, z.ZodObject<{
+}, z.core.$strip>>, z.ZodObject<{
     installationId: z.ZodString;
     countryISOCode: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    installationId: string;
-    countryISOCode: string;
-}, {
-    installationId: string;
-    countryISOCode: string;
-}>>;
+}, z.core.$strip>>;
 type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;
-declare const createRouteHandler: ({ platformUrl, installationId, }: {
+declare const createRouteHandler: ({ platformUrl, installationId, disableAnalytics, }: {
     platformUrl?: string;
     installationId: string;
+    disableAnalytics?: boolean;
 }) => (request: NextRequest) => Promise<Response>;
 declare const makeEventTracker: (options?: {
     endpoint?: string;

package/dist/index.js

@@ -1,32 +1,23 @@
 // src/index.ts
 import { NextResponse } from "next/server";
+import z from "zod";
 
 // src/utils.ts
-import { z } from "zod";
 function ensureError(value) {
-  if (!value)
-    return new Error("No value was thrown");
-  if (value instanceof Error)
-    return value;
-  if (Object.prototype.isPrototypeOf.call(value, Error))
-    return value;
+  if (!value) return new Error("No value was thrown");
+  if (value instanceof Error) return value;
+  if (Object.prototype.isPrototypeOf.call(value, Error)) return value;
   let stringified = "[Unable to stringify the thrown value]";
   try {
     stringified = JSON.stringify(value);
   } catch (e) {
     console.error(e);
   }
-  const error = new Error(
-    `This value was thrown as is, not through an Error: ${stringified}`
-  );
+  const error = new Error(`This value was thrown as is, not through an Error: ${stringified}`);
   return error;
 }
-var strictBooleanSchema = z.enum(["true", "false", "True", "False", "TRUE", "FALSE"]).default("false").transform(
-  (value) => value === "true" || value === "True" || value === "TRUE"
-);
 
 // src/index.ts
-import z2 from "zod";
 var eventTypes = [
   "AppSetup",
   "ProtocolInstalled",
@@ -34,64 +25,48 @@ var eventTypes = [
   "InterviewCompleted",
   "DataExported"
 ];
-var EventSchema = z2.object({
-  type: z2.enum(eventTypes)
+var EventSchema = z.object({
+  type: z.enum(eventTypes)
 });
-var ErrorSchema = z2.object({
-  type: z2.literal("Error"),
-  message: z2.string(),
-  name: z2.string(),
-  stack: z2.string().optional(),
-  cause: z2.string().optional()
+var ErrorSchema = z.object({
+  type: z.literal("Error"),
+  message: z.string(),
+  name: z.string(),
+  stack: z.string().optional(),
+  cause: z.string().optional()
 });
-var SharedEventAndErrorSchema = z2.object({
-  metadata: z2.record(z2.unknown()).optional()
+var SharedEventAndErrorSchema = z.object({
+  metadata: z.record(z.string(), z.unknown()).optional()
 });
-var RawEventSchema = z2.discriminatedUnion("type", [
+var RawEventSchema = z.discriminatedUnion("type", [
   SharedEventAndErrorSchema.merge(EventSchema),
   SharedEventAndErrorSchema.merge(ErrorSchema)
 ]);
-var TrackablePropertiesSchema = z2.object({
-  timestamp: z2.string()
+var TrackablePropertiesSchema = z.object({
+  timestamp: z.string()
 });
-var TrackableEventSchema = z2.intersection(
-  RawEventSchema,
-  TrackablePropertiesSchema
-);
-var DispatchablePropertiesSchema = z2.object({
-  installationId: z2.string(),
-  countryISOCode: z2.string()
+var TrackableEventSchema = z.intersection(RawEventSchema, TrackablePropertiesSchema);
+var DispatchablePropertiesSchema = z.object({
+  installationId: z.string(),
+  countryISOCode: z.string()
 });
-var AnalyticsEventSchema = z2.intersection(
-  TrackableEventSchema,
-  DispatchablePropertiesSchema
-);
+var AnalyticsEventSchema = z.intersection(TrackableEventSchema, DispatchablePropertiesSchema);
 var createRouteHandler = ({
   platformUrl = "https://analytics.networkcanvas.com",
-  installationId
+  installationId,
+  disableAnalytics
 }) => {
   return async (request) => {
     try {
       const incomingEvent = await request.json();
-      const disableAnalytics = strictBooleanSchema.parse(
-        // eslint-disable-next-line no-process-env
-        process.env.DISABLE_ANALYTICS
-      );
       if (disableAnalytics) {
         console.info("\u{1F6D1} Analytics disabled. Payload not sent.");
         try {
-          console.info(
-            "Payload:",
-            "\n",
-            JSON.stringify(incomingEvent, null, 2)
-          );
+          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 }
-        );
+        return NextResponse.json({ message: "Analytics disabled" }, { status: 200 });
       }
       const trackableEvent = TrackableEventSchema.safeParse(incomingEvent);
       if (!trackableEvent.success) {
@@ -100,15 +75,11 @@ var createRouteHandler = ({
       }
       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");
         }
-        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 {
@@ -133,13 +104,13 @@ var createRouteHandler = ({
       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`;
+          error = "Analytics platform rejected the event as invalid. Please check the event schema";
         }
         if (response.status === 404) {
-          error = `Analytics platform could not be reached. Please specify a valid platform URL, or check that the platform is online.`;
+          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.`;
+          error = "Analytics platform returned an internal server error. Please check the platform logs.";
         }
         console.info(`\u26A0\uFE0F Analytics platform rejected event: ${error}`);
         return Response.json(
@@ -154,10 +125,7 @@ var createRouteHandler = ({
     } catch (e) {
       const error = ensureError(e);
       console.info("\u{1F6AB} Internal error with sending analytics event.");
-      return Response.json(
-        { error: `Error in analytics route handler: ${error.message}` },
-        { status: 500 }
-      );
+      return Response.json({ error: `Error in analytics route handler: ${error.message}` }, { status: 500 });
     }
   };
 };
@@ -179,7 +147,7 @@ var makeEventTracker = (options) => async (event) => {
     if (!response.ok) {
       if (response.status === 404) {
         return {
-          error: `Analytics endpoint not found, did you forget to add the route?`,
+          error: "Analytics endpoint not found, did you forget to add the route?",
           success: false
         };
       }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/utils.ts"],"sourcesContent":["import { NextResponse, type NextRequest } from 'next/server';\nimport { ensureError, strictBooleanSchema } 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 payload that is sent to trackEvent, which can be either\n * general events or errors. We discriminate on the `type` property to determine\n * which 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 by\n * `trackEvent`. The 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      const disableAnalytics = strictBooleanSchema.parse(\n        // eslint-disable-next-line no-process-env\n        process.env.DISABLE_ANALYTICS,\n      );\n\n      // Check if analytics is disabled\n      if (disableAnalytics) {\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  (options?: { endpoint?: string }) =>\n  async (\n    event: RawEvent,\n  ): Promise<{\n    error: string | null;\n    success: boolean;\n  }> => {\n    // We use a relative path by default, which should automatically use the\n    // same origin as the page that is sending the event.\n    const endpoint = options?.endpoint ?? '/api/analytics';\n\n    const eventWithTimeStamp: TrackableEvent = {\n      ...event,\n      timestamp: new Date().toJSON(),\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        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","import { z } from 'zod';\n\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\n// this is a workaround for this issue:https://github.com/colinhacks/zod/issues/1630\n// z.coerce.boolean() doesn't work as expected\nexport const strictBooleanSchema = z\n  .enum(['true', 'false', 'True', 'False', 'TRUE', 'FALSE'])\n  .default('false')\n  .transform(\n    (value) => value === 'true' || value === 'True' || value === 'TRUE',\n  );\n"],"mappings":";AAAA,SAAS,oBAAsC;;;ACA/C,SAAS,SAAS;AAGX,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;AAIO,IAAM,sBAAsB,EAChC,KAAK,CAAC,QAAQ,SAAS,QAAQ,SAAS,QAAQ,OAAO,CAAC,EACxD,QAAQ,OAAO,EACf;AAAA,EACC,CAAC,UAAU,UAAU,UAAU,UAAU,UAAU,UAAU;AAC/D;;;AD/BF,OAAOA,QAAO;AAGP,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEA,IAAM,cAAcA,GAAE,OAAO;AAAA,EAC3B,MAAMA,GAAE,KAAK,UAAU;AACzB,CAAC;AAED,IAAM,cAAcA,GAAE,OAAO;AAAA,EAC3B,MAAMA,GAAE,QAAQ,OAAO;AAAA,EACvB,SAASA,GAAE,OAAO;AAAA,EAClB,MAAMA,GAAE,OAAO;AAAA,EACf,OAAOA,GAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,OAAOA,GAAE,OAAO,EAAE,SAAS;AAC7B,CAAC;AAED,IAAM,4BAA4BA,GAAE,OAAO;AAAA,EACzC,UAAUA,GAAE,OAAOA,GAAE,QAAQ,CAAC,EAAE,SAAS;AAC3C,CAAC;AAOM,IAAM,iBAAiBA,GAAE,mBAAmB,QAAQ;AAAA,EACzD,0BAA0B,MAAM,WAAW;AAAA,EAC3C,0BAA0B,MAAM,WAAW;AAC7C,CAAC;AAQD,IAAM,4BAA4BA,GAAE,OAAO;AAAA,EACzC,WAAWA,GAAE,OAAO;AACtB,CAAC;AAEM,IAAM,uBAAuBA,GAAE;AAAA,EACpC;AAAA,EACA;AACF;AAOA,IAAM,+BAA+BA,GAAE,OAAO;AAAA,EAC5C,gBAAgBA,GAAE,OAAO;AAAA,EACzB,gBAAgBA,GAAE,OAAO;AAC3B,CAAC;AAOM,IAAM,uBAAuBA,GAAE;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;AAE1C,YAAM,mBAAmB,oBAAoB;AAAA;AAAA,QAE3C,QAAQ,IAAI;AAAA,MACd;AAGA,UAAI,kBAAkB;AAEpB,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,YACD,OACE,UAII;AAGJ,QAAM,WAAW,SAAS,YAAY;AAEtC,QAAM,qBAAqC;AAAA,IACzC,GAAG;AAAA,IACH,YAAW,oBAAI,KAAK,GAAE,OAAO;AAAA,EAC/B;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,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":["z"]}
+{"version":3,"sources":["../src/index.ts","../src/utils.ts"],"sourcesContent":["import { type NextRequest, NextResponse } from \"next/server\";\nimport z from \"zod\";\nimport { ensureError } from \"./utils\";\n\n// Todo: it would be great to work out a way to support arbitrary types here.\nexport const eventTypes = [\n\t\"AppSetup\",\n\t\"ProtocolInstalled\",\n\t\"InterviewStarted\",\n\t\"InterviewCompleted\",\n\t\"DataExported\",\n] as const;\n\nconst EventSchema = z.object({\n\ttype: z.enum(eventTypes),\n});\n\nconst ErrorSchema = z.object({\n\ttype: z.literal(\"Error\"),\n\tmessage: z.string(),\n\tname: z.string(),\n\tstack: z.string().optional(),\n\tcause: z.string().optional(),\n});\n\nconst SharedEventAndErrorSchema = z.object({\n\tmetadata: z.record(z.string(), z.unknown()).optional(),\n});\n\n/**\n * Raw events are the payload that is sent to trackEvent, which can be either\n * general events or errors. We discriminate on the `type` property to determine\n * which schema to use, and then merge the shared properties.\n */\nexport const RawEventSchema = z.discriminatedUnion(\"type\", [\n\tSharedEventAndErrorSchema.merge(EventSchema),\n\tSharedEventAndErrorSchema.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 by\n * `trackEvent`. The function adds the timestamp to ensure it is not inaccurate\n * due to network latency or processing time.\n */\nconst TrackablePropertiesSchema = z.object({\n\ttimestamp: z.string(),\n});\n\nexport const TrackableEventSchema = z.intersection(RawEventSchema, TrackablePropertiesSchema);\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\tinstallationId: z.string(),\n\tcountryISOCode: 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(TrackableEventSchema, DispatchablePropertiesSchema);\nexport type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;\n\ntype GeoData = {\n\tstatus: \"success\" | \"fail\";\n\tcountryCode: string;\n\tmessage: string;\n};\n\nexport const createRouteHandler = ({\n\tplatformUrl = \"https://analytics.networkcanvas.com\",\n\tinstallationId,\n\tdisableAnalytics,\n}: {\n\tplatformUrl?: string;\n\tinstallationId: string;\n\tdisableAnalytics?: boolean;\n}) => {\n\treturn async (request: NextRequest) => {\n\t\ttry {\n\t\t\tconst incomingEvent = (await request.json()) as unknown;\n\n\t\t\t// Check if analytics is disabled\n\t\t\tif (disableAnalytics) {\n\t\t\t\tconsole.info(\"🛑 Analytics disabled. Payload not sent.\");\n\t\t\t\ttry {\n\t\t\t\t\tconsole.info(\"Payload:\", \"\\n\", JSON.stringify(incomingEvent, null, 2));\n\t\t\t\t} catch (e) {\n\t\t\t\t\tconsole.error(\"Error stringifying payload:\", e);\n\t\t\t\t}\n\n\t\t\t\treturn NextResponse.json({ message: \"Analytics disabled\" }, { status: 200 });\n\t\t\t}\n\n\t\t\t// Validate the event\n\t\t\tconst trackableEvent = TrackableEventSchema.safeParse(incomingEvent);\n\n\t\t\tif (!trackableEvent.success) {\n\t\t\t\tconsole.error(\"Invalid event:\", trackableEvent.error);\n\t\t\t\treturn NextResponse.json({ error: \"Invalid event\" }, { status: 400 });\n\t\t\t}\n\n\t\t\t// We don't want failures in third party services to prevent us from\n\t\t\t// tracking analytics events, so we'll catch any errors and log them\n\t\t\t// and continue with an 'Unknown' country code.\n\t\t\tlet countryISOCode = \"Unknown\";\n\t\t\ttry {\n\t\t\t\tconst ip = await fetch(\"https://api64.ipify.org\").then((res) => res.text());\n\n\t\t\t\tif (!ip) {\n\t\t\t\t\tthrow new Error(\"Could not fetch IP address\");\n\t\t\t\t}\n\n\t\t\t\tconst geoData = (await fetch(`http://ip-api.com/json/${ip}`).then((res) => res.json())) as GeoData;\n\n\t\t\t\tif (geoData.status === \"success\") {\n\t\t\t\t\tcountryISOCode = geoData.countryCode;\n\t\t\t\t} else {\n\t\t\t\t\tthrow new Error(geoData.message);\n\t\t\t\t}\n\t\t\t} catch (e) {\n\t\t\t\tconsole.error(\"Geolocation failed:\", e);\n\t\t\t}\n\n\t\t\tconst analyticsEvent: analyticsEvent = {\n\t\t\t\t...trackableEvent.data,\n\t\t\t\tinstallationId,\n\t\t\t\tcountryISOCode,\n\t\t\t};\n\n\t\t\t// Forward to backend\n\t\t\tconst response = await fetch(`${platformUrl}/api/event`, {\n\t\t\t\tkeepalive: true,\n\t\t\t\tmethod: \"POST\",\n\t\t\t\theaders: {\n\t\t\t\t\t\"Content-Type\": \"application/json\",\n\t\t\t\t},\n\t\t\t\tbody: JSON.stringify(analyticsEvent),\n\t\t\t});\n\n\t\t\tif (!response.ok) {\n\t\t\t\tlet error = `Analytics platform returned an unexpected error: ${response.statusText}`;\n\n\t\t\t\tif (response.status === 400) {\n\t\t\t\t\terror = \"Analytics platform rejected the event as invalid. Please check the event schema\";\n\t\t\t\t}\n\n\t\t\t\tif (response.status === 404) {\n\t\t\t\t\terror =\n\t\t\t\t\t\t\"Analytics platform could not be reached. Please specify a valid platform URL, or check that the platform is online.\";\n\t\t\t\t}\n\n\t\t\t\tif (response.status === 500) {\n\t\t\t\t\terror = \"Analytics platform returned an internal server error. Please check the platform logs.\";\n\t\t\t\t}\n\n\t\t\t\tconsole.info(`⚠️ Analytics platform rejected event: ${error}`);\n\t\t\t\treturn Response.json(\n\t\t\t\t\t{\n\t\t\t\t\t\terror,\n\t\t\t\t\t},\n\t\t\t\t\t{ status: 500 },\n\t\t\t\t);\n\t\t\t}\n\t\t\tconsole.info(\"🚀 Analytics event sent to platform!\");\n\t\t\treturn Response.json({ message: \"Event forwarded successfully\" });\n\t\t} catch (e) {\n\t\t\tconst error = ensureError(e);\n\t\t\tconsole.info(\"🚫 Internal error with sending analytics event.\");\n\n\t\t\treturn Response.json({ error: `Error in analytics route handler: ${error.message}` }, { status: 500 });\n\t\t}\n\t};\n};\n\nexport const makeEventTracker =\n\t(options?: { endpoint?: string }) =>\n\tasync (\n\t\tevent: RawEvent,\n\t): Promise<{\n\t\terror: string | null;\n\t\tsuccess: boolean;\n\t}> => {\n\t\t// We use a relative path by default, which should automatically use the\n\t\t// same origin as the page that is sending the event.\n\t\tconst endpoint = options?.endpoint ?? \"/api/analytics\";\n\n\t\tconst eventWithTimeStamp: TrackableEvent = {\n\t\t\t...event,\n\t\t\ttimestamp: new Date().toJSON(),\n\t\t};\n\n\t\ttry {\n\t\t\tconst response = await fetch(endpoint, {\n\t\t\t\tmethod: \"POST\",\n\t\t\t\tkeepalive: true,\n\t\t\t\tbody: JSON.stringify(eventWithTimeStamp),\n\t\t\t\theaders: {\n\t\t\t\t\t\"Content-Type\": \"application/json\",\n\t\t\t\t},\n\t\t\t});\n\n\t\t\tif (!response.ok) {\n\t\t\t\tif (response.status === 404) {\n\t\t\t\t\treturn {\n\t\t\t\t\t\terror: \"Analytics endpoint not found, did you forget to add the route?\",\n\t\t\t\t\t\tsuccess: false,\n\t\t\t\t\t};\n\t\t\t\t}\n\n\t\t\t\t// createRouteHandler will return a 400 if the event failed schema validation.\n\t\t\t\tif (response.status === 400) {\n\t\t\t\t\treturn {\n\t\t\t\t\t\terror: `Invalid event sent to analytics endpoint: ${response.statusText}`,\n\t\t\t\t\t\tsuccess: false,\n\t\t\t\t\t};\n\t\t\t\t}\n\n\t\t\t\t// createRouteHandler will return a 500 for all error states\n\t\t\t\treturn {\n\t\t\t\t\terror: `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`,\n\t\t\t\t\tsuccess: false,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\treturn { error: null, success: true };\n\t\t} catch (e) {\n\t\t\tconst error = ensureError(e);\n\t\t\treturn {\n\t\t\t\terror: `Internal error when sending analytics event: ${error.message}`,\n\t\t\t\tsuccess: false,\n\t\t\t};\n\t\t}\n\t};\n","// Helper function that ensures that a value is an Error\nexport function ensureError(value: unknown): Error {\n\tif (!value) return new Error(\"No value was thrown\");\n\n\tif (value instanceof Error) return value;\n\n\t// Test if value inherits from Error\n\tif (Object.prototype.isPrototypeOf.call(value, Error)) return value as Error & typeof value;\n\n\tlet stringified = \"[Unable to stringify the thrown value]\";\n\ttry {\n\t\tstringified = JSON.stringify(value);\n\t} catch (e) {\n\t\tconsole.error(e);\n\t}\n\n\tconst error = new Error(`This value was thrown as is, not through an Error: ${stringified}`);\n\treturn error;\n}\n"],"mappings":";AAAA,SAA2B,oBAAoB;AAC/C,OAAO,OAAO;;;ACAP,SAAS,YAAY,OAAuB;AAClD,MAAI,CAAC,MAAO,QAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB,MAAO,QAAO;AAGnC,MAAI,OAAO,UAAU,cAAc,KAAK,OAAO,KAAK,EAAG,QAAO;AAE9D,MAAI,cAAc;AAClB,MAAI;AACH,kBAAc,KAAK,UAAU,KAAK;AAAA,EACnC,SAAS,GAAG;AACX,YAAQ,MAAM,CAAC;AAAA,EAChB;AAEA,QAAM,QAAQ,IAAI,MAAM,sDAAsD,WAAW,EAAE;AAC3F,SAAO;AACR;;;ADbO,IAAM,aAAa;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD;AAEA,IAAM,cAAc,EAAE,OAAO;AAAA,EAC5B,MAAM,EAAE,KAAK,UAAU;AACxB,CAAC;AAED,IAAM,cAAc,EAAE,OAAO;AAAA,EAC5B,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;AAC5B,CAAC;AAED,IAAM,4BAA4B,EAAE,OAAO;AAAA,EAC1C,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,EAAE,SAAS;AACtD,CAAC;AAOM,IAAM,iBAAiB,EAAE,mBAAmB,QAAQ;AAAA,EAC1D,0BAA0B,MAAM,WAAW;AAAA,EAC3C,0BAA0B,MAAM,WAAW;AAC5C,CAAC;AAQD,IAAM,4BAA4B,EAAE,OAAO;AAAA,EAC1C,WAAW,EAAE,OAAO;AACrB,CAAC;AAEM,IAAM,uBAAuB,EAAE,aAAa,gBAAgB,yBAAyB;AAO5F,IAAM,+BAA+B,EAAE,OAAO;AAAA,EAC7C,gBAAgB,EAAE,OAAO;AAAA,EACzB,gBAAgB,EAAE,OAAO;AAC1B,CAAC;AAOM,IAAM,uBAAuB,EAAE,aAAa,sBAAsB,4BAA4B;AAS9F,IAAM,qBAAqB,CAAC;AAAA,EAClC,cAAc;AAAA,EACd;AAAA,EACA;AACD,MAIM;AACL,SAAO,OAAO,YAAyB;AACtC,QAAI;AACH,YAAM,gBAAiB,MAAM,QAAQ,KAAK;AAG1C,UAAI,kBAAkB;AACrB,gBAAQ,KAAK,iDAA0C;AACvD,YAAI;AACH,kBAAQ,KAAK,YAAY,MAAM,KAAK,UAAU,eAAe,MAAM,CAAC,CAAC;AAAA,QACtE,SAAS,GAAG;AACX,kBAAQ,MAAM,+BAA+B,CAAC;AAAA,QAC/C;AAEA,eAAO,aAAa,KAAK,EAAE,SAAS,qBAAqB,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,MAC5E;AAGA,YAAM,iBAAiB,qBAAqB,UAAU,aAAa;AAEnE,UAAI,CAAC,eAAe,SAAS;AAC5B,gBAAQ,MAAM,kBAAkB,eAAe,KAAK;AACpD,eAAO,aAAa,KAAK,EAAE,OAAO,gBAAgB,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,MACrE;AAKA,UAAI,iBAAiB;AACrB,UAAI;AACH,cAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;AAE1E,YAAI,CAAC,IAAI;AACR,gBAAM,IAAI,MAAM,4BAA4B;AAAA,QAC7C;AAEA,cAAM,UAAW,MAAM,MAAM,0BAA0B,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;AAErF,YAAI,QAAQ,WAAW,WAAW;AACjC,2BAAiB,QAAQ;AAAA,QAC1B,OAAO;AACN,gBAAM,IAAI,MAAM,QAAQ,OAAO;AAAA,QAChC;AAAA,MACD,SAAS,GAAG;AACX,gBAAQ,MAAM,uBAAuB,CAAC;AAAA,MACvC;AAEA,YAAM,iBAAiC;AAAA,QACtC,GAAG,eAAe;AAAA,QAClB;AAAA,QACA;AAAA,MACD;AAGA,YAAM,WAAW,MAAM,MAAM,GAAG,WAAW,cAAc;AAAA,QACxD,WAAW;AAAA,QACX,QAAQ;AAAA,QACR,SAAS;AAAA,UACR,gBAAgB;AAAA,QACjB;AAAA,QACA,MAAM,KAAK,UAAU,cAAc;AAAA,MACpC,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AACjB,YAAI,QAAQ,oDAAoD,SAAS,UAAU;AAEnF,YAAI,SAAS,WAAW,KAAK;AAC5B,kBAAQ;AAAA,QACT;AAEA,YAAI,SAAS,WAAW,KAAK;AAC5B,kBACC;AAAA,QACF;AAEA,YAAI,SAAS,WAAW,KAAK;AAC5B,kBAAQ;AAAA,QACT;AAEA,gBAAQ,KAAK,mDAAyC,KAAK,EAAE;AAC7D,eAAO,SAAS;AAAA,UACf;AAAA,YACC;AAAA,UACD;AAAA,UACA,EAAE,QAAQ,IAAI;AAAA,QACf;AAAA,MACD;AACA,cAAQ,KAAK,6CAAsC;AACnD,aAAO,SAAS,KAAK,EAAE,SAAS,+BAA+B,CAAC;AAAA,IACjE,SAAS,GAAG;AACX,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,KAAK,wDAAiD;AAE9D,aAAO,SAAS,KAAK,EAAE,OAAO,qCAAqC,MAAM,OAAO,GAAG,GAAG,EAAE,QAAQ,IAAI,CAAC;AAAA,IACtG;AAAA,EACD;AACD;AAEO,IAAM,mBACZ,CAAC,YACD,OACC,UAIK;AAGL,QAAM,WAAW,SAAS,YAAY;AAEtC,QAAM,qBAAqC;AAAA,IAC1C,GAAG;AAAA,IACH,YAAW,oBAAI,KAAK,GAAE,OAAO;AAAA,EAC9B;AAEA,MAAI;AACH,UAAM,WAAW,MAAM,MAAM,UAAU;AAAA,MACtC,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,MACvC,SAAS;AAAA,QACR,gBAAgB;AAAA,MACjB;AAAA,IACD,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AACjB,UAAI,SAAS,WAAW,KAAK;AAC5B,eAAO;AAAA,UACN,OAAO;AAAA,UACP,SAAS;AAAA,QACV;AAAA,MACD;AAGA,UAAI,SAAS,WAAW,KAAK;AAC5B,eAAO;AAAA,UACN,OAAO,6CAA6C,SAAS,UAAU;AAAA,UACvE,SAAS;AAAA,QACV;AAAA,MACD;AAGA,aAAO;AAAA,QACN,OAAO,uDAAuD,SAAS,UAAU;AAAA,QACjF,SAAS;AAAA,MACV;AAAA,IACD;AAEA,WAAO,EAAE,OAAO,MAAM,SAAS,KAAK;AAAA,EACrC,SAAS,GAAG;AACX,UAAM,QAAQ,YAAY,CAAC;AAC3B,WAAO;AAAA,MACN,OAAO,gDAAgD,MAAM,OAAO;AAAA,MACpE,SAAS;AAAA,IACV;AAAA,EACD;AACD;","names":[]}

package/package.json

@@ -1,38 +1,25 @@
 {
   "name": "@codaco/analytics",
-  "version": "6.0.0",
-  "packageManager": "pnpm@8.15.5+sha256.4b4efa12490e5055d59b9b9fc9438b7d581a6b7af3b5675eb5c5f447cee1a589",
+  "version": "8.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "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",
-    "publish": "pnpm lint && pnpm build && npm publish --access public",
-    "lint": "eslint .",
-    "dev": "npm run build -- --watch"
-  },
   "peerDependencies": {
-    "next": "13 || 14 || 15"
+    "next": "15.4.7"
   },
   "devDependencies": {
-    "@codaco/eslint-config": "workspace:*",
-    "@codaco/tsconfig": "workspace:*",
-    "eslint": "^8.57.0",
-    "prettier": "^3.2.5",
-    "tsup": "^8.0.2",
-    "typescript": "^5.4.5"
+    "tsup": "^8.4.0",
+    "typescript": "^5.9.2",
+    "@codaco/tsconfig": "0.1.0"
   },
   "dependencies": {
-    "zod": "^3.23.8"
+    "zod": "^4.1.5"
   },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@codaco/eslint-config/base",
-      "@codaco/eslint-config/nextjs",
-      "@codaco/eslint-config/react"
-    ]
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --sourcemap",
+    "dev": "npm run build -- --watch",
+    "typecheck": "tsc --noEmit"
   }
-}
+}

package/src/index.ts

@@ -1,30 +1,30 @@
-import { NextResponse, type NextRequest } from 'next/server';
-import { ensureError, strictBooleanSchema } from './utils';
-import z from 'zod';
+import { type NextRequest, NextResponse } from "next/server";
+import z from "zod";
+import { ensureError } from "./utils";
 
 // 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({
-  type: z.enum(eventTypes),
+	type: z.enum(eventTypes),
 });
 
 const ErrorSchema = z.object({
-  type: z.literal('Error'),
-  message: z.string(),
-  name: z.string(),
-  stack: z.string().optional(),
-  cause: z.string().optional(),
+	type: z.literal("Error"),
+	message: z.string(),
+	name: z.string(),
+	stack: z.string().optional(),
+	cause: z.string().optional(),
 });
 
 const SharedEventAndErrorSchema = z.object({
-  metadata: z.record(z.unknown()).optional(),
+	metadata: z.record(z.string(), z.unknown()).optional(),
 });
 
 /**
@@ -32,9 +32,9 @@ const SharedEventAndErrorSchema = z.object({
  * general 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', [
-  SharedEventAndErrorSchema.merge(EventSchema),
-  SharedEventAndErrorSchema.merge(ErrorSchema),
+export const RawEventSchema = z.discriminatedUnion("type", [
+	SharedEventAndErrorSchema.merge(EventSchema),
+	SharedEventAndErrorSchema.merge(ErrorSchema),
 ]);
 export type RawEvent = z.infer<typeof RawEventSchema>;
 
@@ -44,13 +44,10 @@ export type RawEvent = z.infer<typeof RawEventSchema>;
  * due to network latency or processing time.
  */
 const TrackablePropertiesSchema = z.object({
-  timestamp: z.string(),
+	timestamp: z.string(),
 });
 
-export const TrackableEventSchema = z.intersection(
-  RawEventSchema,
-  TrackablePropertiesSchema,
-);
+export const TrackableEventSchema = z.intersection(RawEventSchema, TrackablePropertiesSchema);
 export type TrackableEvent = z.infer<typeof TrackableEventSchema>;
 
 /**
@@ -58,8 +55,8 @@ export type TrackableEvent = z.infer<typeof TrackableEventSchema>;
  * handler injects the installationId and countryISOCode properties.
  */
 const DispatchablePropertiesSchema = z.object({
-  installationId: z.string(),
-  countryISOCode: z.string(),
+	installationId: z.string(),
+	countryISOCode: z.string(),
 });
 
 /**
@@ -67,204 +64,177 @@ const DispatchablePropertiesSchema = z.object({
  * validate the event before it is inserted into the database. It is the
  * intersection of the trackable event and the dispatchable properties.
  */
-export const AnalyticsEventSchema = z.intersection(
-  TrackableEventSchema,
-  DispatchablePropertiesSchema,
-);
+export const AnalyticsEventSchema = z.intersection(TrackableEventSchema, DispatchablePropertiesSchema);
 export type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;
 
 type GeoData = {
-  status: 'success' | 'fail';
-  countryCode: string;
-  message: string;
+	status: "success" | "fail";
+	countryCode: string;
+	message: string;
 };
 
 export const createRouteHandler = ({
-  platformUrl = 'https://analytics.networkcanvas.com',
-  installationId,
+	platformUrl = "https://analytics.networkcanvas.com",
+	installationId,
+	disableAnalytics,
 }: {
-  platformUrl?: string;
-  installationId: string;
+	platformUrl?: string;
+	installationId: string;
+	disableAnalytics?: boolean;
 }) => {
-  return async (request: NextRequest) => {
-    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) {
-        // 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';
-      try {
-        const ip = await fetch('https://api64.ipify.org').then((res) =>
-          res.text(),
-        );
-
-        if (!ip) {
-          throw new Error('Could not fetch IP address');
-        }
-
-        const geoData = (await fetch(`http://ip-api.com/json/${ip}`).then(
-          (res) => res.json(),
-        )) as GeoData;
-
-        if (geoData.status === 'success') {
-          countryISOCode = geoData.countryCode;
-        } else {
-          throw new Error(geoData.message);
-        }
-      } catch (e) {
-        // eslint-disable-next-line no-console
-        console.error('Geolocation failed:', e);
-      }
-
-      const analyticsEvent: analyticsEvent = {
-        ...trackableEvent.data,
-        installationId,
-        countryISOCode,
-      };
-
-      // Forward to backend
-      const response = await fetch(`${platformUrl}/api/event`, {
-        keepalive: true,
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        body: JSON.stringify(analyticsEvent),
-      });
-
-      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) {
-          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.`;
-        }
-
-        // eslint-disable-next-line no-console
-        console.info(`⚠️ Analytics platform rejected event: ${error}`);
-        return Response.json(
-          {
-            error,
-          },
-          { status: 500 },
-        );
-      }
-      // 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);
-      // 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 },
-      );
-    }
-  };
+	return async (request: NextRequest) => {
+		try {
+			const incomingEvent = (await request.json()) as unknown;
+
+			// Check if analytics is disabled
+			if (disableAnalytics) {
+				console.info("🛑 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 });
+			}
+
+			// Validate the event
+			const trackableEvent = TrackableEventSchema.safeParse(incomingEvent);
+
+			if (!trackableEvent.success) {
+				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";
+			try {
+				const ip = await fetch("https://api64.ipify.org").then((res) => res.text());
+
+				if (!ip) {
+					throw new Error("Could not fetch IP address");
+				}
+
+				const geoData = (await fetch(`http://ip-api.com/json/${ip}`).then((res) => res.json())) as GeoData;
+
+				if (geoData.status === "success") {
+					countryISOCode = geoData.countryCode;
+				} else {
+					throw new Error(geoData.message);
+				}
+			} catch (e) {
+				console.error("Geolocation failed:", e);
+			}
+
+			const analyticsEvent: analyticsEvent = {
+				...trackableEvent.data,
+				installationId,
+				countryISOCode,
+			};
+
+			// Forward to backend
+			const response = await fetch(`${platformUrl}/api/event`, {
+				keepalive: true,
+				method: "POST",
+				headers: {
+					"Content-Type": "application/json",
+				},
+				body: JSON.stringify(analyticsEvent),
+			});
+
+			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) {
+					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.";
+				}
+
+				console.info(`⚠️ Analytics platform rejected event: ${error}`);
+				return Response.json(
+					{
+						error,
+					},
+					{ status: 500 },
+				);
+			}
+			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.");
+
+			return Response.json({ error: `Error in analytics route handler: ${error.message}` }, { status: 500 });
+		}
+	};
 };
 
 export const makeEventTracker =
-  (options?: { endpoint?: string }) =>
-  async (
-    event: RawEvent,
-  ): Promise<{
-    error: string | null;
-    success: boolean;
-  }> => {
-    // We use a relative path by default, which should automatically use the
-    // same origin as the page that is sending the event.
-    const endpoint = options?.endpoint ?? '/api/analytics';
-
-    const eventWithTimeStamp: TrackableEvent = {
-      ...event,
-      timestamp: new Date().toJSON(),
-    };
-
-    try {
-      const response = await fetch(endpoint, {
-        method: 'POST',
-        keepalive: true,
-        body: JSON.stringify(eventWithTimeStamp),
-        headers: {
-          'Content-Type': 'application/json',
-        },
-      });
-
-      if (!response.ok) {
-        if (response.status === 404) {
-          return {
-            error: `Analytics endpoint not found, did you forget to add the route?`,
-            success: false,
-          };
-        }
-
-        // createRouteHandler will return a 400 if the event failed schema validation.
-        if (response.status === 400) {
-          return {
-            error: `Invalid event sent to analytics endpoint: ${response.statusText}`,
-            success: false,
-          };
-        }
-
-        // createRouteHandler will return a 500 for all error states
-        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);
-      return {
-        error: `Internal error when sending analytics event: ${error.message}`,
-        success: false,
-      };
-    }
-  };
+	(options?: { endpoint?: string }) =>
+	async (
+		event: RawEvent,
+	): Promise<{
+		error: string | null;
+		success: boolean;
+	}> => {
+		// We use a relative path by default, which should automatically use the
+		// same origin as the page that is sending the event.
+		const endpoint = options?.endpoint ?? "/api/analytics";
+
+		const eventWithTimeStamp: TrackableEvent = {
+			...event,
+			timestamp: new Date().toJSON(),
+		};
+
+		try {
+			const response = await fetch(endpoint, {
+				method: "POST",
+				keepalive: true,
+				body: JSON.stringify(eventWithTimeStamp),
+				headers: {
+					"Content-Type": "application/json",
+				},
+			});
+
+			if (!response.ok) {
+				if (response.status === 404) {
+					return {
+						error: "Analytics endpoint not found, did you forget to add the route?",
+						success: false,
+					};
+				}
+
+				// createRouteHandler will return a 400 if the event failed schema validation.
+				if (response.status === 400) {
+					return {
+						error: `Invalid event sent to analytics endpoint: ${response.statusText}`,
+						success: false,
+					};
+				}
+
+				// createRouteHandler will return a 500 for all error states
+				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);
+			return {
+				error: `Internal error when sending analytics event: ${error.message}`,
+				success: false,
+			};
+		}
+	};

package/src/utils.ts

@@ -1,34 +1,19 @@
-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;
+	if (value instanceof Error) return value;
 
-  // Test if value inherits from Error
-  if (Object.prototype.isPrototypeOf.call(value, Error))
-    return value as Error & typeof value;
+	// Test if value inherits from Error
+	if (Object.prototype.isPrototypeOf.call(value, Error)) return value as Error & typeof value;
 
-  let stringified = '[Unable to stringify the thrown value]';
-  try {
-    stringified = JSON.stringify(value);
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-  }
+	let stringified = "[Unable to stringify the thrown value]";
+	try {
+		stringified = JSON.stringify(value);
+	} catch (e) {
+		console.error(e);
+	}
 
-  const error = new Error(
-    `This value was thrown as is, not through an Error: ${stringified}`,
-  );
-  return error;
+	const error = new Error(`This value was thrown as is, not through an Error: ${stringified}`);
+	return error;
 }
-
-// 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,9 +1,9 @@
 {
-  "extends": "@codaco/tsconfig/base.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.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/.turbo/turbo-build.log

@@ -1,12 +0,0 @@
-
-
-> @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 v8.0.2
-CLI Target: es2022
-CLI Cleaning output folder
-ESM Build start
-DTS Build start