make types more strict

Author: AbhiPrasad

packages/node/src/client.ts

@@ -164,17 +164,20 @@ export class NodeClient extends BaseClient<NodeClientOptions> {
     const options = this.getOptions();
     const { release, environment, tunnel } = options;
 
-    const id = checkIn.checkInId || uuid4();
+    const id = checkIn.status === 'in_progress' ? uuid4() : checkIn.checkInId;
 
     const serializedCheckIn: SerializedCheckIn = {
       check_in_id: id,
       monitor_slug: checkIn.monitorSlug,
       status: checkIn.status,
-      duration: checkIn.duration,
       release,
       environment,
     };
 
+    if (checkIn.status !== 'in_progress') {
+      serializedCheckIn.duration = checkIn.duration;
+    }
+
     if (monitorConfig) {
       serializedCheckIn.monitor_config = {
         schedule: monitorConfig.schedule,

packages/node/test/client.test.ts

@@ -361,7 +361,7 @@ describe('NodeClient', () => {
       // @ts-ignore accessing private method
       const sendEnvelopeSpy = jest.spyOn(client, '_sendEnvelope');
 
-      client.captureCheckIn({ monitorSlug: 'foo', status: 'ok', duration: 1222 });
+      client.captureCheckIn({ monitorSlug: 'foo', status: 'in_progress' });
 
       expect(sendEnvelopeSpy).toHaveBeenCalledTimes(0);
     });

packages/types/src/checkin.ts

@@ -38,16 +38,25 @@ export interface SerializedCheckIn {
   };
 }
 
-export type CheckIn = {
+interface InProgressCheckIn {
+  // The distinct slug of the monitor.
+  monitorSlug: SerializedCheckIn['monitor_slug'];
+  // The status of the check-in.
+  status: 'in_progress';
+}
+
+interface FinishedCheckIn {
   // The distinct slug of the monitor.
   monitorSlug: SerializedCheckIn['monitor_slug'];
   // Check-In ID (unique and client generated).
-  checkInId?: SerializedCheckIn['check_in_id'];
+  checkInId: SerializedCheckIn['check_in_id'];
   // The status of the check-in.
-  status: SerializedCheckIn['status'];
+  status: 'ok' | 'error';
   // The duration of the check-in in seconds. Will only take effect if the status is ok or error.
   duration?: SerializedCheckIn['duration'];
-};
+}
+
+export type CheckIn = InProgressCheckIn | FinishedCheckIn;
 
 type SerializedMonitorConfig = NonNullable<SerializedCheckIn['monitor_config']>;