@codaco/analytics 4.0.0 → 5.0.0

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
 
-> @codaco/analytics@4.0.0 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
+> @codaco/analytics@5.0.0 build /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
 > tsup src/index.ts --format esm --dts --clean --sourcemap
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
+CLI tsup v7.3.0
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
-ESM dist/index.mjs     5.69 KB
-ESM dist/index.mjs.map 11.29 KB
-ESM ⚡️ Build success in 31ms
+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 980ms
-DTS dist/index.d.mts 5.97 KB
+DTS ⚡️ Build success in 907ms
+DTS dist/index.d.ts 5.64 KB

package/dist/{index.d.mts → index.d.ts}

@@ -3,6 +3,11 @@ import { WebServiceClient } from '@maxmind/geoip2-node';
 import z from 'zod';
 
 declare const eventTypes: readonly ["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"];
+/**
+ * Raw events are the events that are sent trackEvent. They are either 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<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
@@ -15,35 +20,24 @@ declare const RawEventSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
 }>, z.ZodObject<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     type: z.ZodLiteral<"Error">;
-    error: z.ZodObject<{
-        message: z.ZodString;
-        name: z.ZodString;
-        stack: z.ZodOptional<z.ZodString>;
-    }, "strict", z.ZodTypeAny, {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    }, {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    }>;
+    message: z.ZodString;
+    name: z.ZodString;
+    stack: z.ZodOptional<z.ZodString>;
+    cause: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "Error";
-    error: {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    };
+    message: string;
+    name: string;
     metadata?: Record<string, unknown> | undefined;
+    stack?: string | undefined;
+    cause?: string | undefined;
 }, {
     type: "Error";
-    error: {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    };
+    message: string;
+    name: string;
     metadata?: Record<string, unknown> | undefined;
+    stack?: string | undefined;
+    cause?: string | undefined;
 }>]>;
 type RawEvent = z.infer<typeof RawEventSchema>;
 declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
@@ -58,35 +52,24 @@ declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"t
 }>, z.ZodObject<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     type: z.ZodLiteral<"Error">;
-    error: z.ZodObject<{
-        message: z.ZodString;
-        name: z.ZodString;
-        stack: z.ZodOptional<z.ZodString>;
-    }, "strict", z.ZodTypeAny, {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    }, {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    }>;
+    message: z.ZodString;
+    name: z.ZodString;
+    stack: z.ZodOptional<z.ZodString>;
+    cause: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "Error";
-    error: {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    };
+    message: string;
+    name: string;
     metadata?: Record<string, unknown> | undefined;
+    stack?: string | undefined;
+    cause?: string | undefined;
 }, {
     type: "Error";
-    error: {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    };
+    message: string;
+    name: string;
     metadata?: Record<string, unknown> | undefined;
+    stack?: string | undefined;
+    cause?: string | undefined;
 }>]>, z.ZodObject<{
     timestamp: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -95,7 +78,12 @@ declare const TrackableEventSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"t
     timestamp: string;
 }>>;
 type TrackableEvent = z.infer<typeof TrackableEventSchema>;
-declare const DispatchableEventSchema: z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+/**
+ * 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<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     type: z.ZodEnum<["AppSetup", "ProtocolInstalled", "InterviewStarted", "InterviewCompleted", "DataExported"]>;
 }, "strip", z.ZodTypeAny, {
@@ -107,35 +95,24 @@ declare const DispatchableEventSchema: z.ZodIntersection<z.ZodIntersection<z.Zod
 }>, z.ZodObject<{
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     type: z.ZodLiteral<"Error">;
-    error: z.ZodObject<{
-        message: z.ZodString;
-        name: z.ZodString;
-        stack: z.ZodOptional<z.ZodString>;
-    }, "strict", z.ZodTypeAny, {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    }, {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    }>;
+    message: z.ZodString;
+    name: z.ZodString;
+    stack: z.ZodOptional<z.ZodString>;
+    cause: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "Error";
-    error: {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    };
+    message: string;
+    name: string;
     metadata?: Record<string, unknown> | undefined;
+    stack?: string | undefined;
+    cause?: string | undefined;
 }, {
     type: "Error";
-    error: {
-        message: string;
-        name: string;
-        stack?: string | undefined;
-    };
+    message: string;
+    name: string;
     metadata?: Record<string, unknown> | undefined;
+    stack?: string | undefined;
+    cause?: string | undefined;
 }>]>, z.ZodObject<{
     timestamp: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -152,21 +129,18 @@ declare const DispatchableEventSchema: z.ZodIntersection<z.ZodIntersection<z.Zod
     installationId: string;
     countryISOCode: string;
 }>>;
-type DispatchableEvent = z.infer<typeof DispatchableEventSchema>;
-type RouteHandlerConfiguration = {
-    platformUrl?: string;
+type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;
+declare const createRouteHandler: ({ platformUrl, installationId, maxMindClient, }: {
+    platformUrl?: string | undefined;
     installationId: string;
     maxMindClient: WebServiceClient;
-};
-declare const createRouteHandler: ({ platformUrl, installationId, maxMindClient, }: RouteHandlerConfiguration) => (request: NextRequest) => Promise<Response>;
-type ConsumerConfiguration = {
-    enabled?: boolean;
-    endpoint?: string;
-};
-type EventTrackerReturn = {
+}) => (request: NextRequest) => Promise<Response>;
+declare const makeEventTracker: ({ enabled, endpoint, }: {
+    enabled?: boolean | undefined;
+    endpoint?: string | undefined;
+}) => (event: RawEvent) => Promise<{
     error: string | null;
     success: boolean;
-};
-declare const makeEventTracker: ({ enabled, endpoint }: ConsumerConfiguration) => (event: RawEvent) => Promise<EventTrackerReturn>;
+}>;
 
-export { DispatchableEvent, DispatchableEventSchema, EventTrackerReturn, RawEvent, RawEventSchema, TrackableEvent, TrackableEventSchema, createRouteHandler, eventTypes, makeEventTracker };
+export { AnalyticsEventSchema, type RawEvent, RawEventSchema, type TrackableEvent, TrackableEventSchema, type analyticsEvent, createRouteHandler, eventTypes, makeEventTracker };

package/dist/{index.mjs → index.js}

@@ -35,19 +35,18 @@ var eventTypes = [
   "InterviewCompleted",
   "DataExported"
 ];
-var SharedEventAndErrorSchema = z.object({
-  metadata: z.record(z.unknown()).optional()
-});
 var EventSchema = z.object({
   type: z.enum(eventTypes)
 });
 var ErrorSchema = z.object({
   type: z.literal("Error"),
-  error: z.object({
-    message: z.string(),
-    name: z.string(),
-    stack: z.string().optional()
-  }).strict()
+  message: z.string(),
+  name: z.string(),
+  stack: z.string().optional(),
+  cause: z.string().optional()
+});
+var SharedEventAndErrorSchema = z.object({
+  metadata: z.record(z.unknown()).optional()
 });
 var RawEventSchema = z.discriminatedUnion("type", [
   SharedEventAndErrorSchema.merge(EventSchema),
@@ -64,7 +63,7 @@ var DispatchablePropertiesSchema = z.object({
   installationId: z.string(),
   countryISOCode: z.string()
 });
-var DispatchableEventSchema = z.intersection(
+var AnalyticsEventSchema = z.intersection(
   TrackableEventSchema,
   DispatchablePropertiesSchema
 );
@@ -91,12 +90,15 @@ var createRouteHandler = ({
         const ip = await fetch("https://api64.ipify.org").then(
           (res) => res.text()
         );
+        if (!ip) {
+          throw new Error("Could not fetch IP address");
+        }
         const { country } = await maxMindClient.country(ip);
         countryISOCode = country?.isoCode ?? "Unknown";
       } catch (e) {
         console.error("Geolocation failed:", e);
       }
-      const dispatchableEvent = {
+      const analyticsEvent = {
         ...trackableEvent.data,
         installationId,
         countryISOCode
@@ -107,7 +109,7 @@ var createRouteHandler = ({
         headers: {
           "Content-Type": "application/json"
         },
-        body: JSON.stringify(dispatchableEvent)
+        body: JSON.stringify(analyticsEvent)
       });
       if (!response.ok) {
         let error = `Analytics platform returned an unexpected error: ${response.statusText}`;
@@ -120,7 +122,7 @@ var createRouteHandler = ({
         if (response.status === 500) {
           error = `Analytics platform returned an internal server error. Please check the platform logs.`;
         }
-        console.info("\u26A0\uFE0F Analytics platform rejected event.");
+        console.info(`\u26A0\uFE0F Analytics platform rejected event: ${error}`);
         return Response.json(
           {
             error
@@ -140,9 +142,12 @@ var createRouteHandler = ({
     }
   };
 };
-var makeEventTracker = ({ enabled = false, endpoint = "/api/analytics" }) => async (event) => {
+var makeEventTracker = ({
+  enabled = false,
+  endpoint = "/api/analytics"
+}) => async (event) => {
   if (!enabled) {
-    console.log("Analytics disabled, not sending event");
+    console.log("Analytics disabled - event not sent.");
     return { error: null, success: true };
   }
   const endpointWithHost = getBaseUrl() + endpoint;
@@ -187,11 +192,11 @@ var makeEventTracker = ({ enabled = false, endpoint = "/api/analytics" }) => asy
   }
 };
 export {
-  DispatchableEventSchema,
+  AnalyticsEventSchema,
   RawEventSchema,
   TrackableEventSchema,
   createRouteHandler,
   eventTypes,
   makeEventTracker
 };
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/index.ts"],"sourcesContent":["// Helper function that ensures that a value is an Error\nexport function ensureError(value: unknown): Error {\n  if (!value) return new Error(\"No value was thrown\");\n\n  if (value instanceof Error) return value;\n\n  // Test if value inherits from Error\n  if (value.isPrototypeOf(Error)) return value as Error & typeof value;\n\n  let stringified = \"[Unable to stringify the thrown value]\";\n  try {\n    stringified = JSON.stringify(value);\n  } catch {}\n\n  const error = new Error(\n    `This value was thrown as is, not through an Error: ${stringified}`\n  );\n  return error;\n}\n\nexport function getBaseUrl() {\n  if (typeof window !== \"undefined\")\n    // browser should use relative path\n    return \"\";\n\n  if (process.env.VERCEL_URL)\n    // reference for vercel.com\n    return `https://${process.env.VERCEL_URL}`;\n\n  if (process.env.NEXT_PUBLIC_URL)\n    // Manually set deployment URL from env\n    return process.env.NEXT_PUBLIC_URL;\n\n  // assume localhost\n  return `http://127.0.0.1:3000`;\n}\n","import { type NextRequest } from \"next/server\";\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { ensureError, getBaseUrl } from \"./utils\";\nimport z from \"zod\";\n\n// Todo: it would be great to work out a way to support arbitrary types here.\nexport const eventTypes = [\n  \"AppSetup\",\n  \"ProtocolInstalled\",\n  \"InterviewStarted\",\n  \"InterviewCompleted\",\n  \"DataExported\",\n] as const;\n\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  maxMindClient,\n}: {\n  platformUrl?: string;\n  installationId: string;\n  maxMindClient: WebServiceClient;\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 { country } = await maxMindClient.country(ip);\n        countryISOCode = country?.isoCode ?? \"Unknown\";\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;;;AChCA,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;AAAA,EACA;AACF,MAIM;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,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,yBAAiB,SAAS,WAAW;AAAA,MACvC,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":[]}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@codaco/analytics",
-  "version": "4.0.0",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
+  "version": "5.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "author": "Complex Data Collective <developers@coda.co>",
   "description": "Utilities for tracking analytics and error reporting in Fresco",
   "scripts": {

package/src/index.ts

@@ -12,34 +12,38 @@ export const eventTypes = [
   "DataExported",
 ] as const;
 
-// Properties that everything has in common.
-const SharedEventAndErrorSchema = z.object({
-  metadata: z.record(z.unknown()).optional(),
-});
-
 const EventSchema = z.object({
   type: z.enum(eventTypes),
 });
 
 const ErrorSchema = z.object({
   type: z.literal("Error"),
-  error: z
-    .object({
-      message: z.string(),
-      name: z.string(),
-      stack: z.string().optional(),
-    })
-    .strict(),
+  message: z.string(),
+  name: z.string(),
+  stack: z.string().optional(),
+  cause: z.string().optional(),
+});
+
+const SharedEventAndErrorSchema = z.object({
+  metadata: z.record(z.unknown()).optional(),
 });
 
-// Raw events are the events that are sent trackEvent.
+/**
+ * Raw events are the events that are sent trackEvent. They are either 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 type RawEvent = z.infer<typeof RawEventSchema>;
 
-// Trackable events are the events that are sent to the route handler.
+/**
+ * Trackable events are the events that are sent to the route handler. The
+ * `trackEvent` function adds the timestamp to ensure it is not inaccurate
+ * due to network latency or processing time.
+ */
 const TrackablePropertiesSchema = z.object({
   timestamp: z.string(),
 });
