@codaco/analytics 2.1.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +3 -8
- package/dist/index.mjs +0 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +3 -10
package/dist/index.d.mts
CHANGED
|
@@ -6,19 +6,14 @@ type GeoLocation = {
|
|
|
6
6
|
};
|
|
7
7
|
type AnalyticsEventBase = {
|
|
8
8
|
type: "DataExported" | "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup" | "Error";
|
|
9
|
+
metadata?: Record<string, unknown>;
|
|
9
10
|
};
|
|
10
11
|
type AnalyticsEvent = AnalyticsEventBase & {
|
|
11
|
-
type: "InterviewCompleted" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
|
|
12
|
-
metadata?: Record<string, unknown>;
|
|
12
|
+
type: "InterviewCompleted" | "DataExported" | "InterviewStarted" | "ProtocolInstalled" | "AppSetup";
|
|
13
13
|
};
|
|
14
14
|
type AnalyticsError = AnalyticsEventBase & {
|
|
15
15
|
type: "Error";
|
|
16
|
-
error:
|
|
17
|
-
message: string;
|
|
18
|
-
details: string;
|
|
19
|
-
stacktrace: string;
|
|
20
|
-
path: string;
|
|
21
|
-
};
|
|
16
|
+
error: Error;
|
|
22
17
|
};
|
|
23
18
|
type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
|
|
24
19
|
type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {
|
package/dist/index.mjs
CHANGED
|
@@ -79,8 +79,6 @@ var createRouteHandler = ({
|
|
|
79
79
|
}
|
|
80
80
|
);
|
|
81
81
|
}
|
|
82
|
-
console.info(`\u{1F680} Analytics event forwarded successfully.`);
|
|
83
|
-
console.info(JSON.stringify(dispatchableEvent, null, 2));
|
|
84
82
|
return new Response(
|
|
85
83
|
JSON.stringify({ message: "Event forwarded successfully" }),
|
|
86
84
|
{
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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\n\r\ntype GeoLocation = {\r\n countryCode: string;\r\n};\r\n\r\nexport type AnalyticsEventBase = {\r\n type:\r\n | \"DataExported\"\r\n | \"InterviewCompleted\"\r\n | \"InterviewStarted\"\r\n | \"ProtocolInstalled\"\r\n | \"AppSetup\"\r\n | \"Error\";\r\n};\r\n\r\nexport type AnalyticsEvent = AnalyticsEventBase & {\r\n type:\r\n | \"InterviewCompleted\"\r\n | \"InterviewStarted\"\r\n | \"ProtocolInstalled\"\r\n | \"AppSetup\";\r\n
|
|
1
|
+
{"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\n\r\ntype GeoLocation = {\r\n countryCode: string;\r\n};\r\n\r\nexport type AnalyticsEventBase = {\r\n type:\r\n | \"DataExported\"\r\n | \"InterviewCompleted\"\r\n | \"InterviewStarted\"\r\n | \"ProtocolInstalled\"\r\n | \"AppSetup\"\r\n | \"Error\";\r\n metadata?: Record<string, unknown>;\r\n};\r\n\r\nexport type AnalyticsEvent = AnalyticsEventBase & {\r\n type:\r\n | \"InterviewCompleted\"\r\n | \"DataExported\"\r\n | \"InterviewStarted\"\r\n | \"ProtocolInstalled\"\r\n | \"AppSetup\";\r\n};\r\n\r\nexport type AnalyticsError = AnalyticsEventBase & {\r\n type: \"Error\";\r\n error: Error;\r\n};\r\n\r\nexport type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;\r\n\r\nexport type AnalyticsEventOrErrorWithTimestamp = AnalyticsEventOrError & {\r\n timestamp: Date;\r\n};\r\n\r\nexport type DispatchableAnalyticsEvent = AnalyticsEventOrErrorWithTimestamp & {\r\n installationId: string;\r\n geolocation?: GeoLocation;\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: DispatchableAnalyticsEvent = {\r\n ...event,\r\n installationId,\r\n geolocation: {\r\n countryCode,\r\n },\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;;;ACeO,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,oBAAgD;AAAA,QACpD,GAAG;AAAA,QACH;AAAA,QACA,aAAa;AAAA,UACX;AAAA,QACF;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,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/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -14,25 +14,21 @@ export type AnalyticsEventBase = {
|
|
|
14
14
|
| "ProtocolInstalled"
|
|
15
15
|
| "AppSetup"
|
|
16
16
|
| "Error";
|
|
17
|
+
metadata?: Record<string, unknown>;
|
|
17
18
|
};
|
|
18
19
|
|
|
19
20
|
export type AnalyticsEvent = AnalyticsEventBase & {
|
|
20
21
|
type:
|
|
21
22
|
| "InterviewCompleted"
|
|
23
|
+
| "DataExported"
|
|
22
24
|
| "InterviewStarted"
|
|
23
25
|
| "ProtocolInstalled"
|
|
24
26
|
| "AppSetup";
|
|
25
|
-
metadata?: Record<string, unknown>;
|
|
26
27
|
};
|
|
27
28
|
|
|
28
29
|
export type AnalyticsError = AnalyticsEventBase & {
|
|
29
30
|
type: "Error";
|
|
30
|
-
error:
|
|
31
|
-
message: string;
|
|
32
|
-
details: string;
|
|
33
|
-
stacktrace: string;
|
|
34
|
-
path: string;
|
|
35
|
-
};
|
|
31
|
+
error: Error;
|
|
36
32
|
};
|
|
37
33
|
|
|
38
34
|
export type AnalyticsEventOrError = AnalyticsEvent | AnalyticsError;
|
|
@@ -113,9 +109,6 @@ export const createRouteHandler = ({
|
|
|
113
109
|
);
|
|
114
110
|
}
|
|
115
111
|
|
|
116
|
-
console.info(`🚀 Analytics event forwarded successfully.`);
|
|
117
|
-
console.info(JSON.stringify(dispatchableEvent, null, 2));
|
|
118
|
-
|
|
119
112
|
return new Response(
|
|
120
113
|
JSON.stringify({ message: "Event forwarded successfully" }),
|
|
121
114
|
{
|