@codaco/analytics 6.0.0-alpha.5 → 7.0.0

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @codaco/analytics@5.1.0 build /Users/jmh629/Projects/network-canvas/packages/analytics
+> @codaco/analytics@6.0.0 build /Users/buckhalt/Code/complexdatacollective/network-canvas-monorepo/packages/analytics
 > tsup src/index.ts --format esm --dts --clean --sourcemap
 
 CLI Building entry: src/index.ts
@@ -9,4 +9,8 @@
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
+ESM dist/index.js     6.32 KB
+ESM dist/index.js.map 13.22 KB
+ESM ⚡️ Build success in 167ms
 DTS Build start
+ ELIFECYCLE  Command failed.

package/.turbo/turbo-lint.log

@@ -0,0 +1,7 @@
+
+
+> @codaco/analytics@7.0.0 lint /Users/buckhalt/Code/complexdatacollective/network-canvas-monorepo/packages/analytics
+> eslint .
+
+Warning: React version was set to "detect" in eslint-plugin-react settings, but the "react" package is not installed. Assuming latest React version for linting.
+Pages directory cannot be found at /Users/buckhalt/Code/complexdatacollective/network-canvas-monorepo/packages/analytics/pages or /Users/buckhalt/Code/complexdatacollective/network-canvas-monorepo/packages/analytics/src/pages. If using a custom path, please configure with the `no-html-link-for-pages` rule in your eslint config file.

package/dist/index.d.ts

@@ -135,9 +135,10 @@ declare const AnalyticsEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDis
     countryISOCode: string;
 }>>;
 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

@@ -2,12 +2,9 @@
 import { NextResponse } from "next/server";
 
 // 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 (!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]";
@@ -21,12 +18,9 @@ function ensureError(value) {
   );
   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";
+import z from "zod";
 var eventTypes = [
   "AppSetup",
   "ProtocolInstalled",
@@ -34,49 +28,46 @@ 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.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(
+var TrackableEventSchema = z.intersection(
   RawEventSchema,
   TrackablePropertiesSchema
 );
-var DispatchablePropertiesSchema = z2.object({
-  installationId: z2.string(),
-  countryISOCode: z2.string()
+var DispatchablePropertiesSchema = z.object({
+  installationId: z.string(),
+  countryISOCode: z.string()
 });
-var AnalyticsEventSchema = z2.intersection(
+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 {

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 { NextResponse, type NextRequest } from 'next/server';\nimport { ensureError } 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  disableAnalytics,\n}: {\n  platformUrl?: string;\n  installationId: string;\n  disableAnalytics?: boolean;\n}) => {\n  return async (request: NextRequest) => {\n    try {\n      const incomingEvent = (await request.json()) as unknown;\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","// 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"],"mappings":";AAAA,SAAS,oBAAsC;;;ACCxC,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC,MAAO,QAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB,MAAO,QAAO;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;;;ADpBA,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;AAAA,EACA;AACF,MAIM;AACJ,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,gBAAiB,MAAM,QAAQ,KAAK;AAG1C,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":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codaco/analytics",
-  "version": "6.0.0-alpha.5",
+  "version": "7.0.0",
   "packageManager": "pnpm@8.15.5+sha256.4b4efa12490e5055d59b9b9fc9438b7d581a6b7af3b5675eb5c5f447cee1a589",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -1,5 +1,5 @@
 import { NextResponse, type NextRequest } from 'next/server';
-import { ensureError, strictBooleanSchema } from './utils';
+import { ensureError } from './utils';
 import z from 'zod';
 
 // Todo: it would be great to work out a way to support arbitrary types here.
@@ -82,19 +82,16 @@ type GeoData = {
 export const createRouteHandler = ({
   platformUrl = 'https://analytics.networkcanvas.com',
   installationId,
+  disableAnalytics,
 }: {
   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

package/src/utils.ts

@@ -1,5 +1,3 @@
-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');
@@ -23,12 +21,3 @@ export function ensureError(value: unknown): Error {
   );
   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',
-  );