@@ -50,29 +54,35 @@ export const TrackableEventSchema = z.intersection(
 );
 export type TrackableEvent = z.infer<typeof TrackableEventSchema>;
 
-// Dispatchable events are the events that are sent to the platform.
+/**
+ * Dispatchable events are the events that are sent to the platform. The route
+ * handler injects the installationId and countryISOCode properties.
+ */
 const DispatchablePropertiesSchema = z.object({
   installationId: z.string(),
   countryISOCode: z.string(),
 });
 
-export const DispatchableEventSchema = z.intersection(
+/**
+ * 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.
+ */
+export const AnalyticsEventSchema = z.intersection(
   TrackableEventSchema,
   DispatchablePropertiesSchema
 );
-export type DispatchableEvent = z.infer<typeof DispatchableEventSchema>;
-
-type RouteHandlerConfiguration = {
-  platformUrl?: string;
-  installationId: string;
-  maxMindClient: WebServiceClient;
-};
+export type analyticsEvent = z.infer<typeof AnalyticsEventSchema>;
 
 export const createRouteHandler = ({
   platformUrl = "https://analytics.networkcanvas.com",
   installationId,
   maxMindClient,
-}: RouteHandlerConfiguration) => {
+}: {
+  platformUrl?: string;
+  installationId: string;
+  maxMindClient: WebServiceClient;
+}) => {
   return async (request: NextRequest) => {
     try {
       const incomingEvent = (await request.json()) as unknown;
@@ -91,32 +101,38 @@ export const createRouteHandler = ({
       }
 
       // We don't want failures in third party services to prevent us from
-      // tracking analytics events.
+      // 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 { country } = await maxMindClient.country(ip);
         countryISOCode = country?.isoCode ?? "Unknown";
       } catch (e) {
         console.error("Geolocation failed:", e);
       }
 
-      const dispatchableEvent: DispatchableEvent = {
+      const analyticsEvent: analyticsEvent = {
         ...trackableEvent.data,
         installationId,
         countryISOCode,
       };
 
-      // Forward to microservice
+      // Forward to backend
       const response = await fetch(`${platformUrl}/api/event`, {
         keepalive: true,
         method: "POST",
         headers: {
           "Content-Type": "application/json",
         },
-        body: JSON.stringify(dispatchableEvent),
+        body: JSON.stringify(analyticsEvent),
       });
 
       if (!response.ok) {
@@ -134,7 +150,7 @@ export const createRouteHandler = ({
           error = `Analytics platform returned an internal server error. Please check the platform logs.`;
         }
 
-        console.info("⚠️ Analytics platform rejected event.");
+        console.info(`⚠️ Analytics platform rejected event: ${error}`);
         return Response.json(
           {
             error,
@@ -156,22 +172,22 @@ export const createRouteHandler = ({
   };
 };
 
-type ConsumerConfiguration = {
-  enabled?: boolean;
-  endpoint?: string;
-};
-
-export type EventTrackerReturn = {
-  error: string | null;
-  success: boolean;
-};
-
 export const makeEventTracker =
-  ({ enabled = false, endpoint = "/api/analytics" }: ConsumerConfiguration) =>
-  async (event: RawEvent): Promise<EventTrackerReturn> => {
-    // If analytics is disabled don't send analytics events.
+  ({
+    enabled = false,
+    endpoint = "/api/analytics",
+  }: {
+    enabled?: boolean;
+    endpoint?: string;
+  }) =>
+  async (
+    event: RawEvent
+  ): Promise<{
+    error: string | null;
+    success: boolean;
+  }> => {
     if (!enabled) {
-      console.log("Analytics disabled, not sending event");
+      console.log("Analytics disabled - event not sent.");
       return { error: null, success: true };
     }
 

package/.turbo/turbo-test.log

@@ -1,31 +0,0 @@
-
-> @codaco/analytics@0.6.0-alpha test /Users/jmh629/Projects/error-analytics-microservice/packages/analytics
-> NODE_OPTIONS=--experimental-vm-modules jest "--watch"
-
-(node:55883) ExperimentalWarning: VM Modules is an experimental feature and might change at any time
-(Use `node --trace-warnings ...` to show where the warning was created)
-FAIL src/index.test.mjs
-  Analytics client package
-    ✕ should be able to create a new client (1 ms)
-
-  ● Analytics client package › should be able to create a new client
-
-    TypeError: Cannot read properties of undefined (reading 'platformUrl')
-
-      50 |   private platformUrl?: string = "https://analytics.networkcanvas.dev";
-      51 |   private installationId: string | null = null;
-    > 52 |
-         | ^
-      53 |   private dispatchQueue: QueueObject<AnalyticsEventOrError>;
-      54 |
-      55 |   private enabled: boolean = true;
-
-      at new s (src/index.ts:52:11)
-      at Object.<anonymous> (src/index.test.mjs:6:20)
-
-Test Suites: 1 failed, 1 total
-Tests:       1 failed, 1 total
-Snapshots:   0 total
-Time:        0.215 s, estimated 1 s
-Ran all test suites related to changed files.
-

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/utils.ts","../src/index.ts"],"sourcesContent":["// Helper function that ensures that a value is an Error\nexport function ensureError(value: unknown): Error {\n  if (!value) return new Error(\"No value was thrown\");\n\n  if (value instanceof Error) return value;\n\n  // Test if value inherits from Error\n  if (value.isPrototypeOf(Error)) return value as Error & typeof value;\n\n  let stringified = \"[Unable to stringify the thrown value]\";\n  try {\n    stringified = JSON.stringify(value);\n  } catch {}\n\n  const error = new Error(\n    `This value was thrown as is, not through an Error: ${stringified}`\n  );\n  return error;\n}\n\nexport function getBaseUrl() {\n  if (typeof window !== \"undefined\")\n    // browser should use relative path\n    return \"\";\n\n  if (process.env.VERCEL_URL)\n    // reference for vercel.com\n    return `https://${process.env.VERCEL_URL}`;\n\n  if (process.env.NEXT_PUBLIC_URL)\n    // Manually set deployment URL from env\n    return process.env.NEXT_PUBLIC_URL;\n\n  // assume localhost\n  return `http://127.0.0.1:3000`;\n}\n","import { type NextRequest } from \"next/server\";\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\nimport { ensureError, getBaseUrl } from \"./utils\";\nimport z from \"zod\";\n\n// Todo: it would be great to work out a way to support arbitrary types here.\nexport const eventTypes = [\n  \"AppSetup\",\n  \"ProtocolInstalled\",\n  \"InterviewStarted\",\n  \"InterviewCompleted\",\n  \"DataExported\",\n] as const;\n\n// Properties that everything has in common.\nconst SharedEventAndErrorSchema = z.object({\n  metadata: z.record(z.unknown()).optional(),\n});\n\nconst EventSchema = z.object({\n  type: z.enum(eventTypes),\n});\n\nconst ErrorSchema = z.object({\n  type: z.literal(\"Error\"),\n  error: z\n    .object({\n      message: z.string(),\n      name: z.string(),\n      stack: z.string().optional(),\n    })\n    .strict(),\n});\n\n// Raw events are the events that are sent trackEvent.\nexport const RawEventSchema = z.discriminatedUnion(\"type\", [\n  SharedEventAndErrorSchema.merge(EventSchema),\n  SharedEventAndErrorSchema.merge(ErrorSchema),\n]);\nexport type RawEvent = z.infer<typeof RawEventSchema>;\n\n// Trackable events are the events that are sent to the route handler.\nconst TrackablePropertiesSchema = z.object({\n  timestamp: z.string(),\n});\n\nexport const TrackableEventSchema = z.intersection(\n  RawEventSchema,\n  TrackablePropertiesSchema\n);\nexport type TrackableEvent = z.infer<typeof TrackableEventSchema>;\n\n// Dispatchable events are the events that are sent to the platform.\nconst DispatchablePropertiesSchema = z.object({\n  installationId: z.string(),\n  countryISOCode: z.string(),\n});\n\nexport const DispatchableEventSchema = z.intersection(\n  TrackableEventSchema,\n  DispatchablePropertiesSchema\n);\nexport type DispatchableEvent = z.infer<typeof DispatchableEventSchema>;\n\ntype RouteHandlerConfiguration = {\n  platformUrl?: string;\n  installationId: string;\n  maxMindClient: WebServiceClient;\n};\n\nexport const createRouteHandler = ({\n  platformUrl = \"https://analytics.networkcanvas.com\",\n  installationId,\n  maxMindClient,\n}: RouteHandlerConfiguration) => {\n  return async (request: NextRequest) => {\n    try {\n      const incomingEvent = (await request.json()) as unknown;\n\n      // Validate the event\n      const trackableEvent = TrackableEventSchema.safeParse(incomingEvent);\n\n      if (!trackableEvent.success) {\n        console.error(\"Invalid event:\", trackableEvent.error);\n        return new Response(JSON.stringify({ error: \"Invalid event\" }), {\n          status: 400,\n          headers: {\n            \"Content-Type\": \"application/json\",\n          },\n        });\n      }\n\n      // We don't want failures in third party services to prevent us from\n      // tracking analytics events.\n      let countryISOCode = \"Unknown\";\n      try {\n        const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\n          res.text()\n        );\n        const { country } = await maxMindClient.country(ip);\n        countryISOCode = country?.isoCode ?? \"Unknown\";\n      } catch (e) {\n        console.error(\"Geolocation failed:\", e);\n      }\n\n      const dispatchableEvent: DispatchableEvent = {\n        ...trackableEvent.data,\n        installationId,\n        countryISOCode,\n      };\n\n      // Forward to microservice\n      const response = await fetch(`${platformUrl}/api/event`, {\n        keepalive: true,\n        method: \"POST\",\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n        body: JSON.stringify(dispatchableEvent),\n      });\n\n      if (!response.ok) {\n        let error = `Analytics platform returned an unexpected error: ${response.statusText}`;\n\n        if (response.status === 400) {\n          error = `Analytics platform rejected the event as invalid. Please check the event schema`;\n        }\n\n        if (response.status === 404) {\n          error = `Analytics platform could not be reached. Please specify a valid platform URL, or check that the platform is online.`;\n        }\n\n        if (response.status === 500) {\n          error = `Analytics platform returned an internal server error. Please check the platform logs.`;\n        }\n\n        console.info(\"⚠️ Analytics platform rejected event.\");\n        return Response.json(\n          {\n            error,\n          },\n          { status: 500 }\n        );\n      }\n      console.info(\"🚀 Analytics event sent to platform!\");\n      return Response.json({ message: \"Event forwarded successfully\" });\n    } catch (e) {\n      const error = ensureError(e);\n      console.info(\"🚫 Internal error with sending analytics event.\");\n\n      return Response.json(\n        { error: `Error in analytics route handler: ${error.message}` },\n        { status: 500 }\n      );\n    }\n  };\n};\n\ntype ConsumerConfiguration = {\n  enabled?: boolean;\n  endpoint?: string;\n};\n\nexport type EventTrackerReturn = {\n  error: string | null;\n  success: boolean;\n};\n\nexport const makeEventTracker =\n  ({ enabled = false, endpoint = \"/api/analytics\" }: ConsumerConfiguration) =>\n  async (event: RawEvent): Promise<EventTrackerReturn> => {\n    // If analytics is disabled don't send analytics events.\n    if (!enabled) {\n      console.log(\"Analytics disabled, not sending event\");\n      return { error: null, success: true };\n    }\n\n    const endpointWithHost = getBaseUrl() + endpoint;\n\n    const eventWithTimeStamp: TrackableEvent = {\n      ...event,\n      timestamp: new Date().toJSON(),\n    };\n\n    try {\n      const response = await fetch(endpointWithHost, {\n        method: \"POST\",\n        keepalive: true,\n        body: JSON.stringify(eventWithTimeStamp),\n        headers: {\n          \"Content-Type\": \"application/json\",\n        },\n      });\n\n      if (!response.ok) {\n        if (response.status === 404) {\n          return {\n            error: `Analytics endpoint not found, did you forget to add the route?`,\n            success: false,\n          };\n        }\n\n        // createRouteHandler will return a 400 if the event failed schema validation.\n        if (response.status === 400) {\n          return {\n            error: `Invalid event sent to analytics endpoint: ${response.statusText}`,\n            success: false,\n          };\n        }\n\n        // createRouteHandler will return a 500 for all error states\n        return {\n          error: `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`,\n          success: false,\n        };\n      }\n\n      return { error: null, success: true };\n    } catch (e) {\n      const error = ensureError(e);\n      return {\n        error: `Internal error when sending analytics event: ${error.message}`,\n        success: false,\n      };\n    }\n  };\n"],"mappings":";AACO,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC;AAAO,WAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB;AAAO,WAAO;AAGnC,MAAI,MAAM,cAAc,KAAK;AAAG,WAAO;AAEvC,MAAI,cAAc;AAClB,MAAI;AACF,kBAAc,KAAK,UAAU,KAAK;AAAA,EACpC,QAAQ;AAAA,EAAC;AAET,QAAM,QAAQ,IAAI;AAAA,IAChB,sDAAsD,WAAW;AAAA,EACnE;AACA,SAAO;AACT;AAEO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW;AAEpB,WAAO;AAET,MAAI,QAAQ,IAAI;AAEd,WAAO,WAAW,QAAQ,IAAI,UAAU;AAE1C,MAAI,QAAQ,IAAI;AAEd,WAAO,QAAQ,IAAI;AAGrB,SAAO;AACT;;;AChCA,OAAO,OAAO;AAGP,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAGA,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,SAAS;AAC3C,CAAC;AAED,IAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,MAAM,EAAE,KAAK,UAAU;AACzB,CAAC;AAED,IAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,MAAM,EAAE,QAAQ,OAAO;AAAA,EACvB,OAAO,EACJ,OAAO;AAAA,IACN,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,OAAO;AAAA,IACf,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,CAAC,EACA,OAAO;AACZ,CAAC;AAGM,IAAM,iBAAiB,EAAE,mBAAmB,QAAQ;AAAA,EACzD,0BAA0B,MAAM,WAAW;AAAA,EAC3C,0BAA0B,MAAM,WAAW;AAC7C,CAAC;AAID,IAAM,4BAA4B,EAAE,OAAO;AAAA,EACzC,WAAW,EAAE,OAAO;AACtB,CAAC;AAEM,IAAM,uBAAuB,EAAE;AAAA,EACpC;AAAA,EACA;AACF;AAIA,IAAM,+BAA+B,EAAE,OAAO;AAAA,EAC5C,gBAAgB,EAAE,OAAO;AAAA,EACzB,gBAAgB,EAAE,OAAO;AAC3B,CAAC;AAEM,IAAM,0BAA0B,EAAE;AAAA,EACvC;AAAA,EACA;AACF;AASO,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,gBAAiB,MAAM,QAAQ,KAAK;AAG1C,YAAM,iBAAiB,qBAAqB,UAAU,aAAa;AAEnE,UAAI,CAAC,eAAe,SAAS;AAC3B,gBAAQ,MAAM,kBAAkB,eAAe,KAAK;AACpD,eAAO,IAAI,SAAS,KAAK,UAAU,EAAE,OAAO,gBAAgB,CAAC,GAAG;AAAA,UAC9D,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,UAClB;AAAA,QACF,CAAC;AAAA,MACH;AAIA,UAAI,iBAAiB;AACrB,UAAI;AACF,cAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,UAAK,CAAC,QACtD,IAAI,KAAK;AAAA,QACX;AACA,cAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,yBAAiB,SAAS,WAAW;AAAA,MACvC,SAAS,GAAG;AACV,gBAAQ,MAAM,uBAAuB,CAAC;AAAA,MACxC;AAEA,YAAM,oBAAuC;AAAA,QAC3C,GAAG,eAAe;AAAA,QAClB;AAAA,QACA;AAAA,MACF;AAGA,YAAM,WAAW,MAAM,MAAM,GAAG,WAAW,cAAc;AAAA,QACvD,WAAW;AAAA,QACX,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,iBAAiB;AAAA,MACxC,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AAChB,YAAI,QAAQ,oDAAoD,SAAS,UAAU;AAEnF,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,QACV;AAEA,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,QACV;AAEA,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,QACV;AAEA,gBAAQ,KAAK,iDAAuC;AACpD,eAAO,SAAS;AAAA,UACd;AAAA,YACE;AAAA,UACF;AAAA,UACA,EAAE,QAAQ,IAAI;AAAA,QAChB;AAAA,MACF;AACA,cAAQ,KAAK,6CAAsC;AACnD,aAAO,SAAS,KAAK,EAAE,SAAS,+BAA+B,CAAC;AAAA,IAClE,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,KAAK,wDAAiD;AAE9D,aAAO,SAAS;AAAA,QACd,EAAE,OAAO,qCAAqC,MAAM,OAAO,GAAG;AAAA,QAC9D,EAAE,QAAQ,IAAI;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AACF;AAYO,IAAM,mBACX,CAAC,EAAE,UAAU,OAAO,WAAW,iBAAiB,MAChD,OAAO,UAAiD;AAEtD,MAAI,CAAC,SAAS;AACZ,YAAQ,IAAI,uCAAuC;AACnD,WAAO,EAAE,OAAO,MAAM,SAAS,KAAK;AAAA,EACtC;AAEA,QAAM,mBAAmB,WAAW,IAAI;AAExC,QAAM,qBAAqC;AAAA,IACzC,GAAG;AAAA,IACH,YAAW,oBAAI,KAAK,GAAE,OAAO;AAAA,EAC/B;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,kBAAkB;AAAA,MAC7C,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,MACvC,SAAS;AAAA,QACP,gBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,UAAI,SAAS,WAAW,KAAK;AAC3B,eAAO;AAAA,UACL,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,MACF;AAGA,UAAI,SAAS,WAAW,KAAK;AAC3B,eAAO;AAAA,UACL,OAAO,6CAA6C,SAAS,UAAU;AAAA,UACvE,SAAS;AAAA,QACX;AAAA,MACF;AAGA,aAAO;AAAA,QACL,OAAO,uDAAuD,SAAS,UAAU;AAAA,QACjF,SAAS;AAAA,MACX;AAAA,IACF;AAEA,WAAO,EAAE,OAAO,MAAM,SAAS,KAAK;AAAA,EACtC,SAAS,GAAG;AACV,UAAM,QAAQ,YAAY,CAAC;AAC3B,WAAO;AAAA,MACL,OAAO,gDAAgD,MAAM,OAAO;AAAA,MACpE,SAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}

package/jest.config.js

@@ -1,198 +0,0 @@
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
-/** @type {import('jest').Config} */
-const config = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/vc/szx71k5j5sqcmrljl1w44ryddl7zmw/T/jest_pb0330",
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  // clearMocks: false,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: false,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  // coverageDirectory: undefined,
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  testEnvironment: "node",
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  testMatch: [
-    "**/__tests__/**/*.[jt]s?(x)",
-    "**/?(*.)+(spec|test).m[tj]s?(x)"
-  ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-};
-
-module.exports = config;