@quesmed/types 2.1.24 → 2.2.1

package/dist/mjs/models/Marksheet.d.ts

@@ -1,6 +1,39 @@
+import { IPreBuildMarksheet } from '../resolvers/mutation/restricted/marksheet';
 import { IPrescribeAnswer, IPrescribeMark, IQuestion, IQuestionChoice, IQuestionQAAnswer } from './Question';
 import { Id } from './Type';
 import { IUser } from './User';
+export declare const enum EMarksheetState {
+    LOBBY = 0,
+    PRESTART = 1,
+    QUIZ_BUILDER = 2,
+    STATION = 3,
+    RESULT = 4
+}
+export declare const enum EMarksheetAction {
+    PRESTART = 0,
+    START = 1,
+    END = 2,
+    PAUSE = 3,
+    CONTINUE = 4,
+    CONNECT = 5,
+    DISCONNECT = 6,
+    SELECT = 7,
+    LEFT = 8,
+    KICK = 9,
+    CHOICE_SELECTED = 10,
+    QUESTION_CHANGE = 11,
+    TOPIC_CONCEPT_SELECTION = 12,
+    BUILDER_CONFIG_SELECTION = 13,
+    STATE_CHANGE = 14
+}
+export interface IMarksheetMember {
+    id: Id;
+    createdAt: number | Date | null;
+    marksheetId: Id;
+    marksheet?: IMarksheet | null;
+    userId: Id;
+    user?: IUser | null;
+}
 export interface IMarksheet {
     id: Id;
     createdAt: number | Date;
@@ -18,6 +51,15 @@ export interface IMarksheet {
     incorrect?: number;
     totalQuestions?: number;
     isTestMarksheet?: boolean;
+    solo: boolean;
+    agoraId: string;
+    users: IMarksheetMember[];
+    state: EMarksheetState;
+    completed: boolean;
+    timeTaken: number;
+    currentMarkId?: number;
+    topicConceptData?: string;
+    preBuildData?: IPreBuildMarksheet;
 }
 export declare type IMarksheetMarkJSONB = string | [string] | [IQuestionQAAnswer] | [string[], string[]] | [IPrescribeMark] | IPrescribeAnswer | null;
 export interface IMarksheetMark {
@@ -33,4 +75,5 @@ export interface IMarksheetMark {
     questionId: Id;
     question: IQuestion;
     mark: IMarksheetMarkJSONB;
+    marksheet?: IMarksheet;
 }

package/dist/mjs/models/Notification.d.ts

@@ -9,12 +9,10 @@ export declare const enum ENotificationType {
 }
 export declare const enum ENotificationActionType {
     REPLY = "REPLY",
-    UP_VOTE = "UP_VOTE",
-    DOWN_VOTE = "DOWN_VOTE",
     LIKE = "LIKE",
     DISLIKE = "DISLIKE",
     FEATURE = "FEATURE",
-    WARNING = "WARNING",
+    INFORMATION = "INFORMATION",
     REQUESTED = "REQUESTED",
     ACCEPTED = "ACCEPTED"
 }
@@ -28,6 +26,8 @@ export interface INotification {
     fromUser?: IUser;
     commentId: Id | null;
     comment?: IQuestionComment;
+    fromUserCommentId: Id | null;
+    fromUserComment?: IQuestionComment;
     conceptId: Id | null;
     concept?: IConcept;
     description: string;

package/dist/mjs/resolvers/mutation/restricted/marksheet.d.ts

@@ -1,23 +1,31 @@
 import { ApolloCache, ApolloClient } from '@apollo/client';
 import { ApolloUpdateOptions, ApolloUpdateResultRestricted } from '../..';
-import { Id } from '../../../models';
+import { EDifficultyType, Id } from '../../../models';
 import { graphqlNormalize, RestrictedData } from '../../types';
-import { IMarksheet } from './../../../models/Marksheet';
-import { IUserFlaggedQuestion } from './../../../models/User';
+import { EMarksheetAction, EMarksheetState, IMarksheet, IMarksheetMarkJSONB } from './../../../models/Marksheet';
+import { IUser, IUserFlaggedQuestion } from './../../../models/User';
 export interface IPreBuildMarksheet {
     unseen: number;
     seenCorrect: number;
     seenIncorrect: number;
     buildRef: number;
 }
-export declare const BUILD_MARKSHEET: import("@apollo/client").DocumentNode;
+/**
+ * buildMarksheet
+ */
 export interface IBuildMarksheetInput extends IPreBuildMarksheet {
     isTest: boolean;
+    marksheetId: Id;
+    secondsPerQuestion: number;
 }
 export interface IBuildMarksheetVar {
     buildMarksheet: IBuildMarksheetInput;
 }
 export declare type IBuildMarksheetData = RestrictedData<graphqlNormalize & IMarksheet, 'buildMarksheet'>;
+export declare const BUILD_MARKSHEET: import("@apollo/client").DocumentNode;
+/**
+ * reBuildMarksheet
+ */
 export declare const RE_BUILD_MARKSHEET: import("@apollo/client").DocumentNode;
 export interface IReBuildMarksheetVar {
     marksheetId: number;
@@ -30,6 +38,9 @@ export interface IMarksheetInput {
     mark?: string;
     timeTaken: number;
 }
+/**
+ * saveMarksheets
+ */
 export declare const SAVE_MARKSHEET: import("@apollo/client").DocumentNode;
 export declare const updateMarksheets: (cache: ApolloCache<any>, result: ApolloUpdateResultRestricted<ISaveMarksheetsData>, options: ApolloUpdateOptions) => void;
 export declare const optimisticSaveMarksheets: (client: ApolloClient<any>, marksheetInput: IMarksheetInput, questionIndex: number) => ISaveMarksheetsData;
@@ -37,14 +48,102 @@ export interface ISaveMarksheetsVar {
     marksheetInput: IMarksheetInput[];
 }
 export declare type ISaveMarksheetsData = RestrictedData<(graphqlNormalize & IMarksheet)[], 'saveMarksheets'>;
+/**
+ * addFlaggedQuestion
+ */
 export declare const ADD_FLAGGED_QUESTION: import("@apollo/client").DocumentNode;
 export interface IAddFlaggedQuestionVar {
     markId: number;
     questionId: number;
 }
 export declare type IAddFlaggedQuestionData = RestrictedData<graphqlNormalize & IUserFlaggedQuestion, 'addFlaggedQuestion'>;
+/**
+ * removeFlaggedQuestion
+ */
 export declare const REMOVE_FLAGGED_QUESTION: import("@apollo/client").DocumentNode;
 export interface IRemoveFlaggedQuestionVar {
     id: Id;
 }
 export declare type IRemoveFlaggedQuestionData = RestrictedData<graphqlNormalize & IUserFlaggedQuestion, 'removeFlaggedQuestion'>;
+/**
+ * startOrJoinMarksheet
+ */
+export interface IStartOrJoinMarksheetVar {
+    agoraId: string;
+    solo: boolean;
+}
+export declare type IStartOrJoinMarksheetData = RestrictedData<graphqlNormalize & IMarksheet, 'startOrJoinMarksheet'>;
+export declare const START_OR_JOIN_MARKSHEET: import("@apollo/client").DocumentNode;
+/**
+ * modifyMarksheetInfo
+ */
+export interface IMarksheetAction {
+    userId: Id;
+    user: IUser;
+    startedAt: Date | null;
+    endedAt: Date | null;
+    state: EMarksheetState;
+    action: EMarksheetAction;
+}
+export interface IMarkDataInfo {
+    markId?: Id;
+    questionChoiceId?: Id;
+    updatedAt?: Date;
+    questionId?: Id;
+    timeTaken?: number;
+    mark?: IMarksheetMarkJSONB;
+}
+export interface IBuildConfigData {
+    numberOfQuestions?: number;
+    difficulty?: number[];
+    unseen?: number;
+    seenIncorrect?: number;
+    seenCorrect?: number;
+    secondsPerQuestion?: number;
+    isTest?: boolean;
+}
+export interface IQbankInfoInput {
+    markSheetAction?: IMarksheetAction;
+    topicConceptData?: string;
+    builderConfig?: IBuildConfigData;
+    markData?: IMarkDataInfo;
+    action?: EMarksheetAction;
+    marksheetId: Id;
+}
+export interface IModifyMarksheetInfo {
+    qBankInfo: IQbankInfoInput;
+}
+export declare type IModifyMarksheetData = RestrictedData<graphqlNormalize & IMarksheet, 'modifyMarksheetInfo'>;
+export declare const MODIFY_MARKSHEET_INFO: import("@apollo/client").DocumentNode;
+/**
+ * preBuildMarksheet
+ */
+export interface IPreBuildMarksheetVarInput {
+    topicIds: number[];
+    conceptIds: number[];
+    search: string;
+    marksheetId?: Id;
+    source: string;
+    difficulty?: EDifficultyType[];
+}
+export interface IPreBuildMarksheetVar {
+    preBuildMarksheet: IPreBuildMarksheetVarInput;
+}
+export declare type IPreBuildMarksheetData = RestrictedData<graphqlNormalize & IPreBuildMarksheet, 'preBuildMarksheet'>;
+export declare const PRE_BUILD_MARKSHEET: import("@apollo/client").DocumentNode;
+/**
+ * leaveMarksheet
+ */
+export interface ILeaveMarksheetVar {
+    marksheetId: Id;
+}
+export declare type ILeaveMarksheetData = RestrictedData<graphqlNormalize & IMarksheet, 'leaveMarksheet'>;
+export declare const LEAVE_MARKSHEET: import("@apollo/client").DocumentNode;
+/**
+ * endMarksheet
+ */
+export interface IEndMarksheetVar {
+    marksheetId: Id;
+}
+export declare type IEndMarksheetData = RestrictedData<graphqlNormalize & boolean, 'endMarksheet'>;
+export declare const END_MARKSHEET: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/mutation/restricted/marksheet.js

@@ -2,14 +2,46 @@ import { gql } from '@apollo/client';
 import { MARKSHEET_MARK_FIELDS } from '../../fragments/marksheet';
 import { MARKSHEET, } from '../../query/restricted';
 export const BUILD_MARKSHEET = gql `
-  mutation BuildMarksheet($buildMarksheet: BuildMarksheetInput) {
+  mutation BuildMarksheet($buildMarksheet: BuildMarksheetInput!) {
     restricted {
       buildMarksheet(buildMarksheet: $buildMarksheet) {
         id
+        createdAt
+        startedAt
+        endedAt
+        topicIds
+        state
+        currentMarkId
+        topicConceptData
+        preBuildData
+        builderConfig
+        topicNames
+        source
+        user {
+          displayName
+          id
+        }
+        users {
+          user {
+            id
+            displayName
+          }
+        }
+        marks {
+          ...MarksheetMarkFields
+        }
+        mockTestId
+        correct
+        incorrect
+        totalQuestions
+        isTestMarksheet
       }
     }
   }
 `;
+/**
+ * reBuildMarksheet
+ */
 export const RE_BUILD_MARKSHEET = gql `
   ${MARKSHEET_MARK_FIELDS}
   mutation ReBuildMarksheet($marksheetId: Int!) {
@@ -21,8 +53,18 @@ export const RE_BUILD_MARKSHEET = gql `
         endedAt
         topicIds
         topicNames
+        state
+        currentMarkId
+        topicConceptData
+        preBuildData
+        builderConfig
         source
-        userId
+        users {
+          user {
+            id
+            displayName
+          }
+        }
         user {
           displayName
           id
@@ -39,6 +81,9 @@ export const RE_BUILD_MARKSHEET = gql `
     }
   }
 `;
+/**
+ * saveMarksheets
+ */
 export const SAVE_MARKSHEET = gql `
   mutation SaveMarksheet($marksheetInput: [MarksheetInput!]!) {
     restricted {
@@ -128,6 +173,9 @@ export const optimisticSaveMarksheets = (client, marksheetInput, questionIndex)
         },
     };
 };
+/**
+ * addFlaggedQuestion
+ */
 export const ADD_FLAGGED_QUESTION = gql `
   mutation AddFlaggedQuestion($markId: Int!, $questionId: Int!) {
     restricted {
@@ -137,6 +185,9 @@ export const ADD_FLAGGED_QUESTION = gql `
     }
   }
 `;
+/**
+ * removeFlaggedQuestion
+ */
 export const REMOVE_FLAGGED_QUESTION = gql `
   mutation RemoveFlaggedQuestion($id: Int!) {
     restricted {
@@ -146,3 +197,95 @@ export const REMOVE_FLAGGED_QUESTION = gql `
     }
   }
 `;
+export const START_OR_JOIN_MARKSHEET = gql `
+  mutation StartOrJoinMarksheet($agoraId: String!, $solo: Boolean!) {
+    restricted {
+      startOrJoinMarksheet(agoraId: $agoraId, solo: $solo) {
+        id
+        createdAt
+        startedAt
+        agoraId
+        endedAt
+        source
+        user {
+          id
+          displayName
+        }
+        state
+        users {
+          user {
+            id
+            displayName
+          }
+        }
+        completed
+      }
+    }
+  }
+`;
+export const MODIFY_MARKSHEET_INFO = gql `
+  mutation ModifyQbankInfo($qBankInfo: ModifyMarksheetInfoInput) {
+    restricted {
+      modifyQbankInfo(qBankInfo: $qBankInfo) {
+        id
+        createdAt
+        startedAt
+        endedAt
+        topicIds
+        state
+        currentMarkId
+        topicConceptData
+        preBuildData
+        builderConfig
+        topicNames
+        source
+        user {
+          displayName
+          id
+        }
+        users {
+          user {
+            id
+            displayName
+          }
+        }
+        marks {
+          ...MarksheetMarkFields
+        }
+        mockTestId
+        correct
+        incorrect
+        totalQuestions
+        isTestMarksheet
+      }
+    }
+  }
+`;
+export const PRE_BUILD_MARKSHEET = gql `
+  mutation PreBuildMarksheet($preBuildMarksheet: PreBuildMarksheetInput) {
+    restricted {
+      preBuildMarksheet(preBuildMarksheet: $preBuildMarksheet) {
+        unseen
+        seenCorrect
+        seenIncorrect
+        buildRef
+      }
+    }
+  }
+`;
+export const LEAVE_MARKSHEET = gql `
+  mutation LeaveMarksheet($marksheetId: Int!) {
+    restricted {
+      leaveMarksheet(marksheetId: $marksheetId) {
+        id
+      }
+    }
+  }
+`;
+export const END_MARKSHEET = gql `
+  mutation EndMarksheet($marksheetId: Int!) {
+    restricted {
+      endMarksheet(marksheetId: $marksheetId)
+    }
+  }
+`;

package/dist/mjs/resolvers/mutation/restricted/notification.d.ts

@@ -3,6 +3,7 @@ import { graphqlNormalize, RestrictedData } from '../../types';
 export interface IAddNotificationInput {
     fromUserId: Id | null;
     userId: Id | null;
+    fromUserCommentId: Id | null;
     commentId: Id | null;
     conceptId: Id | null;
     description: string;

package/dist/mjs/resolvers/query/restricted/marksheet.d.ts

@@ -1,20 +1,10 @@
-import { EDifficultyType, Id, IMarksheet, IUserFlaggedQuestion } from '../../../models';
-import { IPreBuildMarksheet } from '../../mutation/restricted';
+import { Id, IMarksheet, IUserFlaggedQuestion } from '../../../models';
 import { graphqlNormalize, RestrictedData } from '../../types';
 export interface IMarksheetVar {
     id: Id;
 }
 export declare type IMarksheetData = RestrictedData<graphqlNormalize & IMarksheet, 'marksheet'>;
 export declare const MARKSHEET: import("@apollo/client").DocumentNode;
-export interface IPreBuildMarksheetVar {
-    topicIds: number[];
-    conceptIds: number[];
-    search: string;
-    source: string;
-    difficulty?: EDifficultyType[];
-}
-export declare type IPreBuildMarksheetData = RestrictedData<graphqlNormalize & IPreBuildMarksheet, 'preBuildMarksheet'>;
-export declare const PRE_BUILD_MARKSHEET: import("@apollo/client").DocumentNode;
 export interface IMarksheetsVar {
     filter: {
         limit: number;
@@ -51,3 +41,11 @@ export interface IMarksheetFeedback {
 }
 export declare type IMarksheetFeedbackData = RestrictedData<graphqlNormalize & IMarksheetFeedback, 'marksheetFeedback'>;
 export declare const MARKSHEET_FEEDBACK: import("@apollo/client").DocumentNode;
+/**
+ * heartbeatQbank
+ */
+export interface IQbankHeartbeatVar {
+    agoraId: string;
+}
+export declare type IQBankHeartBeatData = RestrictedData<boolean, 'heartbeatQbank'>;
+export declare const HEARTBEAT_QBANK: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/query/restricted/marksheet.js

@@ -4,6 +4,30 @@ export const MARKSHEET = gql `
     restricted {
       marksheet(id: $id) {
         id
+        topicConceptData
+        currentMarkId
+        state
+        users {
+          user {
+            id
+            displayName
+          }
+        }
+        builderConfig {
+          difficulty
+          isTest
+          numberOfQuestions
+          secondsPerQuestion
+          unseen
+          seenCorrect
+          seenIncorrect
+        }
+        preBuildData {
+          buildRef
+          seenCorrect
+          seenIncorrect
+          unseen
+        }
         createdAt
         startedAt
         endedAt
@@ -522,30 +546,6 @@ export const MARKSHEET = gql `
     }
   }
 `;
-export const PRE_BUILD_MARKSHEET = gql `
-  query PreBuildMarksheet(
-    $topicIds: [Int!]
-    $conceptIds: [Int!]
-    $search: String
-    $source: String!
-    $difficulty: [Int!]
-  ) {
-    restricted {
-      preBuildMarksheet(
-        difficulty: $difficulty
-        topicIds: $topicIds
-        conceptIds: $conceptIds
-        search: $search
-        source: $source
-      ) {
-        unseen
-        seenCorrect
-        seenIncorrect
-        buildRef
-      }
-    }
-  }
-`;
 export const MARKSHEETS = gql `
   query Marksheets($filter: MarksheetFilterInput!) {
     restricted {
@@ -1213,3 +1213,10 @@ export const MARKSHEET_FEEDBACK = gql `
     }
   }
 `;
+export const HEARTBEAT_QBANK = gql `
+  query HeartbeatQbank($agoraId: String!) {
+    restricted {
+      heartbeatQbank(agoraId: $agoraId)
+    }
+  }
+`;

package/dist/mjs/resolvers/subscription/index.d.ts

@@ -1,2 +1,3 @@
 export * from './osce';
 export * from './notification';
+export * from './marksheet';

package/dist/mjs/resolvers/subscription/index.js

@@ -1,2 +1,3 @@
 export * from './osce';
 export * from './notification';
+export * from './marksheet';

package/dist/mjs/resolvers/subscription/marksheet.d.ts

@@ -0,0 +1,65 @@
+import { EMarksheetAction, EMarksheetState, Id, IMarksheetMarkJSONB, IMarksheetMember, IUser } from '../../models';
+import { IBuildConfigData } from '../mutation/restricted';
+import { RootData } from '../types';
+export interface IMarksheetGroupMember {
+    user: IUser | null;
+}
+export interface IMarksheetGroup {
+    marksheetId: Id;
+    agoraId: string;
+    members: IMarksheetMember[];
+    users: IUser[];
+}
+/**
+ * onMarksheetActionInfoChange
+ */
+export interface IOnMarksheetActionInfoChangeVar {
+    marksheetId: Id;
+}
+export interface IMarksheetActionInfo {
+    state: EMarksheetState;
+    marksheetId: Id;
+    agoraId: string;
+    userId: Id;
+    user: IUser;
+    startedAt: Date | null;
+    endedAt: Date | null;
+    action: EMarksheetAction;
+}
+export declare type IOnMarksheetActionChangeData = RootData<IMarksheetActionInfo, 'payload'>;
+export declare const ON_MARKSHEET_ACTION_INFO_CHANGE_KEY = "ON_MARKSHEET_ACTION_INFO_CHANGE";
+export declare const ON_MARKSHEET_ACTION_INFO_CHANGE: import("@apollo/client").DocumentNode;
+/**
+ * onPreStartMarksheetModification
+ */
+export interface IOnPreStartMarksheetModificationVar {
+    marksheetId: Id;
+}
+export interface IPreStartMarksheetData {
+    topicConceptData?: string;
+    action: EMarksheetAction;
+    builderConfig?: IBuildConfigData;
+    marksheetId: Id;
+}
+export declare type IOnPreStartMarksheetModificationData = RootData<IPreStartMarksheetData, 'payload'>;
+export declare const ON_PRESTART_MARKSHEET_MODIFICATION_KEY = "ON_PRESTART_MARKSHEET_MODIFICATION";
+export declare const ON_PRESTART_MARKSHEET_MODIFICATION: import("@apollo/client").DocumentNode;
+/**
+ * OnMarksheetDataModification
+ */
+export interface IOnMarksheetDataModificationVar {
+    marksheetId: Id;
+}
+export interface IMarksheetDataModification {
+    markId?: Id;
+    updatedAt?: Date;
+    marksheetId: Id;
+    questionChoiceId?: Id;
+    questionId?: Id;
+    timeTaken?: number;
+    mark?: IMarksheetMarkJSONB;
+    action?: EMarksheetAction;
+}
+export declare type IOnMarksheetDataModificationData = RootData<IMarksheetDataModification, 'payload'>;
+export declare const ON_MARKSHEET_DATA_MODIFICATION_KEY = "ON_MARKSHEET_DATA_MODIFICATION";
+export declare const ON_MARKSHEET_DATA_MODIFICATION: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/subscription/marksheet.js

@@ -0,0 +1,55 @@
+import { gql } from '@apollo/client';
+export const ON_MARKSHEET_ACTION_INFO_CHANGE_KEY = 'ON_MARKSHEET_ACTION_INFO_CHANGE';
+export const ON_MARKSHEET_ACTION_INFO_CHANGE = gql `
+  subscription OnMarksheetActionInfoChange($marksheetId: Int!) {
+    onMarksheetActionInfoChange(marksheetId: $marksheetId) {
+      marksheetId
+      agoraId
+      userId
+      user {
+        id
+        firstname
+        lastname
+        dispayname
+      }
+      startedAt
+      endedAt
+      state
+      action
+    }
+  }
+`;
+export const ON_PRESTART_MARKSHEET_MODIFICATION_KEY = 'ON_PRESTART_MARKSHEET_MODIFICATION';
+export const ON_PRESTART_MARKSHEET_MODIFICATION = gql `
+  subscription OnPreStartMarksheetModification($marksheetId: Int!) {
+    onPreStartMarksheetModification(marksheetId: $marksheetId) {
+      marksheetId
+      topicConceptData
+      action
+      builderConfig {
+        difficulty
+        isTest
+        numberOfQuestions
+        secondsPerQuestion
+        unseen
+        seenCorrect
+        seenIncorrect
+      }
+    }
+  }
+`;
+export const ON_MARKSHEET_DATA_MODIFICATION_KEY = 'ON_MARKSHEET_DATA_MODIFICATION';
+export const ON_MARKSHEET_DATA_MODIFICATION = gql `
+  subscription OnMarksheetDataModification($marksheetId: Int!) {
+    onMarksheetDataModification(marksheetId: $marksheetId) {
+      markId
+      updatedAt
+      marksheetId
+      questionId
+      questionChoiceId
+      timeTaken
+      mark
+      action
+    }
+  }
+`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quesmed/types",
-  "version": "2.1.24",
+  "version": "2.2.1",
   "description": "Typescript types for Quesmed",
   "keywords": [
     "quesmed",