@codaco/analytics 3.1.0 → 5.0.0

package/dist/index.mjs

@@ -1,165 +0,0 @@
-// src/utils.ts
-function ensureError(value) {
-  if (!value)
-    return new Error("No value was thrown");
-  if (value instanceof Error)
-    return value;
-  if (value.isPrototypeOf(Error))
-    return value;
-  let stringified = "[Unable to stringify the thrown value]";
-  try {
-    stringified = JSON.stringify(value);
-  } catch {
-  }
-  const error = new Error(
-    `This value was thrown as is, not through an Error: ${stringified}`
-  );
-  return error;
-}
-function getBaseUrl() {
-  if (typeof window !== "undefined")
-    return "";
-  if (process.env.VERCEL_URL)
-    return `https://${process.env.VERCEL_URL}`;
-  if (process.env.NEXT_PUBLIC_URL)
-    return process.env.NEXT_PUBLIC_URL;
-  return `http://127.0.0.1:3000`;
-}
-
-// src/index.ts
-import z from "zod";
-var eventTypes = [
-  "AppSetup",
-  "ProtocolInstalled",
-  "InterviewStarted",
-  "InterviewCompleted",
-  "DataExported",
-  "Error"
-];
-var EventsSchema = z.object({
-  type: z.enum(eventTypes),
-  installationId: z.string(),
-  timestamp: z.string(),
-  isocode: z.string().optional(),
-  error: z.object({
-    message: z.string(),
-    name: z.string(),
-    stack: z.string().optional()
-  }).optional(),
-  metadata: z.record(z.unknown()).optional()
-});
-var createRouteHandler = ({
-  platformUrl = "https://analytics.networkcanvas.com",
-  installationId,
-  maxMindClient
-}) => {
-  return async (request) => {
-    try {
-      const event = await request.json();
-      const ip = await fetch("https://api64.ipify.org").then(
-        (res) => res.text()
-      );
-      const { country } = await maxMindClient.country(ip);
-      const countryCode = country?.isoCode ?? "Unknown";
-      const dispatchableEvent = {
-        ...event,
-        installationId,
-        isocode: countryCode
-      };
-      const response = await fetch(`${platformUrl}/api/event`, {
-        keepalive: true,
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json"
-        },
-        body: JSON.stringify(dispatchableEvent)
-      });
-      if (!response.ok) {
-        if (response.status === 404) {
-          console.error(
-            `Analytics platform not found. Please specify a valid platform URL.`
-          );
-        } else if (response.status === 500) {
-          console.error(
-            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`
-          );
-        } else {
-          console.error(
-            `General error when forwarding event: ${response.statusText}`
-          );
-        }
-        return new Response(
-          JSON.stringify({ error: "Internal Server Error" }),
-          {
-            status: 500,
-            headers: {
-              "Content-Type": "application/json"
-            }
-          }
-        );
-      }
-      return new Response(
-        JSON.stringify({ message: "Event forwarded successfully" }),
-        {
-          status: 200,
-          headers: {
-            "Content-Type": "application/json"
-          }
-        }
-      );
-    } catch (e) {
-      const error = ensureError(e);
-      console.error("Error in route handler:", error);
-      return new Response(JSON.stringify({ error: "Internal Server Error" }), {
-        status: 500,
-        headers: {
-          "Content-Type": "application/json"
-        }
-      });
-    }
-  };
-};
-var makeEventTracker = (endpoint = "/api/analytics") => async (event) => {
-  const endpointWithHost = getBaseUrl() + endpoint;
-  const eventWithTimeStamp = {
-    ...event,
-    timestamp: /* @__PURE__ */ new Date()
-  };
-  try {
-    const response = await fetch(endpointWithHost, {
-      method: "POST",
-      keepalive: true,
-      body: JSON.stringify(eventWithTimeStamp),
-      headers: {
-        "Content-Type": "application/json"
-      }
-    });
-    if (!response.ok) {
-      if (response.status === 404) {
-        console.error(
-          `Analytics endpoint not found, did you forget to add the route?`
-        );
-        return;
-      }
-      if (response.status === 500) {
-        console.error(
-          `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`
-        );
-        return;
-      }
-      console.error(
-        `General error sending analytics event: ${response.statusText}`
-      );
-    }
-  } catch (e) {
-    const error = ensureError(e);
-    console.error("Internal error with analytics:", error.message);
-  }
-};
-export {
-  EventsSchema,
-  createRouteHandler,
-  eventTypes,
-  makeEventTracker
-};
-//# sourceMappingURL=index.mjs.map

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\r\nexport function ensureError(value: unknown): Error {\r\n  if (!value) return new Error(\"No value was thrown\");\r\n\r\n  if (value instanceof Error) return value;\r\n\r\n  // Test if value inherits from Error\r\n  if (value.isPrototypeOf(Error)) return value as Error & typeof value;\r\n\r\n  let stringified = \"[Unable to stringify the thrown value]\";\r\n  try {\r\n    stringified = JSON.stringify(value);\r\n  } catch {}\r\n\r\n  const error = new Error(\r\n    `This value was thrown as is, not through an Error: ${stringified}`\r\n  );\r\n  return error;\r\n}\r\n\r\nexport function getBaseUrl() {\r\n  if (typeof window !== \"undefined\")\r\n    // browser should use relative path\r\n    return \"\";\r\n\r\n  if (process.env.VERCEL_URL)\r\n    // reference for vercel.com\r\n    return `https://${process.env.VERCEL_URL}`;\r\n\r\n  if (process.env.NEXT_PUBLIC_URL)\r\n    // Manually set deployment URL from env\r\n    return process.env.NEXT_PUBLIC_URL;\r\n\r\n  // assume localhost\r\n  return `http://127.0.0.1:3000`;\r\n}\r\n","import type { NextRequest } from \"next/server\";\r\nimport { WebServiceClient } from \"@maxmind/geoip2-node\";\r\nimport { ensureError, getBaseUrl } from \"./utils\";\r\nimport z from \"zod\";\r\n\r\nexport const eventTypes = [\r\n  \"AppSetup\",\r\n  \"ProtocolInstalled\",\r\n  \"InterviewStarted\",\r\n  \"InterviewCompleted\",\r\n  \"DataExported\",\r\n  \"Error\",\r\n] as const;\r\n\r\nexport type EventType = (typeof eventTypes)[number];\r\ntype EventTypeWithoutError = Exclude<EventType, \"Error\">;\r\n\r\nexport const EventsSchema = z.object({\r\n  type: z.enum(eventTypes),\r\n  installationId: z.string(),\r\n  timestamp: z.string(),\r\n  isocode: z.string().optional(),\r\n  error: z\r\n    .object({\r\n      message: z.string(),\r\n      name: z.string(),\r\n      stack: z.string().optional(),\r\n    })\r\n    .optional(),\r\n  metadata: z.record(z.unknown()).optional(),\r\n});\r\n\r\nexport type Event = z.infer<typeof EventsSchema>;\r\n\r\nexport type AnalyticsEvent = {\r\n  type: EventTypeWithoutError;\r\n  metadata?: Record<string, unknown>;\r\n};\r\n\r\nexport type AnalyticsError = {\r\n  type: \"Error\";\r\n  error: Error;\r\n  metadata?: Record<string, unknown>;\r\n};\r\n\r\nexport type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;\r\n\r\nexport type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {\r\n  timestamp: string;\r\n};\r\n\r\ntype RouteHandlerConfiguration = {\r\n  platformUrl?: string;\r\n  installationId: string;\r\n  maxMindClient: WebServiceClient;\r\n};\r\n\r\nexport const createRouteHandler = ({\r\n  platformUrl = \"https://analytics.networkcanvas.com\",\r\n  installationId,\r\n  maxMindClient,\r\n}: RouteHandlerConfiguration) => {\r\n  return async (request: NextRequest) => {\r\n    try {\r\n      const event =\r\n        (await request.json()) as AnalyticsEventOrErrorWithTimestamp;\r\n\r\n      const ip = await fetch(\"https://api64.ipify.org\").then((res) =>\r\n        res.text()\r\n      );\r\n\r\n      const { country } = await maxMindClient.country(ip);\r\n      const countryCode = country?.isoCode ?? \"Unknown\";\r\n\r\n      const dispatchableEvent: Event = {\r\n        ...event,\r\n        installationId,\r\n        isocode: countryCode,\r\n      };\r\n\r\n      // Forward to microservice\r\n      const response = await fetch(`${platformUrl}/api/event`, {\r\n        keepalive: true,\r\n        method: \"POST\",\r\n        headers: {\r\n          \"Content-Type\": \"application/json\",\r\n        },\r\n        body: JSON.stringify(dispatchableEvent),\r\n      });\r\n\r\n      if (!response.ok) {\r\n        if (response.status === 404) {\r\n          console.error(\r\n            `Analytics platform not found. Please specify a valid platform URL.`\r\n          );\r\n        } else if (response.status === 500) {\r\n          console.error(\r\n            `Internal server error on analytics platform when forwarding event: ${response.statusText}.`\r\n          );\r\n        } else {\r\n          console.error(\r\n            `General error when forwarding event: ${response.statusText}`\r\n          );\r\n        }\r\n\r\n        return new Response(\r\n          JSON.stringify({ error: \"Internal Server Error\" }),\r\n          {\r\n            status: 500,\r\n            headers: {\r\n              \"Content-Type\": \"application/json\",\r\n            },\r\n          }\r\n        );\r\n      }\r\n\r\n      return new Response(\r\n        JSON.stringify({ message: \"Event forwarded successfully\" }),\r\n        {\r\n          status: 200,\r\n          headers: {\r\n            \"Content-Type\": \"application/json\",\r\n          },\r\n        }\r\n      );\r\n    } catch (e) {\r\n      const error = ensureError(e);\r\n      console.error(\"Error in route handler:\", error);\r\n\r\n      // Return an appropriate error response\r\n      return new Response(JSON.stringify({ error: \"Internal Server Error\" }), {\r\n        status: 500,\r\n        headers: {\r\n          \"Content-Type\": \"application/json\",\r\n        },\r\n      });\r\n    }\r\n  };\r\n};\r\n\r\nexport const makeEventTracker =\r\n  (endpoint: string = \"/api/analytics\") =>\r\n  async (event: AnalyticsEventOrError) => {\r\n    const endpointWithHost = getBaseUrl() + endpoint;\r\n\r\n    const eventWithTimeStamp = {\r\n      ...event,\r\n      timestamp: new Date(),\r\n    };\r\n\r\n    try {\r\n      const response = await fetch(endpointWithHost, {\r\n        method: \"POST\",\r\n        keepalive: true,\r\n        body: JSON.stringify(eventWithTimeStamp),\r\n        headers: {\r\n          \"Content-Type\": \"application/json\",\r\n        },\r\n      });\r\n\r\n      if (!response.ok) {\r\n        if (response.status === 404) {\r\n          console.error(\r\n            `Analytics endpoint not found, did you forget to add the route?`\r\n          );\r\n          return;\r\n        }\r\n\r\n        if (response.status === 500) {\r\n          console.error(\r\n            `Internal server error when sending analytics event: ${response.statusText}. Check the route handler implementation.`\r\n          );\r\n          return;\r\n        }\r\n\r\n        console.error(\r\n          `General error sending analytics event: ${response.statusText}`\r\n        );\r\n      }\r\n    } catch (e) {\r\n      const error = ensureError(e);\r\n\r\n      console.error(\"Internal error with analytics:\", error.message);\r\n    }\r\n  };\r\n"],"mappings":";AACO,SAAS,YAAY,OAAuB;AACjD,MAAI,CAAC;AAAO,WAAO,IAAI,MAAM,qBAAqB;AAElD,MAAI,iBAAiB;AAAO,WAAO;AAGnC,MAAI,MAAM,cAAc,KAAK;AAAG,WAAO;AAEvC,MAAI,cAAc;AAClB,MAAI;AACF,kBAAc,KAAK,UAAU,KAAK;AAAA,EACpC,QAAQ;AAAA,EAAC;AAET,QAAM,QAAQ,IAAI;AAAA,IAChB,sDAAsD,WAAW;AAAA,EACnE;AACA,SAAO;AACT;AAEO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW;AAEpB,WAAO;AAET,MAAI,QAAQ,IAAI;AAEd,WAAO,WAAW,QAAQ,IAAI,UAAU;AAE1C,MAAI,QAAQ,IAAI;AAEd,WAAO,QAAQ,IAAI;AAGrB,SAAO;AACT;;;AChCA,OAAO,OAAO;AAEP,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAKO,IAAM,eAAe,EAAE,OAAO;AAAA,EACnC,MAAM,EAAE,KAAK,UAAU;AAAA,EACvB,gBAAgB,EAAE,OAAO;AAAA,EACzB,WAAW,EAAE,OAAO;AAAA,EACpB,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,OAAO,EACJ,OAAO;AAAA,IACN,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,OAAO;AAAA,IACf,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,CAAC,EACA,SAAS;AAAA,EACZ,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,SAAS;AAC3C,CAAC;AA2BM,IAAM,qBAAqB,CAAC;AAAA,EACjC,cAAc;AAAA,EACd;AAAA,EACA;AACF,MAAiC;AAC/B,SAAO,OAAO,YAAyB;AACrC,QAAI;AACF,YAAM,QACH,MAAM,QAAQ,KAAK;AAEtB,YAAM,KAAK,MAAM,MAAM,yBAAyB,EAAE;AAAA,QAAK,CAAC,QACtD,IAAI,KAAK;AAAA,MACX;AAEA,YAAM,EAAE,QAAQ,IAAI,MAAM,cAAc,QAAQ,EAAE;AAClD,YAAM,cAAc,SAAS,WAAW;AAExC,YAAM,oBAA2B;AAAA,QAC/B,GAAG;AAAA,QACH;AAAA,QACA,SAAS;AAAA,MACX;AAGA,YAAM,WAAW,MAAM,MAAM,GAAG,WAAW,cAAc;AAAA,QACvD,WAAW;AAAA,QACX,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,QACA,MAAM,KAAK,UAAU,iBAAiB;AAAA,MACxC,CAAC;AAED,UAAI,CAAC,SAAS,IAAI;AAChB,YAAI,SAAS,WAAW,KAAK;AAC3B,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF,WAAW,SAAS,WAAW,KAAK;AAClC,kBAAQ;AAAA,YACN,sEAAsE,SAAS,UAAU;AAAA,UAC3F;AAAA,QACF,OAAO;AACL,kBAAQ;AAAA,YACN,wCAAwC,SAAS,UAAU;AAAA,UAC7D;AAAA,QACF;AAEA,eAAO,IAAI;AAAA,UACT,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC;AAAA,UACjD;AAAA,YACE,QAAQ;AAAA,YACR,SAAS;AAAA,cACP,gBAAgB;AAAA,YAClB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,aAAO,IAAI;AAAA,QACT,KAAK,UAAU,EAAE,SAAS,+BAA+B,CAAC;AAAA,QAC1D;AAAA,UACE,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,gBAAgB;AAAA,UAClB;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,GAAG;AACV,YAAM,QAAQ,YAAY,CAAC;AAC3B,cAAQ,MAAM,2BAA2B,KAAK;AAG9C,aAAO,IAAI,SAAS,KAAK,UAAU,EAAE,OAAO,wBAAwB,CAAC,GAAG;AAAA,QACtE,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,gBAAgB;AAAA,QAClB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,IAAM,mBACX,CAAC,WAAmB,qBACpB,OAAO,UAAiC;AACtC,QAAM,mBAAmB,WAAW,IAAI;AAExC,QAAM,qBAAqB;AAAA,IACzB,GAAG;AAAA,IACH,WAAW,oBAAI,KAAK;AAAA,EACtB;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,kBAAkB;AAAA,MAC7C,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM,KAAK,UAAU,kBAAkB;AAAA,MACvC,SAAS;AAAA,QACP,gBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN;AAAA,QACF;AACA;AAAA,MACF;AAEA,UAAI,SAAS,WAAW,KAAK;AAC3B,gBAAQ;AAAA,UACN,uDAAuD,SAAS,UAAU;AAAA,QAC5E;AACA;AAAA,MACF;AAEA,cAAQ;AAAA,QACN,0CAA0C,SAAS,UAAU;AAAA,MAC/D;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AACV,UAAM,QAAQ,YAAY,CAAC;AAE3B,YAAQ,MAAM,kCAAkC,MAAM,OAAO;AAAA,EAC/D;AACF;","names":[]}

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;