CSP-1039: Caliper | Ensure reliable delivery on tab/window close using fetch/keepalive

.eslintrc

@@ -3,6 +3,7 @@
 	"parserOptions": {
 		"project": ["./tsconfig.json", "./tsconfig.tests.json"]
 	},
+	"plugins": ["@typescript-eslint", "import"],
 	"overrides": [
 		{
 			// Overrides for generated code
@@ -12,10 +13,16 @@
 				"@typescript-eslint/naming-convention": [
 					"error",
 					{ "selector": "default", "format": ["camelCase"] },
-					{ "selector": "function", "format": ["camelCase", "PascalCase"] },
+					{
+						"selector": "function",
+						"format": ["camelCase", "PascalCase"]
+					},
 					{ "selector": "typeLike", "format": ["PascalCase"] },
 					// Allow UPPER_CASE for enums
-					{ "selector": "enumMember", "format": ["PascalCase", "UPPER_CASE"] },
+					{
+						"selector": "enumMember",
+						"format": ["PascalCase", "UPPER_CASE"]
+					},
 					{
 						"selector": "variable",
 						"modifiers": ["const"],

.gitignore

@@ -1,6 +1,10 @@
 *.log
 .DS_Store
-node_modules
-dist
+
+node_modules/
+dist/
 .vscode/
 coverage/
+
+yarn.lock
+package-lock.json

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@carnegie-learning/caliper-ts",
-	"version": "2.2.3",
+	"version": "2.3.0",
 	"description": "Reference implementation of the Caliper Sensor API written in TypeScript",
 	"author": "Imagine Learning",
 	"license": "MIT",
@@ -21,14 +21,15 @@
 		"test": "tsdx test --watch",
 		"test:ci": "cross-env CI=true tsdx test --coverage",
 		"test:coverage": "tsdx test --coverage",
-		"lint": "eslint src/**/*.ts",
+		"lint": "eslint src --ext .ts",
 		"format": "prettier --write **/*.{js,json,ts}"
 	},
 	"peerDependencies": {
 		"jsonschema": ">=1.4",
 		"uuid": ">=8"
 	},
 	"devDependencies": {
+		"@types/jest": "^26.0.24",
 		"@types/jsonschema": "^1.1.1",
 		"@types/lodash": "^4.14.161",
 		"@types/text-encoding": "^0.0.35",

src/caliper-delivery-options.ts

@@ -0,0 +1,11 @@
+/**
+ * Optional delivery options for Caliper HTTP requests.
+ */
+export interface CaliperSendOptions {
+	/**
+	 * Allows the request to outlive the current page during browser lifecycle transitions
+	 * Requires Angular HttpClient to be configured with fetch support
+	 * @see https://angular.dev/guide/http/setup#withfetch
+	 */
+	keepalive?: boolean;
+}

src/clients/client.ts

@@ -1,9 +1,15 @@
-import { Envelope } from '../envelope';
+import { CaliperSendOptions } from "../caliper-delivery-options";
+import { Envelope } from "../envelope";
 
 export interface Client {
 	getId(): string;
-	send<TEnvelope, TResponse>(envelope: Envelope<TEnvelope>): Promise<TResponse>;
-	queueDeadletterMessage<TEnvelope>(message: DeadletterMessage<TEnvelope>): Promise<void>;
+	send<TEnvelope, TResponse>(
+		envelope: Envelope<TEnvelope>,
+		options: CaliperSendOptions
+	): Promise<TResponse>;
+	queueDeadletterMessage<TEnvelope>(
+		message: DeadletterMessage<TEnvelope>
+	): Promise<void>;
 }
 
 export interface DeadletterMessage<TEnvelope> {

src/index.ts

@@ -11,3 +11,4 @@ export { Envelope, EnvelopeOptions } from "./envelope";
 export * from "./models";
 export * from "./sensor";
 export * from "./adjustedTime";
+export * from "./caliper-delivery-options";