@quesmed/types 1.5.0 → 1.5.3

package/models/OsceMarksheet.d.ts

@@ -62,6 +62,9 @@ export interface IOsceMarksheet {
     startedAt: number | Date;
     endedAt: number | Date;
     pausedAt: number | Date;
+    timeRemaining: string;
+    totalStationTime: string;
+    stage: EOsceStage;
     marks: IOsceMarksheetMark[];
     users: IOsceMarksheetUser[];
     members: IUser[];
@@ -85,9 +88,16 @@ export declare enum EOsceTimerState {
     PAUSE = 1,
     COMPLETED = 2
 }
+export declare enum EOsceStage {
+    READING = 0,
+    STATION = 1,
+    FEEDBACK = 2
+}
 export interface IOsceMarksheetTimer {
     osceMarksheetId: number;
     timeRemaining: string;
-    stationTime: string;
+    totalStationTime: string;
+    stage: EOsceStage;
     state: EOsceTimerState;
 }
+export declare function createTimerPayload(osceMarksheet: Partial<Omit<IOsceMarksheet, 'marks'>>): IOsceMarksheetTimer;

package/models/OsceMarksheet.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EOsceTimerState = exports.EOsceMarksheetState = exports.EOsceMarksheetAction = exports.EOsceRoles = void 0;
+exports.createTimerPayload = exports.EOsceStage = exports.EOsceTimerState = exports.EOsceMarksheetState = exports.EOsceMarksheetAction = exports.EOsceRoles = void 0;
+const utils_1 = require("../utils");
 var EOsceRoles;
 (function (EOsceRoles) {
     EOsceRoles[EOsceRoles["ALL"] = 0] = "ALL";
@@ -34,3 +35,65 @@ var EOsceTimerState;
     EOsceTimerState[EOsceTimerState["PAUSE"] = 1] = "PAUSE";
     EOsceTimerState[EOsceTimerState["COMPLETED"] = 2] = "COMPLETED";
 })(EOsceTimerState = exports.EOsceTimerState || (exports.EOsceTimerState = {}));
+var EOsceStage;
+(function (EOsceStage) {
+    EOsceStage[EOsceStage["READING"] = 0] = "READING";
+    EOsceStage[EOsceStage["STATION"] = 1] = "STATION";
+    EOsceStage[EOsceStage["FEEDBACK"] = 2] = "FEEDBACK";
+})(EOsceStage = exports.EOsceStage || (exports.EOsceStage = {}));
+function createTimerPayload(osceMarksheet) {
+    const payload = {
+        osceMarksheetId: osceMarksheet.id,
+        timeRemaining: '00:00',
+        totalStationTime: '00:00',
+        stage: EOsceStage.READING,
+        state: EOsceTimerState.PAUSE,
+    };
+    if (!osceMarksheet.startedAt ||
+        !osceMarksheet.endedAt ||
+        !osceMarksheet.readingTime ||
+        !osceMarksheet.stationTime ||
+        !osceMarksheet.feedbackTime) {
+        return payload;
+    }
+    payload.state = EOsceTimerState.START;
+    const stationDuration = osceMarksheet.readingTime +
+        (osceMarksheet.stationTime + osceMarksheet.feedbackTime) * 60;
+    payload.totalStationTime = (0, utils_1.printDuration)(stationDuration);
+    let endedAt;
+    if (typeof osceMarksheet.endedAt === 'number') {
+        endedAt = osceMarksheet.endedAt;
+    }
+    else {
+        endedAt = Math.floor(osceMarksheet.endedAt.getTime() / 1000);
+    }
+    // calculate duration from pause timestamp or from current time
+    let timeRemainingDuration = endedAt - Math.floor(Date.now() / 1000);
+    if (osceMarksheet.completed || timeRemainingDuration < 0) {
+        payload.state = EOsceTimerState.COMPLETED;
+    }
+    if (osceMarksheet.pausedAt) {
+        let pausedAt;
+        if (typeof osceMarksheet.pausedAt === 'number') {
+            pausedAt = osceMarksheet.pausedAt;
+        }
+        else {
+            pausedAt = Math.floor(osceMarksheet.pausedAt.getTime() / 1000);
+        }
+        timeRemainingDuration = endedAt - pausedAt;
+        payload.state = EOsceTimerState.PAUSE;
+    }
+    if (timeRemainingDuration > stationDuration - osceMarksheet.readingTime) {
+        payload.stage = EOsceStage.READING;
+    }
+    else if (timeRemainingDuration >
+        stationDuration - osceMarksheet.readingTime - osceMarksheet.stationTime * 60) {
+        payload.stage = EOsceStage.STATION;
+    }
+    else {
+        payload.stage = EOsceStage.FEEDBACK;
+    }
+    payload.timeRemaining = (0, utils_1.printDuration)(timeRemainingDuration);
+    return payload;
+}
+exports.createTimerPayload = createTimerPayload;

package/models/OsceMarksheet.mjs

@@ -1,3 +1,4 @@
+import { printDuration } from '../utils';
 export var EOsceRoles;
 (function (EOsceRoles) {
     EOsceRoles[EOsceRoles["ALL"] = 0] = "ALL";
@@ -31,3 +32,64 @@ export var EOsceTimerState;
     EOsceTimerState[EOsceTimerState["PAUSE"] = 1] = "PAUSE";
     EOsceTimerState[EOsceTimerState["COMPLETED"] = 2] = "COMPLETED";
 })(EOsceTimerState || (EOsceTimerState = {}));
+export var EOsceStage;
+(function (EOsceStage) {
+    EOsceStage[EOsceStage["READING"] = 0] = "READING";
+    EOsceStage[EOsceStage["STATION"] = 1] = "STATION";
+    EOsceStage[EOsceStage["FEEDBACK"] = 2] = "FEEDBACK";
+})(EOsceStage || (EOsceStage = {}));
+export function createTimerPayload(osceMarksheet) {
+    const payload = {
+        osceMarksheetId: osceMarksheet.id,
+        timeRemaining: '00:00',
+        totalStationTime: '00:00',
+        stage: EOsceStage.READING,
+        state: EOsceTimerState.PAUSE,
+    };
+    if (!osceMarksheet.startedAt ||
+        !osceMarksheet.endedAt ||
+        !osceMarksheet.readingTime ||
+        !osceMarksheet.stationTime ||
+        !osceMarksheet.feedbackTime) {
+        return payload;
+    }
+    payload.state = EOsceTimerState.START;
+    const stationDuration = osceMarksheet.readingTime +
+        (osceMarksheet.stationTime + osceMarksheet.feedbackTime) * 60;
+    payload.totalStationTime = printDuration(stationDuration);
+    let endedAt;
+    if (typeof osceMarksheet.endedAt === 'number') {
+        endedAt = osceMarksheet.endedAt;
+    }
+    else {
+        endedAt = Math.floor(osceMarksheet.endedAt.getTime() / 1000);
+    }
+    // calculate duration from pause timestamp or from current time
+    let timeRemainingDuration = endedAt - Math.floor(Date.now() / 1000);
+    if (osceMarksheet.completed || timeRemainingDuration < 0) {
+        payload.state = EOsceTimerState.COMPLETED;
+    }
+    if (osceMarksheet.pausedAt) {
+        let pausedAt;
+        if (typeof osceMarksheet.pausedAt === 'number') {
+            pausedAt = osceMarksheet.pausedAt;
+        }
+        else {
+            pausedAt = Math.floor(osceMarksheet.pausedAt.getTime() / 1000);
+        }
+        timeRemainingDuration = endedAt - pausedAt;
+        payload.state = EOsceTimerState.PAUSE;
+    }
+    if (timeRemainingDuration > stationDuration - osceMarksheet.readingTime) {
+        payload.stage = EOsceStage.READING;
+    }
+    else if (timeRemainingDuration >
+        stationDuration - osceMarksheet.readingTime - osceMarksheet.stationTime * 60) {
+        payload.stage = EOsceStage.STATION;
+    }
+    else {
+        payload.stage = EOsceStage.FEEDBACK;
+    }
+    payload.timeRemaining = printDuration(timeRemainingDuration);
+    return payload;
+}

package/models/User.d.ts

@@ -5,6 +5,7 @@ import { IQuestion } from './Question';
 import { ISubscription } from './Subscription';
 import { ITopic } from './Topic';
 import { Id } from './Type';
+export declare type IAccessLevel = 'subscriber' | 'administrator' | 'tutor';
 export declare type IClassYear = 'Year 1' | 'Year 2' | 'Year 3' | 'Year 4' | 'Year 5' | 'Graduated' | 'PhD' | 'BSc' | 'MSc' | 'Beta Tester';
 export declare const classYears: IClassYear[];
 export declare enum EClassYearGroup {
@@ -20,7 +21,7 @@ export interface IPayload {
     firstName: string;
     lastName: string;
     username: string;
-    accessLevel: string;
+    accessLevel: IAccessLevel;
     tocAccepted: boolean;
     exp: number;
     stripeSubscriptionEndDate: number | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quesmed/types",
-  "version": "1.5.0",
+  "version": "1.5.3",
   "description": "Typescript types for Quesmed",
   "main": "index.js",
   "module": "index.mjs",

package/resolvers/fragments/osce.js

@@ -88,6 +88,9 @@ exports.OSCE_MARKSHEET_FIELDS = (0, client_1.gql) `
     startedAt
     endedAt
     pausedAt
+    timeRemaining
+    totalStationTime
+    stage
     marks {
       ...OsceMarksheetMarkFields
     }

package/resolvers/fragments/osce.mjs

@@ -85,6 +85,9 @@ export const OSCE_MARKSHEET_FIELDS = gql `
     startedAt
     endedAt
     pausedAt
+    timeRemaining
+    totalStationTime
+    stage
     marks {
       ...OsceMarksheetMarkFields
     }

package/resolvers/mutation/restricted/osce.d.ts

@@ -74,7 +74,6 @@ export declare type ISaveOsceMarksheetData = RestrictedData<graphqlNormalize & I
 export declare const OSCE_MARKSHEET_ACTIONS: import("@apollo/client").DocumentNode;
 export interface IOsceMarksheetActionsVar {
     osceMarksheetId: Id;
-    agoraId: string;
     action: EOsceMarksheetAction;
 }
 export declare type IOsceMarksheetActionsData = RestrictedData<number, 'osceMarksheetActions'>;

package/resolvers/mutation/restricted/osce.js

@@ -132,7 +132,7 @@ exports.START_OSCE_TIMER = (0, client_1.gql) `
       startOsceTimer(osceMarksheetId: $osceMarksheetId) {
         osceMarksheetId
         timeRemaining
-        stationTime
+        totalStationTime
         state
       }
     }
@@ -183,17 +183,9 @@ exports.SAVE_OSCE_MARKSHEET = (0, client_1.gql) `
   }
 `;
 exports.OSCE_MARKSHEET_ACTIONS = (0, client_1.gql) `
-  mutation OsceMarksheetActions(
-    $osceMarksheetId: Int!
-    $agoraId: String!
-    $action: Int!
-  ) {
+  mutation OsceMarksheetActions($osceMarksheetId: Int!, $action: Int!) {
     restricted {
-      osceMarksheetActions(
-        osceMarksheetId: $osceMarksheetId
-        agoraId: $agoraId
-        action: $action
-      )
+      osceMarksheetActions(osceMarksheetId: $osceMarksheetId, action: $action)
     }
   }
 `;

package/resolvers/mutation/restricted/osce.mjs

@@ -128,7 +128,7 @@ export const START_OSCE_TIMER = gql `
       startOsceTimer(osceMarksheetId: $osceMarksheetId) {
         osceMarksheetId
         timeRemaining
-        stationTime
+        totalStationTime
         state
       }
     }
@@ -179,17 +179,9 @@ export const SAVE_OSCE_MARKSHEET = gql `
   }
 `;
 export const OSCE_MARKSHEET_ACTIONS = gql `
-  mutation OsceMarksheetActions(
-    $osceMarksheetId: Int!
-    $agoraId: String!
-    $action: Int!
-  ) {
+  mutation OsceMarksheetActions($osceMarksheetId: Int!, $action: Int!) {
     restricted {
-      osceMarksheetActions(
-        osceMarksheetId: $osceMarksheetId
-        agoraId: $agoraId
-        action: $action
-      )
+      osceMarksheetActions(osceMarksheetId: $osceMarksheetId, action: $action)
     }
   }
 `;

package/resolvers/subscription/osce.d.ts

@@ -1,6 +1,5 @@
-import { EOsceMarksheetAction, EOsceRoles, IClassYear, Id, IOsceMarksheetTimer, IOsceMarksheetUser, IUser } from '../../models';
+import { EClassYearGroup, EOsceMarksheetAction, EOsceRoles, IAccessLevel, IClassYear, Id, IOsceMarksheetTimer, IOsceMarksheetUser, IUser } from '../../models';
 import { RootData } from '../types';
-import { EClassYearGroup } from './../../models/User';
 export declare const OSCE_ROLE_CHANGE_KEY = "OSCE_ROLE_CHANGE";
 export declare const OSCE_MARKSHEET_ACTION_KEY = "OSCE_MARKSHEET_ACTION";
 export declare const OSCE_MARKSHEET_TIMER_KEY = "OSCE_MARKSHEET_TIMER";
@@ -44,6 +43,7 @@ export interface IOsceMatchmakingAction {
     userId: Id;
     classYear: IClassYear;
     classYearGroup: EClassYearGroup;
+    accessLevel: IAccessLevel;
     lastSyncAt: number;
     startedAt: number;
     grouped: boolean;

package/resolvers/subscription/osce.js

@@ -100,7 +100,8 @@ exports.OSCE_MARKSHEET_TIMER = (0, client_1.gql) `
     osceMarksheetTimer(osceMarksheetId: $osceMarksheetId) {
       osceMarksheetId
       timeRemaining
-      stationTime
+      totalStationTime
+      stage
       state
     }
   }

package/resolvers/subscription/osce.mjs

@@ -96,7 +96,8 @@ export const OSCE_MARKSHEET_TIMER = gql `
     osceMarksheetTimer(osceMarksheetId: $osceMarksheetId) {
       osceMarksheetId
       timeRemaining
-      stationTime
+      totalStationTime
+      stage
       state
     }
   }

package/utils/index.d.ts

@@ -6,3 +6,4 @@ export * from './webSocketLink';
 export * from './wordsToNumber';
 import uuid from './uuid4';
 export declare const Uuid4: typeof uuid;
+export declare function printDuration(duration: number): string;

package/utils/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Uuid4 = void 0;
+exports.printDuration = exports.Uuid4 = void 0;
 __exportStar(require("./commonFunctions"), exports);
 __exportStar(require("./lightgallery"), exports);
 __exportStar(require("./offlineLink"), exports);
@@ -22,3 +22,21 @@ __exportStar(require("./webSocketLink"), exports);
 __exportStar(require("./wordsToNumber"), exports);
 const uuid4_1 = __importDefault(require("./uuid4"));
 exports.Uuid4 = uuid4_1.default;
+function printDuration(duration) {
+    let timeRemainingMins = Math.floor(duration / 60);
+    if (timeRemainingMins < 0) {
+        timeRemainingMins = 0;
+    }
+    const timeRemainingMinsStr = timeRemainingMins >= 10
+        ? timeRemainingMins.toString()
+        : `0${timeRemainingMins}`;
+    let timeRemainingSecs = duration % 60;
+    if (timeRemainingSecs < 0) {
+        timeRemainingSecs = 0;
+    }
+    const timeRemainingSecsStr = timeRemainingSecs >= 10
+        ? timeRemainingSecs.toString()
+        : `0${timeRemainingSecs}`;
+    return `${timeRemainingMinsStr}:${timeRemainingSecsStr}`;
+}
+exports.printDuration = printDuration;

package/utils/index.mjs

@@ -6,3 +6,20 @@ export * from './webSocketLink';
 export * from './wordsToNumber';
 import uuid from './uuid4';
 export const Uuid4 = uuid;
+export function printDuration(duration) {
+    let timeRemainingMins = Math.floor(duration / 60);
+    if (timeRemainingMins < 0) {
+        timeRemainingMins = 0;
+    }
+    const timeRemainingMinsStr = timeRemainingMins >= 10
+        ? timeRemainingMins.toString()
+        : `0${timeRemainingMins}`;
+    let timeRemainingSecs = duration % 60;
+    if (timeRemainingSecs < 0) {
+        timeRemainingSecs = 0;
+    }
+    const timeRemainingSecsStr = timeRemainingSecs >= 10
+        ? timeRemainingSecs.toString()
+        : `0${timeRemainingSecs}`;
+    return `${timeRemainingMinsStr}:${timeRemainingSecsStr}`;
+}